2018-09-29 01:16:40 -05:00
|
|
|
<?php
|
2019-10-05 10:26:10 -05:00
|
|
|
|
2018-09-29 01:16:40 -05:00
|
|
|
declare(strict_types=1);
|
|
|
|
|
|
|
|
namespace ShlinkioTest\Shlink\Rest\Authentication;
|
|
|
|
|
|
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
use Prophecy\Prophecy\ObjectProphecy;
|
|
|
|
use Shlinkio\Shlink\Rest\Authentication\AuthenticationPluginManagerInterface;
|
|
|
|
use Shlinkio\Shlink\Rest\Authentication\Plugin\ApiKeyHeaderPlugin;
|
|
|
|
use Shlinkio\Shlink\Rest\Authentication\Plugin\AuthenticationPluginInterface;
|
|
|
|
use Shlinkio\Shlink\Rest\Authentication\Plugin\AuthorizationHeaderPlugin;
|
|
|
|
use Shlinkio\Shlink\Rest\Authentication\RequestToHttpAuthPlugin;
|
2019-11-26 14:43:29 -06:00
|
|
|
use Shlinkio\Shlink\Rest\Exception\MissingAuthenticationException;
|
2018-12-25 16:01:30 -06:00
|
|
|
use Zend\Diactoros\ServerRequest;
|
2019-02-26 15:56:43 -06:00
|
|
|
|
2018-10-28 02:34:02 -05:00
|
|
|
use function implode;
|
|
|
|
use function sprintf;
|
2018-09-29 01:16:40 -05:00
|
|
|
|
|
|
|
class RequestToAuthPluginTest extends TestCase
|
|
|
|
{
|
2018-11-20 12:30:27 -06:00
|
|
|
/** @var RequestToHttpAuthPlugin */
|
2018-09-29 01:16:40 -05:00
|
|
|
private $requestToPlugin;
|
2018-11-20 12:30:27 -06:00
|
|
|
/** @var ObjectProphecy */
|
2018-09-29 01:16:40 -05:00
|
|
|
private $pluginManager;
|
|
|
|
|
2019-02-16 03:53:45 -06:00
|
|
|
public function setUp(): void
|
2018-09-29 01:16:40 -05:00
|
|
|
{
|
|
|
|
$this->pluginManager = $this->prophesize(AuthenticationPluginManagerInterface::class);
|
|
|
|
$this->requestToPlugin = new RequestToHttpAuthPlugin($this->pluginManager->reveal());
|
|
|
|
}
|
|
|
|
|
2019-02-17 13:28:34 -06:00
|
|
|
/** @test */
|
|
|
|
public function exceptionIsFoundWhenNoneOfTheSupportedMethodsIsFound(): void
|
2018-09-29 01:16:40 -05:00
|
|
|
{
|
2018-12-25 16:01:30 -06:00
|
|
|
$request = new ServerRequest();
|
2018-09-29 01:16:40 -05:00
|
|
|
|
2019-11-26 14:43:29 -06:00
|
|
|
$this->expectException(MissingAuthenticationException::class);
|
2018-09-29 01:16:40 -05:00
|
|
|
$this->expectExceptionMessage(sprintf(
|
2019-11-26 15:12:52 -06:00
|
|
|
'Expected one of the following authentication headers, but none were provided, ["%s"]',
|
2018-09-29 01:16:40 -05:00
|
|
|
implode('", "', RequestToHttpAuthPlugin::SUPPORTED_AUTH_HEADERS)
|
|
|
|
));
|
|
|
|
|
|
|
|
$this->requestToPlugin->fromRequest($request);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @test
|
|
|
|
* @dataProvider provideHeaders
|
|
|
|
*/
|
2019-02-17 13:28:34 -06:00
|
|
|
public function properPluginIsFetchedWhenAnyAuthTypeIsFound(array $headers, string $expectedHeader): void
|
2018-09-29 01:16:40 -05:00
|
|
|
{
|
2018-12-25 16:01:30 -06:00
|
|
|
$request = new ServerRequest();
|
2018-09-29 01:16:40 -05:00
|
|
|
foreach ($headers as $header => $value) {
|
|
|
|
$request = $request->withHeader($header, $value);
|
|
|
|
}
|
|
|
|
|
|
|
|
$plugin = $this->prophesize(AuthenticationPluginInterface::class);
|
|
|
|
$getPlugin = $this->pluginManager->get($expectedHeader)->willReturn($plugin->reveal());
|
|
|
|
|
|
|
|
$this->requestToPlugin->fromRequest($request);
|
|
|
|
|
2018-11-11 06:18:21 -06:00
|
|
|
$getPlugin->shouldHaveBeenCalledOnce();
|
2018-09-29 01:16:40 -05:00
|
|
|
}
|
|
|
|
|
2019-02-17 13:28:34 -06:00
|
|
|
public function provideHeaders(): iterable
|
2018-09-29 01:16:40 -05:00
|
|
|
{
|
2019-02-17 13:28:34 -06:00
|
|
|
yield 'API key header only' => [[
|
|
|
|
ApiKeyHeaderPlugin::HEADER_NAME => 'foobar',
|
|
|
|
], ApiKeyHeaderPlugin::HEADER_NAME];
|
|
|
|
yield 'Authorization header only' => [[
|
|
|
|
AuthorizationHeaderPlugin::HEADER_NAME => 'foobar',
|
|
|
|
], AuthorizationHeaderPlugin::HEADER_NAME];
|
|
|
|
yield 'Both headers' => [[
|
|
|
|
AuthorizationHeaderPlugin::HEADER_NAME => 'foobar',
|
|
|
|
ApiKeyHeaderPlugin::HEADER_NAME => 'foobar',
|
|
|
|
], ApiKeyHeaderPlugin::HEADER_NAME];
|
2018-09-29 01:16:40 -05:00
|
|
|
}
|
|
|
|
}
|