PHPUnit tests

Warning

This page is primarily targeted at developers. If you are a normal user of this plugin, you can safely skip this section.

Creating a PHPUnit Test Environment

Spawn a shell inside your Moodle / php-fpm container and navigate to your Moodle root directory:
```
docker exec -it my-moodle-container sh
cd /usr/share/nginx/www/moodle/
```

Prepare the Moodle PHPUnit configuration. Add the following lines to your config.php:

config.php

<?php
$CFG->phpunit_prefix = 'phpu_';
$CFG->phpunit_dataroot = '/path/to/your/phpunit_moodledata';

Download composer and install dev dependencies:

wget https://getcomposer.org/download/latest-stable/composer.phar
php composer.phar install

Bootstrap the test environment:

php admin/tool/phpunit/cli/init.php --disable-composer

See: https://moodledev.io/general/development/tools/phpunit

Running tests

After you have sucessfully created a PHPUnit envirnoment, you can run the tests using the following commands:

Running all tests:
```
vendor/bin/phpunit --colors --testdox
```

Running all tests for a single component:

vendor/bin/phpunit --colors --testdox --filter quiz_archiver/*

Running a single test suite:

vendor/bin/phpunit --colors --testdox mod/quiz/report/archiver/tests/Report_test.php

Warning

All commands must be run from inside your Moodle root directory.

Automatic Test Execution for All Supported Software Configurations

The configuration for automated test execution via GitHub CI can be found in .github/workflows/moodle-plugin-ci.yml. It holds a matrix of all supported software configurations and runs the tests for each of them.