add notifier assertions trait

Author: d-mitrofanov-v

src/Codeception/Module/Symfony.php

@@ -21,6 +21,7 @@
 use Codeception\Module\Symfony\LoggerAssertionsTrait;
 use Codeception\Module\Symfony\MailerAssertionsTrait;
 use Codeception\Module\Symfony\MimeAssertionsTrait;
+use Codeception\Module\Symfony\NotifierAssertionsTrait;
 use Codeception\Module\Symfony\ParameterAssertionsTrait;
 use Codeception\Module\Symfony\RouterAssertionsTrait;
 use Codeception\Module\Symfony\SecurityAssertionsTrait;
@@ -52,6 +53,7 @@
 use Symfony\Component\HttpKernel\Profiler\Profile;
 use Symfony\Component\HttpKernel\Profiler\Profiler;
 use Symfony\Component\Mailer\DataCollector\MessageDataCollector;
+use Symfony\Component\Notifier\DataCollector\NotificationDataCollector;
 use Symfony\Component\Translation\DataCollector\TranslationDataCollector;
 use Symfony\Component\VarDumper\Cloner\Data;
 
@@ -156,6 +158,7 @@ class Symfony extends Framework implements DoctrineProvider, PartedModule
     use LoggerAssertionsTrait;
     use MailerAssertionsTrait;
     use MimeAssertionsTrait;
+    use NotifierAssertionsTrait;
     use ParameterAssertionsTrait;
     use RouterAssertionsTrait;
     use SecurityAssertionsTrait;
@@ -412,6 +415,7 @@ protected function getProfile(): ?Profile
      *     ($collector is DataCollectorName::TWIG ? TwigDataCollector :
      *     ($collector is DataCollectorName::SECURITY ? SecurityDataCollector :
      *     ($collector is DataCollectorName::MAILER ? MessageDataCollector :
+     *     ($collector is DataCollectorName::NOTIFIER ? NotificationDataCollector :
      *      DataCollectorInterface
      *     ))))))))
      * )
@@ -465,6 +469,13 @@ protected function debugResponse(mixed $url): void
             }
         }
 
+        if ($profile->hasCollector(DataCollectorName::NOTIFIER->value)) {
+            $notifierCollector = $profile->getCollector(DataCollectorName::NOTIFIER->value);
+            if ($notifierCollector instanceof NotificationDataCollector) {
+                $this->debugNotifierData($notifierCollector);
+            }
+        }
+
         if ($profile->hasCollector(DataCollectorName::TIME->value)) {
             $timeCollector = $profile->getCollector(DataCollectorName::TIME->value);
             if ($timeCollector instanceof TimeDataCollector) {
@@ -543,6 +554,12 @@ private function debugMailerData(MessageDataCollector $messageCollector): void
         $this->debugSection('Emails', sprintf('%d sent', $count));
     }
 
+    private function debugNotifierData(NotificationDataCollector $notificationCollector): void
+    {
+        $count = count($notificationCollector->getEvents()->getMessages());
+        $this->debugSection('Notifications', sprintf('%d sent', $count));
+    }
+
     private function debugTimeData(TimeDataCollector $timeCollector): void
     {
         $this->debugSection('Time', sprintf('%.2f ms', $timeCollector->getDuration()));

src/Codeception/Module/Symfony/DataCollectorName.php

@@ -18,4 +18,5 @@ enum DataCollectorName: string
     case TWIG = 'twig';
     case SECURITY = 'security';
     case MAILER = 'mailer';
+    case NOTIFIER = 'notifier';
 }

src/Codeception/Module/Symfony/NotifierAssertionsTrait.php

@@ -0,0 +1,253 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codeception\Module\Symfony;
+
+use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\Constraint\LogicalNot;
+use Symfony\Component\Notifier\Event\MessageEvent;
+use Symfony\Component\Notifier\Event\NotificationEvents;
+use Symfony\Component\Notifier\EventListener\NotificationLoggerListener;
+use Symfony\Component\Notifier\Message\MessageInterface;
+use Symfony\Component\Notifier\Test\Constraint as NotifierConstraint;
+
+trait NotifierAssertionsTrait
+{
+    /**
+     * Asserts that the expected number of notifications was sent.
+     *
+     * ```php
+     * <?php
+     * $I->assertNotificationCount(2, 'smtp');
+     * ```
+     */
+    public function assertNotificationCount(int $count, ?string $transportName = null, string $message = ''): void
+    {
+        $this->assertThat($this->getNotificationEvents(), new NotifierConstraint\NotificationCount($count, $transportName), $message);
+    }
+
+    /**
+     * Asserts that the given notifier event is not queued.
+     * Use `getNotifierEvent(int $index = 0, ?string $transportName = null)` to retrieve a notifier event by index.
+     *
+     * ```php
+     * <?php
+     * $event = $I->getNotifierEvent();
+     * $I->asserNotificationIsNotQueued($event);
+     * ```
+     */
+    public function assertNotificationIsNotQueued(MessageEvent $event, string $message = ''): void
+    {
+        $this->assertThat($event, new LogicalNot(new NotifierConstraint\NotificationIsQueued()), $message);
+    }
+
+    /**
+     * Asserts that the given notifier event is queued.
+     * Use `getNotifierEvent(int $index = 0, ?string $transportName = null)` to retrieve a notifier event by index.
+     *
+     * ```php
+     * <?php
+     * $event = $I->getNotifierEvent();
+     * $I->assertNotificationlIsQueued($event);
+     * ```
+     */
+    public function assertNotificationIsQueued(MessageEvent $event, string $message = ''): void
+    {
+        $this->assertThat($event, new NotifierConstraint\NotificationIsQueued(), $message);
+    }
+
+    /**
+     * Asserts that the given notification contains given subject.
+     * Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index.
+     *
+     * ```php
+     * <?php
+     * $notification = $I->getNotifierMessage();
+     * $I->assertNotificationSubjectContains($notification, 'Subject');
+     * ```
+     */
+    public function assertNotificationSubjectContains(MessageInterface $notification, string $text, string $message = ''): void
+    {
+        $bbep = $this->assertThat($notification, new NotifierConstraint\NotificationSubjectContains($text), $message);
+        $test = $notification;
+    }
+
+    /**
+     * Asserts that the given notification does not contain given subject.
+     * Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index.
+     *
+     * ```php
+     * <?php
+     * $notification = $I->getNotifierMessage();
+     * $I->assertNotificationSubjectNotContains($notification, 'Subject');
+     * ```
+     */
+    public function assertNotificationSubjectNotContains(MessageInterface $notification, string $text, string $message = ''): void
+    {
+        $this->assertThat($notification, new LogicalNot(new NotifierConstraint\NotificationSubjectContains($text)), $message);
+    }
+
+    /**
+     * Asserts that the given notification uses given transport.
+     * Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index.
+     *
+     * ```php
+     * <?php
+     * $notification = $I->getNotifierMessage();
+     * $I->assertNotificationTransportIsEqual($notification, 'chat');
+     * ```
+     */
+    public function assertNotificationTransportIsEqual(MessageInterface $notification, ?string $transportName = null, string $message = ''): void
+    {
+        $this->assertThat($notification, new NotifierConstraint\NotificationTransportIsEqual($transportName), $message);
+    }
+
+    /**
+     * Asserts that the given notification does not use given transport.
+     * Use `getNotifierMessage(int $index = 0, ?string $transportName = null)` to retrieve a notification by index.
+     *
+     * ```php
+     * <?php
+     * $notification = $I->getNotifierMessage();
+     * $I->assertNotificationTransportIsNotEqual($notification, 'transport');
+     * ```
+     */
+    public function assertNotificationTransportIsNotEqual(MessageInterface $notification, ?string $transportName = null, string $message = ''): void
+    {
+        $this->assertThat($notification, new LogicalNot(new NotifierConstraint\NotificationTransportIsEqual($transportName)), $message);
+    }
+
+    /**
+     * Asserts that the expected number of notifications was queued (e.g. using the Notifier component).
+     *
+     * ```php
+     * <?php
+     * $I->assertQueuedNotificationCount(1, 'smtp');
+     * ```
+     */
+    public function assertQueuedNotificationCount(int $count, ?string $transportName = null, string $message = ''): void
+    {
+        $this->assertThat($this->getNotificationEvents(), new NotifierConstraint\NotificationCount($count, $transportName, true), $message);
+    }
+
+    /**
+     * Checks that no notification was sent.
+     * The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means:
+     * If your app performs an HTTP redirect, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first; otherwise this check will *always* pass.
+     *
+     * ```php
+     * <?php
+     * $I->dontSeeNotificationIsSent();
+     * ```
+     */
+    public function dontSeeNotificationIsSent(): void
+    {
+        $this->assertThat($this->getNotificationEvents(), new NotifierConstraint\NotificationCount(0));
+    }
+
+    /**
+     * Returns the last sent notification.
+     * The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means:
+     * If your app performs an HTTP redirect after sending the notification, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first.
+     * See also: [grabSentNotifications()](https://codeception.com/docs/modules/Symfony#grabSentNotifications)
+     *
+     * ```php
+     * <?php
+     * $message = $I->grabLastSentNotification();
+     * $I->assertSame('Subject', $message->getSubject());
+     * ```
+     */
+    public function grabLastSentNotification(): ?MessageInterface
+    {
+        $notification = $this->getNotifierMessages();
+        $lastNotification = end($notification);
+
+        return $lastNotification ?: null;
+    }
+
+
+    /**
+     * Returns an array of all sent notifications.
+     * The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means:
+     * If your app performs an HTTP redirect after sending the notification, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first.
+     * See also: [grabLastSentNotification()](https://codeception.com/docs/modules/Symfony#grabLastSentNotification)
+     *
+     * ```php
+     * <?php
+     * $notifications = $I->grabSentNotifications();
+     * ```
+     *
+     * @return MessageEvent[]
+     */
+    public function grabSentNotifications(): array
+    {
+        return $this->getNotifierMessages();
+    }
+
+    /**
+     * Checks if the given number of notifications was sent (default `$expectedCount`: 1).
+     * The check is based on `\Symfony\Component\Notifier\EventListener\NotificationLoggerListener`, which means:
+     * If your app performs an HTTP redirect after sending the notification, you need to suppress it using [stopFollowingRedirects()](#stopFollowingRedirects) first.
+     *
+     * ```php
+     * <?php
+     * $I->seeNotificatoinIsSent(2);
+     * ```
+     *
+     * @param int $expectedCount The expected number of notifications sent
+     */
+    public function seeNotificationIsSent(int $expectedCount = 1): void
+    {
+        $this->assertThat($this->getNotificationEvents(), new NotifierConstraint\NotificationCount($expectedCount));
+    }
+
+    public function getNotifierEvents(?string $transportName = null): array
+    {
+        return $this->getNotificationEvents()->getEvents($transportName);
+    }
+
+    /**
+     * Returns the notifier event at the specified index.
+     *
+     * ```php
+     * <?php
+     * $event = $I->getNotifierEvent();
+     * ```
+     */
+    public function getNotifierEvent(int $index = 0, ?string $transportName = null): ?MessageEvent
+    {
+        return $this->getNotifierEvents($transportName)[$index] ?? null;
+    }
+
+    public function getNotifierMessages(?string $transportName = null): array
+    {
+        return $this->getNotificationEvents()->getMessages($transportName);
+    }
+
+    /**
+     * Returns the notifier message at the specified index.
+     *
+     * ```php
+     * <?php
+     * $message = $I->getNotifierMessage();
+     * ```
+     */
+    public function getNotifierMessage(int $index = 0, ?string $transportName = null): ?MessageInterface
+    {
+        return $this->getNotifierMessages($transportName)[$index] ?? null;
+    }
+
+    protected function getNotificationEvents(): NotificationEvents
+    {
+        $notifier = $this->getService('notifier.notification_logger_listener');
+        if ($notifier instanceof NotificationLoggerListener) {
+            return $notifier->getEvents();
+        }
+        $notifier = $this->getService('notifier.logger_notification_listener');
+        if ($notifier instanceof NotificationLoggerListener) {
+            return $notifier->getEvents();
+        }
+        Assert::fail("Notifications can't be tested without Symfony Notifier service.");
+    }
+}