Enhancement: Compose data into Test\SkippedWithMessage event

Related to #36. Co-authored-by: Andreas Möller <am@localheinz.com> Co-authored-by: Arne Blankerts <Arne@Blankerts.de>
theseer · Nov 20, 2020 · 547bf04 · 547bf04
1 parent e2914b7
commit 547bf04
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 11 deletions.
diff --git a/src/Event/DispatchingEmitter.php b/src/Event/DispatchingEmitter.php
@@ -171,9 +171,13 @@ public function testSkippedDueToUnsatisfiedRequirements(Code\ClassMethod $testMe
         ));
     }
 
-    public function testSkippedWithMessage(): void
+    public function testSkippedWithMessage(Code\Test $test, string $message): void
     {
-        $this->dispatcher->dispatch(new Test\SkippedWithMessage($this->telemetryInfo()));
+        $this->dispatcher->dispatch(new Test\SkippedWithMessage(
+            $this->telemetryInfo(),
+            $test,
+            $message
+        ));
     }
 
     public function testPrepared(Code\Test $test): void

diff --git a/src/Event/Emitter.php b/src/Event/Emitter.php
@@ -57,7 +57,7 @@ public function testAbortedWithMessage(Code\Test $test, string $message): void;
 
     public function testSkippedDueToUnsatisfiedRequirements(Code\ClassMethod $testMethod, string ...$missingRequirements): void;
 
-    public function testSkippedWithMessage(): void;
+    public function testSkippedWithMessage(Code\Test $test, string $message): void;
 
     public function testPrepared(Code\Test $test): void;
 

diff --git a/src/Event/Test/SkippedWithMessage.php b/src/Event/Test/SkippedWithMessage.php
@@ -9,6 +9,7 @@
  */
 namespace PHPUnit\Event\Test;
 
+use PHPUnit\Event\Code;
 use PHPUnit\Event\Event;
 use PHPUnit\Event\Telemetry;
 
@@ -19,13 +20,35 @@ final class SkippedWithMessage implements Event
      */
     private $telemetryInfo;
 
-    public function __construct(Telemetry\Info $telemetryInfo)
+    /**
+     * @var Code\Test
+     */
+    private $testMethod;
+
+    /**
+     * @var string
+     */
+    private $message;
+
+    public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test, string $message)
     {
         $this->telemetryInfo = $telemetryInfo;
+        $this->testMethod    = $test;
+        $this->message       = $message;
     }
 
     public function telemetryInfo(): Telemetry\Info
     {
         return $this->telemetryInfo;
     }
+
+    public function test(): Code\Test
+    {
+        return $this->testMethod;
+    }
+
+    public function message(): string
+    {
+        return $this->message;
+    }
 }
diff --git a/src/Framework/TestCase.php b/src/Framework/TestCase.php
@@ -1231,7 +1231,13 @@ public function runBare(): void
             $this->status        = BaseTestRunner::STATUS_SKIPPED;
             $this->statusMessage = $e->getMessage();
 
-            Event\Registry::emitter()->testSkippedWithMessage();
+            Event\Registry::emitter()->testSkippedWithMessage(
+                new Event\Code\Test(
+                    static::class,
+                    $this->name
+                ),
+                $e->getMessage()
+            );
         } catch (Warning $e) {
             $this->status        = BaseTestRunner::STATUS_WARNING;
             $this->statusMessage = $e->getMessage();

diff --git a/tests/_files/NullEmitter.php b/tests/_files/NullEmitter.php
@@ -87,7 +87,7 @@ public function testSkippedDueToUnsatisfiedRequirements(Code\ClassMethod $testMe
     {
     }
 
-    public function testSkippedWithMessage(): void
+    public function testSkippedWithMessage(Code\Test $test, string $message): void
     {
     }
 

diff --git a/tests/unit/Event/DispatchingEmitterTest.php b/tests/unit/Event/DispatchingEmitterTest.php
@@ -637,8 +637,14 @@ public function notify(Test\SkippedDueToUnsatisfiedRequirements $event): void
         self::assertSame($missingRequirements, $event->missingRequirements());
     }
 
-    public function testTestRunSkippedWithWarningDispatchesTestRunSkippedWithWarningEvent(): void
+    public function testTestSkippedMessageDispatchesTestSkippedWithMessageEvent(): void
     {
+        $test = new Code\Test(...array_values(explode(
+            '::',
+            __METHOD__
+        )));
+        $message = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.';
+
         $subscriber = new class extends RecordingSubscriber implements Test\SkippedWithMessageSubscriber {
             public function notify(Test\SkippedWithMessage $event): void
             {
@@ -659,10 +665,19 @@ public function notify(Test\SkippedWithMessage $event): void
             $telemetrySystem
         );
 
-        $emitter->testSkippedWithMessage();
+        $emitter->testSkippedWithMessage(
+            $test,
+            $message
+        );
 
         self::assertSame(1, $subscriber->recordedEventCount());
-        self::assertInstanceOf(Test\SkippedWithMessage::class, $subscriber->lastRecordedEvent());
+
+        $event = $subscriber->lastRecordedEvent();
+
+        self::assertInstanceOf(Test\SkippedWithMessage::class, $event);
+
+        self::assertSame($test, $event->test());
+        self::assertSame($message, $event->message());
     }
 
     public function testTestPreparedDispatchesTestPreparedEvent(): void

diff --git a/tests/unit/Event/Test/SkippedWithMessageTest.php b/tests/unit/Event/Test/SkippedWithMessageTest.php
@@ -10,18 +10,30 @@
 namespace PHPUnit\Event\Test;
 
 use PHPUnit\Event\AbstractEventTestCase;
+use PHPUnit\Event\Code;
 
 /**
- * @covers \PHPUnit\Event\Test\SkippedWithMessage
+ * @covers \PHPUnit\Event\Test\SkippedByDataProvider
  */
 final class SkippedWithMessageTest extends AbstractEventTestCase
 {
     public function testConstructorSetsValues(): void
     {
         $telemetryInfo = self::createTelemetryInfo();
+        $test          = new Code\Test(...array_values(explode(
+            '::',
+            __METHOD__
+        )));
+        $message = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.';
 
-        $event = new SkippedWithMessage($telemetryInfo);
+        $event = new SkippedWithMessage(
+            $telemetryInfo,
+            $test,
+            $message
+        );
 
         self::assertSame($telemetryInfo, $event->telemetryInfo());
+        self::assertSame($test, $event->test());
+        self::assertSame($message, $event->message());
     }
 }