Merge pull request #255 from fabio-ivona/exclude-pest-extends

Exclude Pest expectation pipes code from failure snippets
nunomaduro · Feb 19, 2023 · d7ff6ad · d7ff6ad
2 parents dc683d4 + d137151
commit d7ff6ad
Showing 1 changed file with 67 additions and 28 deletions.
diff --git a/src/Adapters/Phpunit/Style.php b/src/Adapters/Phpunit/Style.php
@@ -24,6 +24,7 @@
 use function Termwind\renderUsing;
 use Termwind\Terminal;
 use function Termwind\terminal;
+use Whoops\Exception\Frame;
 use Whoops\Exception\Inspector;
 
 /**
@@ -42,7 +43,7 @@ final class Style
     /**
      * @var string[]
      */
-    private const TYPES = [TestResult::DEPRECATED, TestResult::FAIL, TestResult::WARN, TestResult::RISKY, TestResult::INCOMPLETE, TestResult::TODO,  TestResult::SKIPPED, TestResult::PASS];
+    private const TYPES = [TestResult::DEPRECATED, TestResult::FAIL, TestResult::WARN, TestResult::RISKY, TestResult::INCOMPLETE, TestResult::TODO, TestResult::SKIPPED, TestResult::PASS];
 
     /**
      * Style constructor.
@@ -167,7 +168,8 @@ public function writeErrorsSummary(State $state, bool $onFailure): void
                 <div class="mx-2 text-red">
                     <hr/>
                 </div>
-            HTML);
+            HTML
+            );
 
             $testCaseName = $testResult->testCaseName;
             $description = $testResult->description;
@@ -336,32 +338,8 @@ public function writeError(Throwable $throwable): void
             '/vendor\/sulu\/sulu\/src\/Sulu\/Bundle\/TestBundle\/Testing/',
             '/vendor\/webmozart\/assert/',
 
-            //Ignores frames in PestPHP custom expectations
-            function ($frame) {
-                if (class_exists(Expectation::class)) {
-                    $reflection = new ReflectionClass(Expectation::class);
-
-                    /** @var array<int, Closure> $extends */
-                    $extends = $reflection->getStaticPropertyValue('extends', []);
-
-                    foreach ($extends as $extendClosure) {
-                        $reflection = new ReflectionFunction($extendClosure);
-
-                        $sanitizedPath = (string) str_replace('\\', '/', $frame->getFile());
-
-                        /** @phpstan-ignore-next-line */
-                        $sanitizedClosurePath = (string) str_replace('\\', '/', $reflection->getFileName());
-
-                        if ($sanitizedPath === $sanitizedClosurePath) {
-                            if ($reflection->getStartLine() <= $frame->getLine() && $frame->getLine() <= $reflection->getEndLine()) {
-                                return true;
-                            }
-                        }
-                    }
-                }
-
-                return false;
-            },
+            $this->ignorePestPipes(...),
+            $this->ignorePestExtends(...),
         ]);
 
         /** @var \Throwable $throwable */
@@ -459,4 +437,65 @@ private function writeDescriptionLine(TestResult $result): void
             </div>
         HTML, $seconds === '' ? '' : 'flex space-x-1 justify-between', $truncateClasses, $result->color, $result->icon, $description, $warning, $seconds));
     }
+
+    /**
+     * @param  Frame  $frame
+     */
+    private function ignorePestPipes($frame): bool
+    {
+        if (class_exists(Expectation::class)) {
+            $reflection = new ReflectionClass(Expectation::class);
+            $expectationPipes = $reflection->getStaticPropertyValue('pipes', []);
+
+            foreach ($expectationPipes as $pipes) {
+                foreach ($pipes as $pipeClosure) {
+                    if ($this->isFrameInClosure($frame, $pipeClosure)) {
+                        return true;
+                    }
+                }
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param  Frame  $frame
+     */
+    private function ignorePestExtends($frame): bool
+    {
+        if (class_exists(Expectation::class)) {
+            $reflection = new ReflectionClass(Expectation::class);
+            $extends = $reflection->getStaticPropertyValue('extends', []);
+
+            foreach ($extends as $extendClosure) {
+                if ($this->isFrameInClosure($frame, $extendClosure)) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param  Frame  $frame
+     */
+    private function isFrameInClosure($frame, Closure $closure): bool
+    {
+        $reflection = new ReflectionFunction($closure);
+
+        $sanitizedPath = (string) str_replace('\\', '/', $frame->getFile());
+
+        /** @phpstan-ignore-next-line */
+        $sanitizedClosurePath = (string) str_replace('\\', '/', $reflection->getFileName());
+
+        if ($sanitizedPath === $sanitizedClosurePath) {
+            if ($reflection->getStartLine() <= $frame->getLine() && $frame->getLine() <= $reflection->getEndLine()) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }