add NotifierAssertionTrait

Author: ismail1432

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

@@ -4,6 +4,7 @@ CHANGELOG
 6.2
 ---
 
+ * Add `NotificationAssertionsTrait`
  * Add option `framework.catch_all_throwables` to allow `Symfony\Component\HttpKernel\HttpKernel` to catch all kinds of `Throwable`
  * Make `AbstractController::render()` able to deal with forms and deprecate `renderForm()`
  * Deprecate the `Symfony\Component\Serializer\Normalizer\ObjectNormalizer` and

src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php

@@ -26,6 +26,7 @@
 abstract class KernelTestCase extends TestCase
 {
     use MailerAssertionsTrait;
+    use NotificationAssertionsTrait;
 
     protected static $class;
 

src/Symfony/Bundle/FrameworkBundle/Test/NotificationAssertionsTrait.php

@@ -0,0 +1,120 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Test;
+
+use PHPUnit\Framework\Constraint\LogicalNot;
+use Symfony\Component\Notifier\Event\MessageEvent;
+use Symfony\Component\Notifier\Event\NotificationEvents;
+use Symfony\Component\Notifier\Message\MessageInterface;
+use Symfony\Component\Notifier\Test\Constraint as NotifierConstraint;
+
+/*
+ * @author Smaïne Milianni <smaine.milianni@gmail.com>
+ */
+trait NotificationAssertionsTrait
+{
+    public static function assertNotificationCount(int $count, string $transport = null, string $message = ''): void
+    {
+        self::assertThat(self::getNotificationEvents(), new NotifierConstraint\NotificationCount($count, $transport), $message);
+    }
+
+    public static function assertQueuedNotificationCount(int $count, string $transport = null, string $message = ''): void
+    {
+        self::assertThat(self::getMessageMailerEvents(), new NotifierConstraint\NotificationCount($count, $transport, true), $message);
+    }
+
+    public static function assertNotificationIsQueued(MessageEvent $event, string $message = ''): void
+    {
+        self::assertThat($event, new NotifierConstraint\NotificationIsQueued(), $message);
+    }
+
+    public static function assertNotificationIsNotQueued(MessageEvent $event, string $message = ''): void
+    {
+        self::assertThat($event, new LogicalNot(new NotifierConstraint\NotificationIsQueued()), $message);
+    }
+
+    public static function assertNotificationSubjectContains(MessageInterface $messageObject, string $text, string $message = ''): void
+    {
+        self::assertThat($messageObject, new NotifierConstraint\NotificationSubjectContains($text), $message);
+    }
+
+    public static function assertNotificationSubjectNotContains(MessageInterface $messageObject, string $text, string $message = ''): void
+    {
+        self::assertThat($messageObject, new LogicalNot(new NotifierConstraint\NotificationSubjectContains($text)), $message);
+    }
+
+    public static function assertNotificationContentContains(MessageInterface $messageObject, string $text, string $message = ''): void
+    {
+        self::assertThat($messageObject, new NotifierConstraint\NotificationContentContains($text), $message);
+    }
+
+    public static function assertNotificationContentNotContains(MessageInterface $messageObject, string $text, string $message = ''): void
+    {
+        self::assertThat($messageObject, new LogicalNot(new NotifierConstraint\NotificationContentContains($text)), $message);
+    }
+
+    public static function assertNotificationTransportIsEqual(MessageInterface $messageObject, string $text, string $message = ''): void
+    {
+        self::assertThat($messageObject, new NotifierConstraint\NotificationTransportIsEqual($text), $message);
+    }
+
+    public static function assertNotificationTransportIsNotEqual(MessageInterface $messageObject, string $text, string $message = ''): void
+    {
+        self::assertThat($messageObject, new LogicalNot(new NotifierConstraint\NotificationTransportIsEqual($text)), $message);
+    }
+
+    public static function assertNotificationImportanceIsEqual(MessageInterface $messageObject, string $text, string $message = ''): void
+    {
+        self::assertThat($messageObject, new NotifierConstraint\NotificationImportanceIsEqual($text), $message);
+    }
+
+    public static function assertNotificationImportanceIsNotEqual(MessageInterface $messageObject, string $text, string $message = ''): void
+    {
+        self::assertThat($messageObject, new LogicalNot(new NotifierConstraint\NotificationImportanceIsEqual($text)), $message);
+    }
+
+    /**
+     * @return MessageEvent[]
+     */
+    public static function getNotifierEvents(string $transport = null): array
+    {
+        return self::getNotificationEvents()->getEvents($transport);
+    }
+
+    public static function getNotifierEvent(int $index = 0, string $transport = null): ?MessageEvent
+    {
+        return self::getNotifierEvents($transport)[$index] ?? null;
+    }
+
+    /**
+     * @return MessageInterface[]
+     */
+    public static function getNotifierMessages(string $transport = null): array
+    {
+        return self::getNotificationEvents()->getMessages($transport);
+    }
+
+    public static function getNotifierMessage(int $index = 0, string $transport = null): ?MessageInterface
+    {
+        return self::getNotifierMessages($transport)[$index] ?? null;
+    }
+
+    public static function getNotificationEvents(): NotificationEvents
+    {
+        $container = static::getContainer();
+        if ($container->has('notifier.logger_notification_listener')) {
+            return $container->get('notifier.logger_notification_listener')->getEvents();
+        }
+
+        static::fail('A client must have Notifier enabled to make notifications assertions. Did you forget to require symfony/notifier?');
+    }
+}

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/NotificationController.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller;
+
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Notifier\Notification\Notification;
+use Symfony\Component\Notifier\NotifierInterface;
+
+final class NotificationController
+{
+    public function indexAction(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);
+
+        return new Response();
+    }
+}

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Resources/config/routing.yml

@@ -64,3 +64,7 @@ send_email:
 uid:
     resource: "../../Controller/UidController.php"
     type: "annotation"
+
+send_notification:
+    path:     /send_notification
+    defaults: { _controller: Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller\NotificationController::indexAction }

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/NotificationTest.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;
+
+use Symfony\Component\Notifier\Notification\Notification;
+
+final class NotificationTest extends AbstractWebTestCase
+{
+    public function testNotifierAssertion()
+    {
+        $client = $this->createClient(['test_case' => 'Notifier', 'root_config' => 'config.yml', 'debug' => true]);
+        $client->request('GET', '/send_notification');
+
+        $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');
+        $this->assertNotificationContentContains($notification,'Symfony is awesome!');
+        $this->assertNotificationContentNotContains($notification,'mercure');
+        $this->assertNotificationImportanceIsEqual($notification,Notification::IMPORTANCE_HIGH);
+        $this->assertNotificationImportanceIsNotEqual($notification,Notification::IMPORTANCE_URGENT);
+
+        $notification = $this->getNotifierMessage($second);
+        $this->assertNotificationSubjectContains($notification, 'New urgent notification');
+        $this->assertNotificationSubjectNotContains($notification, 'Hello World!');
+        $this->assertNotificationTransportIsEqual($notification,'mercure');
+        $this->assertNotificationTransportIsNotEqual($notification,'slack');
+        $this->assertNotificationContentNotContains($notification,'mercure');
+        $this->assertNotificationImportanceIsEqual($notification,Notification::IMPORTANCE_URGENT);
+    }
+}

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Notifier/bundles.php

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+use Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\TestBundle;
+use Symfony\Bundle\MercureBundle\MercureBundle;
+
+return [
+    new FrameworkBundle(),
+    new TestBundle(),
+    new MercureBundle(),
+];

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Notifier/config.yml

@@ -0,0 +1,25 @@
+imports:
+    - { resource: ../config/default.yml }
+    - { resource: services.yml }
+
+framework:
+    mailer:
+        dsn: 'null://null'
+    notifier:
+        chatter_transports:
+            slack: 'null://null'
+            mercure: 'null://null'
+        channel_policy:
+            urgent: ['chat/mercure']
+        admin_recipients:
+            - { email: admin@example.com }
+    profiler: ~
+
+mercure:
+    hubs:
+        default:
+            url: 'null://null'
+            jwt:
+                secret: '!ChangeMe!'
+                publish: [ 'foo', 'https://example.com/foo' ]
+                subscribe: [ 'bar', 'https://example.com/bar' ]

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Notifier/routing.yml

@@ -0,0 +1,2 @@
+_notifiertest_bundle:
+    resource: '@TestBundle/Resources/config/routing.yml'

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Notifier/services.yml

@@ -0,0 +1,7 @@
+services:
+    _defaults:
+        public: true
+
+    Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller\NotificationController:
+        tags: ['controller.service_arguments']
+

src/Symfony/Component/Notifier/CHANGELOG.md

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

src/Symfony/Component/Notifier/Message/NullMessage.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Notifier\Message;
 
+use Symfony\Component\Notifier\Notification\Notification;
+
 /**
  * @author Jan Schädlich <jan.schaedlich@sensiolabs.de>
  */
@@ -42,4 +44,13 @@ public function getTransport(): ?string
     {
         return $this->decoratedMessage->getTransport() ?? 'null';
     }
+
+    public function getNotification(): ?Notification
+    {
+        if (true === method_exists($this->decoratedMessage, 'getNotification')) {
+            return $this->decoratedMessage->getNotification();
+        }
+
+        return null;
+    }
 }

src/Symfony/Component/Notifier/Test/Constraint/NotificationContentContains.php

@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * 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;
+use Symfony\Component\Notifier\Notification\Notification;
+
+/**
+ * @author Smaïne Milianni <smaine.milianni@gmail.com>
+ */
+final class NotificationContentContains 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
+    {
+        if (true === method_exists($message, 'getNotification')) {
+            /** @var Notification $notification */
+            $notification = $message->getNotification();
+
+            return false !== mb_strpos($notification->getContent(), $this->expectedText);
+        }
+
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param MessageInterface $message
+     */
+    protected function failureDescription($message): string
+    {
+        return 'the Notification content '.$this->toString();
+    }
+}