[5.x] Fix failing tests due to lowercase utf-8 charset (#13213)

duncanmcclean · jasonvarga · web-flow · commit db9856fe25a0 · 2025-11-30T13:55:17.000-05:00
Co-authored-by: Jason Varga &lt;jason@pixelfear.com&gt;
diff --git a/src/Http/Responses/DataResponse.php b/src/Http/Responses/DataResponse.php
@@ -216,13 +216,13 @@ public static function contentType($type)
     {
         switch ($type) {
             case 'html':
-                return 'text/html; charset=UTF-8';
+                return 'text/html; charset=utf-8';
             case 'xml':
                 return 'text/xml';
             case 'rss':
                 return 'application/rss+xml';
             case 'atom':
-                return 'application/atom+xml; charset=UTF-8';
+                return 'application/atom+xml; charset=utf-8';
             case 'json':
                 return 'application/json';
             case 'text':
diff --git a/tests/FrontendTest.php b/tests/FrontendTest.php
@@ -464,34 +464,34 @@ public function changes_content_type_to_xml()
     {
         $this->createPage('about', ['with' => ['content_type' => 'xml']]);
 
-        // Laravel adds utf-8 if the content-type starts with text/
-        $this->get('about')->assertHeader('Content-Type', 'text/xml; charset=UTF-8');
+        // Symfony adds utf-8 if the content-type starts with text/
+        $this->get('about')->assertContentType('text/xml; charset=utf-8');
     }
 
     #[Test]
     public function changes_content_type_to_atom()
     {
         $this->createPage('about', ['with' => ['content_type' => 'atom']]);
 
-        // Laravel adds utf-8 if the content-type starts with text/
-        $this->get('about')->assertHeader('Content-Type', 'application/atom+xml; charset=UTF-8');
+        // Symfony adds utf-8 if the content-type starts with text/
+        $this->get('about')->assertContentType('application/atom+xml; charset=utf-8');
     }
 
     #[Test]
     public function changes_content_type_to_json()
     {
         $this->createPage('about', ['with' => ['content_type' => 'json']]);
 
-        $this->get('about')->assertHeader('Content-Type', 'application/json');
+        $this->get('about')->assertContentType('application/json');
     }
 
     #[Test]
     public function changes_content_type_to_text()
     {
         $this->createPage('about', ['with' => ['content_type' => 'text']]);
 
-        // Laravel adds utf-8 if the content-type starts with text/
-        $this->get('about')->assertHeader('Content-Type', 'text/plain; charset=UTF-8');
+        // Symfony adds utf-8 if the content-type starts with text/
+        $this->get('about')->assertContentType('text/plain; charset=utf-8');
     }
 
     #[Test]
@@ -504,7 +504,7 @@ public function xml_antlers_template_with_xml_layout_will_use_both_and_change_th
 
         $response = $this
             ->get('about')
-            ->assertHeader('Content-Type', 'text/xml; charset=UTF-8');
+            ->assertContentType('text/xml; charset=utf-8');
 
         $this->assertEquals('<?xml ?><foo></foo>', $response->getContent());
     }
@@ -519,7 +519,7 @@ public function xml_antlers_template_with_non_xml_layout_will_change_content_typ
 
         $response = $this
             ->get('about')
-            ->assertHeader('Content-Type', 'text/xml; charset=UTF-8');
+            ->assertContentType('text/xml; charset=utf-8');
 
         $this->assertEquals('<foo></foo>', $response->getContent());
     }
@@ -534,7 +534,7 @@ public function xml_antlers_layout_will_change_the_content_type()
 
         $response = $this
             ->get('about')
-            ->assertHeader('Content-Type', 'text/xml; charset=UTF-8');
+            ->assertContentType('text/xml; charset=utf-8');
 
         $this->assertEquals('<?xml ?><foo></foo>', $response->getContent());
     }
@@ -551,7 +551,7 @@ public function xml_blade_template_will_not_change_content_type()
 
         $response = $this
             ->get('about')
-            ->assertHeader('Content-Type', 'text/html; charset=UTF-8');
+            ->assertContentType('text/html; charset=utf-8');
 
         $this->assertEquals('<foo></foo>', $response->getContent());
     }
@@ -566,7 +566,7 @@ public function xml_template_with_custom_content_type_does_not_change_to_xml()
 
         $this
             ->get('about')
-            ->assertHeader('Content-Type', 'application/json');
+            ->assertContentType('application/json');
     }
 
     #[Test]
diff --git a/tests/Routing/RoutesTest.php b/tests/Routing/RoutesTest.php
@@ -473,7 +473,7 @@ public function it_renders_a_view_with_custom_content_type()
 
         $this->get('/route-with-custom-content-type')
             ->assertOk()
-            ->assertHeader('Content-Type', 'application/json')
+            ->assertContentType('application/json')
             ->assertExactJson(['hello' => 'world']);
     }
 
@@ -486,7 +486,7 @@ public function xml_antlers_template_with_xml_layout_will_use_both_and_change_th
 
         $response = $this
             ->get('/xml')
-            ->assertHeader('Content-Type', 'text/xml; charset=UTF-8');
+            ->assertContentType('text/xml; charset=utf-8');
 
         $this->assertEquals('<?xml ?><foo></foo>', $response->getContent());
     }
@@ -500,7 +500,7 @@ public function xml_antlers_template_with_non_xml_layout_will_change_content_typ
 
         $response = $this
             ->get('/xml')
-            ->assertHeader('Content-Type', 'text/xml; charset=UTF-8');
+            ->assertContentType('text/xml; charset=utf-8');
 
         $this->assertEquals('<foo></foo>', $response->getContent());
     }
@@ -514,7 +514,7 @@ public function xml_antlers_layout_will_change_the_content_type()
 
         $response = $this
             ->get('/xml')
-            ->assertHeader('Content-Type', 'text/xml; charset=UTF-8');
+            ->assertContentType('text/xml; charset=utf-8');
 
         $this->assertEquals('<?xml ?><foo></foo>', $response->getContent());
     }
@@ -530,7 +530,7 @@ public function xml_blade_template_will_not_change_content_type()
 
         $response = $this
             ->get('/xml')
-            ->assertHeader('Content-Type', 'text/html; charset=UTF-8');
+            ->assertContentType('text/html; charset=utf-8');
 
         $this->assertEquals('<foo></foo>', $response->getContent());
     }
@@ -544,7 +544,7 @@ public function xml_template_with_custom_content_type_does_not_change_to_xml()
 
         $this
             ->get('/xml-with-custom-type')
-            ->assertHeader('Content-Type', 'application/json');
+            ->assertContentType('application/json');
     }
 
     #[Test]
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -238,6 +238,29 @@ private function addGqlMacros()
 
             return $this;
         });
+
+        // Symfony 7.4.0 changed "UTF-8" to "utf-8".
+        // https://github.com/symfony/symfony/pull/60685
+        // While we continue to support lower versions, we'll do a case-insensitive check.
+        // This macro is essentially assertHeader but with case-insensitive value check.
+        TestResponse::macro('assertContentType', function (string $value) {
+            $headerName = 'Content-Type';
+
+            Assert::assertTrue(
+                $this->headers->has($headerName), "Header [{$headerName}] not present on response."
+            );
+
+            $actual = $this->headers->get($headerName);
+
+            if (! is_null($value)) {
+                Assert::assertEquals(
+                    strtolower($value), strtolower($this->headers->get($headerName)),
+                    "Header [{$headerName}] was found, but value [{$actual}] does not match [{$value}]."
+                );
+            }
+
+            return $this;
+        });
     }
 
     public function __call($name, $arguments)

Original file line number	Diff line number	Diff line change
`@@ -464,34 +464,34 @@ public function changes_content_type_to_xml()`
`464`	`464`	`{`
`465`	`465`	`$this->createPage('about', ['with' => ['content_type' => 'xml']]);`
`466`	`466`
`467`		`- // Laravel adds utf-8 if the content-type starts with text/`
`468`		`- $this->get('about')->assertHeader('Content-Type', 'text/xml; charset=UTF-8');`
	`467`	`+ // Symfony adds utf-8 if the content-type starts with text/`
	`468`	`+ $this->get('about')->assertContentType('text/xml; charset=utf-8');`
`469`	`469`	`}`
`470`	`470`
`471`	`471`	`#[Test]`
`472`	`472`	`public function changes_content_type_to_atom()`
`473`	`473`	`{`
`474`	`474`	`$this->createPage('about', ['with' => ['content_type' => 'atom']]);`
`475`	`475`
`476`		`- // Laravel adds utf-8 if the content-type starts with text/`
`477`		`- $this->get('about')->assertHeader('Content-Type', 'application/atom+xml; charset=UTF-8');`
	`476`	`+ // Symfony adds utf-8 if the content-type starts with text/`
	`477`	`+ $this->get('about')->assertContentType('application/atom+xml; charset=utf-8');`
`478`	`478`	`}`
`479`	`479`
`480`	`480`	`#[Test]`
`481`	`481`	`public function changes_content_type_to_json()`
`482`	`482`	`{`
`483`	`483`	`$this->createPage('about', ['with' => ['content_type' => 'json']]);`
`484`	`484`
`485`		`- $this->get('about')->assertHeader('Content-Type', 'application/json');`
	`485`	`+ $this->get('about')->assertContentType('application/json');`
`486`	`486`	`}`
`487`	`487`
`488`	`488`	`#[Test]`
`489`	`489`	`public function changes_content_type_to_text()`
`490`	`490`	`{`
`491`	`491`	`$this->createPage('about', ['with' => ['content_type' => 'text']]);`
`492`	`492`
`493`		`- // Laravel adds utf-8 if the content-type starts with text/`
`494`		`- $this->get('about')->assertHeader('Content-Type', 'text/plain; charset=UTF-8');`
	`493`	`+ // Symfony adds utf-8 if the content-type starts with text/`
	`494`	`+ $this->get('about')->assertContentType('text/plain; charset=utf-8');`
`495`	`495`	`}`
`496`	`496`
`497`	`497`	`#[Test]`
`@@ -504,7 +504,7 @@ public function xml_antlers_template_with_xml_layout_will_use_both_and_change_th`
`504`	`504`
`505`	`505`	`$response = $this`
`506`	`506`	`->get('about')`
`507`		`- ->assertHeader('Content-Type', 'text/xml; charset=UTF-8');`
	`507`	`+ ->assertContentType('text/xml; charset=utf-8');`
`508`	`508`
`509`	`509`	`$this->assertEquals('<?xml ?><foo></foo>', $response->getContent());`
`510`	`510`	`}`
`@@ -519,7 +519,7 @@ public function xml_antlers_template_with_non_xml_layout_will_change_content_typ`
`519`	`519`
`520`	`520`	`$response = $this`
`521`	`521`	`->get('about')`
`522`		`- ->assertHeader('Content-Type', 'text/xml; charset=UTF-8');`
	`522`	`+ ->assertContentType('text/xml; charset=utf-8');`
`523`	`523`
`524`	`524`	`$this->assertEquals('<foo></foo>', $response->getContent());`
`525`	`525`	`}`
`@@ -534,7 +534,7 @@ public function xml_antlers_layout_will_change_the_content_type()`
`534`	`534`
`535`	`535`	`$response = $this`
`536`	`536`	`->get('about')`
`537`		`- ->assertHeader('Content-Type', 'text/xml; charset=UTF-8');`
	`537`	`+ ->assertContentType('text/xml; charset=utf-8');`
`538`	`538`
`539`	`539`	`$this->assertEquals('<?xml ?><foo></foo>', $response->getContent());`
`540`	`540`	`}`
`@@ -551,7 +551,7 @@ public function xml_blade_template_will_not_change_content_type()`
`551`	`551`
`552`	`552`	`$response = $this`
`553`	`553`	`->get('about')`
`554`		`- ->assertHeader('Content-Type', 'text/html; charset=UTF-8');`
	`554`	`+ ->assertContentType('text/html; charset=utf-8');`
`555`	`555`
`556`	`556`	`$this->assertEquals('<foo></foo>', $response->getContent());`
`557`	`557`	`}`
`@@ -566,7 +566,7 @@ public function xml_template_with_custom_content_type_does_not_change_to_xml()`
`566`	`566`
`567`	`567`	`$this`
`568`	`568`	`->get('about')`
`569`		`- ->assertHeader('Content-Type', 'application/json');`
	`569`	`+ ->assertContentType('application/json');`
`570`	`570`	`}`
`571`	`571`
`572`	`572`	`#[Test]`