Manual:PHP unit testing/Getting started

« Unit testing
PHPUnit testing

Contents

• Getting started
• Installing PHPUnit
• Running the unit tests
  • PostgreSQL
  • Oracle
• Generate code coverage
• Writing testable PHP code
• Writing unit tests
  • ...for extensions
• Continuous integration
• Understanding build failures
• Appendix
  (how to help, resources..)

---

Tools

• PHPUnit

Core MediaWiki PHP unit tests are in the tests/phpunit directory. Extensions often have tests in a tests/ subdirectory.

1. Install PHPUnit using the MediaWiki PHPUnit installer (Note: only works for Unix-like operating systems, such as Ubuntu, Mac OS X, Linux, etc.)

   cd tests/phpunit

   sudo ./install-phpunit.sh

2. Run the tests. The --testdox option produces a nicer output, with checkboxes, where an unchecked box ([ ]) means the test failed.

   php phpunit.php --testdox

3. Restricting the tests:

   by file:

   php phpunit.php --testdox <path/to/fileTest.php> # Usually it's enough to simply append "Test" to the filename.

   by folder:

   php phpunit.php --testdox <path/to/directory/>

   by group:

   make list-groups

   php phpunit.php --testdox --group <group-name>

   by target:

   make help # list available targets

   make <target-name> # run the chosen target

---