[phpunit 12] Add ExplicitMockExpectsCallRector

TomasVotruba · TomasVotruba · commit 292071e72a71 · 2026-01-29T00:11:50.000+01:00
diff --git a/rules-tests/AnnotationsToAttributes/Rector/ClassMethod/DataProviderAnnotationToAttributeRector/Fixture/both_annotation_and_attribute_exists.php.inc b/rules-tests/AnnotationsToAttributes/Rector/ClassMethod/DataProviderAnnotationToAttributeRector/Fixture/both_annotation_and_attribute_exists.php.inc
@@ -45,4 +45,4 @@ final class BothAnnotationAndAttributeExists extends TestCase
     }
 }
 
-?>
+?>
diff --git a/rules-tests/CodeQuality/Rector/MethodCall/WithCallbackIdenticalToStandaloneAssertsRector/Fixture/on_self.php.inc b/rules-tests/CodeQuality/Rector/MethodCall/WithCallbackIdenticalToStandaloneAssertsRector/Fixture/on_self.php.inc
@@ -44,4 +44,4 @@ final class OnSelf extends TestCase
     }
 }
 
-?>
+?>
diff --git a/rules-tests/CodeQuality/Rector/StmtsAwareInterface/DeclareStrictTypesTestsRector/Fixture/without_namespace.php.inc b/rules-tests/CodeQuality/Rector/StmtsAwareInterface/DeclareStrictTypesTestsRector/Fixture/without_namespace.php.inc
@@ -38,4 +38,4 @@ class WithoutNamespaceTest extends \PHPUnit\Framework\TestCase
     }
 }
 
-?>
+?>
diff --git a/rules-tests/PHPUnit120/Rector/Class_/AssertIsTypeMethodCallRector/AssertIsTypeMethodCallRectorTest.php b/rules-tests/PHPUnit120/Rector/Class_/AssertIsTypeMethodCallRector/AssertIsTypeMethodCallRectorTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\MethodCall\AssertIsTypeMethodCallRector;
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AssertIsTypeMethodCallRector;
 
 use Iterator;
 use PHPUnit\Framework\Attributes\DataProvider;
diff --git a/rules-tests/PHPUnit120/Rector/Class_/AssertIsTypeMethodCallRector/Fixture/fixture.php.inc b/rules-tests/PHPUnit120/Rector/Class_/AssertIsTypeMethodCallRector/Fixture/fixture.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\MethodCall\AssertIsTypeMethodCallRector\Fixture;
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AssertIsTypeMethodCallRector\Fixture;
 
 use PHPUnit\Framework\TestCase;
 
@@ -31,7 +31,7 @@ final class Fixture extends TestCase
 -----
 <?php
 
-namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\MethodCall\AssertIsTypeMethodCallRector\Fixture;
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AssertIsTypeMethodCallRector\Fixture;
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/rules-tests/PHPUnit120/Rector/Class_/AssertIsTypeMethodCallRector/Fixture/static_fixture.php.inc b/rules-tests/PHPUnit120/Rector/Class_/AssertIsTypeMethodCallRector/Fixture/static_fixture.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\MethodCall\AssertIsTypeMethodCallRector\Fixture;
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AssertIsTypeMethodCallRector\Fixture;
 
 use PHPUnit\Framework\TestCase;
 
@@ -31,7 +31,7 @@ final class StaticFixture extends TestCase
 -----
 <?php
 
-namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\MethodCall\AssertIsTypeMethodCallRector\Fixture;
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AssertIsTypeMethodCallRector\Fixture;
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/rules-tests/PHPUnit120/Rector/Class_/AssertIsTypeMethodCallRector/config/configured_rule.php b/rules-tests/PHPUnit120/Rector/Class_/AssertIsTypeMethodCallRector/config/configured_rule.php
diff --git a/rules-tests/PHPUnit120/Rector/MethodCall/ExplicitMockExpectsCallRector/ExplicitMockExpectsCallRectorTest.php b/rules-tests/PHPUnit120/Rector/MethodCall/ExplicitMockExpectsCallRector/ExplicitMockExpectsCallRectorTest.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\MethodCall\ExplicitMockExpectsCallRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ExplicitMockExpectsCallRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/rules-tests/PHPUnit120/Rector/MethodCall/ExplicitMockExpectsCallRector/Fixture/fixture.php.inc b/rules-tests/PHPUnit120/Rector/MethodCall/ExplicitMockExpectsCallRector/Fixture/fixture.php.inc
@@ -0,0 +1,35 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\MethodCall\ExplicitMockExpectsCallRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class Fixture extends TestCase
+{
+    public function testMethod(): void
+    {
+        $someClass = $this->createMock(\stdClass::class);
+
+        $someClass->method('some');
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\MethodCall\ExplicitMockExpectsCallRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class Fixture extends TestCase
+{
+    public function testMethod(): void
+    {
+        $someClass = $this->createMock(\stdClass::class);
+
+        $someClass->expects($this->atLeastOnce())->method('some');
+    }
+}
+
+?>
diff --git a/rules-tests/PHPUnit120/Rector/MethodCall/ExplicitMockExpectsCallRector/config/configured_rule.php b/rules-tests/PHPUnit120/Rector/MethodCall/ExplicitMockExpectsCallRector/config/configured_rule.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\PHPUnit\PHPUnit120\Rector\MethodCall\ExplicitMockExpectsCallRector;
+
+return RectorConfig::configure()
+    ->withRules([ExplicitMockExpectsCallRector::class]);
diff --git a/rules/PHPUnit120/Rector/Class_/AssertIsTypeMethodCallRector.php b/rules/PHPUnit120/Rector/Class_/AssertIsTypeMethodCallRector.php
@@ -17,7 +17,8 @@
 /**
  * @see https://github.com/sebastianbergmann/phpunit/issues/6053
  * @see https://github.com/sebastianbergmann/phpunit/blob/12.0.0/ChangeLog-12.0.md
- * @see \Rector\PHPUnit\Tests\PHPUnit120\Rector\MethodCall\AssertIsTypeMethodCallRector\AssertIsTypeMethodCallRectorTest
+ *
+ * @see \Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AssertIsTypeMethodCallRector\AssertIsTypeMethodCallRectorTest
  */
 final class AssertIsTypeMethodCallRector extends AbstractRector
 {
diff --git a/rules/PHPUnit120/Rector/MethodCall/ExplicitMockExpectsCallRector.php b/rules/PHPUnit120/Rector/MethodCall/ExplicitMockExpectsCallRector.php
@@ -0,0 +1,101 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\PHPUnit120\Rector\MethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\PropertyFetch;
+use PhpParser\Node\Expr\Variable;
+use PHPStan\Type\ObjectType;
+use Rector\PHPUnit\Enum\PHPUnitClassName;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\PHPUnit\Tests\PHPUnit120\Rector\MethodCall\ExplicitMockExpectsCallRector\ExplicitMockExpectsCallRectorTest
+ */
+final class ExplicitMockExpectsCallRector extends AbstractRector
+{
+    public function __construct(
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Add explicit expects() to mocks, to make expectations count explicit',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+                    use PHPUnit\Framework\TestCase;
+
+                    final class SomeClass extends TestCase
+                    {
+                        public function testMe()
+                        {
+                            $someMock = $this->createMock(\stdClass::class);
+                            $someMock->method('some');
+                        }
+                    }
+                    CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+                    use PHPUnit\Framework\TestCase;
+
+                    final class SomeClass extends TestCase
+                    {
+                        public function testMe()
+                        {
+                            $someMock = $this->createMock(\stdClass::class);
+                            $someMock->expects($this->atLeastOnce())->method('some');
+                        }
+                    }
+                    CODE_SAMPLE
+                    ,
+                ),
+            ],
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [MethodCall::class];
+    }
+
+    /**
+     * @param MethodCall $node
+     */
+    public function refactor(Node $node): Node|null
+    {
+        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
+            return null;
+        }
+
+        if (! $node->var instanceof Variable && ! $node->var instanceof PropertyFetch) {
+            return null;
+        }
+
+        if (! $this->isName($node->name, 'method')) {
+            return null;
+        }
+
+        if (! $this->isObjectType($node->var, new ObjectType(PHPUnitClassName::MOCK_OBJECT))) {
+            return null;
+        }
+
+        $node->var = new MethodCall($node->var, 'expects', [
+            new Arg(new MethodCall(new Variable('this'), 'atLeastOnce')),
+        ]);
+
+        return $node;
+    }
+}
diff --git a/tests/Issues/DoubleAnnotation/Fixture/some_test.php.inc b/tests/Issues/DoubleAnnotation/Fixture/some_test.php.inc
@@ -42,3 +42,4 @@ final class SomeTest extends TestCase
     {
     }
 }
+

Original file line number	Diff line number	Diff line change
`@@ -45,4 +45,4 @@ final class BothAnnotationAndAttributeExists extends TestCase`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`
`48`		`-?>`
	`48`	`+?>`
Original file line number	Diff line number	Diff line change
`@@ -44,4 +44,4 @@ final class OnSelf extends TestCase`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`
`47`		`-?>`
	`47`	`+?>`
Original file line number	Diff line number	Diff line change
`@@ -38,4 +38,4 @@ class WithoutNamespaceTest extends \PHPUnit\Framework\TestCase`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`
`41`		`-?>`
	`41`	`+?>`