Merge pull request #2935 from teohhanhui/feature/http-client-default-options

Allow setting default options on the test Client

Author: teohhanhui

src/Bridge/Symfony/Bundle/Test/ApiTestCase.php

@@ -37,11 +37,12 @@ protected function doTearDown(): void
     /**
      * Creates a Client.
      *
-     * @param array $options An array of options to pass to the createKernel method
+     * @param array $kernelOptions  Options to pass to the createKernel method
+     * @param array $defaultOptions Default options for the requests
      */
-    protected static function createClient(array $options = []): Client
+    protected static function createClient(array $kernelOptions = [], array $defaultOptions = []): Client
     {
-        $kernel = static::bootKernel($options);
+        $kernel = static::bootKernel($kernelOptions);
 
         try {
             /**
@@ -55,6 +56,8 @@ protected static function createClient(array $options = []): Client
             throw new \LogicException('You cannot create the client used in functional tests if the BrowserKit component is not available. Try running "composer require symfony/browser-kit".');
         }
 
+        $client->setDefaultOptions($defaultOptions);
+
         self::getHttpClient($client);
         self::getClient($client->getKernelBrowser());
 

src/Bridge/Symfony/Bundle/Test/Client.php

@@ -31,15 +31,12 @@
  */
 final class Client implements HttpClientInterface
 {
-    /**
-     * @var Response
-     */
-    private $response;
+    use HttpClientTrait;
 
     /**
      * @see HttpClientInterface::OPTIONS_DEFAULTS
      */
-    public const OPTIONS_DEFAULT = [
+    public const API_OPTIONS_DEFAULTS = [
         'auth_basic' => null,
         'auth_bearer' => null,
         'query' => [],
@@ -49,27 +46,48 @@ final class Client implements HttpClientInterface
         'base_uri' => 'http://example.com',
     ];
 
-    use HttpClientTrait;
-
     private $kernelBrowser;
 
-    public function __construct(KernelBrowser $kernelBrowser)
+    private $defaultOptions = self::API_OPTIONS_DEFAULTS;
+
+    /**
+     * @var Response
+     */
+    private $response;
+
+    /**
+     * @param array $defaultOptions Default options for the requests
+     *
+     * @see HttpClientInterface::OPTIONS_DEFAULTS for available options
+     */
+    public function __construct(KernelBrowser $kernelBrowser, array $defaultOptions = [])
     {
         $this->kernelBrowser = $kernelBrowser;
         $kernelBrowser->followRedirects(false);
+        if ($defaultOptions) {
+            $this->setDefaultOptions($defaultOptions);
+        }
     }
 
     /**
-     * {@inheritdoc}
+     * Sets the default options for the requests.
      *
-     * @see Client::OPTIONS_DEFAULTS for available options
+     * @see HttpClientInterface::OPTIONS_DEFAULTS for available options
+     */
+    public function setDefaultOptions(array $defaultOptions): void
+    {
+        [, $this->defaultOptions] = self::prepareRequest(null, null, $defaultOptions, self::API_OPTIONS_DEFAULTS);
+    }
+
+    /**
+     * {@inheritdoc}
      *
      * @return Response
      */
     public function request(string $method, string $url, array $options = []): ResponseInterface
     {
         $basic = $options['auth_basic'] ?? null;
-        [$url, $options] = self::prepareRequest($method, $url, $options, self::OPTIONS_DEFAULT);
+        [$url, $options] = self::prepareRequest($method, $url, $options, $this->defaultOptions);
         $resolvedUrl = implode('', $url);
 
         $server = [];

tests/Bridge/Symfony/Bundle/Test/ClientTest.php

@@ -67,6 +67,25 @@ public function testCustomHeader(): void
         $this->assertStringContainsString('<name>Kevin</name>', $response->getContent());
     }
 
+    public function testDefaultHeaders(): void
+    {
+        $client = self::createClient([], [
+            'headers' => [
+                'content-type' => 'application/json',
+                'accept' => 'text/xml',
+            ],
+        ]);
+        $client->disableReboot();
+
+        $response = $client->request('POST', '/dummies', [
+            'body' => '{"name": "Kevin"}',
+        ]);
+
+        $this->assertSame('application/xml; charset=utf-8', $response->getHeaders()['content-type'][0]);
+        $this->assertResponseHeaderSame('content-type', 'application/xml; charset=utf-8');
+        $this->assertStringContainsString('<name>Kevin</name>', $response->getContent());
+    }
+
     /**
      * @dataProvider authBasicProvider
      */