Skip to content

[CodeQuality] Detect Behat context by interface, not class name suffix #691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TomasVotruba merged 1 commit into from
Jun 29, 2026
Merged

[CodeQuality] Detect Behat context by interface, not class name suffix #691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions ...ector/FuncCall/AssertFuncCallToPHPUnitAssertRector/Fixture/assert_compare_context.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;

final class AssertCompareContext
use Behat\Behat\Context\Context;

final class AssertCompareContext implements Context
{
public function some($response)
{
Expand All @@ -17,7 +19,9 @@ final class AssertCompareContext

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;

final class AssertCompareContext
use Behat\Behat\Context\Context;

final class AssertCompareContext implements Context
{
public function some($response)
{
Expand Down
8 changes: 6 additions & 2 deletions .../FuncCall/AssertFuncCallToPHPUnitAssertRector/Fixture/assert_null_compare_context.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;

final class AssertNullCompareContext
use Behat\Behat\Context\Context;

final class AssertNullCompareContext implements Context
{
public function some($response)
{
Expand All @@ -16,7 +18,9 @@ final class AssertNullCompareContext

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;

final class AssertNullCompareContext
use Behat\Behat\Context\Context;

final class AssertNullCompareContext implements Context
{
public function some($response)
{
Expand Down
8 changes: 6 additions & 2 deletions ...Rector/FuncCall/AssertFuncCallToPHPUnitAssertRector/Fixture/method_exists_context.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;

final class MethodExistsContext
use Behat\Behat\Context\Context;

final class MethodExistsContext implements Context
{
public function some($response)
{
Expand All @@ -16,7 +18,9 @@ final class MethodExistsContext

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;

final class MethodExistsContext
use Behat\Behat\Context\Context;

final class MethodExistsContext implements Context
{
public function some($response)
{
Expand Down
8 changes: 6 additions & 2 deletions ...uality/Rector/FuncCall/AssertFuncCallToPHPUnitAssertRector/Fixture/simple_context.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;

final class SimpleContext
use Behat\Behat\Context\Context;

final class SimpleContext implements Context
{
public function some($response)
{
Expand All @@ -18,7 +20,9 @@ final class SimpleContext

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;

final class SimpleContext
use Behat\Behat\Context\Context;

final class SimpleContext implements Context
{
public function some($response)
{
Expand Down
11 changes: 11 additions & 0 deletions ...FuncCall/AssertFuncCallToPHPUnitAssertRector/Fixture/skip_non_behat_context_class.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;

final class SchemaValidationContext
{
public function some($response)
{
assert($response instanceof \DateTime, 'only remaining option');
}
}
9 changes: 4 additions & 5 deletions rules/CodeQuality/Rector/FuncCall/AssertFuncCallToPHPUnitAssertRector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
use Rector\PhpParser\Node\Value\ValueResolver;
use Rector\PHPStan\ScopeFetcher;
use Rector\PHPUnit\Enum\AssertMethod;
use Rector\PHPUnit\Enum\BehatClassName;
use Rector\PHPUnit\Enum\PHPUnitClassName;
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
use Rector\Rector\AbstractRector;
Expand Down Expand Up @@ -195,15 +196,13 @@ public function refactor(Node $node): ?Class_
private function isBehatContext(Class_ $class): bool
{
$scope = ScopeFetcher::fetch($class);
if (! $scope->getClassReflection() instanceof ClassReflection) {
$classReflection = $scope->getClassReflection();
if (! $classReflection instanceof ClassReflection) {
return false;
}

$className = $scope->getClassReflection()
->getName();

// special case with static call
return str_ends_with($className, 'Context');
return $classReflection->is(BehatClassName::CONTEXT);
}

/**
Expand Down
Loading