Fetching contributors…
Cannot retrieve contributors at this time
106 lines (66 sloc) 5.05 KB

ThinkUp Tests

All code submitted to the repository should have corresponding tests that pass. Here's how to run and write tests.

Running Tests

First, configure your test environment.

Copy tests/ to tests/ and set the appropriate values. You will need a clean, empty database to run your tests. By default, name it thinkup_tests and set the $TEST_DATABASE config variable to that name. You will also need a local installation of ThinkUp; set the $TEST_SERVER_DOMAIN config variable equal to its URL--for example, http://localhost.

In webapp/, in the DEVELOPER CONFIG section, set the name of your tests database, and the username and password to access it. This database name should match the one you just set in tests/

Test Assumptions

In order for the tests to pass, you must:

  • Have a tests/ file with the correct values set
  • Set the crawler and stream log files in webapp/ and make those files writable
  • Set the test database name to an empty tests database which the tests will destroy each run in webapp/
  • Set the test database user to a user with all privileges in the test database and global CREATE, DROP, and FILE privs
  • Set caching to false in webapp/
  • Have a local installation of ThinkUp using your test database
  • Have a working internet connection

To run a particular test suite, like the UserDAO suite, in the ThinkUp source code root folder, use this command:

$ php tests/TestOfUserMySQLDAO.php

To run all the test suites, use:

$ php tests/all_tests.php

To run a single test, set the TEST_METHOD environment variable. For example:

$ TEST_METHOD=testIsPluginActive php tests/TestOfPluginMySQLDAO.php

Writing Tests

The test suite assumes there is an empty tests database (like thinkup_tests) which the default ThinkUp database user can access. If your test needs to read and write to the ThinkUp database, extend ThinkUpUnitTestCase and run parent::setUp() in your setUp() method, and parent::tearDown() in your tearDown() method. These methods create an empty copy of the ThinkUp database structure to execute a test, then drop all the tables in it when the test is complete. After you call the parent setUp() method in your test's setUp(), insert the data your test requires.

Best practices for writing tests are still getting developed. In the meantime, use existing tests as examples.

Model Tests (all_model_tests.php)

See TestOfOwnerInstanceMySQLDAO.php as an example of a set of DAO tests. Use the FixtureBuilder class to create test data fixtures to test against.

Controller Tests (all_controller_tests.php)

See TestOfDashboardController.php as an example of a set of controller test cases.

Plugin Tests (all_plugin_tests.php)

All plugin-specific tests should live in the thinkup/webapp/plugins/plugin-name/tests/ directory. Write tests for the plugin's model and controller objects.

To test consumption of data from web services, mock up the appropriate classes and store test data to local files in the format the API would return them in. For example, the classes/mock.TwitterOAuth.php class reads Twitter data from the files in the testdata directory.

See /thinkup/webapp/plugins/twitter/tests/ for examples of Twitter crawler plugin tests.

Integration Tests (all_integration_tests.php)

Add tests for particular pages inside the webapp to an appropriately-named class. See WebTestOfChangePassword.php for an example.

Once your tests pass, add them to the appropriate all_tests.php file to run with the existing suites. For example, new model tests should go in all_model_tests.php, new controller tests should go in all_controller_tests.php, etc.

How to Debug Tests

To print variable values to the terminal while running tests, use the ThinkUpWebTestCase::debug method or ThinkUpBasicTestCase::debug method. For example, you can add a line like this to your test:

$this->debug("This is my debugging statement which will print during my test run.");

To print something other than a string in a debug statement, use the Utils::varDumpToString method, like this:


To see your debug statements, run your test like so:

TEST_DEBUG=1 php tests/yourtest.php

I'm getting lots of test failures. Help!

Possible reasons for getting a high number of test failures include:

  • An incorrect $TEST_SERVER_DOMAIN in tests/ Please make sure that this points to the web root of your ThinkUp installation. Relevant thread
  • An incorrect value for any of the test database values. Please make sure that both and point to an existing, empty database.

If you have double-checked these and everything appears to be intact, send an email to the mailing list or pop into the IRC channel and we'll see what we can do to help you out.