Add event dispatch assertions, event listener call assertions (deprecate existing ones)

Author: xEdelweiss

src/Codeception/Module/Symfony/EventsAssertionsTrait.php

@@ -43,7 +43,7 @@ public function dontSeeOrphanEvent(array|object|string $expected = null): void
  }
 
  /**
- * Verifies that one or more event listeners were not called during the test.
+ * Verifies that one or more events were not dispatched during the test.
  *
  * ```php
  * <?php
@@ -55,7 +55,7 @@ public function dontSeeOrphanEvent(array|object|string $expected = null): void
  * @param object|string|string[] $expected
  * @deprecated Use `dontSeeEventListenerIsCalled()` instead.
  */
- public function dontSeeEventTriggered(array|object|string $expected): void
+ public function dontSeeEvent(array|object|string $expected): void
  {
  trigger_error('dontSeeEventTriggered is deprecated, please use dontSeeEventListenerIsCalled instead', E_USER_DEPRECATED);
  $this->dontSeeEventListenerIsCalled($expected);
@@ -83,6 +83,47 @@ public function dontSeeEventListenerIsCalled(array|object|string $expected): voi
  $this->assertEventNotTriggered($data, $expected);
  }
 
+ /**
+ * Verifies that one or more event listeners were not called during the test.
+ *
+ * ```php
+ * <?php
+ * $I->dontSeeEventTriggered('App\MyEventSubscriber');
+ * $I->dontSeeEventTriggered(new App\Events\MyEventSubscriber());
+ * $I->dontSeeEventTriggered(['App\MyEventSubscriber', 'App\MyOtherEventSubscriber']);
+ * ```
+ *
+ * @param object|string|string[] $expected
+ * @deprecated Use `dontSeeEventListenerCalled` instead.
+ */
+ public function dontSeeEventTriggered(array|object|string $expected): void
+ {
+ $this->dontSeeEventListenerCalled($expected);
+ }
+
+ /**
+ * Verifies that one or more event listeners were not called during the test.
+ *
+ * ```php
+ * <?php
+ * $I->dontSeeEventListenerCalled('App\MyEventSubscriber');
+ * $I->dontSeeEventListenerCalled(new App\Events\MyEventSubscriber());
+ * $I->dontSeeEventListenerCalled(['App\MyEventSubscriber', 'App\MyOtherEventSubscriber']);
+ * ```
+ *
+ * @param object|string|string[] $expected
+ */
+ public function dontSeeEventListenerCalled(array|object|string $expected): void
+ {
+ $eventCollector = $this->grabEventCollector(__FUNCTION__);
+
+ /** @var Data $data */
+ $data = $eventCollector->getCalledListeners();
+ $expected = is_array($expected) ? $expected : [$expected];
+
+ $this->assertListenerNotCalled($data, $expected);
+ }
+
  /**
  * Verifies that one or more orphan events were dispatched during the test.
  *
@@ -110,19 +151,19 @@ public function seeOrphanEvent(array|object|string $expected): void
  }
 
  /**
- * Verifies that one or more event listeners were called during the test.
+ * Verifies that one or more events were dispatched during the test.
  *
  * ```php
  * <?php
- * $I->seeEventTriggered('App\MyEvent');
- * $I->seeEventTriggered(new App\Events\MyEvent());
- * $I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
+ * $I->seeEvent('App\MyEvent');
+ * $I->seeEvent(new App\Events\MyEvent());
+ * $I->seeEvent(['App\MyEvent', 'App\MyOtherEvent']);
  * ```
  *
  * @param object|string|string[] $expected
  * @deprecated Use `seeEventListenerIsCalled()` instead.
  */
- public function seeEventTriggered(array|object|string $expected): void
+ public function seeEvent(array|object|string $expected): void
  {
  trigger_error('seeEventTriggered is deprecated, please use seeEventListenerIsCalled instead', E_USER_DEPRECATED);
  $this->seeEventListenerIsCalled($expected);
@@ -150,6 +191,47 @@ public function seeEventListenerIsCalled(array|object|string $expected): void
  $this->assertEventTriggered($data, $expected);
  }
 
+ /**
+ * Verifies that one or more event listeners were called during the test.
+ *
+ * ```php
+ * <?php
+ * $I->seeEventTriggered('App\MyEventSubscriber');
+ * $I->seeEventTriggered(new App\Events\MyEventSubscriber());
+ * $I->seeEventTriggered(['App\MyEventSubscriber', 'App\MyOtherEventSubscriber']);
+ * ```
+ *
+ * @param object|string|string[] $expected
+ * @deprecated Use `seeEventListenerCalled` instead.
+ */
+ public function seeEventTriggered(array|object|string $expected): void
+ {
+ $this->seeEventListenerCalled($expected);
+ }
+
+ /**
+ * Verifies that one or more event listeners were called during the test.
+ *
+ * ```php
+ * <?php
+ * $I->seeEventListenerCalled('App\MyEventSubscriber');
+ * $I->seeEventListenerCalled(new App\Events\MyEventSubscriber());
+ * $I->seeEventListenerCalled(['App\MyEventSubscriber', 'App\MyOtherEventSubscriber']);
+ * ```
+ *
+ * @param object|string|string[] $expected
+ */
+ public function seeEventListenerCalled(array|object|string $expected): void
+ {
+ $eventCollector = $this->grabEventCollector(__FUNCTION__);
+
+ /** @var Data $data */
+ $data = $eventCollector->getCalledListeners();
+ $expected = is_array($expected) ? $expected : [$expected];
+
+ $this->assertListenerCalled($data, $expected);
+ }
+
  protected function assertEventNotTriggered(Data $data, array $expected): void
  {
  $actual = $data->getValue(true);
@@ -163,6 +245,19 @@ protected function assertEventNotTriggered(Data $data, array $expected): void
  }
  }
 
+ protected function assertListenerNotCalled(Data $data, array $expected): void
+ {
+ $actual = $data->getValue(true);
+
+ foreach ($expected as $expectedListener) {
+ $expectedListener = is_object($expectedListener) ? $expectedListener::class : $expectedListener;
+ $this->assertFalse(
+ $this->listenerWasCalled($actual, (string)$expectedListener),
+ "The '{$expectedListener}' listener was called"
+ );
+ }
+ }
+
  protected function assertEventTriggered(Data $data, array $expected): void
  {
  if ($data->count() === 0) {
@@ -180,22 +275,49 @@ protected function assertEventTriggered(Data $data, array $expected): void
  }
  }
 
- protected function eventWasTriggered(array $actual, string $expectedEvent): bool
+ protected function assertListenerCalled(Data $data, array $expected): void
  {
- $triggered = false;
+ if ($data->count() === 0) {
+ $this->fail('No listener was called');
+ }
 
+ $actual = $data->getValue(true);
+
+ foreach ($expected as $expectedListener) {
+ $expectedListener = is_object($expectedListener) ? $expectedListener::class : $expectedListener;
+ $this->assertTrue(
+ $this->listenerWasCalled($actual, (string) $expectedListener),
+ "The '{$expectedListener}' listener was not called"
+ );
+ }
+ }
+
+ protected function eventWasTriggered(array $actual, string $expectedEvent): bool
+ {
  foreach ($actual as $actualEvent) {
  if (is_array($actualEvent)) { // Called Listeners
- if (str_starts_with($actualEvent['pretty'], $expectedEvent)) {
- $triggered = true;
+ if ($actualEvent['event'] === $expectedEvent) {
+ return true;
  }
  } else { // Orphan Events
  if ($actualEvent === $expectedEvent) {
- $triggered = true;
+ return true;
  }
  }
  }
- return $triggered;
+
+ return false;
+ }
+
+ protected function listenerWasCalled(array $actual, string $expectedListener): bool
+ {
+ foreach ($actual as $actualEvent) {
+ if (str_starts_with($actualEvent['pretty'], $expectedListener)) {
+ return true;
+ }
+ }
+
+ return false;
  }
 
  protected function grabEventCollector(string $function): EventDataCollector