added PHPUnit constraints and assertions for the Mailer

fabpot · fabpot · commit 33cf60381824 · 2019-08-04T17:05:36.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/MailerAssertionsTrait.php b/src/Symfony/Bundle/FrameworkBundle/Test/MailerAssertionsTrait.php
@@ -0,0 +1,39 @@
+<?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\LogicalAnd;
+use PHPUnit\Framework\Constraint\LogicalNot;
+use Symfony\Component\Mailer\Test\Constraint as MailerConstraint;
+use Symfony\Component\Mailer\Event\MessageEvents;
+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::getEvents(), new MailerConstraint\MailerMessageCount($count, $transport), $message);
+    }
+
+    private static function getEvents(): 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,13 +11,9 @@
 
 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;
     use DomCrawlerAssertionsTrait;
+    use MailerAssertionsTrait;
 }
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/src/Symfony/Component/Mailer/Test/Constraint/MailerMessageCount.php b/src/Symfony/Component/Mailer/Test/Constraint/MailerMessageCount.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 MailerMessageCount 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 === $events->getMessageCount($this->transport);
+    }
+
+    /**
+     * @param MessageEvents $events
+     *
+     * {@inheritdoc}
+     */
+    protected function failureDescription($events): string
+    {
+        return sprintf('the Transport %s (%d sent)', $this->toString(), $events->getMessageCount($this->transport));
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,9 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Bundle\FrameworkBundle\Test;`
`13`	`13`
`14`		`-/**`
`15`		`- * Ideas borrowed from Laravel Dusk's assertions.`
`16`		`- *`
`17`		`- * @see https://laravel.com/docs/5.7/dusk#available-assertions`
`18`		`- */`
`19`	`14`	`trait WebTestAssertionsTrait`
`20`	`15`	`{`
`21`	`16`	`use BrowserKitAssertionsTrait;`
`22`	`17`	`use DomCrawlerAssertionsTrait;`
	`18`	`+ use MailerAssertionsTrait;`
`23`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ abstract class WebTestCase extends KernelTestCase`
`23`	`23`	`{`
`24`	`24`	`use ForwardCompatTestTrait;`
`25`	`25`	`use WebTestAssertionsTrait;`
	`26`	`+ use MailerAssertionsTrait;`
`26`	`27`
`27`	`28`	`private function doTearDown()`
`28`	`29`	`{`