To ensure that all checks are working correctly, the team is maintaining a set of unit tests. The tests setup is based on wp-env, so you could run a clean installation to run all tests.
Follow these instructions to configure and run tests:
- You would need npm installed in your computer.
- Ensure that you have installed all npm dependencies with
npm ci. - You need to have Docker installed and running wp-env environment
npm run wp-env start. - Run tests with npm command
npm run test-php.
The full test suite is run against PRs as a GitHub action (example) so tests can be run against all supported environments. Passing tests is a requirement for merging PRs. Being able to run them locally is meant to help developers while working on or debugging tests, prior to submitting their code for review.
We have this structure for the tests folder:
tests/phpunitUnit tests for the plugin.tests/phpunit/tests/All PHPUnit tests that run as part of the suite.tests/phpunit/testdata/Example classes or plugins that can be used in tests.tests/phpunit/utils/Shared helpers that can be used across different test classes.
Ensure that you create your check and unit test at same time.