MDL-36701 add composer to phpunit readme
[moodle.git] / lib / phpunit / readme.md
1 PHPUnit testing support in Moodle
2 ==================================
5 Documentation
6 -------------
7 * [Moodle Dev wiki](http://docs.moodle.org/dev/PHPUnit)
8 * [PHPUnit online documentation](http://www.phpunit.de/manual/current/en/)
9 * [Composer dependency manager](http://getcomposer.org/)
12 Composer installation
13 ---------------------
14 Composer is a new dependency manager for PHP projects.
15 It installs PHP libraries into /vendor/ subdirectory inside your moodle dirroot.
17 1. install Composer - http://getcomposer.org/doc/00-intro.md
18 2. go to your moodle dirroot and execute `php composer.phar install`
21 PEAR installation (not recommended)
22 -----------------------------------
23 PEAR is a framework and distribution system for reusable PHP components.
24 The packages installed via PEAR are available in all PHP projects.
26 1. install PEAR package manager - see [PEAR Manual](http://pear.php.net/manual/en/installation.php)
27 2. install PHPUnit package and phpunit/DbUnit extension - see [PHPUnit installation documentation](http://www.phpunit.de/manual/current/en/installation.html)
28 3. edit main config.php - add `$CFG->phpunit_prefix` and `$CFG->phpunit_dataroot` - see config-dist.php
29 4. execute `php admin/tool/phpunit/cli/init.php` to initialise the test environment, repeat it after every upgrade or installation of plugins
32 Test execution
33 --------------
34 * execute `vendor/bin/phpunit` (or `phpunit` if you use PEAR) from dirroot directory
35 * you can execute a single test case class using class name followed by path to test file `vendor/bin/phpunit core_phpunit_basic_testcase lib/tests/phpunit_test.php`
36 * it is also possible to create custom configuration files in xml format and use `vendor/bin/phpunit -c mytestsuites.xml`
39 How to add more tests?
40 ----------------------
41 1. create `tests` directory in your plugin
42 2. add `local/mytest/tests/my_test.php` file with `local_my_testcase` class that extends `basic_testcase` or `advanced_testcase`
43 3. add some test_*() methods
44 4. execute your new test case `phpunit local_my_testcase local/mytest/tests/my_test.php`
45 5. execute `php admin/tool/phpunit/cli/init.php` to get the plugin tests included in main phpunit.xml configuration file
48 How to convert existing tests?
49 ------------------------------
50 1. create new test file in `xxx/tests/yyy_test.php`
51 2. copy contents of the old test file
52 3. replace `extends UnitTestCase` with `extends basic_testcase`
53 4. fix setUp(), tearDown(), asserts, etc.