[Mailer] added a way to test the number of queued emails

fabpot · fabpot · commit 28275f136d90 · 2019-08-16T10:23:44.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/MailerAssertionsTrait.php b/src/Symfony/Bundle/FrameworkBundle/Test/MailerAssertionsTrait.php
@@ -25,6 +25,11 @@ public static function assertEmailCount(int $count, string $transport = null, st
         self::assertThat(self::getMessageMailerEvents(), new MailerConstraint\EmailCount($count, $transport), $message);
     }
 
+    public static function assertQueuedEmailCount(int $count, string $transport = null, string $message = ''): void
+    {
+        self::assertThat(self::getMessageMailerEvents(), new MailerConstraint\EmailCount($count, $transport, true), $message);
+    }
+
     public static function assertEmailIsQueued(MessageEvent $event, string $message = ''): void
     {
         self::assertThat($event, new MailerConstraint\EmailIsQueued(), $message);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/MailerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/MailerTest.php
@@ -70,10 +70,11 @@ public function testMailerAssertions()
         $client = $this->createClient(['test_case' => 'Mailer', 'root_config' => 'config.yml', 'debug' => true]);
         $client->request('GET', '/send_email');
 
+        $this->assertQueuedEmailCount(2);
         $this->assertEmailCount(2);
-        $this->assertEmailIsQueued($this->getMailerEvent(0));
+        $this->assertEmailIsQueued($this->getMailerEvent(1));
 
-        $email = $this->getMailerMessage(0);
+        $email = $this->getMailerMessage(1);
         $this->assertEmailHasHeader($email, 'To');
         $this->assertEmailHeaderSame($email, 'To', 'fabien@symfony.com');
         $this->assertEmailHeaderNotSame($email, 'To', 'helene@symfony.com');
@@ -83,7 +84,7 @@ public function testMailerAssertions()
         $this->assertEmailHtmlBodyNotContains($email, 'Bar');
         $this->assertEmailAttachementCount($email, 1);
 
-        $email = $this->getMailerMessage(1);
+        $email = $this->getMailerMessage(3);
         $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/Component/Mailer/Test/Constraint/EmailCount.php b/src/Symfony/Component/Mailer/Test/Constraint/EmailCount.php
@@ -18,19 +18,21 @@ final class EmailCount extends Constraint
 {
     private $expectedValue;
     private $transport;
+    private $queued;
 
-    public function __construct(int $expectedValue, string $transport = null)
+    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 sent "%d" emails', $this->transport ? $this->transport.' ' : '', $this->expectedValue);
+        return sprintf('%shas %s "%d" emails', $this->transport ? $this->transport.' ' : '', $this->queued ? 'queued' : 'sent', $this->expectedValue);
     }
 
     /**
@@ -40,7 +42,7 @@ public function toString(): string
      */
     protected function matches($events): bool
     {
-        return $this->expectedValue === \count($events->getEvents($this->transport));
+        return $this->expectedValue === $this->countEmails($events);
     }
 
     /**
@@ -50,6 +52,22 @@ protected function matches($events): bool
      */
     protected function failureDescription($events): string
     {
-        return sprintf('the Transport %s (%d sent)', $this->toString(), \count($events->getEvents($this->transport)));
+        return sprintf('the Transport %s (%d %s)', $this->toString(), $this->countEmails($events), $this->queued ? 'queued' : 'sent');
+    }
+
+    private function countEmails(MessageEvents $events): int
+    {
+        $count = 0;
+        foreach ($events->getEvents($this->transport) as $event) {
+            if (
+                ($this->queued && $event->isQueued())
+                ||
+                (!$this->queued && !$event->isQueued())
+            ) {
+                ++$count;
+            }
+        }
+
+        return $count;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,11 @@ public static function assertEmailCount(int $count, string $transport = null, st`
`25`	`25`	`self::assertThat(self::getMessageMailerEvents(), new MailerConstraint\EmailCount($count, $transport), $message);`
`26`	`26`	`}`
`27`	`27`
	`28`	`+ public static function assertQueuedEmailCount(int $count, string $transport = null, string $message = ''): void`
	`29`	`+ {`
	`30`	`+ self::assertThat(self::getMessageMailerEvents(), new MailerConstraint\EmailCount($count, $transport, true), $message);`
	`31`	`+ }`
	`32`	`+`
`28`	`33`	`public static function assertEmailIsQueued(MessageEvent $event, string $message = ''): void`
`29`	`34`	`{`
`30`	`35`	`self::assertThat($event, new MailerConstraint\EmailIsQueued(), $message);`
Original file line number	Diff line number	Diff line change
`@@ -18,19 +18,21 @@ final class EmailCount extends Constraint`
`18`	`18`	`{`
`19`	`19`	`private $expectedValue;`
`20`	`20`	`private $transport;`
	`21`	`+ private $queued;`
`21`	`22`
`22`		`- public function __construct(int $expectedValue, string $transport = null)`
	`23`	`+ public function __construct(int $expectedValue, string $transport = null, bool $queued = false)`
`23`	`24`	`{`
`24`	`25`	`$this->expectedValue = $expectedValue;`
`25`	`26`	`$this->transport = $transport;`
	`27`	`+ $this->queued = $queued;`
`26`	`28`	`}`
`27`	`29`
`28`	`30`	`/**`
`29`	`31`	`* {@inheritdoc}`
`30`	`32`	`*/`
`31`	`33`	`public function toString(): string`
`32`	`34`	`{`
`33`		`- return sprintf('%shas sent "%d" emails', $this->transport ? $this->transport.' ' : '', $this->expectedValue);`
	`35`	`+ return sprintf('%shas %s "%d" emails', $this->transport ? $this->transport.' ' : '', $this->queued ? 'queued' : 'sent', $this->expectedValue);`
`34`	`36`	`}`
`35`	`37`
`36`	`38`	`/**`
`@@ -40,7 +42,7 @@ public function toString(): string`
`40`	`42`	`*/`
`41`	`43`	`protected function matches($events): bool`
`42`	`44`	`{`
`43`		`- return $this->expectedValue === \count($events->getEvents($this->transport));`
	`45`	`+ return $this->expectedValue === $this->countEmails($events);`
`44`	`46`	`}`
`45`	`47`
`46`	`48`	`/**`
`@@ -50,6 +52,22 @@ protected function matches($events): bool`
`50`	`52`	`*/`
`51`	`53`	`protected function failureDescription($events): string`
`52`	`54`	`{`
`53`		`- return sprintf('the Transport %s (%d sent)', $this->toString(), \count($events->getEvents($this->transport)));`
	`55`	`+ return sprintf('the Transport %s (%d %s)', $this->toString(), $this->countEmails($events), $this->queued ? 'queued' : 'sent');`
	`56`	`+ }`
	`57`	`+`
	`58`	`+ private function countEmails(MessageEvents $events): int`
	`59`	`+ {`
	`60`	`+ $count = 0;`
	`61`	`+ foreach ($events->getEvents($this->transport) as $event) {`
	`62`	`+ if (`
	`63`	`+ ($this->queued && $event->isQueued())`
	`64`	`+ \|\|`
	`65`	`+ (!$this->queued && !$event->isQueued())`
	`66`	`+ ) {`
	`67`	`+ ++$count;`
	`68`	`+ }`
	`69`	`+ }`
	`70`	`+`
	`71`	`+ return $count;`
`54`	`72`	`}`
`55`	`73`	`}`