mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 22:08:20 +01:00
86b45212e8
After some tests, it seems that we can safely cover phpunit_util::reset_all_data() executing it within own basic_test self tests. That way we can confirm that the reset code is doing its job and detecting unexpected changes at various levels (database, globals, ...). Note that, in order to catch the E_USER_WARNINGS, for PHPUnit 9.6 and up, we have to convert them to exceptions, because the notice/ warning/error expectations have been deprecated and will be removed in PHPUnit 10. So we are using a trick, already used also by advanced_test. And, no matter that we are repeating the trick a few times, that's ok in order to have all its uses controlled.
PHPUnit testing support in Moodle
Documentation
- Moodle PHPUnit integration
- Moodle Writing PHPUnit tests
- PHPUnit online documentation
- Composer dependency manager
Composer installation
Composer is a dependency manager for PHP projects. It installs PHP libraries into /vendor/ subdirectory inside your moodle dirroot.
- install Composer - http://getcomposer.org/doc/00-intro.md
- install PHUnit and dependencies - go to your Moodle dirroot and execute
php composer.phar install
Configure your server
You need to create a new dataroot directory and specify a separate database prefix for the test environment, see config-dist.php for more information.
- add
$CFG->phpunit_prefix = 'phpu_';
to your config.php file - and
$CFG->phpunit_dataroot = '/path/to/phpunitdataroot';
to your config.php file
Initialise the test environment
Before first execution and after every upgrade the PHPUnit test environment needs to be initialised, this command also builds the phpunit.xml configuration files.
- execute
php admin/tool/phpunit/cli/init.php
Execute tests
- execute
vendor/bin/phpunit
from dirroot directory - you can execute a single test case class using class name followed by path to test file
vendor/bin/phpunit 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?
- create
tests/
directory in your add-on - add test file, for example
local/mytest/tests/my_test.php
file withmy_test
class that extendsbasic_testcase
oradvanced_testcase
- set the test class namespace to that of the class being tested
- add some
test_*()
methods - execute your new test case
vendor/bin/phpunit local/mytest/tests/my_test.php
- execute
php admin/tool/phpunit/cli/init.php
to get the plugin tests included in main phpunit.xml configuration file
Windows support
- use
\
instead of/
in paths in examples above