From 6d62d4fec443c2a3c393894c5e70a700f8c9d9c8 Mon Sep 17 00:00:00 2001
From: Tavo Nieves J <ganieves@outlook.com>
Date: Fri, 29 Jan 2021 10:04:10 -0500
Subject: [PATCH] Added orphan events assertions

---
 .../Module/Symfony/EventsAssertionsTrait.php  | 54 +++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/src/Codeception/Module/Symfony/EventsAssertionsTrait.php b/src/Codeception/Module/Symfony/EventsAssertionsTrait.php
index dcb4a2b1..ce8dfff3 100644
--- a/src/Codeception/Module/Symfony/EventsAssertionsTrait.php
+++ b/src/Codeception/Module/Symfony/EventsAssertionsTrait.php
@@ -13,6 +13,33 @@
 
 trait EventsAssertionsTrait
 {
+    /**
+     * Verifies that one or more orphan events were not dispatched during the test.
+     *
+     * An orphan event is an event that is triggered by manually executing the
+     * [`dispatch()`](https://symfony.com/doc/current/components/event_dispatcher.html#dispatch-the-event) method
+     * of the EventDispatcher, in other words, it is an event that is not handled by any listener.
+     *
+     * ```php
+     * <?php
+     * $I->dontSeeOrphanEventTriggered('App\MyEvent');
+     * $I->dontSeeOrphanEventTriggered(new App\Events\MyEvent());
+     * $I->dontSeeOrphanEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
+     * ```
+     *
+     * @param string|object|string[] $expected
+     */
+    public function dontSeeOrphanEventTriggered($expected): void
+    {
+        $eventCollector = $this->grabEventCollector(__FUNCTION__);
+
+        /** @var Data $data */
+        $data = $eventCollector->getOrphanedEvents();
+        $expected = is_array($expected) ? $expected : [$expected];
+
+        $this->assertEventNotTriggered($data, $expected);
+    }
+
     /**
      * Verifies that one or more event listeners were not called during the test.
      *
@@ -36,6 +63,33 @@ public function dontSeeEventTriggered($expected): void
         $this->assertEventNotTriggered($data, $expected);
     }
 
+    /**
+     * Verifies that one or more orphan events were dispatched during the test.
+     *
+     * An orphan event is an event that is triggered by manually executing the
+     * [`dispatch()`](https://symfony.com/doc/current/components/event_dispatcher.html#dispatch-the-event) method
+     * of the EventDispatcher, in other words, it is an event that is not handled by any listener.
+     *
+     * ```php
+     * <?php
+     * $I->seeOrphanEventTriggered('App\MyEvent');
+     * $I->seeOrphanEventTriggered(new App\Events\MyEvent());
+     * $I->seeOrphanEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
+     * ```
+     *
+     * @param string|object|string[] $expected
+     */
+    public function seeOrphanEventTriggered($expected): void
+    {
+        $eventCollector = $this->grabEventCollector(__FUNCTION__);
+
+        /** @var Data $data */
+        $data = $eventCollector->getOrphanedEvents();
+        $expected = is_array($expected) ? $expected : [$expected];
+
+        $this->assertEventTriggered($data, $expected);
+    }
+
     /**
      * Verifies that one or more event listeners were called during the test.
      *