#27781

pending completion

Build # #27781

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/682eb8c51d8588d9ddc12e1627be1904296968f8">682eb8c51<a href="https://github.com/api-platform/core/commit/682eb8c51d8588d9ddc12e1627be1904296968f8">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/e2329332afdc5908b6599429ee94f71bb91b64a4">e2329332a</a>">e2329332a</a><a href="https://github.com/api-platform/core/commit/682eb8c51d8588d9ddc12e1627be1904296968f8"> into a9cc84d8d">a9cc84d8d</a>

Run Details

4 of 4 new or added lines in 2 files covered. (100.0%)

9758 of 11679 relevant lines covered (83.55%)

14.77 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.04

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

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test;

use Symfony\Bundle\FrameworkBundle\KernelBrowser;
use Symfony\Component\BrowserKit\CookieJar;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpClient\HttpClientTrait;
use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\HttpKernel\Profiler\Profile;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
use Symfony\Contracts\HttpClient\ResponseStreamInterface;

/**
 * Convenient test client that makes requests to a Kernel object.
 *
 * @experimental
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class Client implements HttpClientInterface
{
    use HttpClientTrait;

    /**
     * @see HttpClientInterface::OPTIONS_DEFAULTS
     */
    public const API_OPTIONS_DEFAULTS = [
        'auth_basic' => null,
        'auth_bearer' => null,
        'query' => [],
        'headers' => ['accept' => ['application/ld+json']],
        'body' => '',
        'json' => null,
        'base_uri' => 'http://example.com',
        'extra' => [],
    ];

    private $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);
        }
    }

    /**
     * Sets the default options for the requests.
     *
     * @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}
     */
    public function request(string $method, string $url, array $options = []): ResponseInterface
    {
        $basic = $options['auth_basic'] ?? null;
        [$url, $options] = self::prepareRequest($method, $url, $options, $this->defaultOptions);
        $resolvedUrl = implode('', $url);
        $server = [];

        // Convert headers to a $_SERVER-like array
        foreach (self::extractHeaders($options) as $key => $value) {
            $normalizedHeaderName = strtoupper(str_replace('-', '_', $key));
            $header = \in_array($normalizedHeaderName, ['CONTENT_TYPE', 'REMOTE_ADDR'], true) ? $normalizedHeaderName : sprintf('HTTP_%s', $normalizedHeaderName);
            // BrowserKit doesn't support setting several headers with the same name
            $server[$header] = $value[0] ?? '';
        }

        if ($basic) {
            $credentials = \is_array($basic) ? $basic : explode(':', $basic, 2);
            $server['PHP_AUTH_USER'] = $credentials[0];
            $server['PHP_AUTH_PW'] = $credentials[1] ?? '';
        }

        $info = [
            'response_headers' => [],
            'redirect_count' => 0,
            'redirect_url' => null,
            'start_time' => 0.0,
            'http_method' => $method,
            'http_code' => 0,
            'error' => null,
            'user_data' => $options['user_data'] ?? null,
            'url' => $resolvedUrl,
            'primary_port' => 'http:' === $url['scheme'] ? 80 : 443,
        ];
        $this->kernelBrowser->request($method, $resolvedUrl, $options['extra']['parameters'] ?? [], $options['extra']['files'] ?? [], $server, $options['body'] ?? null);

        return $this->response = new Response($this->kernelBrowser->getResponse(), $this->kernelBrowser->getInternalResponse(), $info);
    }

    /**
     * {@inheritdoc}
     */
    public function stream($responses, float $timeout = null): ResponseStreamInterface
    {
        throw new \LogicException('Not implemented yet');
    }

    /**
     * Gets the latest response.
     *
     * @internal
     */
    public function getResponse(): ?Response
    {
        return $this->response;
    }

    /**
     * Gets the underlying test client.
     *
     * @internal
     */
    public function getKernelBrowser(): KernelBrowser
    {
        return $this->kernelBrowser;
    }

    // The following methods are proxy methods for KernelBrowser's ones

    /**
     * Returns the container.
     *
     * @return ContainerInterface|null Returns null when the Kernel has been shutdown or not started yet
     */
    public function getContainer(): ?ContainerInterface
    {
        return $this->kernelBrowser->getContainer();
    }

    /**
     * Returns the CookieJar instance.
     */
    public function getCookieJar(): CookieJar
    {
        return $this->kernelBrowser->getCookieJar();
    }

    /**
     * Returns the kernel.
     */
    public function getKernel(): KernelInterface
    {
        return $this->kernelBrowser->getKernel();
    }

    /**
     * Gets the profile associated with the current Response.
     *
     * @return Profile|false A Profile instance
     */
    public function getProfile()
    {
        return $this->kernelBrowser->getProfile();
    }

    /**
     * Enables the profiler for the very next request.
     *
     * If the profiler is not enabled, the call to this method does nothing.
     */
    public function enableProfiler(): void
    {
        $this->kernelBrowser->enableProfiler();
    }

    /**
     * Disables kernel reboot between requests.
     *
     * By default, the Client reboots the Kernel for each request. This method
     * allows to keep the same kernel across requests.
     */
    public function disableReboot(): void
    {
        $this->kernelBrowser->disableReboot();
    }

    /**
     * Enables kernel reboot between requests.
     */
    public function enableReboot(): void
    {
        $this->kernelBrowser->enableReboot();
    }

    /**
     * Extracts headers depending on the symfony/http-client version being used.
     *
     * @return array<string, string[]>
     */
    private static function extractHeaders(array $options): array
    {
        if (!isset($options['normalized_headers'])) {
            return $options['headers'];
        }

        $headers = [];

        /** @var string $key */
        foreach ($options['normalized_headers'] as $key => $values) {
            foreach ($values as $value) {
                [, $value] = explode(': ', $value, 2);
                $headers[$key][] = $value;
            }
        }

        return $headers;
    }

    /**
     * {@inheritdoc}
     */
    public function withOptions(array $options): self
    {
        $clone = clone $this;
        $clone->defaultOptions = self::mergeDefaultOptions($options, $this->defaultOptions);

        return $clone;
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test;
15
16	use Symfony\Bundle\FrameworkBundle\KernelBrowser;
17	use Symfony\Component\BrowserKit\CookieJar;
18	use Symfony\Component\DependencyInjection\ContainerInterface;
19	use Symfony\Component\HttpClient\HttpClientTrait;
20	use Symfony\Component\HttpKernel\KernelInterface;
21	use Symfony\Component\HttpKernel\Profiler\Profile;
22	use Symfony\Contracts\HttpClient\HttpClientInterface;
23	use Symfony\Contracts\HttpClient\ResponseInterface;
24	use Symfony\Contracts\HttpClient\ResponseStreamInterface;
25
26	/**
27	* Convenient test client that makes requests to a Kernel object.
28	*
29	* @experimental
30	*
31	* @author Kévin Dunglas <dunglas@gmail.com>
32	*/
33	final class Client implements HttpClientInterface
34	{
35	use HttpClientTrait;
36
37	/**
38	* @see HttpClientInterface::OPTIONS_DEFAULTS
39	*/
40	public const API_OPTIONS_DEFAULTS = [
41	'auth_basic' => null,
42	'auth_bearer' => null,
43	'query' => [],
44	'headers' => ['accept' => ['application/ld+json']],
45	'body' => '',
46	'json' => null,
47	'base_uri' => 'http://example.com',
48	'extra' => [],
49	];
50
51	private $kernelBrowser;
52
53	private $defaultOptions = self::API_OPTIONS_DEFAULTS;
54
55	/**
56	* @var Response
57	*/
58	private $response;
59
60	/**
61	* @param array $defaultOptions Default options for the requests
62	*
63	* @see HttpClientInterface::OPTIONS_DEFAULTS for available options
64	*/
65	public function __construct(KernelBrowser $kernelBrowser, array $defaultOptions = [])
66	{
67	$this->kernelBrowser = $kernelBrowser;	18✔
68	$kernelBrowser->followRedirects(false);	18✔
69	if ($defaultOptions) {	18✔
70	$this->setDefaultOptions($defaultOptions);	×
71	}
72	}	18✔
73
74	/**
75	* Sets the default options for the requests.
76	*
77	* @see HttpClientInterface::OPTIONS_DEFAULTS for available options
78	*/
79	public function setDefaultOptions(array $defaultOptions): void
80	{
81	[, $this->defaultOptions] = self::prepareRequest(null, null, $defaultOptions, self::API_OPTIONS_DEFAULTS);	18✔
82	}	18✔
83
84	/**
85	* {@inheritdoc}
86	*/
87	public function request(string $method, string $url, array $options = []): ResponseInterface
88	{
89	$basic = $options['auth_basic'] ?? null;	17✔
90	[$url, $options] = self::prepareRequest($method, $url, $options, $this->defaultOptions);	17✔
91	$resolvedUrl = implode('', $url);	17✔
92	$server = [];	17✔
93
94	// Convert headers to a $_SERVER-like array
95	foreach (self::extractHeaders($options) as $key => $value) {	17✔
96	$normalizedHeaderName = strtoupper(str_replace('-', '_', $key));	17✔
97	$header = \in_array($normalizedHeaderName, ['CONTENT_TYPE', 'REMOTE_ADDR'], true) ? $normalizedHeaderName : sprintf('HTTP_%s', $normalizedHeaderName);	17✔
98	// BrowserKit doesn't support setting several headers with the same name
99	$server[$header] = $value[0] ?? '';	17✔
100	}
101
102	if ($basic) {	17✔
103	$credentials = \is_array($basic) ? $basic : explode(':', $basic, 2);	3✔
104	$server['PHP_AUTH_USER'] = $credentials[0];	3✔
105	$server['PHP_AUTH_PW'] = $credentials[1] ?? '';	3✔
106	}
107
108	$info = [	17✔
109	'response_headers' => [],	17✔
110	'redirect_count' => 0,	17✔
111	'redirect_url' => null,
112	'start_time' => 0.0,	17✔
113	'http_method' => $method,	17✔
114	'http_code' => 0,	17✔
115	'error' => null,
116	'user_data' => $options['user_data'] ?? null,	17✔
117	'url' => $resolvedUrl,	17✔
118	'primary_port' => 'http:' === $url['scheme'] ? 80 : 443,	17✔
119	];
120	$this->kernelBrowser->request($method, $resolvedUrl, $options['extra']['parameters'] ?? [], $options['extra']['files'] ?? [], $server, $options['body'] ?? null);	17✔
121
122	return $this->response = new Response($this->kernelBrowser->getResponse(), $this->kernelBrowser->getInternalResponse(), $info);	17✔
123	}
124
125	/**
126	* {@inheritdoc}
127	*/
128	public function stream($responses, float $timeout = null): ResponseStreamInterface
129	{
130	throw new \LogicException('Not implemented yet');	1✔
131	}
132
133	/**
134	* Gets the latest response.
135	*
136	* @internal
137	*/
138	public function getResponse(): ?Response
139	{
140	return $this->response;	9✔
141	}
142
143	/**
144	* Gets the underlying test client.
145	*
146	* @internal
147	*/
148	public function getKernelBrowser(): KernelBrowser
149	{
150	return $this->kernelBrowser;	18✔
151	}
152
153	// The following methods are proxy methods for KernelBrowser's ones
154
155	/**
156	* Returns the container.
157	*
158	* @return ContainerInterface\|null Returns null when the Kernel has been shutdown or not started yet
159	*/
160	public function getContainer(): ?ContainerInterface
161	{
162	return $this->kernelBrowser->getContainer();	×
163	}
164
165	/**
166	* Returns the CookieJar instance.
167	*/
168	public function getCookieJar(): CookieJar
169	{
170	return $this->kernelBrowser->getCookieJar();	×
171	}
172
173	/**
174	* Returns the kernel.
175	*/
176	public function getKernel(): KernelInterface
177	{
178	return $this->kernelBrowser->getKernel();	1✔
179	}
180
181	/**
182	* Gets the profile associated with the current Response.
183	*
184	* @return Profile\|false A Profile instance
185	*/
186	public function getProfile()
187	{
188	return $this->kernelBrowser->getProfile();	1✔
189	}
190
191	/**
192	* Enables the profiler for the very next request.
193	*
194	* If the profiler is not enabled, the call to this method does nothing.
195	*/
196	public function enableProfiler(): void
197	{
198	$this->kernelBrowser->enableProfiler();	1✔
199	}	1✔
200
201	/**
202	* Disables kernel reboot between requests.
203	*
204	* By default, the Client reboots the Kernel for each request. This method
205	* allows to keep the same kernel across requests.
206	*/
207	public function disableReboot(): void
208	{
209	$this->kernelBrowser->disableReboot();	2✔
210	}	2✔
211
212	/**
213	* Enables kernel reboot between requests.
214	*/
215	public function enableReboot(): void
216	{
217	$this->kernelBrowser->enableReboot();	2✔
218	}	2✔
219
220	/**
221	* Extracts headers depending on the symfony/http-client version being used.
222	*
223	* @return array<string, string[]>
224	*/
225	private static function extractHeaders(array $options): array
226	{
227	if (!isset($options['normalized_headers'])) {	17✔
228	return $options['headers'];	×
229	}
230
231	$headers = [];	17✔
232
233	/** @var string $key */
234	foreach ($options['normalized_headers'] as $key => $values) {	17✔
235	foreach ($values as $value) {	17✔
236	[, $value] = explode(': ', $value, 2);	17✔
237	$headers[$key][] = $value;	17✔
238	}
239	}
240
241	return $headers;	17✔
242	}
243
244	/**
245	* {@inheritdoc}
246	*/
247	public function withOptions(array $options): self
248	{
249	$clone = clone $this;	×
250	$clone->defaultOptions = self::mergeDefaultOptions($options, $this->defaultOptions);	×
251
252	return $clone;	×
253	}
254	}

api-platform / core / #27781

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous