[HttpClient] Add JsonMockResponse::fromFile() and MockResponse::fromFile() shortcuts

fancyweb · fancyweb · commit e3e831fb80d0 · 2023-12-09T14:35:44.000+01:00
diff --git a/src/Symfony/Component/HttpClient/CHANGELOG.md b/src/Symfony/Component/HttpClient/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+7.1
+---
+
+ * Add `MockResponse::fromFile()` and `JsonMockResponse::fromFile()` methods to help using fixtures files
+ * Add optional argument `bool $json = false` to `JsonMockResponse::__construct()` to allow passing JSON data directly
+
 7.0
 ---
 
diff --git a/src/Symfony/Component/HttpClient/Response/JsonMockResponse.php b/src/Symfony/Component/HttpClient/Response/JsonMockResponse.php
@@ -16,18 +16,35 @@
 class JsonMockResponse extends MockResponse
 {
     /**
-     * @param mixed $body Any value that `json_encode()` can serialize
+     * @param mixed $data Any value that `json_encode()` can serialize
+     * @param bool  $json Whether the data is already a JSON string
      */
-    public function __construct(mixed $body = [], array $info = [])
+    public function __construct(mixed $data = [], array $info = [], bool $json = false)
     {
-        try {
-            $json = json_encode($body, \JSON_THROW_ON_ERROR);
-        } catch (\JsonException $e) {
-            throw new InvalidArgumentException('JSON encoding failed: '.$e->getMessage(), $e->getCode(), $e);
+        if (!$json) {
+            try {
+                $data = json_encode($data, \JSON_THROW_ON_ERROR);
+            } catch (\JsonException $e) {
+                throw new InvalidArgumentException('JSON encoding failed: '.$e->getMessage(), $e->getCode(), $e);
+            }
         }
 
         $info['response_headers']['content-type'] ??= 'application/json';
 
-        parent::__construct($json, $info);
+        parent::__construct($data, $info);
+    }
+
+    public static function fromFile(string $path, array $info = []): static
+    {
+        if (!is_file($path)) {
+            throw new \InvalidArgumentException(sprintf('File not found: "%s".', $path));
+        }
+
+        $json = file_get_contents($path);
+        if (!json_validate($json)) {
+            throw new \InvalidArgumentException(sprintf('File "%s" does not contain valid JSON.', $path));
+        }
+
+        return new static($json, $info, true);
     }
 }
diff --git a/src/Symfony/Component/HttpClient/Response/MockResponse.php b/src/Symfony/Component/HttpClient/Response/MockResponse.php
@@ -64,6 +64,15 @@ public function __construct(string|iterable $body = '', array $info = [])
         self::addResponseHeaders($responseHeaders, $this->info, $this->headers);
     }
 
+    public static function fromFile(string $path, array $info = []): static
+    {
+        if (!is_file($path)) {
+            throw new \InvalidArgumentException(sprintf('File not found: "%s".', $path));
+        }
+
+        return new static(file_get_contents($path), $info);
+    }
+
     /**
      * Returns the options used when doing the request.
      */
diff --git a/src/Symfony/Component/HttpClient/Tests/Response/JsonMockResponseTest.php b/src/Symfony/Component/HttpClient/Tests/Response/JsonMockResponseTest.php
@@ -85,4 +85,25 @@ public static function responseHeadersProvider(): array
             ['application/problem+json', ['x-foo' => 'ccc', 'content-type' => 'application/problem+json']],
         ];
     }
+
+    public function testFromFile()
+    {
+        $client = new MockHttpClient(JsonMockResponse::fromFile(__DIR__.'/Fixtures/response.json'));
+        $response = $client->request('GET', 'https://symfony.com');
+
+        $this->assertSame([
+            'foo' => 'bar',
+        ], $response->toArray());
+        $this->assertSame('application/json', $response->getHeaders()['content-type'][0]);
+    }
+
+    public function testFromFileWithInvalidJson()
+    {
+        $path = __DIR__.'/Fixtures/invalid_json.json';
+
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage(sprintf('File "%s" does not contain valid JSON.', $path));
+
+        JsonMockResponse::fromFile($path);
+    }
 }
diff --git a/src/Symfony/Component/HttpClient/Tests/Response/MockResponseTest.php b/src/Symfony/Component/HttpClient/Tests/Response/MockResponseTest.php
@@ -15,11 +15,9 @@
 use Symfony\Component\HttpClient\Exception\InvalidArgumentException;
 use Symfony\Component\HttpClient\Exception\JsonException;
 use Symfony\Component\HttpClient\Exception\TransportException;
+use Symfony\Component\HttpClient\MockHttpClient;
 use Symfony\Component\HttpClient\Response\MockResponse;
 
-/**
- * Test methods from Symfony\Component\HttpClient\Response\*ResponseTrait.
- */
 class MockResponseTest extends TestCase
 {
     public function testTotalTimeShouldBeSimulatedWhenNotProvided()
@@ -133,4 +131,12 @@ public function testMustBeIssuedByMockHttpClient()
 
         (new MockResponse())->getContent();
     }
+
+    public function testFromFile()
+    {
+        $client = new MockHttpClient(MockResponse::fromFile(__DIR__.'/Fixtures/response.txt'));
+        $response = $client->request('GET', 'https://symfony.com');
+
+        $this->assertSame('foo bar ccc', $response->getContent());
+    }
 }
