Refactor

Author: sileence

src/Facades/GitInfo.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Styde\Enlighten\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * @method static string currentBranch
+ * @method static string head
+ * @method static string modified
+ */
+class GitInfo extends Facade
+{
+    public static function getFacadeAccessor()
+    {
+        return \Styde\Enlighten\Utils\GitInfo::class;
+    }
+}

src/Http/Middleware/HttpExampleCreatorMiddleware.php

@@ -3,10 +3,7 @@
 namespace Styde\Enlighten\Http\Middleware;
 
 use Closure;
-use Illuminate\Http\Response;
 use Styde\Enlighten\HttpExampleCreator;
-use Styde\Enlighten\TestRun;
-use Throwable;
 
 class HttpExampleCreatorMiddleware
 {

src/Providers/EnlightenServiceProvider.php

@@ -7,7 +7,6 @@
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Support\Str;
 use Styde\Enlighten\Utils\Annotations;
-use Styde\Enlighten\Utils\GitInfo;
 use Styde\Enlighten\Http\Middleware\HttpExampleCreatorMiddleware;
 use Styde\Enlighten\HttpExampleCreator;
 use Styde\Enlighten\RequestInspector;
@@ -23,7 +22,6 @@
 use Styde\Enlighten\View\Components\EditButtonComponent;
 use Styde\Enlighten\View\Components\ExceptionInfoComponent;
 use Styde\Enlighten\View\Components\HtmlResponseComponent;
-use Styde\Enlighten\View\Components\JsonResponseComponent;
 use Styde\Enlighten\View\Components\KeyValueComponent;
 use Styde\Enlighten\View\Components\RequestInputTableComponent;
 use Styde\Enlighten\View\Components\RouteParametersTableComponent;
@@ -38,7 +36,7 @@ public function boot()
     {
         $this->mergeConfigFrom($this->componentPath('config/enlighten.php'), 'enlighten');
 
-        if (!$this->app['config']->get('enlighten.enabled')) {
+        if (! $this->app['config']->get('enlighten.enabled')) {
             return;
         }
 
@@ -50,9 +48,12 @@ public function boot()
 
         if ($this->app->runningInConsole()) {
             $this->loadMigrationsFrom($this->componentPath('database/migrations'));
-            $this->registerMiddleware();
             $this->registerPublishing();
         }
+
+        if ($this->app->runningUnitTests()) {
+            $this->registerMiddleware();
+        }
     }
 
     protected function addDatabaseConnection(Config $config)
@@ -100,7 +101,7 @@ private function registerMiddleware()
     private function registerTestRun()
     {
         $this->app->singleton(TestRun::class, function () {
-            return new TestRun(new GitInfo);
+            return TestRun::getInstance();
         });
     }
 

src/TestClassInfo.php

@@ -12,9 +12,9 @@ class TestClassInfo
     private array $texts;
     protected ?ExampleGroup $exampleGroup = null;
 
-    public function __construct(TestRun $testRun, string $className, array $texts = [])
+    public function __construct(string $className, array $texts = [])
     {
-        $this->testRun = $testRun;
+        $this->testRun = TestRun::getInstance();
         $this->className = $className;
         $this->texts = $texts;
     }

src/TestInspector.php

@@ -72,7 +72,7 @@ private function makeTestClassInfo($name): TestClassInfo
 
         $this->classOptions = $annotations->get('enlighten', []);
 
-        return new TestClassInfo($this->testRun, $name, $this->getTextsFrom($annotations));
+        return new TestClassInfo($name, $this->getTextsFrom($annotations));
     }
 
     protected function getTextsFrom(Collection $annotations): array

src/TestRun.php

@@ -3,15 +3,15 @@
 namespace Styde\Enlighten;
 
 use Styde\Enlighten\Models\Run;
-use Styde\Enlighten\Utils\GitInfo;
+use Styde\Enlighten\Facades\GitInfo;
 
 class TestRun
 {
-    private static bool $hasBeenReset = false;
+    private static ?self $instance = null;
 
-    private GitInfo $gitInfo;
+    private Run $run;
 
-    private ?Run $run = null;
+    private bool $hasBeenReset = false;
 
     private string $context = 'test';
 
@@ -27,14 +27,26 @@ public static function getFailedTestLink(string $signature): string
         return static::$failedTestLinks[$signature];
     }
 
-    public function __construct(GitInfo $gitInfo)
+    public static function getInstance(): self
     {
-        $this->gitInfo = $gitInfo;
+        if (is_null(static::$instance)) {
+            static::$instance = new self;
+        }
+
+        return static::$instance;
+    }
 
+    public static function resetInstance()
+    {
+        static::$instance = null;
+    }
+
+    private function __construct()
+    {
         $this->run = Run::firstOrNew([
-            'branch' => $this->gitInfo->currentBranch(),
-            'head' => $this->gitInfo->head(),
-            'modified' => $this->gitInfo->modified(),
+            'branch' => GitInfo::currentBranch(),
+            'head' => GitInfo::head(),
+            'modified' => GitInfo::modified(),
         ]);
     }
 
@@ -59,12 +71,12 @@ public function save(): Run
 
     public function reset()
     {
-        if (static::$hasBeenReset) {
+        if ($this->hasBeenReset) {
             return;
         }
 
         $this->run->delete();
 
-        static::$hasBeenReset = true;
+        $this->hasBeenReset = true;
     }
 }

src/Tests/EnlightenSetup.php

@@ -28,8 +28,6 @@ public function setUpEnlighten()
                 return;
             }
 
-            $this->restoreTestRun();
-
             $this->resetRunData();
 
             $this->captureExceptions();
@@ -45,8 +43,6 @@ public function setUpEnlighten()
             $this->stopCapturingQueries();
 
             $this->saveTestExample();
-
-            $this->preserveTestRun();
         });
     }
 
@@ -61,8 +57,7 @@ private function captureQueries()
                 return;
             }
 
-            $test = $this->app->make(TestInspector::class)
-                ->getInfo(get_class($this), $this->getName());
+            $test = $this->app->make(TestInspector::class)->getInfo(get_class($this), $this->getName());
 
             if ($test->isIgnored()) {
                 return;
@@ -118,18 +113,6 @@ protected function withExceptionHandling()
         return $this;
     }
 
-    private function preserveTestRun()
-    {
-        static::$testRun = $this->app->make(TestRun::class);
-    }
-
-    private function restoreTestRun()
-    {
-        if (static::$testRun) {
-            $this->app->instance(TestRun::class, static::$testRun);
-        }
-    }
-
     private function resetRunData()
     {
         $this->app->make(TestRun::class)->reset();

tests/Integration/CaptureQueriesTest.php

@@ -30,7 +30,9 @@ function it_stores_the_queries_executed_during_the_test()
 
         $example = Example::first();
 
-        $this->assertNotNull($example);
+        $this->assertNotNull($example, 'The Example was not recorded as expected');
+
+        $this->assertNotNull($example->http_data->first(), 'The Example HTTP data was not recorded as expected');
 
         tap($example->queries->shift(), function (ExampleQuery $exampleQuery) {
             $this->assertNotNull($exampleQuery);

tests/Unit/TestClassInfoTest.php

@@ -12,22 +12,16 @@ class TestClassInfoTest extends TestCase
     /** @test */
     function it_gets_a_default_title()
     {
-        $testRun = new TestRun(new GitInfo);
-
-        $clasInfo = new TestClassInfo($testRun, 'ListUsersTest');
-
+        $clasInfo = new TestClassInfo('ListUsersTest');
         $this->assertSame('List Users', $clasInfo->getTitle());
 
-        $clasInfo = new TestClassInfo($testRun, 'ListTestsTest');
-
+        $clasInfo = new TestClassInfo('ListTestsTest');
         $this->assertSame('List Tests', $clasInfo->getTitle());
 
-        $clasInfo = new TestClassInfo($testRun, 'ShowUsers');
-
+        $clasInfo = new TestClassInfo('ShowUsers');
         $this->assertSame('Show Users', $clasInfo->getTitle());
 
-        $clasInfo = new TestClassInfo($testRun, 'CreateTestTest');
-
+        $clasInfo = new TestClassInfo('CreateTestTest');
         $this->assertSame('Create Test', $clasInfo->getTitle());
     }
 }

tests/Unit/TestMethodInfoTest.php

@@ -14,7 +14,7 @@ class TestMethodInfoTest extends TestCase
     function generated_titles_do_not_include_the_test_prefix()
     {
         $testMethodInfo = new TestMethodInfo(
-            new TestClassInfo(new TestRun(new GitInfo), 'TestClass'),
+            new TestClassInfo('TestClass'),
             'test_it_removes_the_test_prefix'
         );
 

tests/Unit/TestRunTest.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Tests\Unit;
+
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Styde\Enlighten\Models\Run;
+use Styde\Enlighten\TestRun;
+use Tests\TestCase;
+
+class TestRunTest extends TestCase
+{
+    use RefreshDatabase;
+
+    protected function tearDown(): void
+    {
+        // Reset the instance to allow TestRun to be properly unit tested.
+        // This is required in the tearDown() method to make sure this
+        // test does not interfere with all the integration tests.
+        TestRun::resetInstance();
+
+        parent::tearDown();
+    }
+
+    /** @test */
+    function can_only_create_an_instance_of_test_run()
+    {
+        $reflection = new \ReflectionClass(TestRun::class);
+
+        $this->assertTrue($reflection->getConstructor()->isPrivate());
+    }
+
+    /** @test */
+    function can_get_a_singleton_instance_of_test_run()
+    {
+        $this->assertInstanceOf(TestRun::class, TestRun::getInstance());
+
+        $this->assertSame(TestRun::getInstance(), TestRun::getInstance());
+    }
+
+    /** @test */
+    function can_reset_a_test_run()
+    {
+        TestRun::getInstance()->save();
+
+        $this->assertNotNull(Run::first());
+
+        TestRun::getInstance()->reset();
+
+        $this->assertNull(Run::first());
+    }
+
+    /** @test */
+    function a_test_run_can_only_be_reset_once()
+    {
+        TestRun::getInstance()->save();
+        TestRun::getInstance()->reset();
+
+        $this->assertNull(Run::first());
+
+        TestRun::getInstance()->save();
+        TestRun::getInstance()->reset();
+
+        $this->assertNotNull(Run::first());
+    }
+}