PHPUnit

Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.

PHPUnit
Project state	Work in progress
Tracker issue	MDL-32323, MDL-32149, MDL-31857
Discussion	see tracker issues
Assignee	Petr Škoda (škoďák)

Moodle 2.3

Installation of PHPUnit support

PHPUnit is distributed as PEAR package, it is not part of Moodle installation. You have to manually install it on your dev computer. The installation procedure depends on your operating system or the way you installed PHP.

Installation steps:

1. install or enable PEAR support in your PHP
2. install PHPUnit package
3. verify phpunit (or phpunit.bat in Windows) can be executed

Usual *nix installation commands:

pear config-set auto_discover 1
pear install pear.phpunit.de/PHPUnit

Configuration of server before first test execution

Our PHPUnit integration requires a dedicated database and dataroot. First edit config.php, you need to specify new dataroot directory and prefix, you can find examples in config-dist.php

$CFG->phpunit_prefix = 'phpu_';
$CFG->phpunit_dataroot = '/home/example/phpu_moodledata';

Then you need to initialise the database using following commands:

php admin/tool/phpunit/cli/util.php --drop; php admin/tool/phpunit/cli/util.php --install

These commands have to be used also after any upgrade or plugin (un)installation.

Test execution

PHPUnit tests are executed from the command line. PHP IDEs usually have integration options for PHPUnit.

All test suites

Before first execution you should build new configuration file phpunit.xml by executing:

cd /home/example/moodle
php admin/tool/phpunit/cli/util.php --buildconfig

To execute all system tests specified in default configuration file run:

cd /home/example/moodle
phpunit

Individual tests

phpunit mod/yourmodule/tests/some_test.php

All tests in one directory

phpunit mod/yourmodule/tests/*_test.php

Execution from different directory or in IDEs

If you execute phpunit form directory different from your dirroot you need to specify path to configuration file.

phpunit -c /home/example/moodle/phpunit.xml /home/example/moodle/first_test.php

PHPUnit support in IDEs

• Eclipse PHP Tool Integration
• PHPStorm IDE
• Netbeans

See also

• PHPUnit online documenatation