Constraint ResponseHeaderSame now shows the actual header value

jschaedl · jschaedl · commit f9660ccd008b · 2023-11-26T18:58:04.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Test/WebTestCaseTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Test/WebTestCaseTest.php
@@ -121,7 +121,7 @@ public function testAssertResponseHeaderSame()
     {
         $this->getResponseTester(new Response())->assertResponseHeaderSame('Cache-Control', 'no-cache, private');
         $this->expectException(AssertionFailedError::class);
-        $this->expectExceptionMessage('Failed asserting that the Response has header "Cache-Control" with value "public".');
+        $this->expectExceptionMessage('Failed asserting that the Response has header "Cache-Control" with value "public", value of header "Cache-Control" is "no-cache, private".');
         $this->getResponseTester(new Response())->assertResponseHeaderSame('Cache-Control', 'public');
     }
 
diff --git a/src/Symfony/Component/HttpFoundation/Test/Constraint/ResponseHeaderSame.php b/src/Symfony/Component/HttpFoundation/Test/Constraint/ResponseHeaderSame.php
@@ -18,6 +18,7 @@ final class ResponseHeaderSame extends Constraint
 {
     private string $headerName;
     private string $expectedValue;
+    private ?string $actualValue = null;
 
     public function __construct(string $headerName, string $expectedValue)
     {
@@ -27,15 +28,27 @@ public function __construct(string $headerName, string $expectedValue)
 
     public function toString(): string
     {
-        return sprintf('has header "%s" with value "%s"', $this->headerName, $this->expectedValue);
+        $output = sprintf('has header "%s" with value "%s"', $this->headerName, $this->expectedValue);
+
+        if (null === $this->actualValue) {
+            $output .= sprintf(', header "%s" is not set', $this->headerName);
+        }
+
+        if (null !== $this->actualValue) {
+            $output .= sprintf(', value of header "%s" is "%s"', $this->headerName, $this->actualValue);
+        }
+
+        return $output;
     }
 
     /**
      * @param Response $response
      */
     protected function matches($response): bool
     {
-        return $this->expectedValue === $response->headers->get($this->headerName, null);
+        $this->actualValue = $response->headers->get($this->headerName);
+
+        return $this->expectedValue === $this->actualValue;
     }
 
     /**
diff --git a/src/Symfony/Component/HttpFoundation/Tests/Test/Constraint/ResponseHeaderSameTest.php b/src/Symfony/Component/HttpFoundation/Tests/Test/Constraint/ResponseHeaderSameTest.php
@@ -19,17 +19,48 @@
 
 class ResponseHeaderSameTest extends TestCase
 {
-    public function testConstraint()
+    public function testResponseHeaderSameWithExpectedHeaderValueIsSame()
     {
-        $constraint = new ResponseHeaderSame('Cache-Control', 'no-cache, private');
-        $this->assertTrue($constraint->evaluate(new Response(), '', true));
-        $constraint = new ResponseHeaderSame('Cache-Control', 'public');
-        $this->assertFalse($constraint->evaluate(new Response(), '', true));
+        $constraint = new ResponseHeaderSame('X-Token', 'custom-token');
+
+        $response = new Response();
+        $response->headers->set('X-Token', 'custom-token');
+
+        $this->assertTrue($constraint->evaluate($response, '', true));
+    }
+
+    public function testResponseHeaderSameWithExpectedHeaderValueIsDifferent()
+    {
+        $constraint = new ResponseHeaderSame('X-Token', 'custom-token');
+
+        $response = new Response();
+        $response->headers->set('X-Token', 'default-token');
+
+        $this->assertFalse($constraint->evaluate($response, '', true));
+
+        try {
+            $constraint->evaluate($response);
+        } catch (ExpectationFailedException $e) {
+            $this->assertEquals("Failed asserting that the Response has header \"X-Token\" with value \"custom-token\", value of header \"X-Token\" is \"default-token\".\n", TestFailure::exceptionToString($e));
+
+            return;
+        }
+
+        $this->fail();
+    }
+
+    public function testResponseHeaderSameWithExpectedHeaderIsNotPresent()
+    {
+        $constraint = new ResponseHeaderSame('X-Token', 'custom-token');
+
+        $response = new Response();
+
+        $this->assertFalse($constraint->evaluate($response, '', true));
 
         try {
-            $constraint->evaluate(new Response());
+            $constraint->evaluate($response);
         } catch (ExpectationFailedException $e) {
-            $this->assertEquals("Failed asserting that the Response has header \"Cache-Control\" with value \"public\".\n", TestFailure::exceptionToString($e));
+            $this->assertEquals("Failed asserting that the Response has header \"X-Token\" with value \"custom-token\", header \"X-Token\" is not set.\n", TestFailure::exceptionToString($e));
 
             return;
         }

Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ public function testAssertResponseHeaderSame()`
`121`	`121`	`{`
`122`	`122`	`$this->getResponseTester(new Response())->assertResponseHeaderSame('Cache-Control', 'no-cache, private');`
`123`	`123`	`$this->expectException(AssertionFailedError::class);`
`124`		`- $this->expectExceptionMessage('Failed asserting that the Response has header "Cache-Control" with value "public".');`
	`124`	`+ $this->expectExceptionMessage('Failed asserting that the Response has header "Cache-Control" with value "public", value of header "Cache-Control" is "no-cache, private".');`
`125`	`125`	`$this->getResponseTester(new Response())->assertResponseHeaderSame('Cache-Control', 'public');`
`126`	`126`	`}`
`127`	`127`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ final class ResponseHeaderSame extends Constraint`
`18`	`18`	`{`
`19`	`19`	`private string $headerName;`
`20`	`20`	`private string $expectedValue;`
	`21`	`+ private ?string $actualValue = null;`
`21`	`22`
`22`	`23`	`public function __construct(string $headerName, string $expectedValue)`
`23`	`24`	`{`
`@@ -27,15 +28,27 @@ public function __construct(string $headerName, string $expectedValue)`
`27`	`28`
`28`	`29`	`public function toString(): string`
`29`	`30`	`{`
`30`		`- return sprintf('has header "%s" with value "%s"', $this->headerName, $this->expectedValue);`
	`31`	`+ $output = sprintf('has header "%s" with value "%s"', $this->headerName, $this->expectedValue);`
	`32`	`+`
	`33`	`+ if (null === $this->actualValue) {`
	`34`	`+ $output .= sprintf(', header "%s" is not set', $this->headerName);`
	`35`	`+ }`
	`36`	`+`
	`37`	`+ if (null !== $this->actualValue) {`
	`38`	`+ $output .= sprintf(', value of header "%s" is "%s"', $this->headerName, $this->actualValue);`
	`39`	`+ }`
	`40`	`+`
	`41`	`+ return $output;`
`31`	`42`	`}`
`32`	`43`
`33`	`44`	`/**`
`34`	`45`	`* @param Response $response`
`35`	`46`	`*/`
`36`	`47`	`protected function matches($response): bool`
`37`	`48`	`{`
`38`		`- return $this->expectedValue === $response->headers->get($this->headerName, null);`
	`49`	`+ $this->actualValue = $response->headers->get($this->headerName);`
	`50`	`+`
	`51`	`+ return $this->expectedValue === $this->actualValue;`
`39`	`52`	`}`
`40`	`53`
`41`	`54`	`/**`