Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/123inkt/phpunit-file-coverage-inspection
Configurable phpunit coverage inspection tool. Allow per file coverage inspections.
https://github.com/123inkt/phpunit-file-coverage-inspection
automation coding-standards coverage php phpunit test testing-tools
Last synced: 24 days ago
JSON representation
Configurable phpunit coverage inspection tool. Allow per file coverage inspections.
- Host: GitHub
- URL: https://github.com/123inkt/phpunit-file-coverage-inspection
- Owner: 123inkt
- License: mit
- Created: 2020-09-01T07:07:25.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T12:30:31.000Z (5 months ago)
- Last Synced: 2024-09-29T16:02:01.692Z (about 1 month ago)
- Topics: automation, coding-standards, coverage, php, phpunit, test, testing-tools
- Language: PHP
- Homepage:
- Size: 233 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://php.net/)
# 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
```
| 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
```shell script
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:
```shell script
php vendor/bin/phpfci inspect coverage.xml --reportCheckstyle=reports/checkstyle.xml
```
Gitlab format:
```shell script
php vendor/bin/phpfci inspect coverage.xml --reportGitlab=reports/gitlab.errors.json
```
Gitlab format to file and text output to stdout:
```shell script
php vendor/bin/phpfci inspect coverage.xml --reportGitlab=reports/gitlab.errors.json --reportText
```
Text format to stdout:
```shell script
php vendor/bin/phpfci inspect coverage.xml
php vendor/bin/phpfci inspect coverage1.xml coverage2.xml
```
```shell script
php vendor/bin/phpfci inspect coverage.xml --reportText
```
## 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=[]` | filepath or if absent stdout | the file (or stdout) to write the gitlab format to. |
| `--reportCheckstyle=[]` | filepath or if absent stdout | the file (or stdout) to write the checkstyle format to. |
| `--reportText=[]` | filepath or if absent stdout | the file (or stdout) to write the checkstyle format to. |
| `--config=` | `phpfci.xml` | the path to the config file. |
| `--baseDir=` | 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=`, `--reportCheckstyle=` or `--reportText=`
## 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](https://www.werkenbij123inkt.nl/zoek-op-afdeling/it).