Download the PHP package digitalrevolution/phpunit-file-coverage-inspection without Composer
On this page you can find all versions of the php package digitalrevolution/phpunit-file-coverage-inspection. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download digitalrevolution/phpunit-file-coverage-inspection
More information about digitalrevolution/phpunit-file-coverage-inspection
Files in digitalrevolution/phpunit-file-coverage-inspection
Package phpunit-file-coverage-inspection
Short Description Configurable phpunit file coverage inspection
License MIT
Informations about the package phpunit-file-coverage-inspection
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:
Configuration
File: phpfci.xml
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
The base directory will be subtracted from the filepaths in coverage.xml
Usage
Checkstyle format:
Gitlab format:
Gitlab format to file and text output to stdout:
Text format to stdout:
Command line arguments
Option | Values | Description |
---|---|---|
argument 1 |
inspect , baseline |
the command to execute. |
argument 2 [argument 3 ]... |
coverage.xml [coverage2.xml ] |
the phpunit clover coverage input file(s). |
--reportGitlab=[<file>] |
filepath or if absent stdout | the file (or stdout) to write the gitlab format to. |
--reportCheckstyle=[<file>] |
filepath or if absent stdout | the file (or stdout) to write the checkstyle format to. |
--reportText=[<file>] |
filepath or if absent stdout | the file (or stdout) to write the checkstyle format to. |
--config=<path-to-file> |
phpfci.xml |
the path to the config file. |
--baseDir=<path> |
defaults to directory of the output file | The root directory of the project, will be used to make paths relative. |
--exit-code-on-failure |
- | Set exit code to 1 when there are failures. |
Note: if no --reportGitlab
, --reportCheckstyle
or --reportText
is set, it will default to --reportText=php://stdout
Migrating from 1 to 2
The third required argument and --report
has been removed, and should be replaced by:
--reportGitlab=<file>
, --reportCheckstyle=<file>
or --reportText=<file>
About us
At 123inkt (Part of Digital Revolution B.V.), every day more than 50 development professionals are working on improving our internal ERP and our several shops. Do you want to join us? We are looking for developers.
All versions of phpunit-file-coverage-inspection with dependencies
ext-dom Version *
ext-json Version *
ext-libxml Version *
ext-xmlwriter Version *
symfony/console Version ^6.2 || ^7.0