Add rector rule to automatically add #[CoversClass] attribute to test files

composer.json

@@ -36,7 +36,7 @@
     "scripts": {
         "phpstan": "vendor/bin/phpstan analyse --ansi --error-format symplify",
         "check-cs": "vendor/bin/ecs check --ansi",
-        "class-leak": "vendor/bin/class-leak check config src rules",
+        "class-leak": "vendor/bin/class-leak check config src rules --skip-type=\"Rector\\PHPUnit\\CodeQuality\\Rector\\Class_\\AddCoversClassAttributeRector\"",
         "fix-cs": "vendor/bin/ecs check --fix --ansi",
         "rector": "vendor/bin/rector process --ansi",
         "docs": "vendor/bin/rule-doc-generator generate src rules --output-file docs/rector_rules_overview.md --ansi"

docs/rector_rules_overview.md

@@ -1,4 +1,26 @@
-# 52 Rules Overview
+# 53 Rules Overview
+
+## AddCoversClassAttributeRector
+
+Adds `#[CoversClass(...)]` attribute to test files guessing source class name.
+
+- class: [`Rector\PHPUnit\CodeQuality\Rector\Class_\AddCoversClassAttributeRector`](../rules/CodeQuality/Rector/Class_/AddCoversClassAttributeRector.php)
+
+```diff
+ class SomeService
+ {
+ }
+
+ use PHPUnit\Framework\TestCase;
++use PHPUnit\Framework\Attributes\CoversClass;
+
++#[CoversClass(SomeService::class)]
+ class SomeServiceTest extends TestCase
+ {
+ }
+```
+
+<br>
 
 ## AddDoesNotPerformAssertionToNonAssertingTestRector
 

rules-tests/CodeQuality/Rector/Class_/AddCoversClassAttributeRector/AddCoversClassAttributeRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\AddCoversClassAttributeRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AddCoversClassAttributeRectorTest 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/CodeQuality/Rector/Class_/AddCoversClassAttributeRector/Fixture/adds_covers_class.php.inc

@@ -0,0 +1,22 @@
+<?php
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+class CalculatorTest extends TestCase {}
+class Calculator {}
+
+?>
+-----
+<?php
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+#[\PHPUnit\Framework\Attributes\CoversClass(\Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture\Calculator::class)]
+class CalculatorTest extends TestCase {}
+class Calculator {}
+
+?>

rules-tests/CodeQuality/Rector/Class_/AddCoversClassAttributeRector/Fixture/skips_when_already_added_covers_class.php.inc

@@ -0,0 +1,25 @@
+<?php
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\CoversClass;
+
+#[CoversClass(Calculator::class)]
+class CalculatorTest extends TestCase {}
+class Calculator {}
+
+?>
+-----
+<?php
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\CoversClass;
+
+#[CoversClass(Calculator::class)]
+class CalculatorTest extends TestCase {}
+class Calculator {}
+
+?>

rules-tests/CodeQuality/Rector/Class_/AddCoversClassAttributeRector/Fixture/skips_when_already_added_covers_function.php.inc

@@ -0,0 +1,25 @@
+<?php
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\CoversFunction;
+
+#[CoversFunction('\trim')]
+class CalculatorTest extends TestCase {}
+class Calculator {}
+
+?>
+-----
+<?php
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\CoversFunction;
+
+#[CoversFunction('\trim')]
+class CalculatorTest extends TestCase {}
+class Calculator {}
+
+?>

rules-tests/CodeQuality/Rector/Class_/AddCoversClassAttributeRector/Fixture/skips_when_already_added_covers_nothing.php.inc

@@ -0,0 +1,25 @@
+<?php
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\CoversNothing;
+
+#[CoversNothing]
+class CalculatorTest extends TestCase {}
+class Calculator {}
+
+?>
+-----
+<?php
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\CoversNothing;
+
+#[CoversNothing]
+class CalculatorTest extends TestCase {}
+class Calculator {}
+
+?>

rules-tests/CodeQuality/Rector/Class_/AddCoversClassAttributeRector/Fixture/skips_when_can_not_find_source_class.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture\Abc {
+    use PHPUnit\Framework\TestCase;
+
+    class CalculatorTest extends TestCase {}
+}
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture\Xyz {
+    class Calculator {}
+}
+
+?>
+-----
+<?php
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture\Abc {
+    use PHPUnit\Framework\TestCase;
+
+    class CalculatorTest extends TestCase {}
+}
+
+namespace Utils\Rector\Tests\Rector\AddCoversClassAttributeRector\Fixture\Xyz {
+    class Calculator {}
+}
+
+?>

rules-tests/CodeQuality/Rector/Class_/AddCoversClassAttributeRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\PHPUnit\CodeQuality\Rector\Class_\AddCoversClassAttributeRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(AddCoversClassAttributeRector::class);
+};

rules/CodeQuality/Rector/Class_/AddCoversClassAttributeRector.php

@@ -0,0 +1,164 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\CodeQuality\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\AttributeGroup;
+use PhpParser\Node\Stmt\Class_;
+use PHPStan\Reflection\ReflectionProvider;
+use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
+use Rector\PhpAttribute\NodeFactory\PhpAttributeGroupFactory;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use function array_filter;
+use function array_merge;
+use function count;
+use function explode;
+use function implode;
+use function in_array;
+use function preg_replace;
+use function strtolower;
+use function trim;
+
+final class AddCoversClassAttributeRector extends AbstractRector
+{
+    public function __construct(
+        private readonly ReflectionProvider $reflectionProvider,
+        private readonly PhpAttributeGroupFactory $phpAttributeGroupFactory,
+        private readonly PhpAttributeAnalyzer $phpAttributeAnalyzer,
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Adds `#[CoversClass(...)]` attribute to test files guessing source class name.', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+                    class SomeService
+                    {
+                    }
+
+                    use PHPUnit\Framework\TestCase;
+
+                    class SomeServiceTest extends TestCase
+                    {
+                    }
+                    CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+                    class SomeService
+                    {
+                    }
+
+                    use PHPUnit\Framework\TestCase;
+                    use PHPUnit\Framework\Attributes\CoversClass;
+
+                    #[CoversClass(SomeService::class)]
+                    class SomeServiceTest extends TestCase
+                    {
+                    }
+                    CODE_SAMPLE
+                ,
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        $className = $this->getName($node);
+
+        if ($className === null) {
+            return null;
+        }
+
+        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
+            return null;
+        }
+
+        if ($this->phpAttributeAnalyzer->hasPhpAttributes($node, [
+            'PHPUnit\\Framework\\Attributes\\CoversNothing',
+            'PHPUnit\\Framework\\Attributes\\CoversClass',
+            'PHPUnit\\Framework\\Attributes\\CoversFunction',
+        ])) {
+            return null;
+        }
+
+        $possibleTestClassNames = $this->resolveSourceClassNames($className);
+        $matchingTestClassName = $this->matchExistingClassName($possibleTestClassNames);
+
+        if ($matchingTestClassName === null) {
+            return null;
+        }
+
+        $coversAttributeGroup = $this->createAttributeGroup('\\' . $matchingTestClassName);
+
+        $node->attrGroups = array_merge($node->attrGroups, [$coversAttributeGroup]);
+
+        return $node;
+    }
+
+    /**
+     * @return string[]
+     */
+    private function resolveSourceClassNames(string $className): array
+    {
+        $classNameParts = explode('\\', $className);
+        $partCount = count($classNameParts);
+        $classNameParts[$partCount - 1] = preg_replace('#Test$#', '', $classNameParts[$partCount - 1]);
+
+        $possibleTestClassNames = [implode('\\', $classNameParts)];
+
+        $partsWithoutTests = array_filter(
+            $classNameParts,
+            static fn (string|null $part): bool => $part === null ? false : ! in_array(
+                strtolower($part),
+                ['test', 'tests'],
+                true
+            ),
+        );
+
+        $possibleTestClassNames[] = implode('\\', $partsWithoutTests);
+
+        return $possibleTestClassNames;
+    }
+
+    /**
+     * @param string[] $classNames
+     */
+    private function matchExistingClassName(array $classNames): ?string
+    {
+        foreach ($classNames as $className) {
+            if (! $this->reflectionProvider->hasClass($className)) {
+                continue;
+            }
+
+            return $className;
+        }
+
+        return null;
+    }
+
+    private function createAttributeGroup(string $annotationValue): AttributeGroup
+    {
+        $attributeClass = 'PHPUnit\\Framework\\Attributes\\CoversClass';
+        $attributeValue = trim($annotationValue) . '::class';
+
+        return $this->phpAttributeGroupFactory->createFromClassWithItems($attributeClass, [$attributeValue]);
+    }
+}