Skip to content

Refactor event assertions #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 30, 2021
Merged

Refactor event assertions #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 37 additions & 23 deletions src/Codeception/Module/Symfony/EventsAssertionsTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
trait EventsAssertionsTrait
{
/**
* Make sure events did not fire during the test.
* Verifies that one or more event listeners were not called during the test.
*
* ```php
* <?php
Expand All @@ -30,26 +30,14 @@ public function dontSeeEventTriggered($expected): void
$eventCollector = $this->grabEventCollector(__FUNCTION__);

/** @var Data $data */
$data = $eventCollector->getNotCalledListeners();

$actual = $data->getValue(true);
$data = $eventCollector->getCalledListeners();
$expected = is_array($expected) ? $expected : [$expected];

foreach ($expected as $expectedEvent) {
$notTriggered = false;
$expectedEvent = is_object($expectedEvent) ? get_class($expectedEvent) : $expectedEvent;

foreach ($actual as $actualEvent) {
if (strpos($actualEvent['pretty'], (string) $expectedEvent) === 0) {
$notTriggered = true;
}
}
$this->assertTrue($notTriggered, "The '{$expectedEvent}' event triggered");
}
$this->assertEventNotTriggered($data, $expected);
}

/**
* Make sure events fired during the test.
* Verifies that one or more event listeners were called during the test.
*
* ```php
* <?php
Expand All @@ -66,25 +54,51 @@ public function seeEventTriggered($expected): void

/** @var Data $data */
$data = $eventCollector->getCalledListeners();
$expected = is_array($expected) ? $expected : [$expected];

$this->assertEventTriggered($data, $expected);
}

protected function assertEventNotTriggered(Data $data, array $expected): void
{
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;
$this->assertFalse(
$this->eventWasTriggered($actual, (string) $expectedEvent),
"The '{$expectedEvent}' event triggered"
);
}
}

protected function assertEventTriggered(Data $data, array $expected): void
{
$actual = $data->getValue(true);

foreach ($expected as $expectedEvent) {
$expectedEvent = is_object($expectedEvent) ? get_class($expectedEvent) : $expectedEvent;
$this->assertTrue(
$this->eventWasTriggered($actual, (string) $expectedEvent),
"The '{$expectedEvent}' event did not trigger"
);
}
}

protected function eventWasTriggered(array $actual, string $expectedEvent): bool
{
$triggered = false;

foreach ($actual as $actualEvent) {
if (strpos($actualEvent['pretty'], (string) $expectedEvent) === 0) {
$triggered = true;
}
foreach ($actual as $actualEvent) {
if (strpos($actualEvent['pretty'], $expectedEvent) === 0) {
$triggered = true;
}
$this->assertTrue($triggered, "The '{$expectedEvent}' event did not trigger");
}
return $triggered;
}

protected function grabEventCollector(string $function): EventDataCollector
Expand Down