https://github.com/robiningelbrecht/phpunit-coverage-tools

A PHPUnit extension to enforce minimum code coverage by using the clover XML report
https://github.com/robiningelbrecht/phpunit-coverage-tools

codecoverage phpunit testing website

Last synced: 7 days ago
JSON representation

A PHPUnit extension to enforce minimum code coverage by using the clover XML report

• Host: GitHub
• URL: https://github.com/robiningelbrecht/phpunit-coverage-tools
• Owner: robiningelbrecht
• License: mit
• Created: 2023-04-21T10:25:42.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-08-27T11:30:14.000Z (4 months ago)
• Last Synced: 2024-12-11T17:22:32.653Z (15 days ago)
• Topics: codecoverage, phpunit, testing, website
• Language: PHP
• Homepage: https://packagist.org/packages/robiningelbrecht/phpunit-coverage-tools
• Size: 240 KB
• Stars: 17
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
PHPUnit Coverage tools




















---

This extension allows you to enforce minimum code coverage by using the clover xml report from PHPUnit. 

Based on the given threshold the testsuite will exit ok if the coverage is higher than the threshold 

or exit with code 1 if the coverage is lower than the threshold. 

This can be used in your continuous deployment environment or can be added to a pre-commit hook.

## Installation

```bash

> composer require robiningelbrecht/phpunit-coverage-tools --dev

```

## Configuration

Navigate to your `phpunit.xml.dist` file and add following config to set default options:

```xml

    

        

        

    

```

## Usage

Just run your testsuite like you normally would, but add following arguments:

### --min-coverage=`[INTEGER]`

```bash

> vendor/bin/phpunit --coverage-clover=path/to/clover.xml -d --min-coverage=100

```

When assigning an integer between 0 - 100, you enforce a minimum code coverage 

for all your classes. In other words, the total coverage of your project has to be

higher than this threshold.

### --min-coverage=`[path/to/min-coverage-rules.php]`

```bash

 > vendor/bin/phpunit --coverage-clover=path/to/clover.xml -d --min-coverage="path/to/min-coverage-rules.php"

```

When referencing a PHP config file, you can configure more complex rules. 

This allows you to be stricter for critical parts of your application and less strict

for parts of your app that are not that critical.

For example:

```php