#26064

pending completion

Build # #26064

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/d0a26446214fcf63641d952b29023f4a3a6480ae">d0a264462<a href="https://github.com/api-platform/core/commit/d0a26446214fcf63641d952b29023f4a3a6480ae">">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/9b7d7511ab4915e930c73d80843dfcb68e924316">9b7d7511a</a>">9b7d7511a</a><a href="https://github.com/api-platform/core/commit/d0a26446214fcf63641d952b29023f4a3a6480ae"> into 457208a4a">457208a4a</a>

Run Details

8183 of 9689 relevant lines covered (84.46%)

14.88 hits per line

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

96.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\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}
     *
     * @return Response
     */
    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 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;
    }
}

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

api-platform / core / #26064

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