feat(Testing): AssertEventListeners: Prevent other listeners to be fired

wrk-flow · Jun 23, 2023 · b35f53d · b35f53d
1 parent 3ed5fdb
commit b35f53d
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/src/Testing/Concerns/AssertEventListeners.php b/src/Testing/Concerns/AssertEventListeners.php
@@ -33,18 +33,35 @@ public function assertEventListeners(
 
         $asserts = [];
 
+        /**
+         * The goal is to prevent other listeners from being called, so we will remove all listeners for the event and
+         * validate if the desired listeners were registered. Then we will re-register the listener we want and call the
+         * event again to validate the results.
+         *
+         * @var Dispatcher $events
+         */
+        $events = $app->make(Dispatcher::class);
+        $currentListenersMap = array_flip($events->getRawListeners()[$event::class] ?? []);
+        $events->forget($event::class);
+
         foreach ($contractMap as $contract => $assert) {
             if ($shouldBuildResults) {
                 $expectedListenerResults[] = null;
             }
 
+            // Listener must be registered for the event, if not we will fail
+            Assert::assertArrayHasKey(
+                $contract,
+                $currentListenersMap,
+                sprintf('Listener not %s registered for event: %s', $contract, $event::class)
+            );
+
             $asserts[] = $assert;
 
             $app->bind(abstract: $contract, concrete: static fn () => $assert);
-        }
 
-        /** @var Dispatcher $events */
-        $events = $app->make(Dispatcher::class);
+            $events->listen($event::class, $contract);
+        }
 
         if ($disableWildcard) {
             $events->forget('*');

diff --git a/tests/Feature/Testing/Concerns/AssertEventListenersTest.php b/tests/Feature/Testing/Concerns/AssertEventListenersTest.php
@@ -24,6 +24,8 @@ public function testAssertEventListeners(): void
         $events = $app->get(Dispatcher::class);
         $events->listen(TestEvent::class, TestListenerContract::class);
         $events->listen(TestEvent::class, TestListenerCallsContract::class);
+        // Should not be called - it will be un-registered.
+        $events->listen(TestEvent::class, TestListenerCallsContractAssert::class);
 
         $event = new TestEvent();
         $this->assertEventListeners(