Enhancement: Compose data into TestSuite\Started event

Fixes #25.

Co-authored-by: Andreas Möller <am@localheinz.com>
Co-authored-by: Arne Blankerts <Arne@Blankerts.de>

src/Event/DispatchingEmitter.php

@@ -310,9 +310,12 @@ public function testSuiteSorted(int $executionOrder, int $executionOrderDefects,
         ));
     }
 
-    public function testSuiteStarted(): void
+    public function testSuiteStarted(string $name): void
     {
-        $this->dispatcher->dispatch(new TestSuite\Started($this->telemetryInfo()));
+        $this->dispatcher->dispatch(new TestSuite\Started(
+            $this->telemetryInfo(),
+            $name
+        ));
     }
 
     private function telemetryInfo(): Telemetry\Info

src/Event/Emitter.php

@@ -133,5 +133,5 @@ public function testSuiteRunFinished(): void;
 
     public function testSuiteSorted(int $executionOrder, int $executionOrderDefects, bool $resolveDependencies): void;
 
-    public function testSuiteStarted(): void;
+    public function testSuiteStarted(string $name): void;
 }

src/Event/TestSuite/Started.php

@@ -16,13 +16,21 @@ final class Started implements Event
 {
     private Telemetry\Info $telemetryInfo;
 
-    public function __construct(Telemetry\Info $telemetryInfo)
+    private string $name;
+
+    public function __construct(Telemetry\Info $telemetryInfo, string $name)
     {
         $this->telemetryInfo = $telemetryInfo;
+        $this->name          = $name;
     }
 
     public function telemetryInfo(): Telemetry\Info
     {
         return $this->telemetryInfo;
     }
+
+    public function name(): string
+    {
+        return $this->name;
+    }
 }

src/TextUI/TestRunner.php

@@ -617,7 +617,7 @@ public function run(TestSuite $suite, array $arguments = [], array $warnings = [
             $this->write(PHP_EOL);
         }
 
-        Event\Registry::emitter()->testSuiteStarted();
+        Event\Registry::emitter()->testSuiteStarted($suite->getName());
 
         $suite->run($result);
 

tests/_files/NullEmitter.php

@@ -170,7 +170,7 @@ public function testSuiteSorted(int $executionOrder, int $executionOrderDefects,
     {
     }
 
-    public function testSuiteStarted(): void
+    public function testSuiteStarted(string $name): void
     {
     }
 }

tests/unit/Event/DispatchingEmitterTest.php

@@ -1344,6 +1344,8 @@ public function notify(TestSuite\Sorted $event): void
 
     public function testTestSuiteStartedDispatchesTestSuiteStartedEvent(): void
     {
+        $name = 'foo';
+
         $subscriber = new class extends RecordingSubscriber implements TestSuite\StartedSubscriber {
             public function notify(TestSuite\Started $event): void
             {
@@ -1364,10 +1366,15 @@ public function notify(TestSuite\Started $event): void
             $telemetrySystem
         );
 
-        $emitter->testSuiteStarted();
+        $emitter->testSuiteStarted($name);
 
         $this->assertSame(1, $subscriber->recordedEventCount());
-        $this->assertInstanceOf(TestSuite\Started::class, $subscriber->lastRecordedEvent());
+
+        $event = $subscriber->lastRecordedEvent();
+
+        $this->assertInstanceOf(TestSuite\Started::class, $event);
+
+        $this->assertSame($name, $event->name());
     }
 
     private static function createDispatcherWithRegisteredSubscriber(string $subscriberInterface, string $eventClass, Subscriber $subscriber): Dispatcher

tests/unit/Event/TestSuite/StartedTest.php

@@ -19,9 +19,14 @@ final class StartedTest extends AbstractEventTestCase
     public function testConstructorSetsValues(): void
     {
         $telemetryInfo = self::createTelemetryInfo();
+        $name          = 'foo';
 
-        $event = new Started($telemetryInfo);
+        $event = new Started(
+            $telemetryInfo,
+            $name
+        );
 
         $this->assertSame($telemetryInfo, $event->telemetryInfo());
+        $this->assertSame($name, $event->name());
     }
 }