symfony · fabpot · Aug 5, 2019 · Aug 4, 2019
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 4.4.0
 -----
 
+ * Added `MailerAssertionsTrait`
  * Deprecated support for `templating` engine in `TemplateController`, use Twig instead
  * Deprecated the `$parser` argument of `ControllerResolver::__construct()` and `DelegatingLoader::__construct()`
  * Deprecated the `controller_name_converter` and `resolve_controller_name_subscriber` services

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -553,10 +553,6 @@ private function registerProfilerConfiguration(array $config, ContainerBuilder $
             $loader->load('messenger_debug.xml');
         }
 
-        if (class_exists(Mailer::class)) {
-            $loader->load('mailer_debug.xml');
-        }
-
         $container->setParameter('profiler_listener.only_exceptions', $config['only_exceptions']);
         $container->setParameter('profiler_listener.only_master_requests', $config['only_master_requests']);
 
@@ -1969,6 +1965,9 @@ private function registerMailerConfiguration(array $config, ContainerBuilder $co
         }
 
         $loader->load('mailer.xml');
+        if ($container->getParameter('kernel.debug')) {
+            $loader->load('mailer_debug.xml');
+        }
         $loader->load('mailer_transports.xml');
         $container->getDefinition('mailer.default_transport')->setArgument(0, $config['dsn']);
 

diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/MailerAssertionsTrait.php b/src/Symfony/Bundle/FrameworkBundle/Test/MailerAssertionsTrait.php
@@ -0,0 +1,126 @@
+<?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\Mailer\Event\MessageEvent;
+use Symfony\Component\Mailer\Event\MessageEvents;
+use Symfony\Component\Mailer\Test\Constraint as MailerConstraint;
+use Symfony\Component\Mime\RawMessage;
+use Symfony\Component\Mime\Test\Constraint as MimeConstraint;
+
+trait MailerAssertionsTrait
+{
+    public static function assertEmailCount(int $count, string $transport = null, string $message = ''): void
+    {
+        self::assertThat(self::getMessageMailerEvents(), new MailerConstraint\EmailCount($count, $transport), $message);
+    }
+
+    public static function assertEmailIsQueued(MessageEvent $event, string $message = ''): void
+    {
+        self::assertThat($event, new MailerConstraint\EmailIsQueued(), $message);
+    }
+
+    public static function assertEmailIsNotQueued(MessageEvent $event, string $message = ''): void
+    {
+        self::assertThat($event, new LogicalNot(new MailerConstraint\EmailIsQueued()), $message);
+    }
+
+    public static function assertEmailAttachementCount(RawMessage $email, int $count, string $message = ''): void
+    {
+        self::assertThat($email, new MimeConstraint\EmailAttachmentCount($count), $message);
+    }
+
+    public static function assertEmailTextBodyContains(RawMessage $email, string $text, string $message = ''): void
+    {
+        self::assertThat($email, new MimeConstraint\EmailTextBodyContains($text), $message);
+    }
+
+    public static function assertEmailTextBodyNotContains(RawMessage $email, string $text, string $message = ''): void
+    {
+        self::assertThat($email, new LogicalNot(new MimeConstraint\EmailTextBodyContains($text)), $message);
+    }
+
+    public static function assertEmailHtmlBodyContains(RawMessage $email, string $text, string $message = ''): void
+    {
+        self::assertThat($email, new MimeConstraint\EmailHtmlBodyContains($text), $message);
+    }
+
+    public static function assertEmailHtmlBodyNotContains(RawMessage $email, string $text, string $message = ''): void
+    {
+        self::assertThat($email, new LogicalNot(new MimeConstraint\EmailHtmlBodyContains($text)), $message);
+    }
+
+    public static function assertEmailHasHeader(RawMessage $email, string $headerName, string $message = ''): void
+    {
+        self::assertThat($email, new MimeConstraint\EmailHasHeader($headerName), $message);
+    }
+
+    public static function assertEmailNotHasHeader(RawMessage $email, string $headerName, string $message = ''): void
+    {
+        self::assertThat($email, new LogicalNot(new MimeConstraint\EmailHasHeader($headerName)), $message);
+    }
+
+    public static function assertEmailHeaderSame(RawMessage $email, string $headerName, string $expectedValue, string $message = ''): void
+    {
+        self::assertThat($email, new MimeConstraint\EmailHeaderSame($headerName, $expectedValue), $message);
+    }
+
+    public static function assertEmailHeaderNotSame(RawMessage $email, string $headerName, string $expectedValue, string $message = ''): void
+    {
+        self::assertThat($email, new LogicalNot(new MimeConstraint\EmailHeaderSame($headerName, $expectedValue)), $message);
+    }
+
+    public static function assertEmailAddressContains(RawMessage $email, string $headerName, string $expectedValue, string $message = ''): void
+    {
+        self::assertThat($email, new MimeConstraint\EmailAddressContains($headerName, $expectedValue), $message);
+    }
+
+    /**
+     * @return MessageEvents[]
+     */
+    public static function getMailerEvents(string $transport = null): array
+    {
+        return self::getMessageMailerEvents()->getEvents($transport);
+    }
+
+    public static function getMailerEvent(int $index = 0, string $transport = null): ?MessageEvent
+    {
+        return self::getMailerEvents($transport)[$index] ?? null;
+    }
+
+    /**
+     * @return RawMessage[]
+     */
+    public static function getMailerMessages(string $transport = null): array
+    {
+        return self::getMessageMailerEvents()->getMessages($transport);
+    }
+
+    public static function getMailerMessage(int $index = 0, string $transport = null): ?RawMessage
+    {
+        return self::getMailerMessages($transport)[$index] ?? null;
+    }
+
+    private static function getMessageMailerEvents(): MessageEvents
+    {
+        if (!self::getClient()->getRequest()) {
+            static::fail('Unable to make email assertions. Did you forget to make an HTTP request?');
+        }
+
+        if (!$logger = self::$container->get('mailer.logger_message_listener')) {
+            static::fail('A client must have Mailer enabled to make email assertions. Did you forget to require symfony/mailer?');
+        }
+
+        return $logger->getEvents();
+    }
+}
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/WebTestAssertionsTrait.php b/src/Symfony/Bundle/FrameworkBundle/Test/WebTestAssertionsTrait.php
@@ -11,11 +11,6 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Test;
 
-/**
- * Ideas borrowed from Laravel Dusk's assertions.
- *
- * @see https://laravel.com/docs/5.7/dusk#available-assertions
- */
 trait WebTestAssertionsTrait
 {
     use BrowserKitAssertionsTrait;

diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/WebTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Test/WebTestCase.php
@@ -23,6 +23,7 @@ abstract class WebTestCase extends KernelTestCase
 {
     use ForwardCompatTestTrait;
     use WebTestAssertionsTrait;
+    use MailerAssertionsTrait;
 
     private function doTearDown()
     {

diff --git a/.../Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/EmailController.php b/.../Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/EmailController.php
@@ -0,0 +1,41 @@
+<?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\Mailer\MailerInterface;
+use Symfony\Component\Mime\Email;
+use Symfony\Component\Mime\NamedAddress;
+
+class EmailController
+{
+    public function indexAction(MailerInterface $mailer)
+    {
+        $mailer->send((new Email())->to('fabien@symfony.com')->from('fabien@symfony.com')->subject('Foo')
+            ->addReplyTo('me@symfony.com')
+            ->addCc('cc@symfony.com')
+            ->text('Bar!')
+            ->html('<p>Foo</p>')
+            ->attach(file_get_contents(__FILE__), 'foobar.php')
+        );
+
+        $mailer->send((new Email())->to('fabien@symfony.com', 'thomas@symfony.com')->from('fabien@symfony.com')->subject('Foo')
+            ->addReplyTo(new NamedAddress('me@symfony.com', 'Fabien Potencier'))
+            ->addCc('cc@symfony.com')
+            ->text('Bar!')
+            ->html('<p>Foo</p>')
+            ->attach(file_get_contents(__FILE__), 'foobar.php')
+        );
+
+        return new Response();
+    }
+}
diff --git a/...ny/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Resources/config/routing.yml b/...ny/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Resources/config/routing.yml
@@ -52,3 +52,7 @@ fragment_inlined:
 array_controller:
     path:     /array_controller
     defaults: { _controller: [ArrayController, someAction] }
+
+send_email:
+    path:     /send_email
+    defaults: { _controller: Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller\EmailController::indexAction }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/MailerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/MailerTest.php
@@ -64,4 +64,28 @@ protected function doSend(SentMessage $message): void
 
         $mailer->send($message);
     }
+
+    public function testMailerAssertions()
+    {
+        $client = $this->createClient(['test_case' => 'Mailer', 'root_config' => 'config.yml', 'debug' => true]);
+        $client->request('GET', '/send_email');
+
+        $this->assertEmailCount(2);
+        $this->assertEmailIsQueued($this->getMailerEvent(0));
+
+        $email = $this->getMailerMessage(0);
+        $this->assertEmailHasHeader($email, 'To');
+        $this->assertEmailHeaderSame($email, 'To', 'fabien@symfony.com');
+        $this->assertEmailHeaderNotSame($email, 'To', 'helene@symfony.com');
+        $this->assertEmailTextBodyContains($email, 'Bar');
+        $this->assertEmailTextBodyNotContains($email, 'Foo');
+        $this->assertEmailHtmlBodyContains($email, 'Foo');
+        $this->assertEmailHtmlBodyNotContains($email, 'Bar');
+        $this->assertEmailAttachementCount($email, 1);
+
+        $email = $this->getMailerMessage(1);
+        $this->assertEmailAddressContains($email, 'To', 'fabien@symfony.com');
+        $this->assertEmailAddressContains($email, 'To', 'thomas@symfony.com');
+        $this->assertEmailAddressContains($email, 'Reply-To', 'me@symfony.com');
+    }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Mailer/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Mailer/config.yml
@@ -1,8 +1,10 @@
 imports:
     - { resource: ../config/default.yml }
+    - { resource: services.yml }
 
 framework:
     mailer:
+        dsn: 'smtp://null'
         envelope:
             sender: sender@example.org
             recipients:

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Mailer/routing.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Mailer/routing.yml
@@ -0,0 +1,2 @@
+_emailtest_bundle:
+    resource: '@TestBundle/Resources/config/routing.yml'
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Mailer/services.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Mailer/services.yml
@@ -0,0 +1,6 @@
+services:
+    _defaults:
+        public: true
+
+    Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller\EmailController:
+        tags: ['controller.service_arguments']
diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -42,9 +42,9 @@
         "symfony/expression-language": "^3.4|^4.0|^5.0",
         "symfony/http-client": "^4.3|^5.0",
         "symfony/lock": "^4.4|^5.0",
-        "symfony/mailer": "^4.3|^5.0",
+        "symfony/mailer": "^4.4|^5.0",
         "symfony/messenger": "^4.3|^5.0",
-        "symfony/mime": "^4.3|^5.0",
+        "symfony/mime": "^4.4|^5.0",
         "symfony/process": "^3.4|^4.0|^5.0",
         "symfony/security-csrf": "^3.4|^4.0|^5.0",
         "symfony/security-http": "^3.4|^4.0|^5.0",
@@ -76,6 +76,7 @@
         "symfony/lock": "<4.4",
         "symfony/mailer": "<4.4",
         "symfony/messenger": "<4.3",
+        "symfony/mime": "<4.4",
         "symfony/property-info": "<3.4",
         "symfony/serializer": "<4.2",
         "symfony/stopwatch": "<3.4",

diff --git a/src/Symfony/Component/Mailer/CHANGELOG.md b/src/Symfony/Component/Mailer/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 4.4.0
 -----
 
+ * Added PHPUnit constraints
  * Added `MessageDataCollector`
  * Added `MessageEvents` and `MessageLoggerListener` to allow collecting sent emails
  * [BC BREAK] `TransportInterface` has a new `getName()` method

diff --git a/src/Symfony/Component/Mailer/Test/Constraint/EmailCount.php b/src/Symfony/Component/Mailer/Test/Constraint/EmailCount.php
@@ -0,0 +1,55 @@
+<?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\Mailer\Test\Constraint;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\Mailer\Event\MessageEvents;
+
+final class EmailCount extends Constraint
+{
+    private $expectedValue;
+    private $transport;
+
+    public function __construct(int $expectedValue, string $transport = null)
+    {
+        $this->expectedValue = $expectedValue;
+        $this->transport = $transport;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function toString(): string
+    {
+        return sprintf('%shas sent "%d" emails', $this->transport ? $this->transport.' ' : '', $this->expectedValue);
+    }
+
+    /**
+     * @param MessageEvents $events
+     *
+     * {@inheritdoc}
+     */
+    protected function matches($events): bool
+    {
+        return $this->expectedValue === \count($events->getEvents($this->transport));
+    }
+
+    /**
+     * @param MessageEvents $events
+     *
+     * {@inheritdoc}
+     */
+    protected function failureDescription($events): string
+    {
+        return sprintf('the Transport %s (%d sent)', $this->toString(), \count($events->getEvents($this->transport)));
+    }
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		_emailtest_bundle:
		resource: '@TestBundle/Resources/config/routing.yml'