[Summary view] [Print] [Text view]

   1  PHPUnit testing support in Moodle
   2  ==================================
   3  
   4  
   5  Documentation
   6  -------------
   7  * [Moodle PHPUnit integration](http://docs.moodle.org/dev/PHPUnit)
   8  * [PHPUnit online documentation](http://www.phpunit.de/manual/current/en/)
   9  * [Composer dependency manager](http://getcomposer.org/)
  10  
  11  
  12  Composer installation
  13  ---------------------
  14  Composer is a dependency manager for PHP projects.
  15  It installs PHP libraries into /vendor/ subdirectory inside your moodle dirroot.
  16  
  17  1. install Composer - [http://getcomposer.org/doc/00-intro.md](http://getcomposer.org/doc/00-intro.md)
  18  2. install PHUnit and dependencies - go to your Moodle dirroot and execute `php composer.phar install`
  19  
  20  
  21  Configure your server
  22  ---------------------
  23  You need to create a new dataroot directory and specify a separate database prefix for the test environment,
  24  see config-dist.php for more information.
  25  
  26  * add `$CFG->phpunit_prefix = 'phpu_';` to your config.php file
  27  * and `$CFG->phpunit_dataroot = '/path/to/phpunitdataroot';` to your config.php file
  28  
  29  
  30  Initialise the test environment
  31  -------------------------------
  32  Before first execution and after every upgrade the PHPUnit test environment needs to be initialised,
  33  this command also builds the phpunit.xml configuration files.
  34  
  35  * execute `php admin/tool/phpunit/cli/init.php`
  36  
  37  
  38  Execute tests
  39  --------------
  40  * execute `vendor/bin/phpunit` from dirroot directory
  41  * 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`
  42  * it is also possible to create custom configuration files in xml format and use `vendor/bin/phpunit -c mytestsuites.xml`
  43  
  44  
  45  How to add more tests?
  46  ----------------------
  47  1. create `tests/` directory in your add-on
  48  2. add test file, for example `local/mytest/tests/my_test.php` file with `local_my_testcase` class that extends `basic_testcase` or `advanced_testcase`
  49  3. add some test_*() methods
  50  4. execute your new test case `vendor/bin/phpunit local_my_testcase local/mytest/tests/my_test.php`
  51  5. execute `php admin/tool/phpunit/cli/init.php` to get the plugin tests included in main phpunit.xml configuration file
  52  
  53  
  54  Windows support
  55  ---------------
  56  * use `\` instead of `/` in paths in examples above