7142557150

Committed 08 Dec 2023 02:28PM UTC coverage: 36.003% (-1.4%) from 37.36%

Build # 7142557150

Build Type

push

github

Committed by

web-flow

Commit Message

fix(jsonld): remove link to ApiDocumentation when doc is disabled (#6029)

Run Details

0 of 1 new or added line in 1 file covered. (0.0%)

2297 existing lines in 182 files now uncovered.

9992 of 27753 relevant lines covered (36.0%)

147.09 hits per line

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

0.0

/src/HttpCache/Tests/SouinPurgerTest.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\HttpCache\Tests;

use ApiPlatform\HttpCache\SouinPurger;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\Promise\PromiseInterface;
use GuzzleHttp\Psr7\Response;
use PHPUnit\Framework\TestCase;
use Prophecy\PhpUnit\ProphecyTrait;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Contracts\HttpClient\HttpClientInterface;

/**
 * @author Sylvain Combraque <darkweak@protonmail.com>
 */
class SouinPurgerTest extends TestCase
{
    use ProphecyTrait;

    public function testPurge(): void
    {
        $clientProphecy1 = $this->prophesize(HttpClientInterface::class);
        $clientProphecy1->request('PURGE', '', ['headers' => ['Surrogate-Key' => '/foo']])->shouldBeCalled();
        $clientProphecy1->request('PURGE', '', ['headers' => ['Surrogate-Key' => '/foo, /bar']])->shouldBeCalled();

        $clientProphecy2 = $this->prophesize(HttpClientInterface::class);
        $clientProphecy2->request('PURGE', '', ['headers' => ['Surrogate-Key' => '/foo']])->shouldBeCalled();
        $clientProphecy2->request('PURGE', '', ['headers' => ['Surrogate-Key' => '/foo, /bar']])->shouldBeCalled();

        $purger = new SouinPurger([$clientProphecy1->reveal(), $clientProphecy2->reveal()]);
        $purger->purge(['/foo']);
        $purger->purge(['/foo' => '/foo', '/bar' => '/bar']);
    }

    private function generateXResourcesTags(int $number, int $minimum = 0): array
    {
        $stack = [];

        for ($i = $minimum; $i < $number; ++$i) {
            $stack[] = sprintf('/tags/%d', $i);
        }

        return $stack;
    }

    public function testMultiChunkedTags(): void
    {
        /** @var HttpClientInterface $client */
        $client = new class() implements ClientInterface {
            public array $sentRegexes = [];

            public function send(RequestInterface $request, array $options = []): ResponseInterface
            {
                throw new \LogicException('Not implemented');
            }

            public function sendAsync(RequestInterface $request, array $options = []): PromiseInterface
            {
                throw new \LogicException('Not implemented');
            }

            public function request($method, $uri, array $options = []): ResponseInterface
            {
                $this->sentRegexes[] = $options['headers']['Surrogate-Key'];

                return new Response();
            }

            public function requestAsync($method, $uri, array $options = []): PromiseInterface
            {
                throw new \LogicException('Not implemented');
            }

            public function getConfig($option = null): void
            {
                throw new \LogicException('Not implemented');
            }
        };
        $purger = new SouinPurger([$client]);
        $purger->purge($this->generateXResourcesTags(200));

        self::assertSame([
            implode(', ', $this->generateXResourcesTags(146)),
            implode(', ', $this->generateXResourcesTags(200, 146)),
        ], $client->sentRegexes); // @phpstan-ignore-line
    }

    public function testPurgeWithMultipleClients(): void
    {
        /** @var HttpClientInterface $client1 */
        $client1 = new class() implements ClientInterface {
            public $requests = [];

            public function send(RequestInterface $request, array $options = []): ResponseInterface
            {
                throw new \LogicException('Not implemented');
            }

            public function sendAsync(RequestInterface $request, array $options = []): PromiseInterface
            {
                throw new \LogicException('Not implemented');
            }

            public function request($method, $uri, array $options = []): ResponseInterface
            {
                $this->requests[] = [$method, 'http://dummy_host/dummy_api_path/souin_api', $options];

                return new Response();
            }

            public function requestAsync($method, $uri, array $options = []): PromiseInterface
            {
                throw new \LogicException('Not implemented');
            }

            public function getConfig($option = null): void
            {
                throw new \LogicException('Not implemented');
            }
        };
        /** @var HttpClientInterface $client2 */
        $client2 = new class() implements ClientInterface {
            public $requests = [];

            public function send(RequestInterface $request, array $options = []): ResponseInterface
            {
                throw new \LogicException('Not implemented');
            }

            public function sendAsync(RequestInterface $request, array $options = []): PromiseInterface
            {
                throw new \LogicException('Not implemented');
            }

            public function request($method, $uri, array $options = []): ResponseInterface
            {
                $this->requests[] = [$method, 'http://dummy_host/dummy_api_path/souin_api', $options];

                return new Response();
            }

            public function requestAsync($method, $uri, array $options = []): PromiseInterface
            {
                throw new \LogicException('Not implemented');
            }

            public function getConfig($option = null): void
            {
                throw new \LogicException('Not implemented');
            }
        };

        $purger = new SouinPurger([$client1, $client2]);
        $purger->purge(['/foo']);
        self::assertSame([
            Request::METHOD_PURGE,
            'http://dummy_host/dummy_api_path/souin_api',
            ['headers' => ['Surrogate-Key' => '/foo']],
        ], $client1->requests[0]); // @phpstan-ignore-line
        self::assertSame([
            Request::METHOD_PURGE,
            'http://dummy_host/dummy_api_path/souin_api',
            ['headers' => ['Surrogate-Key' => '/foo']],
        ], $client2->requests[0]); // @phpstan-ignore-line
    }

    public function testGetResponseHeaders(): void
    {
        $purger = new SouinPurger([]);
        self::assertSame(['Surrogate-Key' => ''], $purger->getResponseHeaders([]));
        self::assertSame(['Surrogate-Key' => 'first-value/, second'], $purger->getResponseHeaders(['first-value/', 'second']));
        self::assertSame(['Surrogate-Key' => 'C0mplex_Value/, The value with spaces'], $purger->getResponseHeaders(['C0mplex_Value/', 'The value with spaces']));
    }
}

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\HttpCache\Tests;
15
16	use ApiPlatform\HttpCache\SouinPurger;
17	use GuzzleHttp\ClientInterface;
18	use GuzzleHttp\Promise\PromiseInterface;
19	use GuzzleHttp\Psr7\Response;
20	use PHPUnit\Framework\TestCase;
21	use Prophecy\PhpUnit\ProphecyTrait;
22	use Psr\Http\Message\RequestInterface;
23	use Psr\Http\Message\ResponseInterface;
24	use Symfony\Component\HttpFoundation\Request;
25	use Symfony\Contracts\HttpClient\HttpClientInterface;
26
27	/**
28	* @author Sylvain Combraque <darkweak@protonmail.com>
29	*/
30	class SouinPurgerTest extends TestCase
31	{
32	use ProphecyTrait;
33
34	public function testPurge(): void
35	{
36	$clientProphecy1 = $this->prophesize(HttpClientInterface::class);	×
37	$clientProphecy1->request('PURGE', '', ['headers' => ['Surrogate-Key' => '/foo']])->shouldBeCalled();	×
38	$clientProphecy1->request('PURGE', '', ['headers' => ['Surrogate-Key' => '/foo, /bar']])->shouldBeCalled();	×
39
40	$clientProphecy2 = $this->prophesize(HttpClientInterface::class);	×
41	$clientProphecy2->request('PURGE', '', ['headers' => ['Surrogate-Key' => '/foo']])->shouldBeCalled();	×
42	$clientProphecy2->request('PURGE', '', ['headers' => ['Surrogate-Key' => '/foo, /bar']])->shouldBeCalled();	×
43
44	$purger = new SouinPurger([$clientProphecy1->reveal(), $clientProphecy2->reveal()]);	×
45	$purger->purge(['/foo']);	×
46	$purger->purge(['/foo' => '/foo', '/bar' => '/bar']);	×
47	}
48
49	private function generateXResourcesTags(int $number, int $minimum = 0): array
50	{
51	$stack = [];	×
52
53	for ($i = $minimum; $i < $number; ++$i) {	×
54	$stack[] = sprintf('/tags/%d', $i);	×
55	}
56
57	return $stack;	×
58	}
59
60	public function testMultiChunkedTags(): void
61	{
62	/** @var HttpClientInterface $client */
63	$client = new class() implements ClientInterface {	×
64	public array $sentRegexes = [];
65
UNCOV 66	public function send(RequestInterface $request, array $options = []): ResponseInterface	×
67	{
68	throw new \LogicException('Not implemented');	×
69	}
70
UNCOV 71	public function sendAsync(RequestInterface $request, array $options = []): PromiseInterface	×
72	{
73	throw new \LogicException('Not implemented');	×
74	}
75
UNCOV 76	public function request($method, $uri, array $options = []): ResponseInterface	×
77	{
78	$this->sentRegexes[] = $options['headers']['Surrogate-Key'];	×
79
80	return new Response();	×
81	}
82
UNCOV 83	public function requestAsync($method, $uri, array $options = []): PromiseInterface	×
84	{
85	throw new \LogicException('Not implemented');	×
86	}
87
88	public function getConfig($option = null): void
89	{
90	throw new \LogicException('Not implemented');	×
91	}
92	};	×
93	$purger = new SouinPurger([$client]);	×
94	$purger->purge($this->generateXResourcesTags(200));	×
95
96	self::assertSame([	×
97	implode(', ', $this->generateXResourcesTags(146)),	×
98	implode(', ', $this->generateXResourcesTags(200, 146)),	×
99	], $client->sentRegexes); // @phpstan-ignore-line	×
100	}
101
102	public function testPurgeWithMultipleClients(): void
103	{
104	/** @var HttpClientInterface $client1 */
105	$client1 = new class() implements ClientInterface {	×
106	public $requests = [];
107
UNCOV 108	public function send(RequestInterface $request, array $options = []): ResponseInterface	×
109	{
110	throw new \LogicException('Not implemented');	×
111	}
112
UNCOV 113	public function sendAsync(RequestInterface $request, array $options = []): PromiseInterface	×
114	{
115	throw new \LogicException('Not implemented');	×
116	}
117
UNCOV 118	public function request($method, $uri, array $options = []): ResponseInterface	×
119	{
120	$this->requests[] = [$method, 'http://dummy_host/dummy_api_path/souin_api', $options];	×
121
122	return new Response();	×
123	}
124
UNCOV 125	public function requestAsync($method, $uri, array $options = []): PromiseInterface	×
126	{
127	throw new \LogicException('Not implemented');	×
128	}
129
130	public function getConfig($option = null): void
131	{
132	throw new \LogicException('Not implemented');	×
133	}
134	};	×
135	/** @var HttpClientInterface $client2 */
136	$client2 = new class() implements ClientInterface {	×
137	public $requests = [];
138
UNCOV 139	public function send(RequestInterface $request, array $options = []): ResponseInterface	×
140	{
141	throw new \LogicException('Not implemented');	×
142	}
143
UNCOV 144	public function sendAsync(RequestInterface $request, array $options = []): PromiseInterface	×
145	{
146	throw new \LogicException('Not implemented');	×
147	}
148
UNCOV 149	public function request($method, $uri, array $options = []): ResponseInterface	×
150	{
151	$this->requests[] = [$method, 'http://dummy_host/dummy_api_path/souin_api', $options];	×
152
153	return new Response();	×
154	}
155
UNCOV 156	public function requestAsync($method, $uri, array $options = []): PromiseInterface	×
157	{
158	throw new \LogicException('Not implemented');	×
159	}
160
161	public function getConfig($option = null): void
162	{
163	throw new \LogicException('Not implemented');	×
164	}
165	};	×
166
167	$purger = new SouinPurger([$client1, $client2]);	×
168	$purger->purge(['/foo']);	×
169	self::assertSame([	×
170	Request::METHOD_PURGE,	×
171	'http://dummy_host/dummy_api_path/souin_api',	×
172	['headers' => ['Surrogate-Key' => '/foo']],	×
173	], $client1->requests[0]); // @phpstan-ignore-line	×
174	self::assertSame([	×
175	Request::METHOD_PURGE,	×
176	'http://dummy_host/dummy_api_path/souin_api',	×
177	['headers' => ['Surrogate-Key' => '/foo']],	×
178	], $client2->requests[0]); // @phpstan-ignore-line	×
179	}
180
181	public function testGetResponseHeaders(): void
182	{
183	$purger = new SouinPurger([]);	×
184	self::assertSame(['Surrogate-Key' => ''], $purger->getResponseHeaders([]));	×
185	self::assertSame(['Surrogate-Key' => 'first-value/, second'], $purger->getResponseHeaders(['first-value/', 'second']));	×
186	self::assertSame(['Surrogate-Key' => 'C0mplex_Value/, The value with spaces'], $purger->getResponseHeaders(['C0mplex_Value/', 'The value with spaces']));	×
187	}
188	}

api-platform / core / 7142557150

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