Added seeEventTriggered function (Codeception#68)

TavoNiievez · web-flow · commit 33aa68c951d5 · 2020-12-11T10:33:26.000-05:00
diff --git a/src/Codeception/Module/Symfony.php b/src/Codeception/Module/Symfony.php
@@ -1133,6 +1133,43 @@ public function grabParameter(string $name)
         return $parameterBag->get($name);
     }
 
+    /**
+     * Make sure events fired during the test.
+     *
+     * ``` php
+     * <?php
+     * $I->seeEventTriggered('App\MyEvent');
+     * $I->seeEventTriggered(new App\Events\MyEvent());
+     * $I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
+     * ```
+     * @param string|object|string[] $expected
+     */
+    public function seeEventTriggered($expected)
+    {
+        $eventCollector = $this->grabCollector('events', __FUNCTION__);
+
+        $data = $eventCollector->getCalledListeners();
+
+        if ($data->count() === 0) {
+            $this->fail('No event was triggered');
+        }
+
+        $actual = $data->getValue(true);
+        $expected = is_array($expected) ? $expected : [$expected];
+
+        foreach ($expected as $expectedEvent) {
+            $triggered = false;
+            $expectedEvent = is_object($expectedEvent) ? get_class($expectedEvent) : $expectedEvent;
+
+            foreach ($actual as $actualEvent) {
+                if (strpos($actualEvent['pretty'], $expectedEvent) === 0) {
+                    $triggered = true;
+                }
+            }
+            $this->assertTrue($triggered, "The '$expectedEvent' event did not trigger");
+        }
+    }
+
     /**
      * Checks that current page matches action
      *
