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

Author: fancyweb

CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Allow mocking `start_time` info in `MockResponse`
+ * Add `MockResponse::fromFile()` and `JsonMockResponse::fromFile()` methods to help using fixtures files
 
 7.0
 ---

Response/JsonMockResponse.php

@@ -30,4 +30,18 @@ public function __construct(mixed $body = [], array $info = [])
 
         parent::__construct($json, $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_decode($json, true, flags: \JSON_THROW_ON_ERROR), $info);
+    }
 }

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.
      */

Tests/Response/Fixtures/invalid_json.json

@@ -0,0 +1 @@
+foo ccc

Tests/Response/Fixtures/response.json

@@ -0,0 +1,3 @@
+{
+  "foo": "bar"
+}

Tests/Response/Fixtures/response.txt

@@ -0,0 +1 @@
+foo bar ccc

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);
+    }
 }

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());
+    }
 }