Feedback, add tests and add getName function on TestLiveComponent

Author: Arkalo2

src/LiveComponent/src/Test/InteractsWithLiveComponents.php

@@ -45,23 +45,34 @@ protected function createLiveComponent(string $name, array $data = [], ?KernelBr
         );
     }
 
-    protected function assertComponentEmitEvent(TestLiveComponent $testLiveComponent, string $eventName, ?array $parameters = null): void
+    protected function assertComponentEmitEvent(TestLiveComponent $testLiveComponent, string $expectedEventName, ?array $expectedEventData = null): void
     {
-        $eventData = $testLiveComponent->getEmittedEvent($testLiveComponent->render(), $eventName);
+        $event = $testLiveComponent->getEmittedEvent($testLiveComponent->render(), $expectedEventName);
 
-        $this->assertNotNull($eventData, \sprintf('Event %s not emitted', $eventName));
+        $this->assertNotNull($event, \sprintf('The component "%s" did not emit event "%s".', $testLiveComponent->getName(), $expectedEventName));
 
-        if (null === $parameters) {
+        if (null === $expectedEventData) {
             return;
         }
 
-        foreach ($parameters as $key => $value) {
-            $this->assertSame($value, $eventData['data'][$key] ?? null, \sprintf('EventData (%s) is not valid', $key));
+        foreach ($expectedEventData as $key => $value) {
+            $this->assertArrayHasKey($key, $event['data'], \sprintf('The expected event "%s" data "%s" does not exists', $event['event'], $key));
+            $this->assertSame(
+                $value,
+                $event['data'][$key],
+                \sprintf(
+                    'The expected event "%s" data "%s" expected "%s" but "%s" given',
+                    $event['event'],
+                    $key,
+                    $value,
+                    $event['data'][$key]
+                )
+            );
         }
     }
 
     protected function assertComponentNotEmitEvent(TestLiveComponent $testLiveComponent, string $eventName): void
     {
-        $this->assertNull($testLiveComponent->getEmittedEvent($testLiveComponent->render(), $eventName), \sprintf('Event %s emitted', $eventName));
+        $this->assertNull($testLiveComponent->getEmittedEvent($testLiveComponent->render(), $eventName), \sprintf('The component "%s" did not emit event "%s".', $testLiveComponent->getName(), $eventName));
     }
 }

src/LiveComponent/src/Test/TestLiveComponent.php

@@ -235,11 +235,11 @@ private function flattenFormValues(array $values, string $prefix = ''): array
      */
     public function getEmittedEvent(RenderedComponent $render, string $eventName): ?array
     {
-        $eventsData = $this->getEmittedEvents($render);
+        $events = $this->getEmittedEvents($render);
 
-        foreach ($eventsData as $eventData) {
-            if ($eventData['event'] === $eventName) {
-                return $eventData;
+        foreach ($events as $event) {
+            if ($event['event'] === $eventName) {
+                return $event;
             }
         }
 
@@ -251,13 +251,17 @@ public function getEmittedEvent(RenderedComponent $render, string $eventName): ?
      */
     public function getEmittedEvents(RenderedComponent $render): array
     {
-        $div = $render->crawler()->filter('[data-live-name-value]');
-        $emit = $div->attr('data-live-events-to-emit-value');
+        $emit = $render->crawler()->filter('[data-live-name-value]')->attr('data-live-events-to-emit-value');
 
         if (null === $emit) {
             return [];
         }
 
         return json_decode($emit, associative: true, flags: \JSON_THROW_ON_ERROR);
     }
+
+    public function getName(): string
+    {
+        return $this->metadata->getName();
+    }
 }

src/LiveComponent/tests/Functional/Test/InteractsWithLiveComponentsTest.php

@@ -219,7 +219,7 @@ public function testSetLocaleRenderLocalizedComponent(): void
         $this->assertStringContainsString('Locale: de', $testComponent->render());
     }
 
-    public function testComponentEmitsExpectedEventWithParameters(): void
+    public function testComponentEmitsExpectedEventWithExpectedEventData(): void
     {
         $testComponent = $this->createLiveComponent('component_with_emit');
 
@@ -236,20 +236,44 @@ public function testComponentDoesNotEmitUnexpectedEvent(): void
 
         $testComponent->call('actionThatEmits');
 
-        $this->assertComponentNotEmitEvent($testComponent, 'non_emitted_event');
+        $this->assertComponentNotEmitEvent($testComponent, 'event2');
     }
 
-    public function testComponentEmitsEventWithWrongParametersFails(): void
+    public function testComponentDoesNotEmitUnexpectedEventFails(): void
     {
         $testComponent = $this->createLiveComponent('component_with_emit');
 
         $testComponent->call('actionThatEmits');
 
         $this->expectException(AssertionFailedError::class);
-        $this->expectExceptionMessage('EventData (foo2) is not valid');
+        $this->expectExceptionMessage('The component "component_with_emit" did not emit event "event1".');
+        $this->assertComponentNotEmitEvent($testComponent, 'event1');
+    }
+
+    public function testComponentEmitsEventWithNotFoundExpectedDataFails(): void
+    {
+        $testComponent = $this->createLiveComponent('component_with_emit');
+
+        $testComponent->call('actionThatEmits');
+
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('The expected event "event1" data "foo2" does not exists');
         $this->assertComponentEmitEvent($testComponent, 'event1', [
             'foo' => 'bar',
             'foo2' => 'bar2',
         ]);
     }
+
+    public function testComponentEmitsEventWithNotValidExpectedDataFails(): void
+    {
+        $testComponent = $this->createLiveComponent('component_with_emit');
+
+        $testComponent->call('actionThatEmits');
+
+        $this->expectException(AssertionFailedError::class);
+        $this->expectExceptionMessage('The expected event "event1" data "foo" expected "bar2" but "bar" given');
+        $this->assertComponentEmitEvent($testComponent, 'event1', [
+            'foo' => 'bar2',
+        ]);
+    }
 }