mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-19 06:18:28 +01:00
Code Issues Projects Releases Wiki Activity
moodle/lib/phpunit
History
Petr Skoda a3d5830a0a MDL-32149 PHPUnit test support - part 2 
Includes:
* constants refactoring
* reworked db table init
* support for $CFG->debug = -1
* functional DB tests
* fixed $DB->get_indexes() to not throw exceptions when table does not exist
* fix handling of user passwords in test db
* add debug info to exception messages
* removed unnecessary PHP debug errors from mathslib
* fixed @error suppression in get_string
* fixed PHPUnit error handler setup
* added timezone info to default install
2012-04-03 22:30:53 +02:00
..
bootstrap.php
MDL-32149 PHPUnit test support - part 2
2012-04-03 22:30:53 +02:00
generatorlib.php
MDL-32149 PHPUnit test support - part 2
2012-04-03 22:30:53 +02:00
lib.php
MDL-32149 PHPUnit test support - part 2
2012-04-03 22:30:53 +02:00
readme.md
MDL-32149 PHPUnit test support - part 2
2012-04-03 22:30:53 +02:00

readme.md

PHPUnit testing support in Moodle

Installation

  1. install PHPUnit PEAR extension - see PHPUnit docs for more details
  2. edit main config.php - add $CFG->phpunit_prefix and $CFG->phpunit_dataroot - see config-dist.php for more details
  3. execute php admin/tool/phpunit/cli/util.php --install to initialise test database
  4. it is necessary to reinitialise the test database manually after every upgrade or installation of new plugins

Test execution

  • optionally generate phpunit.xml by executing php admin/tool/phpunit/cli/util.php --buildconfig - it collects test cases from all plugins
  • execute phpunit shell command from dirroot directory
  • you can also execute a single test phpunit core_phpunit_basic_testcase lib/tests/phpunit_test.php
  • or all tests in one directory phpunit --configuration phpunit.xml lib/tests/*_test.php
  • it is possible to create custom configuration files in xml format and use phpunit -c myconfig.xml

How to add more tests

  1. create tests directory in any plugin
  2. add *_test.php files with custom class that extends basic_testcase or advanced_testcase
  3. manually add all core unit test locations to phpunit.xml.dist

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.
  5. some old SimpleTest tests can be executed directly - mocking, database operations, assert(), etc. does not work, you may need to add global $CFG; before includes

FAQs

  • Why is it necessary to execute the tests from the command line? PHPUnit is designed to be executed from shell, existing Moodle globals and constants would interfere with it.
  • Why tests subdirectory? It is very unlikely that it will collide with any plugin name because plugin names use singular form.
  • Why is it necessary to include core and plugin suites in configuration files? PHPUnit does not seem to allow dynamic loading of tests from our dir structure.

TODO

  • add plugin callbacks to data generator
  • convert remaining tests
  • improve performance
  • hide old SimpleTests and FUnctional DB tests in UI
  • shell script that prepares everything for the first execution
  • optionally support for execution of tests and cli/util.php from web UI (to be implemented via shell execution)