OilfieldToolsNet/shlink
4
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2025-02-25 18:45:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

Added API tests covering creating short URLs with new findIfExists param

Browse Source
This commit is contained in:
Alejandro Celaya
2019-02-03 11:01:38 +01:00
parent c4fd8d5120
commit 810b25ff14
9 changed files with 103 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
module/Rest/src/Action/ShortUrl/CreateShortUrlAction.php
View File

@@ -35,7 +35,8 @@ class CreateShortUrlAction extends AbstractCreateShortUrlAction
$this->getOptionalDate($postData, 'validSince'),
$this->getOptionalDate($postData, 'validUntil'),
$postData['customSlug'] ?? null,
isset($postData['maxVisits']) ? (int) $postData['maxVisits'] : null
$postData['maxVisits'] ?? null,
$postData['findIfExists'] ?? null
)
);
}

86
module/Rest/test-api/Action/CreateShortUrlActionTest.php
View File

@@ -12,7 +12,7 @@ class CreateShortUrlActionTest extends ApiTestCase
/**
* @test
*/
public function createsNewShortUrlWhenOnlyLongUrlIsProvided()
public function createsNewShortUrlWhenOnlyLongUrlIsProvided(): void
{
$expectedKeys = ['shortCode', 'shortUrl', 'longUrl', 'dateCreated', 'visitsCount', 'tags'];
[$statusCode, $payload] = $this->createShortUrl();
@@ -26,7 +26,7 @@ class CreateShortUrlActionTest extends ApiTestCase
/**
* @test
*/
public function createsNewShortUrlWithCustomSlug()
public function createsNewShortUrlWithCustomSlug(): void
{
[$statusCode, $payload] = $this->createShortUrl(['customSlug' => 'my cool slug']);
@@ -37,7 +37,7 @@ class CreateShortUrlActionTest extends ApiTestCase
/**
* @test
*/
public function createsNewShortUrlWithTags()
public function createsNewShortUrlWithTags(): void
{
[$statusCode, $payload] = $this->createShortUrl(['tags' => ['foo', 'bar', 'baz']]);
@@ -49,7 +49,7 @@ class CreateShortUrlActionTest extends ApiTestCase
* @test
* @dataProvider provideMaxVisits
*/
public function createsNewShortUrlWithVisitsLimit(int $maxVisits)
public function createsNewShortUrlWithVisitsLimit(int $maxVisits): void
{
[$statusCode, ['shortCode' => $shortCode]] = $this->createShortUrl(['maxVisits' => $maxVisits]);
@@ -75,7 +75,7 @@ class CreateShortUrlActionTest extends ApiTestCase
/**
* @test
*/
public function createsShortUrlWithValidSince()
public function createsShortUrlWithValidSince(): void
{
[$statusCode, ['shortCode' => $shortCode]] = $this->createShortUrl([
'validSince' => Chronos::now()->addDay()->toAtomString(),
@@ -91,7 +91,7 @@ class CreateShortUrlActionTest extends ApiTestCase
/**
* @test
*/
public function createsShortUrlWithValidUntil()
public function createsShortUrlWithValidUntil(): void
{
[$statusCode, ['shortCode' => $shortCode]] = $this->createShortUrl([
'validUntil' => Chronos::now()->subDay()->toAtomString(),
@@ -104,6 +104,76 @@ class CreateShortUrlActionTest extends ApiTestCase
$this->assertEquals(self::STATUS_NOT_FOUND, $lastResp->getStatusCode());
}
/**
* @test
* @dataProvider provideMatchingBodies
*/
public function returnsAnExistingShortUrlWhenRequested(array $body): void
{
[$firstStatusCode, ['shortCode' => $firstShortCode]] = $this->createShortUrl($body);
$body['findIfExists'] = true;
[$secondStatusCode, ['shortCode' => $secondShortCode]] = $this->createShortUrl($body);
$this->assertEquals(self::STATUS_OK, $firstStatusCode);
$this->assertEquals(self::STATUS_OK, $secondStatusCode);
$this->assertEquals($firstShortCode, $secondShortCode);
}
public function provideMatchingBodies(): array
{
$longUrl = 'https://www.alejandrocelaya.com';
return [
'only long URL' => [['longUrl' => $longUrl]],
'long URL and tags' => [['longUrl' => $longUrl, 'tags' => ['boo', 'far']]],
'long URL custom slug' => [['longUrl' => $longUrl, 'customSlug' => 'my cool slug']],
'several params' => [[
'longUrl' => $longUrl,
'tags' => ['boo', 'far'],
'validSince' => Chronos::now()->toAtomString(),
'maxVisits' => 7,
]],
];
}
/**
* @test
*/
public function returnsErrorWhenRequestingReturnExistingButCustomSlugIsInUse(): void
{
$longUrl = 'https://www.alejandrocelaya.com';
[$firstStatusCode] = $this->createShortUrl(['longUrl' => $longUrl]);
[$secondStatusCode] = $this->createShortUrl([
'longUrl' => $longUrl,
'customSlug' => 'custom',
'findIfExists' => true,
]);
$this->assertEquals(self::STATUS_OK, $firstStatusCode);
$this->assertEquals(self::STATUS_BAD_REQUEST, $secondStatusCode);
}
/**
* @test
*/
public function createsNewShortUrlIfRequestedToFindButThereIsNoMatch(): void
{
[$firstStatusCode, ['shortCode' => $firstShortCode]] = $this->createShortUrl([
'longUrl' => 'https://www.alejandrocelaya.com',
]);
[$secondStatusCode, ['shortCode' => $secondShortCode]] = $this->createShortUrl([
'longUrl' => 'https://www.alejandrocelaya.com/projects',
'findIfExists' => true,
]);
$this->assertEquals(self::STATUS_OK, $firstStatusCode);
$this->assertEquals(self::STATUS_OK, $secondStatusCode);
$this->assertNotEquals($firstShortCode, $secondShortCode);
}
/**
* @return array {
* @var int $statusCode
@@ -112,7 +182,9 @@ class CreateShortUrlActionTest extends ApiTestCase
*/
private function createShortUrl(array $body = []): array
{
$body['longUrl'] = 'https://app.shlink.io';
if (! isset($body['longUrl'])) {
$body['longUrl'] = 'https://app.shlink.io';
}
$resp = $this->callApiWithKey(self::METHOD_POST, '/short-urls', [RequestOptions::JSON => $body]);
$payload = $this->getJsonResponsePayload($resp);