moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-04 16:36:37 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
moodle/lib/phpunit
History
Frederic Massart d6277b0ca0 MDL-40997 phpunit: Assertions for events legacy data
2013-08-02 18:30:02 +08:00
..
classes MDL-40997 phpunit: Assertions for events legacy data 2013-08-02 18:30:02 +08:00
tests MDL-40388 Reset globals after each unit test 2013-07-09 12:26:28 +08:00
bootstrap.php MDL-40475 add alternative component cache location and other improvements 2013-07-12 13:05:41 +02:00
bootstraplib.php MDL-38589 improve missing PHPUnit library hint 2013-03-22 22:47:08 +01:00
generatorlib.php MDL-37457 testing Mark current classes as deprecated 2013-01-15 11:07:45 +08:00
lib.php MDL-40997 phpunit: Assertions for events legacy data 2013-08-02 18:30:02 +08:00
phpunit.xsd MDL-32323 add schema for phpunit.xml configuration file 2012-04-10 15:27:01 +02:00
readme.md MDL-36936 require phpunit as composer --dev only 2012-12-07 18:20:03 +01:00

readme.md

PHPUnit testing support in Moodle

Documentation

Composer installation

Composer is a new dependency manager for PHP projects. It installs PHP libraries into /vendor/ subdirectory inside your moodle dirroot.

  1. install Composer - http://getcomposer.org/doc/00-intro.md
  2. go to your moodle dirroot and execute php composer.phar install --dev

PEAR installation (not recommended)

PEAR is a framework and distribution system for reusable PHP components. The packages installed via PEAR are available in all PHP projects.

  1. install PEAR package manager - see PEAR Manual
  2. install PHPUnit package and phpunit/DbUnit extension - see PHPUnit installation documentation
  3. edit main config.php - add $CFG->phpunit_prefix and $CFG->phpunit_dataroot - see config-dist.php
  4. execute php admin/tool/phpunit/cli/init.php to initialise the test environment, repeat it after every upgrade or installation of plugins

Test execution

  • execute vendor/bin/phpunit (or phpunit if you use PEAR) from dirroot directory
  • 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
  • it is also possible to create custom configuration files in xml format and use vendor/bin/phpunit -c mytestsuites.xml

How to add more tests?

  1. create tests directory in your plugin
  2. add local/mytest/tests/my_test.php file with local_my_testcase class that extends basic_testcase or advanced_testcase
  3. add some test_*() methods
  4. execute your new test case phpunit local_my_testcase local/mytest/tests/my_test.php
  5. execute php admin/tool/phpunit/cli/init.php to get the plugin tests included in main phpunit.xml configuration file

How to convert existing tests?

  1. create new test file in xxx/tests/yyy_test.php
  2. copy contents of the old test file
  3. replace extends UnitTestCase with extends basic_testcase
  4. fix setUp(), tearDown(), asserts, etc.