feature #50200 [Mailer] Adds assertEmailSubjectContains and assertEmailSubjectNotContains methods (johanadivare)

fabpot · fabpot · commit f143f34c04ea · 2023-07-09T09:08:25.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Mailer] Adds `assertEmailSubjectContains` and `assertEmailSubjectNotContains` methods > Adds assertEmailSubjectContains and assertEmailSubjectNotContains | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | No | New feature? | yes | Deprecations? | No | Tickets | Fix #49939 | License | MIT | Doc PR | symfony/symfony-docs#18269  Commits ------- 55ba7b8 [Mailer] Add EmailSubjectContains constraint (#49939)
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/MailerAssertionsTrait.php b/src/Symfony/Bundle/FrameworkBundle/Test/MailerAssertionsTrait.php
@@ -90,6 +90,16 @@ public static function assertEmailAddressContains(RawMessage $email, string $hea
         self::assertThat($email, new MimeConstraint\EmailAddressContains($headerName, $expectedValue), $message);
     }
 
+    public static function assertEmailSubjectContains(RawMessage $email, string $expectedValue, string $message = ''): void
+    {
+        self::assertThat($email, new MimeConstraint\EmailSubjectContains($expectedValue), $message);
+    }
+
+    public static function assertEmailSubjectNotContains(RawMessage $email, string $expectedValue, string $message = ''): void
+    {
+        self::assertThat($email, new LogicalNot(new MimeConstraint\EmailSubjectContains($expectedValue)), $message);
+    }
+
     /**
      * @return MessageEvent[]
      */
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/MailerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/MailerTest.php
@@ -104,6 +104,8 @@ public function testMailerAssertions()
         $this->assertEmailAttachmentCount($email, 1);
 
         $email = $this->getMailerMessage($second);
+        $this->assertEmailSubjectContains($email, 'Foo');
+        $this->assertEmailSubjectNotContains($email, 'Bar');
         $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/Mime/Test/Constraint/EmailSubjectContains.php b/src/Symfony/Component/Mime/Test/Constraint/EmailSubjectContains.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\Component\Mime\Test\Constraint;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\Mime\Email;
+
+final class EmailSubjectContains extends Constraint
+{
+    public function __construct(
+        private readonly string $expectedSubjectValue,
+    ) {
+    }
+
+    public function toString(): string
+    {
+        return sprintf('contains subject with value "%s"', $this->expectedSubjectValue);
+    }
+
+    protected function matches($other): bool
+    {
+        if (!$other instanceof Email) {
+            throw new \LogicException('Can only test a message subject on a Email instance.');
+        }
+
+        return str_contains((string) $other->getSubject(), $this->expectedSubjectValue);
+    }
+
+    protected function failureDescription($other): string
+    {
+        $message = 'The email subject '.$this->toString();
+        if ($other instanceof Email) {
+            $message .= sprintf('. The subject was: "%s"', $other->getSubject() ?? '<empty>');
+        }
+
+        return $message;
+    }
+}

-Original file line number
+Diff line change
         $this->assertEmailAttachmentCount($email, 1);
         $email = $this->getMailerMessage($second);
 +        $this->assertEmailSubjectContains($email, 'Foo');
 +        $this->assertEmailSubjectNotContains($email, 'Bar');
         $this->assertEmailAddressContains($email, 'To', '[email protected]');
         $this->assertEmailAddressContains($email, 'To', '[email protected]');
         $this->assertEmailAddressContains($email, 'Reply-To', '[email protected]');