PHPUnit coverage inspection

A tool to allow code coverage rules be defined per file. Set a minimum coverage threshold for every file and configure custom minimum coverage for existing files if the current test coverage is not up to standards yet. Inspection failure will be output in checkstyle format, allowing it to be imported in ci/cd tools.

Use case

Standard coverage calculation is calculated over the whole codebase. If for example the threshold is 80% and one file drops below 80% you never notice this because the overall coverage went from 87.6% to 87.4%. This package makes sure that that doesn't happen anymore and coverage is calculated on a per-file basis.

Supported formats

• Input: clover coverage.xml
• Output: checkstyle or gitlab

Installation

Include the library as dependency in your own project via:

composer require "digitalrevolution/phpunit-file-coverage-inspection" --dev

Configuration

File: phpfci.xml

<?xml version="1.0" encoding="UTF-8"?>
<phpfci xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="vendor/digitalrevolution/phpunit-file-coverage-inspection/resources/phpfci.xsd"
        min-coverage="100"
>
    <custom-coverage>
        <file path="src/FileA.php" min="80"/>
        <file path="src/FileB.php" min="60"/>
    </custom-coverage>
</phpfci>

Option	Required	Default	Description
min-coverage	yes	-	The minimum global coverage
allow-uncovered-methods	no	false	All methods should have atleast some coverage

or generate a config file based on existing coverage results

php vendor/bin/phpfci baseline --baseDir /home/ci/workspace coverage.xml ./phpfci.xml

The base directory will be subtracted from the filepaths in coverage.xml

Usage

Checkstyle format:

php vendor/bin/phpfci inspect coverage.xml reports/checkstyle.xml --report=checkstyle

Gitlab format:

php vendor/bin/phpfci inspect coverage.xml reports/gitlab.errors.json --report=gitlab

Command line arguments

Option	Values	Description
argument 1	inspect, baseline	the command to execute.
argument 2	coverage.xml	the phpunit clover coverage input file.
argument 3	phpfci.xml	the output file to write to.
--report=<report-style>	gitlab, checkstyle	the output format. If absent will default to console.
--config=<path-to-file>	phpfci.xml	the path to the config file.
--exit-code-on-failure	-	Set exit code to 1 when there are failures.

About us

At 123inkt (Part of Digital Revolution B.V.), every day more than 30 developers are working on improving our internal ERP and our several shops. Do you want to join us? We are looking for developers.