Skip to content

Commit 57a5555

Browse files
TomasVotrubaactions-user
TomasVotruba
and
actions-user
authored
[CodeQuality] Add AssertFuncCallToPHPUnitAssertRector (#450)
* [CodeQuality] Add AssertFuncCallToPHPUnitAssertRector * [ci-review] Rector Rectify --------- Co-authored-by: GitHub Action <actions@github.com>
1 parent 289978f commit 57a5555

11 files changed

Lines changed: 366 additions & 2 deletions

File tree

‎config/sets/phpunit-code-quality.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
NarrowUnusedSetUpDefinedPropertyRector::class,
5858

5959
// specific asserts
60+
6061
AssertCompareOnCountableWithMethodToAssertCountRector::class,
6162
AssertComparisonToSpecificMethodRector::class,
6263
AssertNotOperatorRector::class,

‎rector.php‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,13 @@
2323

2424
// object types
2525
StringClassNameToClassConstantRector::class => [
26-
__DIR__ . '/src/Rector/Class_/TestListenerToHooksRector.php',
2726
__DIR__ . '/src/NodeAnalyzer/TestsNodeAnalyzer.php',
2827
__DIR__ . '/config',
2928
__DIR__ . '/src/NodeFinder/DataProviderClassMethodFinder.php',
3029
],
3130
])
3231
->withPhpSets()
33-
->withAttributesSets(all: true)
32+
->withAttributesSets()
3433
->withPreparedSets(
3534
deadCode: true,
3635
codeQuality: true,

‎rules-tests/CodeQuality/Rector/FuncCall/AssertFuncCallToPHPUnitAssertRector/AssertFuncCallToPHPUnitAssertRectorTest.php‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class AssertFuncCallToPHPUnitAssertRectorTest extends AbstractRectorTestCase
12+
{
13+
#[DataProvider('provideData')]
14+
public function test(string $filePath): void
15+
{
16+
$this->doTestFile($filePath);
17+
}
18+
19+
public static function provideData(): Iterator
20+
{
21+
return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
22+
}
23+
24+
public function provideConfigFilePath(): string
25+
{
26+
return __DIR__ . '/config/configured_rule.php';
27+
}
28+
}

‎rules-tests/CodeQuality/Rector/FuncCall/AssertFuncCallToPHPUnitAssertRector/Fixture/assert_bool_in_test.php.inc‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;
4+
5+
use PHPUnit\Framework\TestCase;
6+
7+
final class AssertBoolInTest extends TestCase
8+
{
9+
public function some($response)
10+
{
11+
assert((bool) $response);
12+
}
13+
}
14+
15+
?>
16+
-----
17+
<?php
18+
19+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;
20+
21+
use PHPUnit\Framework\TestCase;
22+
23+
final class AssertBoolInTest extends TestCase
24+
{
25+
public function some($response)
26+
{
27+
$this->assertTrue((bool) $response);
28+
}
29+
}
30+
31+
?>

‎rules-tests/CodeQuality/Rector/FuncCall/AssertFuncCallToPHPUnitAssertRector/Fixture/assert_compare_context.php.inc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;
4+
5+
final class AssertCompareContext
6+
{
7+
public function some($response)
8+
{
9+
assert($response == 2.5);
10+
assert($response === 'yes');
11+
}
12+
}
13+
14+
?>
15+
-----
16+
<?php
17+
18+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;
19+
20+
final class AssertCompareContext
21+
{
22+
public function some($response)
23+
{
24+
\PHPUnit\Framework\Assert::assertEquals(2.5, $response);
25+
\PHPUnit\Framework\Assert::assertSame('yes', $response);
26+
}
27+
}
28+
29+
?>

‎rules-tests/CodeQuality/Rector/FuncCall/AssertFuncCallToPHPUnitAssertRector/Fixture/assert_null_compare_context.php.inc‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;
4+
5+
final class AssertNullCompareContext
6+
{
7+
public function some($response)
8+
{
9+
assert($response !== null);
10+
}
11+
}
12+
13+
?>
14+
-----
15+
<?php
16+
17+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;
18+
19+
final class AssertNullCompareContext
20+
{
21+
public function some($response)
22+
{
23+
\PHPUnit\Framework\Assert::assertNotNull($response);
24+
}
25+
}
26+
27+
?>

‎rules-tests/CodeQuality/Rector/FuncCall/AssertFuncCallToPHPUnitAssertRector/Fixture/method_exists_context.php.inc‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;
4+
5+
final class MethodExistsContext
6+
{
7+
public function some($response)
8+
{
9+
assert(method_exists($response, 'some_method'));
10+
}
11+
}
12+
13+
?>
14+
-----
15+
<?php
16+
17+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;
18+
19+
final class MethodExistsContext
20+
{
21+
public function some($response)
22+
{
23+
\PHPUnit\Framework\Assert::assertTrue(method_exists($response, 'some_method'));
24+
}
25+
}
26+
27+
?>

‎rules-tests/CodeQuality/Rector/FuncCall/AssertFuncCallToPHPUnitAssertRector/Fixture/simple_context.php.inc‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
3+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;
4+
5+
final class SimpleContext
6+
{
7+
public function some($response)
8+
{
9+
assert($response instanceof \DateTime);
10+
11+
assert($response instanceof \DateTimeInterface, 'extra message');
12+
}
13+
}
14+
15+
?>
16+
-----
17+
<?php
18+
19+
namespace Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\Fixture;
20+
21+
final class SimpleContext
22+
{
23+
public function some($response)
24+
{
25+
\PHPUnit\Framework\Assert::assertInstanceOf(\DateTime::class, $response);
26+
27+
\PHPUnit\Framework\Assert::assertInstanceOf(\DateTimeInterface::class, $response, 'extra message');
28+
}
29+
}
30+
31+
?>

‎rules-tests/CodeQuality/Rector/FuncCall/AssertFuncCallToPHPUnitAssertRector/config/configured_rule.php‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\Config\RectorConfig;
6+
use Rector\PHPUnit\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector;
7+
8+
return RectorConfig::configure()
9+
->withRules([AssertFuncCallToPHPUnitAssertRector::class]);

‎rules/CodeQuality/Rector/FuncCall/AssertFuncCallToPHPUnitAssertRector.php‎

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\CodeQuality\Rector\FuncCall;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Arg;
9+
use PhpParser\Node\Expr;
10+
use PhpParser\Node\Expr\BinaryOp\Equal;
11+
use PhpParser\Node\Expr\BinaryOp\Identical;
12+
use PhpParser\Node\Expr\BinaryOp\NotIdentical;
13+
use PhpParser\Node\Expr\Cast\Bool_;
14+
use PhpParser\Node\Expr\ClassConstFetch;
15+
use PhpParser\Node\Expr\FuncCall;
16+
use PhpParser\Node\Expr\Instanceof_;
17+
use PhpParser\Node\Expr\MethodCall;
18+
use PhpParser\Node\Expr\StaticCall;
19+
use PhpParser\Node\Expr\Variable;
20+
use PhpParser\Node\Name\FullyQualified;
21+
use PHPStan\Reflection\ClassReflection;
22+
use Rector\PhpParser\Node\Value\ValueResolver;
23+
use Rector\PHPStan\ScopeFetcher;
24+
use Rector\PHPUnit\Enum\AssertMethod;
25+
use Rector\PHPUnit\Enum\PHPUnitClassName;
26+
use Rector\Rector\AbstractRector;
27+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
28+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
29+
30+
/**
31+
* @see \Rector\PHPUnit\Tests\CodeQuality\Rector\FuncCall\AssertFuncCallToPHPUnitAssertRector\AssertFuncCallToPHPUnitAssertRectorTest
32+
*/
33+
final class AssertFuncCallToPHPUnitAssertRector extends AbstractRector
34+
{
35+
public function __construct(
36+
private readonly ValueResolver $valueResolver
37+
) {
38+
}
39+
40+
public function getRuleDefinition(): RuleDefinition
41+
{
42+
return new RuleDefinition('Turns assert() calls to their explicit PHPUnit assert alternative', [
43+
new CodeSample('assert($value === 100, "message");', '$this->assertSame(100, $value, "message");'),
44+
]);
45+
}
46+
47+
/**
48+
* @return class-string[]
49+
*/
50+
public function getNodeTypes(): array
51+
{
52+
return [FuncCall::class];
53+
}
54+
55+
/**
56+
* @param FuncCall $node
57+
*/
58+
public function refactor(Node $node): StaticCall|MethodCall|null
59+
{
60+
if ($node->isFirstClassCallable()) {
61+
return null;
62+
}
63+
64+
if (! $this->isName($node, 'assert')) {
65+
return null;
66+
}
67+
68+
if (! $this->isTestFilePath($node) && ! $this->isBehatContext($node)) {
69+
return null;
70+
}
71+
72+
$comparedExpr = $node->getArgs()[0]
73+
->value;
74+
75+
if ($comparedExpr instanceof Equal) {
76+
$methodName = AssertMethod::ASSERT_EQUALS;
77+
$exprs = [$comparedExpr->right, $comparedExpr->left];
78+
79+
} elseif ($comparedExpr instanceof Identical) {
80+
$methodName = AssertMethod::ASSERT_SAME;
81+
$exprs = [$comparedExpr->right, $comparedExpr->left];
82+
83+
} elseif ($comparedExpr instanceof NotIdentical) {
84+
if ($this->valueResolver->isNull($comparedExpr->right)) {
85+
$methodName = 'assertNotNull';
86+
$exprs = [$comparedExpr->left];
87+
} else {
88+
return null;
89+
}
90+
91+
} elseif ($comparedExpr instanceof Bool_) {
92+
$methodName = 'assertTrue';
93+
$exprs = [$comparedExpr];
94+
} elseif ($comparedExpr instanceof FuncCall) {
95+
if ($this->isName($comparedExpr, 'method_exists')) {
96+
$methodName = 'assertTrue';
97+
$exprs = [$comparedExpr];
98+
} else {
99+
return null;
100+
}
101+
} elseif ($comparedExpr instanceof Instanceof_) {
102+
// outside TestCase
103+
$methodName = 'assertInstanceOf';
104+
$exprs = [];
105+
106+
if ($comparedExpr->class instanceof FullyQualified) {
107+
$classConstFetch = new ClassConstFetch($comparedExpr->class, 'class');
108+
$exprs[] = $classConstFetch;
109+
} else {
110+
return null;
111+
}
112+
113+
$exprs[] = $comparedExpr->expr;
114+
} else {
115+
return null;
116+
}
117+
118+
// is there a comment message
119+
if (isset($node->getArgs()[1])) {
120+
$exprs[] = $node->getArgs()[1]->value;
121+
}
122+
123+
return $this->createCall($node, $methodName, $exprs);
124+
}
125+
126+
private function isBehatContext(FuncCall $funcCall): bool
127+
{
128+
$scope = ScopeFetcher::fetch($funcCall);
129+
if (! $scope->getClassReflection() instanceof ClassReflection) {
130+
return false;
131+
}
132+
133+
$className = $scope->getClassReflection()
134+
->getName();
135+
136+
// special case with static call
137+
return str_ends_with($className, 'Context');
138+
}
139+
140+
private function isTestFilePath(FuncCall $funcCall): bool
141+
{
142+
$scope = ScopeFetcher::fetch($funcCall);
143+
if (! $scope->getClassReflection() instanceof ClassReflection) {
144+
return false;
145+
}
146+
147+
$className = $scope->getClassReflection()
148+
->getName();
149+
if (str_ends_with($className, 'Test')) {
150+
return true;
151+
}
152+
return str_ends_with($className, 'TestCase');
153+
}
154+
155+
/**
156+
* @param Expr[] $exprs
157+
*/
158+
private function createCall(FuncCall $funcCall, string $methodName, array $exprs): MethodCall|StaticCall
159+
{
160+
$args = [];
161+
foreach ($exprs as $expr) {
162+
$args[] = new Arg($expr);
163+
}
164+
165+
if ($this->isBehatContext($funcCall)) {
166+
$assertFullyQualified = new FullyQualified(PHPUnitClassName::ASSERT);
167+
return new StaticCall($assertFullyQualified, $methodName, $args);
168+
}
169+
170+
return new MethodCall(new Variable('this'), $methodName, $args);
171+
}
172+
}

0 commit comments

Comments
 (0)