https://github.com/oradwell/covers-validator

Validates covers tags in PHPUnit tests
https://github.com/oradwell/covers-validator

coverage php php7 phpunit testing

Last synced: about 11 hours ago
JSON representation

Validates covers tags in PHPUnit tests

• Host: GitHub
• URL: https://github.com/oradwell/covers-validator
• Owner: oradwell
• License: mit
• Created: 2015-10-22T22:43:27.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-10-04T20:01:58.000Z (over 2 years ago)
• Last Synced: 2025-01-11T02:55:05.064Z (8 days ago)
• Topics: coverage, php, php7, phpunit, testing
• Language: PHP
• Homepage:
• Size: 106 KB
• Stars: 21
• Watchers: 5
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
ockcyp/covers-validator

=======================

[![Build Status](https://api.travis-ci.com/oradwell/covers-validator.svg?branch=master)](https://app.travis-ci.com/github/oradwell/covers-validator)

[![Coverage Status](https://coveralls.io/repos/github/oradwell/covers-validator/badge.svg?branch=master)](https://coveralls.io/github/oradwell/covers-validator?branch=master)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/oradwell/covers-validator/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/oradwell/covers-validator/?branch=master)

[![License](https://poser.pugx.org/ockcyp/covers-validator/license)](https://packagist.org/packages/ockcyp/covers-validator)

[![Total Downloads](https://poser.pugx.org/ockcyp/covers-validator/downloads)](https://packagist.org/packages/ockcyp/covers-validator)

PHPUnit @covers tags validator

[PHPUnit](https://github.com/sebastianbergmann/phpunit) fails to generate coverage report

when tests have invalid [@covers](https://phpunit.de/manual/6.0/en/appendixes.annotations.html#appendixes.annotations.covers)

tags.

This tool allows you to determine the tests that have invalid @covers tags

without you needing to run the coverage.

Usually coverage reports are run less often than the tests as it takes

a long time to run. This tool validates your @covers tags

quicker than you run your tests.

**Also see:** [dunkelfrosch/phpcoverfish](https://github.com/dunkelfrosch/phpcoverfish)

Why?

----

```

Trying to @cover or @use not existing class or interface "NonExistentClass".

Trying to @cover or @use not existing method "ExistingClass::nonExistantMethod".

```

See: [phpunit/issues/1758](https://github.com/sebastianbergmann/phpunit/issues/1758)


Also see: [phpunit/issues/1791](https://github.com/sebastianbergmann/phpunit/issues/1791)

Installation

------------

```

composer require --dev ockcyp/covers-validator

```

### PHPUnit versions

Latest version of covers-validator supports PHP 7.1+ and PHPUnit 7+.

Please use version 0.5 for older PHP and PHPUnit versions.

| PHPUnit version | Covers-validator version |

| --------------- | ------------------------ |

| < 6.0           | 0.5.x                    |

| >= 6.0          | 1.x                      |

Install using the following for version 0.5:

```

composer require --dev ockcyp/covers-validator "^0.5"

```

Usage

-----

```

vendor/bin/covers-validator

```

Give optional `-c` argument to load a particular PHPUnit configuration file:

```

vendor/bin/covers-validator -c tests/Fixtures/configuration.xml

```

Override `bootstrap` specified in PHPUnit configuration:

```

vendor/bin/covers-validator --bootstrap tests/bootstrap.php

```

Disable output by providing `-q` argument

```

vendor/bin/covers-validator -q

```

Adjust the verbosity:

| Verbosity | Shows                               |

| --------- | ----------------------------------- |

| -v        | Valid tests                         |

| -vv       | Loaded configuration file           |

| -vvv      | Test name before validation is done |

### Sample output

#### Normal verbosity

```

Invalid - OckCyp\CoversValidator\Tests\Fixtures\TwoTestCoveringNonExistentClassTest::testDummyTest

There were 1 test(s) with invalid @covers tags.

```

#### Maximum verbosity (debug)

```

Configuration file loaded: /home/omer/Projects/Personal/covers-validator/tests/Fixtures/configuration-all.xml

Validating OckCyp\CoversValidator\Tests\Fixtures\TwoTestCoveringExistingClassTest::testDummyTest...

Valid - OckCyp\CoversValidator\Tests\Fixtures\TwoTestCoveringExistingClassTest::testDummyTest

Validating OckCyp\CoversValidator\Tests\Fixtures\TwoTestCoveringNonExistentClassTest::testDummyTest...

Invalid - OckCyp\CoversValidator\Tests\Fixtures\TwoTestCoveringNonExistentClassTest::testDummyTest

There were 1 test(s) with invalid @covers tags.

```

**Tip:** Command gives exit code 1 when any of the covers tags are invalid.

Use this to fail your builds.

Tests

-----

To run the tests, execute:

```

vendor/bin/phpunit

```