Jump to content
From ArchWiki

This article or section is a candidate for merging with PHP#PHPUnit.

Notes: Very small article with nothing more than installation and then usage which is documented upstream as an "example" (Discuss in Talk:PHPUnit)

PHPUnit is a programmer-oriented testing framework for PHP.

## Installation

The factual accuracy of this article or section is disputed.

Reason: AUR package should have priority over manual installation. (Discuss in Talk:PHPUnit)

By far the easiest way to install is using the PHP Archive (PHAR) package provided by the project. The PHAR package contains all dependencies as well as some of the optional dependencies for PHPUnit. The latest version can be retrieved from the project's site:

    $ wget https://phar.phpunit.de/phpunit.phar

Note: PHPUnit is also available as phpunitAUR.

You can then run PHPUnit using `php phpunit.phar`. You can also make the PHP Archive (`phpunit.phar`) executable and move it to /usr/local/bin or ~/bin or somewhere else you have in your `$PATH`.

### DbUnit

Since version 7, the DbUnit extension for database interaction testing is no longer supplied as part of the base PHAR, and needs to be installed separately. Download it from the project site:

    $ wget https://phar.phpunit.de/dbunit.phar

Place it in a suitable directory, and then configure PHPUnit to load extensions in that directory as described in the DbUnit readme.

## Example

This section gives beginners a very brief introduction to how to use PHPUnit to run test cases. It will not explain how to write them but if you want to get more information about this have a look at the references.

As the application to be tested we use in this example a JSON schema validator. In the directory tests you will see the directory mock and three files.

- mock
- JsonValidatorTest.php
- bootstrap.php
- phpunit.xml

mock contains JSON schemas which have nothing to do with PHPUnit itself, it is application-specific here, you will not find it in other applications.

phpunit.xml is a configuration file where you

- configure PHPUnit's core functionality,
- compose a test suite out of test suites and test cases,
- select groups of tests from a suite of tests that should (not) be run,
- configure the blacklist and whitelist for the code coverage reporting,
- configure the logging of the test execution,
- attach additional test listeners to the test execution,
- configure PHP settings, constants, and global variables or
- configure a list of Selenium RC servers.

In bootstrap.php you put code to be run before tests are executed. Here you could register your autoloading functions or include other php scripts. Though there is one limitation, only one bootstrap can be defined per PHPUnit configuration file.

JsonValidatorTest.php is the PHP file with the test cases. It is beyond the scope to explain the content of this file in depth. As a beginner you are most likely interested in how to run the test cases so what you need to execute is simply

    phpunit JsonValidatorTest JsonValidatorTest.php

You pass it the class with the test cases and the file where they are defined. That is it.

## References

- Official PHPUnit Manual
- Introduction to Unit Testing with PHPUnit

Category:

- Development

Hidden categories:

- Pages or sections flagged with Template:Merge
- Pages or sections flagged with Template:Accuracy