#27198

pending completion

Build # #27198

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/0ba7005d3e7363ddfa05d3614cac1eac72c65927">0ba7005d3<a href="https://github.com/api-platform/core/commit/0ba7005d3e7363ddfa05d3614cac1eac72c65927">">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/eb653f5fdd1b36b225fd6eda4f8b3e4ed4d4c807">eb653f5fd</a>">eb653f5fd</a><a href="https://github.com/api-platform/core/commit/0ba7005d3e7363ddfa05d3614cac1eac72c65927"> into d005f7c23">d005f7c23</a>

Run Details

3 of 3 new or added lines in 1 file covered. (100.0%)

7543 of 12169 relevant lines covered (61.99%)

83.76 hits per line

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

0.0

/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) {
            if ('content-type' === $key) {
                $server['CONTENT_TYPE'] = $value[0] ?? '';

                continue;
            }

            // BrowserKit doesn't support setting several headers with the same name
            $server['HTTP_'.strtoupper(str_replace('-', '_', $key))] = $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}
     * TODO: Delete this when we can use symfony/http-client:^5.3.
     */
    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;	×
68	$kernelBrowser->followRedirects(false);	×
69	if ($defaultOptions) {	×
70	$this->setDefaultOptions($defaultOptions);	×
71	}
72	}	×
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);	×
82	}	×
83
84	/**
85	* {@inheritdoc}
86	*/
87	public function request(string $method, string $url, array $options = []): ResponseInterface
88	{
89	$basic = $options['auth_basic'] ?? null;	×
90	[$url, $options] = self::prepareRequest($method, $url, $options, $this->defaultOptions);	×
91	$resolvedUrl = implode('', $url);	×
92	$server = [];	×
93
94	// Convert headers to a $_SERVER-like array
95	foreach (self::extractHeaders($options) as $key => $value) {	×
96	if ('content-type' === $key) {	×
97	$server['CONTENT_TYPE'] = $value[0] ?? '';	×
98
99	continue;	×
100	}
101
102	// BrowserKit doesn't support setting several headers with the same name
103	$server['HTTP_'.strtoupper(str_replace('-', '_', $key))] = $value[0] ?? '';	×
104	}
105
106	if ($basic) {	×
107	$credentials = \is_array($basic) ? $basic : explode(':', $basic, 2);	×
108	$server['PHP_AUTH_USER'] = $credentials[0];	×
109	$server['PHP_AUTH_PW'] = $credentials[1] ?? '';	×
110	}
111
112	$info = [	×
113	'response_headers' => [],	×
114	'redirect_count' => 0,	×
115	'redirect_url' => null,
116	'start_time' => 0.0,	×
117	'http_method' => $method,	×
118	'http_code' => 0,	×
119	'error' => null,
120	'user_data' => $options['user_data'] ?? null,	×
121	'url' => $resolvedUrl,	×
122	'primary_port' => 'http:' === $url['scheme'] ? 80 : 443,	×
123	];
124	$this->kernelBrowser->request($method, $resolvedUrl, $options['extra']['parameters'] ?? [], $options['extra']['files'] ?? [], $server, $options['body'] ?? null);	×
125
126	return $this->response = new Response($this->kernelBrowser->getResponse(), $this->kernelBrowser->getInternalResponse(), $info);	×
127	}
128
129	/**
130	* {@inheritdoc}
131	*/
132	public function stream($responses, float $timeout = null): ResponseStreamInterface
133	{
134	throw new \LogicException('Not implemented yet');	×
135	}
136
137	/**
138	* Gets the latest response.
139	*
140	* @internal
141	*/
142	public function getResponse(): ?Response
143	{
144	return $this->response;	×
145	}
146
147	/**
148	* Gets the underlying test client.
149	*
150	* @internal
151	*/
152	public function getKernelBrowser(): KernelBrowser
153	{
154	return $this->kernelBrowser;	×
155	}
156
157	// The following methods are proxy methods for KernelBrowser's ones
158
159	/**
160	* Returns the container.
161	*
162	* @return ContainerInterface\|null Returns null when the Kernel has been shutdown or not started yet
163	*/
164	public function getContainer(): ?ContainerInterface
165	{
166	return $this->kernelBrowser->getContainer();	×
167	}
168
169	/**
170	* Returns the CookieJar instance.
171	*/
172	public function getCookieJar(): CookieJar
173	{
174	return $this->kernelBrowser->getCookieJar();	×
175	}
176
177	/**
178	* Returns the kernel.
179	*/
180	public function getKernel(): KernelInterface
181	{
182	return $this->kernelBrowser->getKernel();	×
183	}
184
185	/**
186	* Gets the profile associated with the current Response.
187	*
188	* @return Profile\|false A Profile instance
189	*/
190	public function getProfile()
191	{
192	return $this->kernelBrowser->getProfile();	×
193	}
194
195	/**
196	* Enables the profiler for the very next request.
197	*
198	* If the profiler is not enabled, the call to this method does nothing.
199	*/
200	public function enableProfiler(): void
201	{
202	$this->kernelBrowser->enableProfiler();	×
203	}	×
204
205	/**
206	* Disables kernel reboot between requests.
207	*
208	* By default, the Client reboots the Kernel for each request. This method
209	* allows to keep the same kernel across requests.
210	*/
211	public function disableReboot(): void
212	{
213	$this->kernelBrowser->disableReboot();	×
214	}	×
215
216	/**
217	* Enables kernel reboot between requests.
218	*/
219	public function enableReboot(): void
220	{
221	$this->kernelBrowser->enableReboot();	×
222	}	×
223
224	/**
225	* Extracts headers depending on the symfony/http-client version being used.
226	*
227	* @return array<string, string[]>
228	*/
229	private static function extractHeaders(array $options): array
230	{
231	if (!isset($options['normalized_headers'])) {	×
232	return $options['headers'];	×
233	}
234
235	$headers = [];	×
236
237	/** @var string $key */
238	foreach ($options['normalized_headers'] as $key => $values) {	×
239	foreach ($values as $value) {	×
240	[, $value] = explode(': ', $value, 2);	×
241	$headers[$key][] = $value;	×
242	}
243	}
244
245	return $headers;	×
246	}
247
248	/**
249	* {@inheritdoc}
250	* TODO: Delete this when we can use symfony/http-client:^5.3.
251	*/
252	public function withOptions(array $options): self
253	{
254	$clone = clone $this;	×
255	$clone->defaultOptions = self::mergeDefaultOptions($options, $this->defaultOptions);	×
256
257	return $clone;	×
258	}
259	}

api-platform / core / #27198

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