bug #46366 [Mime] Add null check for EmailHeaderSame (magikid)

nicolas-grekas · nicolas-grekas · commit 6a93d11bf385 · 2022-05-17T11:21:53.000+02:00
This PR was squashed before being merged into the 4.4 branch. Discussion ---------- [Mime] Add null check for EmailHeaderSame When asserting that an email header matches some text and the header does not exist on the message, an `Error` was being thrown because the method `getBodyAsString()` was being called on a `null` object. This commit allows a missing header and will show the user that the header's value is `null`. Issue #44190 | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | Fix #44190  | License | MIT  Commits ------- a6ec675 [Mime] Add null check for EmailHeaderSame
diff --git a/src/Symfony/Component/Mime/Test/Constraint/EmailHeaderSame.php b/src/Symfony/Component/Mime/Test/Constraint/EmailHeaderSame.php
@@ -55,12 +55,14 @@ protected function matches($message): bool
      */
     protected function failureDescription($message): string
     {
-        return sprintf('the Email %s (value is %s)', $this->toString(), $this->getHeaderValue($message));
+        return sprintf('the Email %s (value is %s)', $this->toString(), $this->getHeaderValue($message) ?? 'null');
     }
 
-    private function getHeaderValue($message): string
+    private function getHeaderValue($message): ?string
     {
-        $header = $message->getHeaders()->get($this->headerName);
+        if (null === $header = $message->getHeaders()->get($this->headerName)) {
+            return null;
+        }
 
         return $header instanceof UnstructuredHeader ? $header->getValue() : $header->getBodyAsString();
     }
diff --git a/src/Symfony/Component/Mime/Tests/EmailTest.php b/src/Symfony/Component/Mime/Tests/EmailTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Mime\Tests;
 
+use PHPUnit\Framework\ExpectationFailedException;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\Email;
@@ -19,6 +20,7 @@
 use Symfony\Component\Mime\Part\Multipart\MixedPart;
 use Symfony\Component\Mime\Part\Multipart\RelatedPart;
 use Symfony\Component\Mime\Part\TextPart;
+use Symfony\Component\Mime\Test\Constraint\EmailHeaderSame;
 
 class EmailTest extends TestCase
 {
@@ -384,4 +386,14 @@ public function testSerialize()
         $this->assertEquals($expected->getHeaders(), $n->getHeaders());
         $this->assertEquals($e->getBody(), $n->getBody());
     }
+
+    public function testMissingHeaderDoesNotThrowError()
+    {
+        $this->expectException(ExpectationFailedException::class);
+        $this->expectExceptionMessage('Failed asserting that the Email has header "foo" with value "bar" (value is null).');
+
+        $e = new Email();
+        $emailHeaderSame = new EmailHeaderSame('foo', 'bar');
+        $emailHeaderSame->evaluate($e);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -55,12 +55,14 @@ protected function matches($message): bool`
`55`	`55`	`*/`
`56`	`56`	`protected function failureDescription($message): string`
`57`	`57`	`{`
`58`		`- return sprintf('the Email %s (value is %s)', $this->toString(), $this->getHeaderValue($message));`
	`58`	`+ return sprintf('the Email %s (value is %s)', $this->toString(), $this->getHeaderValue($message) ?? 'null');`
`59`	`59`	`}`
`60`	`60`
`61`		`- private function getHeaderValue($message): string`
	`61`	`+ private function getHeaderValue($message): ?string`
`62`	`62`	`{`
`63`		`- $header = $message->getHeaders()->get($this->headerName);`
	`63`	`+ if (null === $header = $message->getHeaders()->get($this->headerName)) {`
	`64`	`+ return null;`
	`65`	`+ }`
`64`	`66`
`65`	`67`	`return $header instanceof UnstructuredHeader ? $header->getValue() : $header->getBodyAsString();`
`66`	`68`	`}`