How to run the test suite

Obviously, you should make sure to have a running development environment first.

The tests can be simply executed with:

$ make test

If you want to filter the tests to run, you can use the FILE and/or the FILTER environment variables:

$ make test FILE=tests/PagesTest.php
$ make test FILE=tests/PagesTest.php FILTER=testHome

Some tests require the mock_server to run. It's automatically started if you use the Docker environment.

A code coverage analysis is generated under the coverage/ folder and can be opened with your browser:

$ xdg-open coverage/index.html

If you want to change the coverage format, you can set the COVERAGE environment variable. It takes one of the value of the PHPUnit CLI options.

$ make test COVERAGE=--coverage-text

You also can run the linters with:

$ make lint
$ # or, to fix errors detected by the linters
$ make lint-fix

The test suite is automatically executed on pull requests with GitHub Actions. You can learn more by having a look at the workflow file.

Provide feedback