[Testing] In case of failed test using multiple rules, show applied R…

…ector rules to make easy to find them (#5222)
rectorphp · Nov 3, 2023 · cc97bec · cc97bec
1 parent 2fac959
commit cc97bec
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 30 deletions.
diff --git a/packages/PostRector/Rector/ClassRenamingPostRector.php b/packages/PostRector/Rector/ClassRenamingPostRector.php
@@ -67,7 +67,11 @@ public function enterNode(Node $node): ?Node
         if (! $result instanceof Name && ! $node instanceof FullyQualified) {
             $phpAttributeName = $node->getAttribute(AttributeKey::PHP_ATTRIBUTE_NAME);
             if (is_string($phpAttributeName)) {
-                return $this->classRenamer->renameNode(new FullyQualified($phpAttributeName, $node->getAttributes()), $oldToNewClasses, $scope);
+                return $this->classRenamer->renameNode(
+                    new FullyQualified($phpAttributeName, $node->getAttributes()),
+                    $oldToNewClasses,
+                    $scope
+                );
             }
         }
 

diff --git a/packages/Testing/PHPUnit/AbstractRectorTestCase.php b/packages/Testing/PHPUnit/AbstractRectorTestCase.php
@@ -29,6 +29,7 @@
 use Rector\Testing\Fixture\FixtureFileFinder;
 use Rector\Testing\Fixture\FixtureFileUpdater;
 use Rector\Testing\Fixture\FixtureSplitter;
+use Rector\Testing\PHPUnit\ValueObject\RectorTestResult;
 
 abstract class AbstractRectorTestCase extends AbstractLazyTestCase implements RectorTestInterface
 {
@@ -228,11 +229,23 @@ private function doTestFileMatchesExpectedContent(
         $originalFileContent = FileSystem::read($originalFilePath);
 
         // the file is now changed (if any rule matches)
-        $changedContent = $this->processFilePath($originalFilePath);
+        $rectorTestResult = $this->processFilePath($originalFilePath);
+
+        $changedContent = $rectorTestResult->getChangedContents();
 
         $fixtureFilename = basename($fixtureFilePath);
         $failureMessage = sprintf('Failed on fixture file "%s"', $fixtureFilename);
 
+        // give more context about used rules in case of set testing
+        if (count($rectorTestResult->getAppliedRectorClasses()) > 1) {
+            $failureMessage .= PHP_EOL . PHP_EOL;
+            $failureMessage .= 'Applied Rector rules:' . PHP_EOL;
+
+            foreach ($rectorTestResult->getAppliedRectorClasses() as $appliedRectorClass) {
+                $failureMessage .= ' * ' . $appliedRectorClass . PHP_EOL;
+            }
+        }
+
         try {
             $this->assertSame($expectedFileContents, $changedContent, $failureMessage);
         } catch (ExpectationFailedException) {
@@ -243,7 +256,7 @@ private function doTestFileMatchesExpectedContent(
         }
     }
 
-    private function processFilePath(string $filePath): string
+    private function processFilePath(string $filePath): RectorTestResult
     {
         $this->dynamicSourceLocatorProvider->setFilePath($filePath);
 
@@ -265,7 +278,8 @@ private function processFilePath(string $filePath): string
         }
 
         // return changed file contents
-        return FileSystem::read($filePath);
+        $changedFileContents = FileSystem::read($filePath);
+        return new RectorTestResult($changedFileContents, $processResult);
     }
 
     private function createInputFilePath(string $fixtureFilePath): string

diff --git a/packages/Testing/PHPUnit/AbstractTestCase.php b/packages/Testing/PHPUnit/AbstractTestCase.php
@@ -6,13 +6,6 @@
 
 abstract class AbstractTestCase extends AbstractLazyTestCase
 {
-    /**
-     * @deprecated only for BC
-     */
-    protected function boot(): void
-    {
-    }
-
     /**
      * @param string[] $configFiles
      */

diff --git a/packages/Testing/PHPUnit/ValueObject/RectorTestResult.php b/packages/Testing/PHPUnit/ValueObject/RectorTestResult.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Testing\PHPUnit\ValueObject;
+
+use Rector\Core\Contract\Rector\RectorInterface;
+use Rector\Core\ValueObject\ProcessResult;
+
+final class RectorTestResult
+{
+    public function __construct(
+        private readonly string $changedContents,
+        private readonly ProcessResult $processResult
+    ) {
+    }
+
+    public function getChangedContents(): string
+    {
+        return $this->changedContents;
+    }
+
+    /**
+     * @return array<class-string<RectorInterface>>
+     */
+    public function getAppliedRectorClasses(): array
+    {
+        $rectorClasses = [];
+
+        foreach ($this->processResult->getFileDiffs() as $fileDiff) {
+            $rectorClasses = array_merge($rectorClasses, $fileDiff->getRectorClasses());
+        }
+
+        sort($rectorClasses);
+
+        return array_unique($rectorClasses);
+    }
+}
diff --git a/...each_/RenameForeachValueVariableToMatchExprVariableRector/Fixture/keep_underscore.php.inc b/...each_/RenameForeachValueVariableToMatchExprVariableRector/Fixture/keep_underscore.php.inc
@@ -12,22 +12,3 @@ class KeepUnderscore
         }
     }
 }
-
-?>
------
-<?php
-
-namespace Rector\Tests\Naming\Rector\Foreach_\RenameForeachValueVariableToMatchExprVariableRector\Fixture;
-
-class KeepUnderscore
-{
-    public function run()
-    {
-        $customer_names = [];
-        foreach ($customer_names as $customer_name) {
-          echo $customer_name;
-        }
-    }
-}
-
-?>