Show 'see in enlighten' link when a test fails

Author: sileence

phpunit.xml

@@ -3,7 +3,8 @@
          bootstrap="vendor/autoload.php" colors="true" convertErrorsToExceptions="true"
          convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false"
          stopOnError="false" stopOnFailure="false" verbose="true"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         printerClass="Styde\Enlighten\Tests\ResultPrinter">
     <coverage processUncoveredFiles="true">
         <include>
             <directory suffix=".php">./src</directory>

src/Models/ExampleGroup.php

@@ -51,6 +51,11 @@ public function scopeBySuite($query, Area $suite) : Builder
     }
 
     // Accessors
+    public function getSuiteAttribute()
+    {
+        return Str::slug(explode('\\', $this->class_name)[1]);
+    }
+
     public function getPassingTestsCountAttribute()
     {
         return $this->stats

src/TestMethodInfo.php

@@ -30,6 +30,24 @@ public function __construct(TestClassInfo $classInfo, string $methodName, array
         $this->line = null;
     }
 
+    public function getSignature()
+    {
+        return $this->classInfo->getClassName().'::'.$this->methodName;
+    }
+
+    public function getLink()
+    {
+        if ($this->example->group == null) {
+            return null;
+        }
+
+        return route('enlighten.group.show', [
+            'run' => $this->example->group->run_id,
+            'suite' => $this->example->group->suite ?: 'feature', //@TODO: fix this link
+            'group' => $this->example->group->id,
+        ]).'#'.$this->example->method_name;
+    }
+
     public function isIgnored(): bool
     {
         return false;

src/TestRun.php

@@ -15,6 +15,18 @@ class TestRun
 
     private string $context = 'test';
 
+    private static $failedTestLinks = [];
+
+    public static function saveFailedTestLink(TestMethodInfo $testMethodInfo)
+    {
+        static::$failedTestLinks[$testMethodInfo->getSignature()] = $testMethodInfo->getLink();
+    }
+
+    public static function getFailedTestLink(string $signature): string
+    {
+        return static::$failedTestLinks[$signature];
+    }
+
     public function __construct(GitInfo $gitInfo)
     {
         $this->gitInfo = $gitInfo;

src/Tests/EnlightenSetup.php

@@ -5,6 +5,7 @@
 use Illuminate\Contracts\Debug\ExceptionHandler;
 use Illuminate\Support\Facades\DB;
 use PHPUnit\TextUI\TestRunner;
+use Styde\Enlighten\Models\Status;
 use Styde\Enlighten\TestInspector;
 use Styde\Enlighten\TestRun;
 
@@ -140,6 +141,10 @@ protected function saveTestExample()
         }
 
         $test->saveTestStatus($this->getStatusAsText());
+
+        if ($this->getStatus() !== TestRunner::STATUS_PASSED) {
+            TestRun::saveFailedTestLink($test);
+        }
     }
 
     private function getStatusAsText()

src/Tests/ResultPrinter.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Styde\Enlighten\Tests;
+
+use PHPUnit\Framework\TestFailure;
+use PHPUnit\TextUI\DefaultResultPrinter;
+use Styde\Enlighten\TestRun;
+
+class ResultPrinter extends DefaultResultPrinter
+{
+    protected function printDefectTrace(TestFailure $defect): void
+    {
+        parent::printDefectTrace($defect);
+
+        if ($link = TestRun::getFailedTestLink($defect->getTestName())) {
+            $this->write("\n⚡See in Enlighten: ");
+            $this->writeWithColor('fg-yellow, bold', "{$link}\n");
+        }
+    }
+}

tests/Integration/ApiRequestTest.php

@@ -32,7 +32,7 @@ function gets_the_list_of_users()
             'email' => '[email protected]',
         ]);
 
-        $this->get('api/users')
+        $this->get('api/user')
             ->assertOk()
             ->assertSimilarJson([
                 'data' => [