[code-quality] Add DeclareStrictTypesTestsRector to code-quality test (#566)

* add FinalizeTestCaseClassRector to phpunit code quality

* [code-quality] Add DeclareStrictTypesTestsRector

* register rule to code quality

Author: TomasVotruba

config/sets/phpunit-code-quality.php

@@ -46,8 +46,10 @@
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\StringCastAssertStringContainsStringRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\UseSpecificWillMethodRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\UseSpecificWithMethodRector;
+use Rector\PHPUnit\CodeQuality\Rector\StmtsAwareInterface\DeclareStrictTypesTestsRector;
 use Rector\PHPUnit\PHPUnit60\Rector\MethodCall\GetMockBuilderGetMockToCreateMockRector;
 use Rector\PHPUnit\PHPUnit90\Rector\MethodCall\ReplaceAtMethodWithDesiredMatcherRector;
+use Rector\Privatization\Rector\Class_\FinalizeTestCaseClassRector;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->rules([
@@ -119,6 +121,8 @@
         SingleMockPropertyTypeRector::class,
 
         SetUpBeforeClassToSetUpRector::class,
+        FinalizeTestCaseClassRector::class,
+        DeclareStrictTypesTestsRector::class,
 
         // prefer simple mocking
         GetMockBuilderGetMockToCreateMockRector::class,

rules-tests/CodeQuality/Rector/StmtsAwareInterface/DeclareStrictTypesTestsRector/DeclareStrictTypesTestsRectorTest.php

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

@@ -0,0 +1,7 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\StmtsAwareInterface\DeclareStrictTypesTestsRector\Fixture;
+
+final class SkipNoTest
+{
+}

rules-tests/CodeQuality/Rector/StmtsAwareInterface/DeclareStrictTypesTestsRector/Fixture/some_test_without_strict.php.inc

@@ -0,0 +1,29 @@
+<?php
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\StmtsAwareInterface\DeclareStrictTypesTestsRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SomeTestWithoutStrict extends TestCase
+{
+    public function test()
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\Tests\CodeQuality\Rector\StmtsAwareInterface\DeclareStrictTypesTestsRector\Fixture;
+
+use PHPUnit\Framework\TestCase;
+
+final class SomeTestWithoutStrict extends TestCase
+{
+    public function test()
+    {
+    }
+}

rules-tests/CodeQuality/Rector/StmtsAwareInterface/DeclareStrictTypesTestsRector/config/configured_rule.php

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

rules/CodeQuality/Rector/StmtsAwareInterface/DeclareStrictTypesTestsRector.php

@@ -0,0 +1,151 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\PHPUnit\CodeQuality\Rector\StmtsAwareInterface;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\Nop;
+use PhpParser\NodeVisitor;
+use Rector\ChangesReporting\ValueObject\RectorWithLineChange;
+use Rector\Contract\PhpParser\Node\StmtsAwareInterface;
+use Rector\Contract\Rector\HTMLAverseRectorInterface;
+use Rector\PhpParser\Node\BetterNodeFinder;
+use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
+use Rector\Rector\AbstractRector;
+use Rector\TypeDeclaration\NodeAnalyzer\DeclareStrictTypeFinder;
+use Rector\ValueObject\Application\File;
+use Rector\ValueObject\PhpVersion;
+use Rector\VersionBonding\Contract\MinPhpVersionInterface;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\StmtsAwareInterface\DeclareStrictTypesTestsRector\DeclareStrictTypesTestsRectorTest
+ */
+final class DeclareStrictTypesTestsRector extends AbstractRector implements HTMLAverseRectorInterface, MinPhpVersionInterface
+{
+    public function __construct(
+        private readonly DeclareStrictTypeFinder $declareStrictTypeFinder,
+        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
+        private readonly BetterNodeFinder $betterNodeFinder,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Add `declare(strict_types=1)` to PHPUnit test class file', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+use PHPUnit\Framework\TestCase;
+
+final class SomeTestWithoutStrict extends TestCase
+{
+    public function test()
+    {
+    }
+}
+CODE_SAMPLE
+
+                ,
+                <<<'CODE_SAMPLE'
+declare(strict_types=1);
+
+use PHPUnit\Framework\TestCase;
+
+final class SomeTestWithoutStrict extends TestCase
+{
+    public function test()
+    {
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @param Stmt[] $nodes
+     * @return Stmt[]|null
+     */
+    public function beforeTraverse(array $nodes): ?array
+    {
+        parent::beforeTraverse($nodes);
+
+        if ($this->shouldSkipNodes($nodes, $this->file)) {
+            return null;
+        }
+
+        /** @var Node $rootStmt */
+        $rootStmt = current($nodes);
+
+        // when first stmt is Declare_, verify if there is strict_types definition already,
+        // as multiple declare is allowed, with declare(strict_types=1) only allowed on very first stmt
+        if ($this->declareStrictTypeFinder->hasDeclareStrictTypes($rootStmt)) {
+            return null;
+        }
+
+        if (! $this->hasPHPUnitTestClass($nodes)) {
+            return null;
+        }
+
+        $rectorWithLineChange = new RectorWithLineChange(self::class, $rootStmt->getStartLine());
+        $this->file->addRectorClassWithLine($rectorWithLineChange);
+
+        return [$this->nodeFactory->createDeclaresStrictType(), new Nop(), ...$nodes];
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [StmtsAwareInterface::class];
+    }
+
+    /**
+     * @param StmtsAwareInterface $node
+     */
+    public function refactor(Node $node): int
+    {
+        // workaround, as Rector now only hooks to specific nodes, not arrays
+        // avoid traversing, as we already handled in beforeTraverse()
+        return NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN;
+    }
+
+    public function provideMinPhpVersion(): int
+    {
+        return PhpVersion::PHP_70;
+    }
+
+    /**
+     * @param Stmt[] $nodes
+     */
+    private function shouldSkipNodes(array $nodes, File $file): bool
+    {
+        if ($this->skipper->shouldSkipElementAndFilePath(self::class, $file->getFilePath())) {
+            return true;
+        }
+
+        if (str_starts_with($file->getFileContent(), '#!')) {
+            return true;
+        }
+
+        return $nodes === [];
+    }
+
+    /**
+     * @param Stmt[] $nodes
+     */
+    private function hasPHPUnitTestClass(array $nodes): bool
+    {
+        $class = $this->betterNodeFinder->findFirstNonAnonymousClass($nodes);
+        if (! $class instanceof Class_) {
+            return false;
+        }
+
+        return $this->testsNodeAnalyzer->isInTestClass($class);
+    }
+}

src/NodeAnalyzer/TestsNodeAnalyzer.php

@@ -34,7 +34,6 @@ public function __construct(
     public function isInTestClass(Node $node): bool
     {
         $classReflection = $this->reflectionResolver->resolveClassReflection($node);
-
         if (! $classReflection instanceof ClassReflection) {
             return false;
         }