Download the PHP package thor-juhasz/phpunit-coverage-check without Composer

phpunit-coverage-check

A PHPUnit test coverage checker.

This command will parse a clover.xml report file (generated by PHPUnit), to check that the test coverage meets a certain threshold (80% by default).

This library is loosely based on johanvanhelden's test coverage check.

Installation

Run this in your projects root directory:

This will add a new PHP binary to your vendor/bin/ directory, named phpunit-coverage-check.

Usage

Use in GitHub workflow

To use this library in a GitHub CI workflow, make sure to generate a clover.xml report file when running phpunit:

Then simply add this after the step than runs phpunit:

Run manually

Generate a clover.xml report file with PHPUnit:

Then you can run the binary provided by this library, passing the name of the clover.xml file as the first argument:

Arguments

filename (required)

The filename of the clover coverage XML file.

Example:

Options

threshold (optional)

Default value: 80

The threshold determines the lower value of acceptable test coverage. You can pass your desired threshold using --threshold N or -t N for short, where N is a number ranging from 0 to 100:

Example:

metric (optional)

Default value: elements

You can specify here which metric you want to use to read the code coverage. The supported metrics are:

• elements
• statements
• methods

Example:

suppress-errors (optional)

When the code coverage reported in the clover XML report is under the specified threshold, the command will exit with code 1. When used in a CI workflow, this results in that job failing.

If you would like to use this tool in a CI workflow, without failing the job, you can pass the --suppress-errors option (or -s for short).

Example:

Output

Example outputs: