feature #46895 [Notifier] Introduce PHPUnit constraints and assertions for the Notifier (ismail1432)

This PR was merged into the 6.2 branch.

Discussion
----------

[Notifier] Introduce PHPUnit constraints and assertions for the Notifier

| Q             | A
| ------------- | ---
| Branch?       | 6.2
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tickets       | Fix #... <!-- prefix each issue number with "Fix #", no need to create an issue if none exist, explain below instead -->
| License       | MIT
| Doc PR        | symfony/symfony-docs#... <!-- required for new features -->

[Since 4.4 we have assertions for email ](https://symfony.com/blog/new-in-symfony-4-4-phpunit-assertions-for-email-messages), the goal of this PR is to introduce the same kind of assertions for the Notifier component.

```php

   public function testNotifier()
      {
         /** @var NotifierInterface $notifier */
         $firstNotification = new Notification('Hello World!', ['chat/slack']);
        $firstNotification->content("Symfony is awesome!");

        $notifier->send($firstNotification);

        $secondNotification = (new Notification('New urgent notification'))
            ->importance(Notification::IMPORTANCE_URGENT)
        ;
        $notifier->send($secondNotification);

                $this->assertNotificationCount(2);
        $first = 0;
        $second = 1;
        $this->assertNotificationIsNotQueued($this->getNotifierEvent($first));
        $this->assertNotificationIsNotQueued($this->getNotifierEvent($second));

        $notification = $this->getNotifierMessage($first);
        $this->assertNotificationSubjectContains($notification, 'Hello World!');
        $this->assertNotificationSubjectNotContains($notification, 'New urgent notification');
        $this->assertNotificationTransportIsEqual($notification,'slack');
        $this->assertNotificationTransportIsNotEqual($notification,'mercure');

        $notification = $this->getNotifierMessage($second);
        $this->assertNotificationSubjectContains($notification, 'New urgent notification');
        $this->assertNotificationSubjectNotContains($notification, 'Hello World!');
        $this->assertNotificationTransportIsEqual($notification,'mercure');
        $this->assertNotificationTransportIsNotEqual($notification,'slack');

  }

Commits
-------

747e9cb631 add NotifierAssertionTrait

Author: fabpot

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.2
+---
+
+ * Add PHPUnit constraints
+
 6.1
 ---
 

Test/Constraint/NotificationCount.php

@@ -0,0 +1,76 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Notifier\Test\Constraint;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\Notifier\Event\NotificationEvents;
+
+/**
+ * @author Smaïne Milianni <[email protected]>
+ */
+final class NotificationCount extends Constraint
+{
+    private $expectedValue;
+    private $transport;
+    private $queued;
+
+    public function __construct(int $expectedValue, string $transport = null, bool $queued = false)
+    {
+        $this->expectedValue = $expectedValue;
+        $this->transport = $transport;
+        $this->queued = $queued;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function toString(): string
+    {
+        return sprintf('%shas %s "%d" emails', $this->transport ? $this->transport.' ' : '', $this->queued ? 'queued' : 'sent', $this->expectedValue);
+    }
+
+    /**
+     * @param NotificationEvents $events
+     *
+     * {@inheritdoc}
+     */
+    protected function matches($events): bool
+    {
+        return $this->expectedValue === $this->countNotifications($events);
+    }
+
+    /**
+     * @param NotificationEvents $events
+     *
+     * {@inheritdoc}
+     */
+    protected function failureDescription($events): string
+    {
+        return sprintf('the Transport %s (%d %s)', $this->toString(), $this->countNotifications($events), $this->queued ? 'queued' : 'sent');
+    }
+
+    private function countNotifications(NotificationEvents $events): int
+    {
+        $count = 0;
+        foreach ($events->getEvents($this->transport) as $event) {
+            if (
+                ($this->queued && $event->isQueued())
+                ||
+                (!$this->queued && !$event->isQueued())
+            ) {
+                ++$count;
+            }
+        }
+
+        return $count;
+    }
+}

Test/Constraint/NotificationIsQueued.php

@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Notifier\Test\Constraint;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\Notifier\Event\MessageEvent;
+
+/**
+ * @author Smaïne Milianni <[email protected]>
+ */
+final class NotificationIsQueued extends Constraint
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function toString(): string
+    {
+        return 'is queued';
+    }
+
+    /**
+     * @param MessageEvent $event
+     *
+     * {@inheritdoc}
+     */
+    protected function matches($event): bool
+    {
+        return $event->isQueued();
+    }
+
+    /**
+     * @param MessageEvent $event
+     *
+     * {@inheritdoc}
+     */
+    protected function failureDescription($event): string
+    {
+        return 'the Notification '.$this->toString();
+    }
+}

Test/Constraint/NotificationSubjectContains.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Notifier\Test\Constraint;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\Notifier\Message\MessageInterface;
+
+/**
+ * @author Smaïne Milianni <[email protected]>
+ */
+final class NotificationSubjectContains extends Constraint
+{
+    private $expectedText;
+
+    public function __construct(string $expectedText)
+    {
+        $this->expectedText = $expectedText;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function toString(): string
+    {
+        return sprintf('contains "%s"', $this->expectedText);
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param MessageInterface $message
+     */
+    protected function matches($message): bool
+    {
+        return false !== mb_strpos($message->getSubject(), $this->expectedText);
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param MessageInterface $message
+     */
+    protected function failureDescription($message): string
+    {
+        return 'the Notification subject '.$this->toString();
+    }
+}

Test/Constraint/NotificationTransportIsEqual.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Notifier\Test\Constraint;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\Notifier\Message\MessageInterface;
+
+/**
+ * @author Smaïne Milianni <[email protected]>
+ */
+final class NotificationTransportIsEqual extends Constraint
+{
+    private $expectedText;
+
+    public function __construct(string $expectedText)
+    {
+        $this->expectedText = $expectedText;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function toString(): string
+    {
+        return sprintf('is "%s"', $this->expectedText);
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param MessageInterface $message
+     */
+    protected function matches($message): bool
+    {
+        return $message->getTransport() === $this->expectedText;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param MessageInterface $message
+     */
+    protected function failureDescription($message): string
+    {
+        return 'the Notification transport '.$this->toString();
+    }
+}