Files

T

Eloy Lafuente (stronk7) 1093256560 MDL-81522 phpunit: Add missing void return type to all tests

While this change is not 100% required now, it's good habit
and we are checking for it since Moodle 4.4.

All the changes in this commit have been applied automatically
using the moodle.PHPUnit.TestReturnType sniff and are, exclusively
adding the ": void" return types when missing.

2024-06-11 12:18:04 +02:00

classes

MDL-81581 phpunit: Create the normalise_line_endings() method

2024-04-25 18:52:25 +02:00

tests

MDL-81522 phpunit: Add missing void return type to all tests

2024-06-11 12:18:04 +02:00

bootstrap.php

MDL-81456 core: Use DI for all hook access

2024-04-08 09:35:41 +08:00

bootstraplib.php

MDL-49841 testing: Correct composer incantation

2015-08-14 10:27:53 +08:00

lib.php

MDL-67673 phpunit: Remove the rerun hint on failed test cases

2020-10-21 12:46:00 +02:00

phpunit.xsd

MDL-71036 phpunit: xml config - add new (9.5) validation xsd

2021-03-11 23:04:31 +01:00

readme.md

MDL-77708 docs: Update references from docs.moodle.org/dev

2023-09-26 10:30:19 +02:00

readme.md

PHPUnit testing support in Moodle

Documentation

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 with my_test class that extends basic_testcase or advanced_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