Merge pull request #576 from ergebnis/feature/test-description

Enhancement: Implement `TestDescription`
ergebnis · Jun 16, 2024 · 1cb0438 · 1cb0438
2 parents dd37d9c + fede7ed
commit 1cb0438
Show file tree

Hide file tree

Showing 12 changed files with 237 additions and 3 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.23.1@8471a896ccea3526b26d082f4461eeea467f10a4">
+<files psalm-version="5.24.0@462c80e31c34e58cc4f750c656be3927e80e550e">
   <file src="src/Collector/Collector.php">
     <MissingReturnType>
       <code><![CDATA[collect]]></code>
@@ -755,6 +755,11 @@
       <code><![CDATA[testNotLessThanOrEqualToEndReturnsException]]></code>
     </MissingReturnType>
   </file>
+  <file src="test/Unit/Exception/InvalidTestDescriptionTest.php">
+    <MissingReturnType>
+      <code><![CDATA[testBlankOrEmptyReturnsException]]></code>
+    </MissingReturnType>
+  </file>
   <file src="test/Unit/Exception/InvalidTestIdentifierTest.php">
     <MissingReturnType>
       <code><![CDATA[testBlankOrEmptyReturnsException]]></code>
@@ -797,6 +802,21 @@
       <code><![CDATA[testCreateReturnsSlowTest]]></code>
     </MissingReturnType>
   </file>
+  <file src="test/Unit/TestDescriptionTest.php">
+    <InternalClass>
+      <code><![CDATA[TestDescription::fromString($value)]]></code>
+      <code><![CDATA[TestDescription::fromString($value)]]></code>
+    </InternalClass>
+    <InternalMethod>
+      <code><![CDATA[TestDescription::fromString($value)]]></code>
+      <code><![CDATA[TestDescription::fromString($value)]]></code>
+      <code><![CDATA[toString]]></code>
+    </InternalMethod>
+    <MissingReturnType>
+      <code><![CDATA[testFromStringRejectsInvalidValue]]></code>
+      <code><![CDATA[testFromStringReturnsTestDescription]]></code>
+    </MissingReturnType>
+  </file>
   <file src="test/Unit/TestIdentifierTest.php">
     <MissingReturnType>
       <code><![CDATA[testFromStringRejectsInvalidValue]]></code>

diff --git a/src/Exception/InvalidTestDescription.php b/src/Exception/InvalidTestDescription.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021-2024 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/phpunit-slow-test-detector
+ */
+
+namespace Ergebnis\PHPUnit\SlowTestDetector\Exception;
+
+/**
+ * @internal
+ */
+final class InvalidTestDescription extends \InvalidArgumentException
+{
+    public static function blankOrEmpty(): self
+    {
+        return new self('Value cannot be blank or empty.');
+    }
+}
diff --git a/src/Extension.php b/src/Extension.php
@@ -175,8 +175,15 @@ public function endTest(
                 $test->getName()
             ));
 
+            $testDescription = TestDescription::fromString(\sprintf(
+                '%s::%s',
+                \get_class($test),
+                $test->getName()
+            ));
+
             $slowTest = SlowTest::create(
                 $testIdentifier,
+                $testDescription,
                 $duration,
                 $maximumDuration
             );
@@ -314,9 +321,11 @@ public function executeAfterTest(
             }
 
             $testIdentifier = TestIdentifier::fromString($test);
+            $testDescription = TestDescription::fromString($test);
 
             $slowTest = SlowTest::create(
                 $testIdentifier,
+                $testDescription,
                 $duration,
                 $maximumDuration
             );

diff --git a/src/Reporter/DefaultReporter.php b/src/Reporter/DefaultReporter.php
@@ -159,10 +159,10 @@ static function (Duration $maximumDuration, SlowTest $slowTest): Duration {
                 )
             );
 
-            $testName = $slowTest->testIdentifier()->toString();
+            $testDescription = $slowTest->testDescription()->toString();
 
             return <<<TXT
-{$formattedNumber}. {$formattedDuration} {$formattedMaximumDuration} {$testName}
+{$formattedNumber}. {$formattedDuration} {$formattedMaximumDuration} {$testDescription}
 TXT;
         }, \range(1, \count($slowTestsToReport)), $slowTestsToReport);
 

diff --git a/src/SlowTest.php b/src/SlowTest.php
@@ -23,6 +23,11 @@ final class SlowTest
      */
     private $testIdentifier;
 
+    /**
+     * @var TestDescription
+     */
+    private $testDescription;
+
     /**
      * @var Duration
      */
@@ -35,21 +40,25 @@ final class SlowTest
 
     private function __construct(
         TestIdentifier $testIdentifier,
+        TestDescription $testDescription,
         Duration $duration,
         Duration $maximumDuration
     ) {
         $this->testIdentifier = $testIdentifier;
+        $this->testDescription = $testDescription;
         $this->duration = $duration;
         $this->maximumDuration = $maximumDuration;
     }
 
     public static function create(
         TestIdentifier $testIdentifier,
+        TestDescription $testDescription,
         Duration $duration,
         Duration $maximumDuration
     ): self {
         return new self(
             $testIdentifier,
+            $testDescription,
             $duration,
             $maximumDuration
         );
@@ -60,6 +69,11 @@ public function testIdentifier(): TestIdentifier
         return $this->testIdentifier;
     }
 
+    public function testDescription(): TestDescription
+    {
+        return $this->testDescription;
+    }
+
     public function duration(): Duration
     {
         return $this->duration;

diff --git a/src/Subscriber/Test/FinishedSubscriber.php b/src/Subscriber/Test/FinishedSubscriber.php
@@ -18,6 +18,7 @@
 use Ergebnis\PHPUnit\SlowTestDetector\Duration;
 use Ergebnis\PHPUnit\SlowTestDetector\PhaseIdentifier;
 use Ergebnis\PHPUnit\SlowTestDetector\SlowTest;
+use Ergebnis\PHPUnit\SlowTestDetector\TestDescription;
 use Ergebnis\PHPUnit\SlowTestDetector\TestIdentifier;
 use Ergebnis\PHPUnit\SlowTestDetector\Time;
 use Ergebnis\PHPUnit\SlowTestDetector\TimeKeeper;
@@ -82,6 +83,7 @@ public function notify(Event\Test\Finished $event): void
 
         $slowTest = SlowTest::create(
             TestIdentifier::fromString($event->test()->id()),
+            TestDescription::fromString($event->test()->id()),
             $duration,
             $maximumDuration
         );

diff --git a/src/TestDescription.php b/src/TestDescription.php
@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021-2024 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/phpunit-slow-test-detector
+ */
+
+namespace Ergebnis\PHPUnit\SlowTestDetector;
+
+/**
+ * @internal
+ */
+final class TestDescription
+{
+    /**
+     * @var string
+     */
+    private $value;
+
+    private function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+
+    /**
+     * @throws Exception\InvalidTestDescription
+     */
+    public static function fromString(string $value): self
+    {
+        if ('' === \trim($value)) {
+            throw Exception\InvalidTestDescription::blankOrEmpty();
+        }
+
+        return new self($value);
+    }
+
+    public function toString(): string
+    {
+        return $this->value;
+    }
+}
diff --git a/test/Unit/Collector/DefaultCollectorTest.php b/test/Unit/Collector/DefaultCollectorTest.php
@@ -17,6 +17,7 @@
 use Ergebnis\PHPUnit\SlowTestDetector\Duration;
 use Ergebnis\PHPUnit\SlowTestDetector\SlowTest;
 use Ergebnis\PHPUnit\SlowTestDetector\Test;
+use Ergebnis\PHPUnit\SlowTestDetector\TestDescription;
 use Ergebnis\PHPUnit\SlowTestDetector\TestIdentifier;
 use PHPUnit\Framework;
 
@@ -25,6 +26,7 @@
  *
  * @uses \Ergebnis\PHPUnit\SlowTestDetector\Duration
  * @uses \Ergebnis\PHPUnit\SlowTestDetector\SlowTest
+ * @uses \Ergebnis\PHPUnit\SlowTestDetector\TestDescription
  * @uses \Ergebnis\PHPUnit\SlowTestDetector\TestIdentifier
  */
 final class DefaultCollectorTest extends Framework\TestCase
@@ -37,12 +39,14 @@ public function testCollectCollectsSlowTests()
 
         $one = SlowTest::create(
             TestIdentifier::fromString($faker->word()),
+            TestDescription::fromString($faker->word()),
             Duration::fromMilliseconds($faker->numberBetween(0)),
             Duration::fromMilliseconds($faker->numberBetween(0))
         );
 
         $two = SlowTest::create(
             TestIdentifier::fromString($faker->word()),
+            TestDescription::fromString($faker->word()),
             Duration::fromMilliseconds($faker->numberBetween(0)),
             Duration::fromMilliseconds($faker->numberBetween(0))
         );
@@ -66,12 +70,14 @@ public function testCollectCollectsSlowerTestWithSameTestIdentifier()
 
         $one = SlowTest::create(
             TestIdentifier::fromString($faker->word()),
+            TestDescription::fromString($faker->word()),
             Duration::fromMilliseconds($faker->numberBetween(0)),
             Duration::fromMilliseconds($faker->numberBetween(0, 999999999 - 1))
         );
 
         $two = SlowTest::create(
             $one->testIdentifier(),
+            TestDescription::fromString($faker->word()),
             Duration::fromSecondsAndNanoseconds(
                 $one->duration()->seconds(),
                 $one->duration()->nanoseconds() + 1
@@ -97,12 +103,14 @@ public function testCollectDoesNotCollectFasterTestWithSameTestIdentifier()
 
         $one = SlowTest::create(
             TestIdentifier::fromString($faker->word()),
+            TestDescription::fromString($faker->word()),
             Duration::fromMilliseconds($faker->numberBetween(0)),
             Duration::fromMilliseconds($faker->numberBetween(1, 999999999))
         );
 
         $two = SlowTest::create(
             $one->testIdentifier(),
+            TestDescription::fromString($faker->word()),
             Duration::fromSecondsAndNanoseconds(
                 $one->duration()->seconds(),
                 $one->duration()->nanoseconds() - 1

diff --git a/test/Unit/Exception/InvalidTestDescriptionTest.php b/test/Unit/Exception/InvalidTestDescriptionTest.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021-2024 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/phpunit-slow-test-detector
+ */
+
+namespace Ergebnis\PHPUnit\SlowTestDetector\Test\Unit\Exception;
+
+use Ergebnis\PHPUnit\SlowTestDetector\Exception;
+use PHPUnit\Framework;
+
+/**
+ * @covers \Ergebnis\PHPUnit\SlowTestDetector\Exception\InvalidTestDescription
+ */
+final class InvalidTestDescriptionTest extends Framework\TestCase
+{
+    public function testBlankOrEmptyReturnsException()
+    {
+        $exception = Exception\InvalidTestDescription::blankOrEmpty();
+
+        self::assertSame('Value cannot be blank or empty.', $exception->getMessage());
+    }
+}