PHPUnit
Moodle 2.3
What is PHPUnit
PHPUnit by Sebastian Bergmann is an advanced unit testing framework for PHP. It is distributed as a PEAR package and is not part of Moodle installation. To run PHPUnit tests, you have to manually install it on your development computer or test server.
Installation of PHPUnit support
The installation procedure depends on your operating system and the way you installed PHP. Moodle requires PHPUnit version 3.6.0 or higher.
- Install or enable PEAR support in your PHP installation (PHPUnit requires PEAR Installer version >= 1.9.4 and "pcntl" and "pdo" PHP extensions).
- Upgrade PEAR as root or administrator:
pear upgrade - Install the PHPUnit package as root or administrator:
pear config-set auto_discover 1
or
pear channel-discover pear.phpunit.de
and then
pear install pear.phpunit.de/PHPUnit pear install phpunit/DbUnit
Detailed instructions:
Initialisation of test environment
Our PHPUnit integration requires a dedicated database and dataroot. First, add a new dataroot directory and prefix into your config.php, you can find examples in config-dist.php
$CFG->phpunit_prefix = 'phpu_'; $CFG->phpunit_dataroot = '/home/example/phpu_moodledata';
If your system does not have a direct connection to the Internet, you also need to specify your proxy in config.php - even though you normally specify it by using the admin settings user interface. (If you do not use a proxy, you can skip this step.) Check the settings on the relevant admin settings page, or from the mdl_config table in your database, if you are unsure of the correct values.
// Normal proxy settings $CFG->proxyhost = 'wwwcache.example.org'; $CFG->proxyport = 80; $CFG->proxytype = 'HTTP'; $CFG->proxybypass = 'localhost, 127.0.0.1, .example.org'; // Omit the next lines if your proxy doesn't need a username/password $CFG->proxyuser = 'systemusername'; $CFG->proxypassword = 'systempassword';
Then you need to initialise the test environment using following command.
cd /home/example/moodle php admin/tool/phpunit/cli/init.php
This command has to be repeated after any upgrade, plugin (un)installation or if you have added tests to a plugin you are developing:
Test execution
To execute all test suites from main configuration file execute the phpunit script from your $CFG->dirroot directory.
cd /home/example/moodle phpunit
Use the relative path to a test file when you wish to execute a single test only (test case classname followed by path to test file):
cd /home/example/moodle phpunit core_phpunit_basic_testcase lib/tests/phpunit_test.php
In IDEs, you may need to specify the path to the PHPUnit configuration file. Use the absolute path to phpunit.xml from your $CFG->dirroot.
There is an alternative script for running of tests via web interface: admin/tool/phpunit/webrunner.php. Use this as the last resort only when you cannot use the command-line interface on your test server. It will most probably break due to permissions problems if you try to execute it both from command-line and from webrunner. This feature is not officially supported.
