ockcyp/covers-validator

Validates @covers tags in PHPUnit tests

ockcyp/covers-validator

, _(*1)

PHPUnit @covers tags validator, _(*2)

PHPUnit fails to generate coverage report when tests have invalid @covers tags., _(*3)

This tool allows you to determine the tests that have invalid @covers tags without you needing to run the coverage., _(*4)

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., _(*5)

Also see: dunkelfrosch/phpcoverfish, _(*6)

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
Also see: phpunit/issues/1791, _(*7)

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., _(*8)

Install using the following for version 0.5:, _(*9)

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

Usage

vendor/bin/covers-validator

Give optional -c argument to load a particular PHPUnit configuration file:, _(*10)

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

Override bootstrap specified in PHPUnit configuration:, _(*11)

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

Disable output by providing -q argument, _(*12)

vendor/bin/covers-validator -q

Adjust the verbosity:, _(*13)

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., _(*14)

Tests

To run the tests, execute:, _(*15)

vendor/bin/phpunit