fix(response): 🐛 assertContentType(), document(), json() considers charset and boundary directives

Author: stein197

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2.0.1 - 2025-05-25
+### Fixed
+- `assertContentType(string $contentType)`, `document()` and `json()` methods don't fail when the header contains charset or boundary directives
+
 ## 2.0.0 - 2025-05-18
 ### Changed
 - Trait and interface names: `TestCase -> ExtendedTestCase`, `ExtendedTestCase -> ExtendedTestCaseInterface`

src/Assert/ResponseAssert.php

@@ -11,6 +11,7 @@
 use function explode;
 use function join;
 use function preg_split;
+use function strcasecmp;
 use function trim;
 use const PREG_SPLIT_NO_EMPTY;
 
@@ -130,7 +131,8 @@ public function assertContentNotRegex(string $regex): void {
 	 * ```
 	 */
 	public function assertContentType(string $contentType): void {
-		$this->assertHeaderEquals('Content-Type', $contentType);
+		$actualType = $this->getResponseContentType();
+		$this->test->assertEquals(0, strcasecmp($actualType, $contentType), "Expected the response to have the header \"Content-Type\" with value \"{$contentType}\", actual: \"{$actualType}\"");
 	}
 
 	/**
@@ -349,10 +351,10 @@ public function assertJson(): void {
 	public function document(bool $error = false): DocumentAssert {
 		if ($this->doc)
 			return $this->doc;
-		$contentType = @$this->response->getHeader('Content-Type')[0];
-		if ($contentType === 'text/html')
+		$contentType = $this->getResponseContentType();
+		if (strcasecmp($contentType, 'text/html') === 0)
 			return $this->doc = $this->test->html($this->getResponseContents(), $error);
-		if ($contentType === 'text/xml')
+		if (strcasecmp($contentType, 'text/xml') === 0)
 			return $this->doc = $this->test->xml($this->getResponseContents(), $error);
 		$this->test->fail("Expected the response to have content-type of either \"text/html\" or \"text/xml\", actual: \"{$contentType}\"");
 	}
@@ -368,8 +370,8 @@ public function document(bool $error = false): DocumentAssert {
 	public function json(): JsonAssert {
 		if ($this->json)
 			return $this->json;
-		$contentType = @$this->response->getHeader('Content-Type')[0];
-		if ($contentType === 'application/json')
+		$contentType = $this->getResponseContentType();
+		if (strcasecmp($contentType, 'application/json') === 0)
 			return $this->json = $this->test->json($this->getResponseContents());
 		$this->test->fail("Expected the response to have content-type \"application/json\", actual: \"{$contentType}\"");
 	}
@@ -389,4 +391,10 @@ private function getResponseCookies(): array {
 		}
 		return $result;
 	}
+
+	private function getResponseContentType(): string {
+		$values = $this->response->getHeader('Content-Type');
+		$header = $values ? $values[0] : '';
+		return preg_split('/\\s*;\\s*/', $header)[0];
+	}
 }

test/Assert/ResponseAssertTest.php

@@ -125,6 +125,11 @@ public function testAssertContentType(?string $exceptionMessage, ResponseInterfa
 	public static function dataAssertContentType(): array {
 		return [
 			'passed' => [null, new Response(200, ['Content-Type' => 'text/html']), 'text/html'],
+			'passed with charset without space' => [null, new Response(200, ['content-type' => 'text/html;charset=utf-8']), 'text/html'],
+			'passed with charset and space' => [null, new Response(200, ['content-type' => 'text/html; charset=utf-8']), 'text/html'],
+			'passed with boundary without space' => [null, new Response(200, ['content-type' => 'text/html;boundary=----']), 'text/html'],
+			'passed with boundary and space' => [null, new Response(200, ['content-type' => 'text/html; boundary=----']), 'text/html'],
+			'passed with charset and boundary' => [null, new Response(200, ['content-type' => 'text/html;charset=utf-8;boundary=----']), 'text/html'],
 			'failed' => ['Expected the response to have the header "Content-Type" with value "text/html", actual: ""', new Response(200), 'text/html'],
 		];
 	}
@@ -386,6 +391,8 @@ public static function dataDocument(): array {
 			'XML failed' => ['Expected to find at least one element matching the query "//body/p"', new Response(200, ['Content-Type' => 'text/xml'], '<body></body>'), '//body/p'],
 			'invalid content-type' => ['Expected the response to have content-type of either "text/html" or "text/xml", actual: "text/plain"', new Response(200, ['Content-Type' => 'text/plain'], '<body><p></p></body>'), '//body/p'],
 			'no content-type' => ['Expected the response to have content-type of either "text/html" or "text/xml", actual: ""', new Response(200, [], '<body><p></p></body>'), '//body/p'],
+			'text/html + charset' => [null, new Response(200, ['Content-Type' => 'text/html; charset=utf-8'], '<body><p></p></body>'), '//body/p'],
+			'text/xml + charset' => [null, new Response(200, ['Content-Type' => 'text/xml; charset=utf-8'], '<body><p></p></body>'), '//body/p'],
 		];
 	}
 
@@ -405,6 +412,7 @@ public static function dataJson(): array {
 			'invalid content-type' => ['Expected the response to have content-type "application/json", actual: "text/plain"', new Response(200, ['Content-Type' => 'text/plain'], '{}'), '$.user', 2],
 			'no content-type' => ['Expected the response to have content-type "application/json", actual: ""', new Response(200, [], '{}'), '$.user', 2],
 			'invalid JSON' => ['string does not contain a valid JSON object', new Response(200, ['Content-Type' => 'application/json'], '{"user":'), '$.user', 2],
+			'content-type + encoding' => [null, new Response(200, ['Content-Type' => 'application/json;charset=utf-8'], '{"user": [{}, {}]}'), '$.user[*]', 2]
 		];
 	}