[phpunit 12] Add AllowMockObjectsWhereParentClassRector (#641)

Author: TomasVotruba

config/sets/phpunit120.php

@@ -4,6 +4,8 @@
 
 use Rector\Config\RectorConfig;
 use Rector\PHPUnit\PHPUnit120\Rector\CallLike\CreateStubOverCreateMockArgRector;
+use Rector\PHPUnit\PHPUnit120\Rector\Class_\AllowMockObjectsWhereParentClassRector;
+use Rector\PHPUnit\PHPUnit120\Rector\Class_\AllowMockObjectsWithoutExpectationsAttributeRector;
 use Rector\PHPUnit\PHPUnit120\Rector\Class_\AssertIsTypeMethodCallRector;
 use Rector\PHPUnit\PHPUnit120\Rector\Class_\PropertyCreateMockToCreateStubRector;
 use Rector\PHPUnit\PHPUnit120\Rector\Class_\RemoveOverrideFinalConstructTestCaseRector;
@@ -18,9 +20,10 @@
         CreateStubOverCreateMockArgRector::class,
         ExpressionCreateMockToCreateStubRector::class,
         PropertyCreateMockToCreateStubRector::class,
+        AllowMockObjectsWhereParentClassRector::class,
 
         // experimental, from PHPUnit 12.5.2
         // @see https://github.com/sebastianbergmann/phpunit/commit/24c208d6a340c3071f28a9b5cce02b9377adfd43
-        // AllowMockObjectsWithoutExpectationsAttributeRector::class,
+        AllowMockObjectsWithoutExpectationsAttributeRector::class,
     ]);
 };

rules-tests/PHPUnit120/Rector/Class_/AllowMockObjectsWhereParentClassRector/AllowMockObjectsWhereParentClassRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AllowMockObjectsWhereParentClassRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AllowMockObjectsWhereParentClassRectorTest 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';
+    }
+}

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

@@ -0,0 +1,26 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AllowMockObjectsWhereParentClassRector\Fixture;
+
+use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;
+
+final class SomeClass extends ConstraintValidatorTestCase
+{
+    private \PHPUnit\Framework\MockObject\MockObject $someMock;
+}
+
+?>
+-----
+<?php
+
+namespace Rector\PHPUnit\Tests\PHPUnit120\Rector\Class_\AllowMockObjectsWhereParentClassRector\Fixture;
+
+use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;
+
+#[\PHPUnit\Framework\Attributes\AllowMockObjectsWithoutExpectations]
+final class SomeClass extends ConstraintValidatorTestCase
+{
+    private \PHPUnit\Framework\MockObject\MockObject $someMock;
+}
+
+?>

rules-tests/PHPUnit120/Rector/Class_/AllowMockObjectsWhereParentClassRector/config/configured_rule.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\PHPUnit\PHPUnit120\Rector\Class_\AllowMockObjectsWhereParentClassRector;
+
+return RectorConfig::configure()
+    ->withRules([AllowMockObjectsWhereParentClassRector::class]);

rules/PHPUnit120/Rector/Class_/AllowMockObjectsWhereParentClassRector.php

@@ -0,0 +1,130 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\PHPUnit120\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Attribute;
+use PhpParser\Node\AttributeGroup;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\Class_;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\ReflectionProvider;
+use Rector\Doctrine\NodeAnalyzer\AttributeFinder;
+use Rector\PHPStan\ScopeFetcher;
+use Rector\PHPUnit\Enum\PHPUnitAttribute;
+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\Class_\AllowMockObjectsWhereParentClassRector\AllowMockObjectsWhereParentClassRectorTest
+ *
+ * @see https://github.com/sebastianbergmann/phpunit/commit/24c208d6a340c3071f28a9b5cce02b9377adfd43
+ */
+final class AllowMockObjectsWhereParentClassRector extends AbstractRector
+{
+    /**
+     * @var string[]
+     */
+    private const array PARENT_CLASSES = [PHPUnitClassName::SYMFONY_CONSTRAINT_VALIDATOR_TEST_CASE];
+
+    public function __construct(
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+        private readonly AttributeFinder $attributeFinder,
+        private readonly ReflectionProvider $reflectionProvider,
+    ) {
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Class_
+    {
+        if ($this->shouldSkipClass($node)) {
+            return null;
+        }
+
+        if (! $this->hasRelateParentClass($node)) {
+            return null;
+        }
+
+        // add attribute
+        $node->attrGroups[] = new AttributeGroup([
+            new Attribute(new FullyQualified(PHPUnitAttribute::ALLOW_MOCK_OBJECTS_WITHOUT_EXPECTATIONS)),
+        ]);
+
+        return $node;
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Add #[AllowMockObjectsWithoutExpectations] attribute to PHPUnit test classes with a 3rd party test case, that provides any mocks',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;
+
+final class SomeTest extends ConstraintValidatorTestCase
+{
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;
+
+#[\PHPUnit\Framework\Attributes\AllowMockObjectsWithoutExpectations]
+final class SomeTest extends ConstraintValidatorTestCase
+{
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    private function shouldSkipClass(Class_ $class): bool
+    {
+        if (! $this->testsNodeAnalyzer->isInTestClass($class)) {
+            return true;
+        }
+
+        // attribute must exist for the rule to work
+        if (! $this->reflectionProvider->hasClass(PHPUnitAttribute::ALLOW_MOCK_OBJECTS_WITHOUT_EXPECTATIONS)) {
+            return true;
+        }
+
+        // already filled
+        return $this->attributeFinder->hasAttributeByClasses(
+            $class,
+            [PHPUnitAttribute::ALLOW_MOCK_OBJECTS_WITHOUT_EXPECTATIONS]
+        );
+    }
+
+    private function hasRelateParentClass(Class_ $class): bool
+    {
+        $scope = ScopeFetcher::fetch($class);
+        $classReflection = $scope->getClassReflection();
+
+        if (! $classReflection instanceof ClassReflection) {
+            return false;
+        }
+
+        foreach (self::PARENT_CLASSES as $parentClass) {
+            if ($classReflection->is($parentClass)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

rules/PHPUnit120/Rector/Class_/AllowMockObjectsWithoutExpectationsAttributeRector.php

@@ -4,12 +4,12 @@
 
 namespace Rector\PHPUnit\PHPUnit120\Rector\Class_;
 
-use PhpParser\Node\Expr\Variable;
 use PhpParser\Node;
 use PhpParser\Node\Attribute;
 use PhpParser\Node\AttributeGroup;
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Expr\PropertyFetch;
+use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Name;
 use PhpParser\Node\Name\FullyQualified;
 use PhpParser\Node\Stmt\Class_;

src/Enum/PHPUnitClassName.php

@@ -27,6 +27,8 @@ final class PHPUnitClassName
 
     public const string STUB = 'PHPUnit\Framework\MockObject\Stub';
 
+    public const string SYMFONY_CONSTRAINT_VALIDATOR_TEST_CASE = 'Symfony\Component\Validator\Test\ConstraintValidatorTestCase';
+
     /**
      * @var string[]
      */

stubs/Symfony/Component/Validator/Test/ConstraintValidatorTestCase.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Symfony\Component\Validator\Test;
+
+use PHPUnit\Framework\TestCase;
+
+abstract class ConstraintValidatorTestCase extends TestCase
+{
+}