[CodeQuality] Detect Behat context by interface, not class name suffix#691
Merged
Conversation
isBehatContext() matched any class whose name ends with 'Context' via str_ends_with(). That false-positives on production classes like SchemaValidationContext, rewriting their assert() calls into \PHPUnit\Framework\Assert:: calls and pulling PHPUnit into non-test code. Detect a real Behat context by whether it implements Behat\Behat\Context\Context instead.
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.
Bug
AssertFuncCallToPHPUnitAssertRectordecided a class was a Behat context with:Any class whose name ends with
Contextmatched — including ordinaryproduction classes that have nothing to do with Behat. The rule then rewrote
their
assert()calls into\PHPUnit\Framework\Assert::calls, pulling PHPUnitinto non-test source.
Found in webonyx/graphql-php, whose
rector.phpskips this rule onsrcfor exactly this reason.SchemaValidationContext(a plain production class) was rewritten:
Fix
Detect a real Behat context by whether it implements
Behat\Behat\Context\Context(the existing
BehatClassName::CONTEXTconstant, already used the same way inScalarArgumentToExpectedParamTypeRector), instead of matching the class name.Existing
*Contextfixtures updated to implement the interface; addedskip_non_behat_context_class.php.inccovering a non-Behat*Contextclass.