#28157

pending completion

Build # #28157

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/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/ec63dae2b61d205794d71906100edb35d01f54a2">ec63dae2b<a href="https://github.com/api-platform/core/commit/ec63dae2b61d205794d71906100edb35d01f54a2">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/api-platform/core/commit/ec63dae2b61d205794d71906100edb35d01f54a2&quot;&gt;ec63dae2b&lt;/a&gt;&lt;a href=&quot;https://github.com/api-platform/core/commit/ec63dae2b61d205794d71906100edb35d01f54a2&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/ec63dae2b61d205794d71906100edb35&lt;/a&gt;d01f54a2">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/55cebf191f6754f0fffbf9bc699369991218fdc7">55cebf191</a><a href="https://github.com/api-platform/core/commit/ec63dae2b61d205794d71906100edb35d01f54a2">&amp;quot;&amp;gt;55cebf191&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;55cebf191&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/ec63dae2b61d205794d71906100edb35d01f5&lt;/a&gt;4a2&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/8cc452c1f">8cc452c1f">8cc452c1f</a>

Run Details

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

13179 of 16539 relevant lines covered (79.68%)

14.8 hits per line

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

86.21

/src/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\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\Component\Security\Core\User\UserInterface;
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://localhost',
        '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;
    }

    public function loginUser(UserInterface $user, string $firewallContext = 'main'): self
    {
        if (!method_exists($this->kernelBrowser, 'loginUser')) {
            throw new \LogicException(sprintf('"%s" requires symfony/framework-bundle 5.1+ to be installed.', __METHOD__));
        }

        $this->kernelBrowser->loginUser($user, $firewallContext);

        return $this;
    }
}

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

api-platform / core / #28157

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