Skip to content

Commit 1993f6b

Browse files
TomasVotrubaTomasVotruba
authored
[phpunit 12] Add AllowMockObjectsForDataProviderRector (#643)
1 parent 43e5326 commit 1993f6b

10 files changed

Lines changed: 315 additions & 4 deletions

File tree

‎config/sets/phpunit120.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
use Rector\Config\RectorConfig;
66
use Rector\PHPUnit\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector;
7+
use Rector\PHPUnit\PHPUnit120\Rector\Class_\AllowMockObjectsForDataProviderRector;
78
use Rector\PHPUnit\PHPUnit120\Rector\Class_\AllowMockObjectsWhereParentClassRector;
89
use Rector\PHPUnit\PHPUnit120\Rector\Class_\AllowMockObjectsWithoutExpectationsAttributeRector;
910
use Rector\PHPUnit\PHPUnit120\Rector\Class_\AssertIsTypeMethodCallRector;
@@ -21,6 +22,7 @@
2122
ExpressionCreateMockToCreateStubRector::class,
2223
PropertyCreateMockToCreateStubRector::class,
2324
AllowMockObjectsWhereParentClassRector::class,
25+
AllowMockObjectsForDataProviderRector::class,
2426

2527
// experimental, from PHPUnit 12.5.2
2628
// @see https://github.com/sebastianbergmann/phpunit/commit/24c208d6a340c3071f28a9b5cce02b9377adfd43

‎rules-tests/PHPUnit120/Rector/Class_/AllowMockObjectsForDataProviderRector/AllowMockObjectsForDataProviderRectorTest.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\PHPUnit120\Rector\Class_\AllowMockObjectsForDataProviderRector;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class AllowMockObjectsForDataProviderRectorTest 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/PHPUnit120/Rector/Class_/AllowMockObjectsForDataProviderRector/Fixture/skip_with_expects.php.inc‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AllowMockObjectsForDataProviderRector\Fixture;
6+
7+
use PHPUnit\Framework\Attributes\DataProvider;
8+
use PHPUnit\Framework\TestCase;
9+
10+
final class SkipWithExpects extends TestCase
11+
{
12+
#[DataProvider('someDataProvider')]
13+
public function test()
14+
{
15+
$someMock = $this->createMock(\stdClass::class);
16+
$someMock->expects($this->once())->method('some')->willReturn(true);
17+
}
18+
19+
public static function someDataProvider(): iterable
20+
{
21+
yield [1];
22+
yield [2];
23+
yield [3];
24+
}
25+
}

‎rules-tests/PHPUnit120/Rector/Class_/AllowMockObjectsForDataProviderRector/Fixture/skip_without_data_provider.php.inc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AllowMockObjectsForDataProviderRector\Fixture;
6+
7+
use PHPUnit\Framework\TestCase;
8+
9+
final class SkipWithoutDataProvider extends TestCase
10+
{
11+
public function test()
12+
{
13+
$someMock = $this->createMock(\stdClass::class);
14+
$someMock->expects($this->once())->method('some')->willReturn(true);
15+
}
16+
}

‎rules-tests/PHPUnit120/Rector/Class_/AllowMockObjectsForDataProviderRector/Fixture/some_class.php.inc‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AllowMockObjectsForDataProviderRector\Fixture;
6+
7+
use PHPUnit\Framework\Attributes\DataProvider;
8+
use PHPUnit\Framework\TestCase;
9+
10+
final class SomeClass extends TestCase
11+
{
12+
#[DataProvider('someDataProvider')]
13+
public function test()
14+
{
15+
$someMock = $this->createMock(\stdClass::class);
16+
$someMock->method('some')->willReturn(true);
17+
}
18+
19+
public static function someDataProvider(): iterable
20+
{
21+
yield [1];
22+
yield [2];
23+
yield [3];
24+
}
25+
}
26+
27+
?>
28+
-----
29+
<?php
30+
31+
declare(strict_types=1);
32+
33+
namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AllowMockObjectsForDataProviderRector\Fixture;
34+
35+
use PHPUnit\Framework\Attributes\DataProvider;
36+
use PHPUnit\Framework\TestCase;
37+
38+
#[\PHPUnit\Framework\Attributes\AllowMockObjectsWithoutExpectations]
39+
final class SomeClass extends TestCase
40+
{
41+
#[DataProvider('someDataProvider')]
42+
public function test()
43+
{
44+
$someMock = $this->createMock(\stdClass::class);
45+
$someMock->method('some')->willReturn(true);
46+
}
47+
48+
public static function someDataProvider(): iterable
49+
{
50+
yield [1];
51+
yield [2];
52+
yield [3];
53+
}
54+
}
55+
56+
?>

‎rules-tests/PHPUnit120/Rector/Class_/AllowMockObjectsForDataProviderRector/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\PHPUnit120\Rector\Class_\AllowMockObjectsForDataProviderRector;
7+
8+
return RectorConfig::configure()
9+
->withRules([AllowMockObjectsForDataProviderRector::class]);

‎rules/AnnotationsToAttributes/Rector/ClassMethod/DataProviderAnnotationToAttributeRector.php‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover;
1818
use Rector\Comments\NodeDocBlock\DocBlockUpdater;
1919
use Rector\PhpAttribute\NodeFactory\PhpAttributeGroupFactory;
20+
use Rector\PHPUnit\Enum\PHPUnitAttribute;
2021
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
2122
use Rector\Rector\AbstractRector;
2223
use Rector\Reflection\ReflectionResolver;
@@ -30,8 +31,6 @@
3031
*/
3132
final class DataProviderAnnotationToAttributeRector extends AbstractRector implements MinPhpVersionInterface
3233
{
33-
private const string DATA_PROVIDER_CLASS = 'PHPUnit\Framework\Attributes\DataProvider';
34-
3534
public function __construct(
3635
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
3736
private readonly PhpAttributeGroupFactory $phpAttributeGroupFactory,
@@ -105,7 +104,7 @@ public function refactor(Node $node): ?Node
105104
return null;
106105
}
107106

108-
if (! $this->reflectionProvider->hasClass(self::DATA_PROVIDER_CLASS)) {
107+
if (! $this->reflectionProvider->hasClass(PHPUnitAttribute::DATA_PROVIDER)) {
109108
return null;
110109
}
111110

@@ -180,7 +179,7 @@ private function createAttributeGroup(ClassMethod $classMethod, string $original
180179
);
181180
} else {
182181
$attributeGroup = $this->phpAttributeGroupFactory->createFromClassWithItems(
183-
self::DATA_PROVIDER_CLASS,
182+
PHPUnitAttribute::DATA_PROVIDER,
184183
[$methodName]
185184
);
186185
}

‎rules/CodeQuality/NodeAnalyser/MockObjectExprDetector.php‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,26 @@ public function __construct(
2323
) {
2424
}
2525

26+
public function hasMethodCallWithoutExpects(ClassMethod $classMethod): bool
27+
{
28+
/** @var array<Expr\MethodCall> $methodCalls */
29+
$methodCalls = $this->betterNodeFinder->findInstancesOfScoped((array) $classMethod->stmts, [MethodCall::class]);
30+
31+
foreach ($methodCalls as $methodCall) {
32+
if (! $this->nodeNameResolver->isName($methodCall->name, 'method')) {
33+
continue;
34+
}
35+
36+
if ($methodCall->var instanceof MethodCall) {
37+
continue;
38+
}
39+
40+
return true;
41+
}
42+
43+
return false;
44+
}
45+
2646
public function isUsedForMocking(Expr $expr, ClassMethod $classMethod): bool
2747
{
2848
if (! $expr instanceof Variable) {

‎rules/PHPUnit120/Rector/Class_/AllowMockObjectsForDataProviderRector.php‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\PHPUnit\PHPUnit120\Rector\Class_;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Attribute;
9+
use PhpParser\Node\AttributeGroup;
10+
use PhpParser\Node\Name\FullyQualified;
11+
use PhpParser\Node\Stmt\Class_;
12+
use PHPStan\Reflection\ReflectionProvider;
13+
use Rector\Doctrine\NodeAnalyzer\AttributeFinder;
14+
use Rector\PHPUnit\CodeQuality\NodeAnalyser\MockObjectExprDetector;
15+
use Rector\PHPUnit\Enum\PHPUnitAttribute;
16+
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
17+
use Rector\Rector\AbstractRector;
18+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
19+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
20+
21+
/**
22+
* @see \Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AllowMockObjectsForDataProviderRector\AllowMockObjectsForDataProviderRectorTest
23+
*/
24+
final class AllowMockObjectsForDataProviderRector extends AbstractRector
25+
{
26+
public function __construct(
27+
private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
28+
private readonly AttributeFinder $attributeFinder,
29+
private readonly ReflectionProvider $reflectionProvider,
30+
private readonly MockObjectExprDetector $mockObjectExprDetector,
31+
) {
32+
}
33+
34+
public function getNodeTypes(): array
35+
{
36+
return [Class_::class];
37+
}
38+
39+
/**
40+
* @param Class_ $node
41+
*/
42+
public function refactor(Node $node): ?Class_
43+
{
44+
if ($this->shouldSkipClass($node)) {
45+
return null;
46+
}
47+
48+
if (! $this->hasDataProviderMethodWithExpectLessMethodMock($node)) {
49+
return null;
50+
}
51+
52+
// add attribute
53+
$node->attrGroups[] = new AttributeGroup([
54+
new Attribute(new FullyQualified(PHPUnitAttribute::ALLOW_MOCK_OBJECTS_WITHOUT_EXPECTATIONS)),
55+
]);
56+
57+
return $node;
58+
}
59+
60+
public function getRuleDefinition(): RuleDefinition
61+
{
62+
return new RuleDefinition(
63+
'Add #[AllowMockObjectsWithoutExpectations] attribute to PHPUnit test classes that have methods with data providers and mock objects without expectations',
64+
[
65+
new CodeSample(
66+
<<<'CODE_SAMPLE'
67+
use PHPUnit\Framework\Attributes\DataProvider;
68+
use PHPUnit\Framework\TestCase;
69+
70+
final class SomeClass extends TestCase
71+
{
72+
#[DataProvider('someDataProvider')]
73+
public function test()
74+
{
75+
$someMock = $this->createMock(\stdClass::class);
76+
$someMock->expects('method')->willReturn(true);
77+
}
78+
79+
public static function someDataProvider(): iterable
80+
{
81+
yield [1];
82+
yield [2];
83+
yield [3];
84+
}
85+
}
86+
CODE_SAMPLE
87+
,
88+
<<<'CODE_SAMPLE'
89+
use PHPUnit\Framework\Attributes\DataProvider;
90+
use PHPUnit\Framework\TestCase;
91+
92+
#[\PHPUnit\Framework\Attributes\AllowMockObjectsWithoutExpectations]
93+
final class SomeClass extends TestCase
94+
{
95+
#[DataProvider('someDataProvider')]
96+
public function test()
97+
{
98+
$someMock = $this->createMock(\stdClass::class);
99+
$someMock->expects('method')->willReturn(true);
100+
}
101+
102+
public static function someDataProvider(): iterable
103+
{
104+
yield [1];
105+
yield [2];
106+
yield [3];
107+
}
108+
}
109+
CODE_SAMPLE
110+
),
111+
]
112+
);
113+
}
114+
115+
private function shouldSkipClass(Class_ $class): bool
116+
{
117+
if (! $this->testsNodeAnalyzer->isInTestClass($class)) {
118+
return true;
119+
}
120+
121+
// attribute must exist for the rule to work
122+
if (! $this->reflectionProvider->hasClass(PHPUnitAttribute::ALLOW_MOCK_OBJECTS_WITHOUT_EXPECTATIONS)) {
123+
return true;
124+
}
125+
126+
// already filled
127+
return $this->attributeFinder->hasAttributeByClasses(
128+
$class,
129+
[PHPUnitAttribute::ALLOW_MOCK_OBJECTS_WITHOUT_EXPECTATIONS]
130+
);
131+
}
132+
133+
private function hasDataProviderMethodWithExpectLessMethodMock(Class_ $class): bool
134+
{
135+
// has a test method, that contains a ->method() call without expects()
136+
// and has a data provider attribute?
137+
foreach ($class->getMethods() as $classMethod) {
138+
if (! $this->testsNodeAnalyzer->isTestClassMethod($classMethod)) {
139+
continue;
140+
}
141+
142+
if (! $this->attributeFinder->hasAttributeByClasses($classMethod, [PHPUnitAttribute::DATA_PROVIDER])) {
143+
continue;
144+
}
145+
146+
// has expects-less mock objects
147+
if ($this->mockObjectExprDetector->hasMethodCallWithoutExpects($classMethod)) {
148+
return true;
149+
}
150+
}
151+
152+
return false;
153+
}
154+
}

‎src/Enum/PHPUnitAttribute.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,6 @@ final class PHPUnitAttribute
2828
* @see https://github.com/sebastianbergmann/phpunit/commit/24c208d6a340c3071f28a9b5cce02b9377adfd43
2929
*/
3030
public const string ALLOW_MOCK_OBJECTS_WITHOUT_EXPECTATIONS = 'PHPUnit\Framework\Attributes\AllowMockObjectsWithoutExpectations';
31+
32+
public const string DATA_PROVIDER = 'PHPUnit\Framework\Attributes\DataProvider';
3133
}

0 commit comments

Comments
 (0)