Repository navigation
Check CoversClass, CoversTrait, CoversMethod and CoversFunction attributes - #358
Open
theluckystrike wants to merge 1 commit into
Open
theluckystrike wants to merge 1 commit into
theluckystrike wants to merge 1 commit into
Conversation
…ction] attributes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #289.
ClassCoversExistsRulenow also checks the PHPUnit coverage attributes on test classes:#[CoversClass(X::class)]: X must exist and must not be an interface (phpunit.coversClass,phpunit.coversInterface)#[CoversTrait(T::class)]: T must exist and be a trait (phpunit.coversTrait)#[CoversMethod(X::class, 'm')]: X must exist and have method m (phpunit.coversMethod)#[CoversFunction('f')]: f must exist (phpunit.coversFunction)The attributes are read with
getAttributesByName()from the BetterReflection class, likeClassAttributeRequiresPhpVersionRuledoes, so arguments come in already evaluated. Named arguments (className:etc.) work too. Errors are reported on the class line, the same place as the@coverserrors.I did not change
ClassMethodCoversExistsRule. In PHPUnit these attributes only target classes (Attribute::TARGET_CLASS), so there is nothing to read on methods. If you want the method rule to report a Covers attribute placed on a method, I can add that.Two points for review:
phpunit.coversTraitandphpunit.coversFunctionare new identifiers, and I kept the messages close to the@coversones. Happy to rename them.The new
testAttributescase inClassCoversExistsRuleTestusesdata/class-coverage-attributes.phpwith valid and invalid uses and a non-TestCase class. It fails on 2.1.x and passes with the change.phpunit,phpstan, parallel-lint and phpcs with build-cs pass locally.