mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2025-03-14 04:00:57 +03:00
Code Issues Projects Releases Packages Wiki Activity

Improved api tests where a short URL needs to be resolved, covering cases where API key lacks permissions

Browse source
This commit is contained in:
Alejandro Celaya 2021-01-10 09:02:05 +01:00
parent f17873b527
commit ea05259bbe
6 changed files with 37 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
module/Rest/test-api/Action/DeleteShortUrlActionTest.php
View file

@ -18,9 +18,10 @@ class DeleteShortUrlActionTest extends ApiTestCase
public function notFoundErrorIsReturnWhenDeletingInvalidUrl(
string $shortCode,
?string $domain,
string $expectedDetail
string $expectedDetail,
string $apiKey
): void {
$resp = $this->callApiWithKey(self::METHOD_DELETE, $this->buildShortUrlPath($shortCode, $domain));
$resp = $this->callApiWithKey(self::METHOD_DELETE, $this->buildShortUrlPath($shortCode, $domain), [], $apiKey);
$payload = $this->getJsonResponsePayload($resp);
self::assertEquals(self::STATUS_NOT_FOUND, $resp->getStatusCode());

5
module/Rest/test-api/Action/EditShortUrlActionTest.php
View file

@ -104,10 +104,11 @@ class EditShortUrlActionTest extends ApiTestCase
public function tryingToEditInvalidUrlReturnsNotFoundError(
string $shortCode,
?string $domain,
string $expectedDetail
string $expectedDetail,
string $apiKey
): void {
$url = $this->buildShortUrlPath($shortCode, $domain);
$resp = $this->callApiWithKey(self::METHOD_PATCH, $url, [RequestOptions::JSON => []]);
$resp = $this->callApiWithKey(self::METHOD_PATCH, $url, [RequestOptions::JSON => []], $apiKey);
$payload = $this->getJsonResponsePayload($resp);
self::assertEquals(self::STATUS_NOT_FOUND, $resp->getStatusCode());

5
module/Rest/test-api/Action/EditShortUrlTagsActionTest.php
View file

@ -34,12 +34,13 @@ class EditShortUrlTagsActionTest extends ApiTestCase
public function providingInvalidShortCodeReturnsBadRequest(
string $shortCode,
?string $domain,
string $expectedDetail
string $expectedDetail,
string $apiKey
): void {
$url = $this->buildShortUrlPath($shortCode, $domain, '/tags');
$resp = $this->callApiWithKey(self::METHOD_PUT, $url, [RequestOptions::JSON => [
'tags' => ['foo', 'bar'],
]]);
]], $apiKey);
$payload = $this->getJsonResponsePayload($resp);
self::assertEquals(self::STATUS_NOT_FOUND, $resp->getStatusCode());

5
module/Rest/test-api/Action/ResolveShortUrlActionTest.php
View file

@ -50,9 +50,10 @@ class ResolveShortUrlActionTest extends ApiTestCase
public function tryingToResolveInvalidUrlReturnsNotFoundError(
string $shortCode,
?string $domain,
string $expectedDetail
string $expectedDetail,
string $apiKey
): void {
$resp = $this->callApiWithKey(self::METHOD_GET, $this->buildShortUrlPath($shortCode, $domain));
$resp = $this->callApiWithKey(self::METHOD_GET, $this->buildShortUrlPath($shortCode, $domain), [], $apiKey);
$payload = $this->getJsonResponsePayload($resp);
self::assertEquals(self::STATUS_NOT_FOUND, $resp->getStatusCode());

10
module/Rest/test-api/Action/ShortUrlVisitsActionTest.php
View file

@ -22,9 +22,15 @@ class ShortUrlVisitsActionTest extends ApiTestCase
public function tryingToGetVisitsForInvalidUrlReturnsNotFoundError(
string $shortCode,
?string $domain,
string $expectedDetail
string $expectedDetail,
string $apiKey
): void {
$resp = $this->callApiWithKey(self::METHOD_GET, $this->buildShortUrlPath($shortCode, $domain, '/visits'));
$resp = $this->callApiWithKey(
self::METHOD_GET,
$this->buildShortUrlPath($shortCode, $domain, '/visits'),
[],
$apiKey,
);
$payload = $this->getJsonResponsePayload($resp);
self::assertEquals(self::STATUS_NOT_FOUND, $resp->getStatusCode());

20
module/Rest/test-api/Utils/NotFoundUrlHelpersTrait.php
View file

@ -4,25 +4,39 @@ declare(strict_types=1);
namespace ShlinkioApiTest\Shlink\Rest\Utils;
use GuzzleHttp\Psr7\Query;
use Laminas\Diactoros\Uri;
use function GuzzleHttp\Psr7\build_query;
use function sprintf;
trait NotFoundUrlHelpersTrait
{
public function provideInvalidUrls(): iterable
{
yield 'invalid shortcode' => ['invalid', null, 'No URL found with short code "invalid"'];
yield 'invalid shortcode' => ['invalid', null, 'No URL found with short code "invalid"', 'valid_api_key'];
yield 'invalid shortcode without domain' => [
'abc123',
'example.com',
'No URL found with short code "abc123" for domain "example.com"',
'valid_api_key',
];
yield 'invalid shortcode + domain' => [
'custom-with-domain',
'example.com',
'No URL found with short code "custom-with-domain" for domain "example.com"',
'valid_api_key',
];
yield 'valid shortcode with invalid API key' => [
'ghi789',
null,
'No URL found with short code "ghi789"',
'author_api_key',
];
yield 'valid shortcode + domain with invalid API key' => [
'custom-with-domain',
'some-domain.com',
'No URL found with short code "custom-with-domain" for domain "some-domain.com"',
'domain_api_key',
];
}
@ -30,7 +44,7 @@ trait NotFoundUrlHelpersTrait
{
$url = new Uri(sprintf('/short-urls/%s%s', $shortCode, $suffix));
if ($domain !== null) {
$url = $url->withQuery(build_query(['domain' => $domain]));
$url = $url->withQuery(Query::build(['domain' => $domain]));
}
return (string) $url;