mirror of
https://github.com/shlinkio/shlink.git
synced 2024-12-18 05:10:43 -06:00
333 lines
14 KiB
PHP
333 lines
14 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace ShlinkioTest\Shlink\Core\Action;
|
|
|
|
use Laminas\Diactoros\Response;
|
|
use Laminas\Diactoros\ServerRequest;
|
|
use Laminas\Diactoros\ServerRequestFactory;
|
|
use PHPUnit\Framework\Attributes\DataProvider;
|
|
use PHPUnit\Framework\Attributes\Test;
|
|
use PHPUnit\Framework\MockObject\MockObject;
|
|
use PHPUnit\Framework\TestCase;
|
|
use Psr\Http\Message\ServerRequestInterface;
|
|
use Psr\Http\Server\RequestHandlerInterface;
|
|
use Psr\Log\NullLogger;
|
|
use Shlinkio\Shlink\Common\Response\QrCodeResponse;
|
|
use Shlinkio\Shlink\Core\Action\QrCodeAction;
|
|
use Shlinkio\Shlink\Core\Config\Options\QrCodeOptions;
|
|
use Shlinkio\Shlink\Core\Exception\ShortUrlNotFoundException;
|
|
use Shlinkio\Shlink\Core\ShortUrl\Entity\ShortUrl;
|
|
use Shlinkio\Shlink\Core\ShortUrl\Helper\ShortUrlStringifier;
|
|
use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlIdentifier;
|
|
use Shlinkio\Shlink\Core\ShortUrl\ShortUrlResolverInterface;
|
|
|
|
use function getimagesizefromstring;
|
|
use function hexdec;
|
|
use function imagecolorat;
|
|
use function imagecreatefromstring;
|
|
|
|
use const Shlinkio\Shlink\DEFAULT_QR_CODE_COLOR;
|
|
|
|
class QrCodeActionTest extends TestCase
|
|
{
|
|
private const int WHITE = 0xFFFFFF;
|
|
private const int BLACK = 0x0;
|
|
|
|
private MockObject & ShortUrlResolverInterface $urlResolver;
|
|
|
|
protected function setUp(): void
|
|
{
|
|
$this->urlResolver = $this->createMock(ShortUrlResolverInterface::class);
|
|
}
|
|
|
|
#[Test]
|
|
public function aNotFoundShortCodeWillDelegateIntoNextMiddleware(): void
|
|
{
|
|
$shortCode = 'abc123';
|
|
$this->urlResolver->expects($this->once())->method('resolveEnabledShortUrl')->with(
|
|
ShortUrlIdentifier::fromShortCodeAndDomain($shortCode, ''),
|
|
)->willThrowException(ShortUrlNotFoundException::fromNotFound(ShortUrlIdentifier::fromShortCodeAndDomain('')));
|
|
$handler = $this->createMock(RequestHandlerInterface::class);
|
|
$handler->expects($this->once())->method('handle')->withAnyParameters()->willReturn(new Response());
|
|
|
|
$this->action()->process((new ServerRequest())->withAttribute('shortCode', $shortCode), $handler);
|
|
}
|
|
|
|
#[Test]
|
|
public function aCorrectRequestReturnsTheQrCodeResponse(): void
|
|
{
|
|
$shortCode = 'abc123';
|
|
$this->urlResolver->expects($this->once())->method('resolveEnabledShortUrl')->with(
|
|
ShortUrlIdentifier::fromShortCodeAndDomain($shortCode, ''),
|
|
)->willReturn(ShortUrl::createFake());
|
|
$handler = $this->createMock(RequestHandlerInterface::class);
|
|
$handler->expects($this->never())->method('handle');
|
|
|
|
$resp = $this->action()->process((new ServerRequest())->withAttribute('shortCode', $shortCode), $handler);
|
|
|
|
self::assertInstanceOf(QrCodeResponse::class, $resp);
|
|
self::assertEquals(200, $resp->getStatusCode());
|
|
}
|
|
|
|
#[Test, DataProvider('provideQueries')]
|
|
public function imageIsReturnedWithExpectedContentTypeBasedOnProvidedFormat(
|
|
string $defaultFormat,
|
|
array $query,
|
|
string $expectedContentType,
|
|
): void {
|
|
$code = 'abc123';
|
|
$this->urlResolver->method('resolveEnabledShortUrl')->with(
|
|
ShortUrlIdentifier::fromShortCodeAndDomain($code, ''),
|
|
)->willReturn(ShortUrl::createFake());
|
|
$handler = $this->createMock(RequestHandlerInterface::class);
|
|
$req = (new ServerRequest())->withAttribute('shortCode', $code)->withQueryParams($query);
|
|
|
|
$resp = $this->action(new QrCodeOptions(format: $defaultFormat))->process($req, $handler);
|
|
|
|
self::assertEquals($expectedContentType, $resp->getHeaderLine('Content-Type'));
|
|
}
|
|
|
|
public static function provideQueries(): iterable
|
|
{
|
|
yield 'no format, png default' => ['png', [], 'image/png'];
|
|
yield 'no format, svg default' => ['svg', [], 'image/svg+xml'];
|
|
yield 'png format, png default' => ['png', ['format' => 'png'], 'image/png'];
|
|
yield 'png format, svg default' => ['svg', ['format' => 'png'], 'image/png'];
|
|
yield 'svg format, png default' => ['png', ['format' => 'svg'], 'image/svg+xml'];
|
|
yield 'svg format, svg default' => ['svg', ['format' => 'svg'], 'image/svg+xml'];
|
|
yield 'unsupported format, png default' => ['png', ['format' => 'jpg'], 'image/png'];
|
|
yield 'unsupported format, svg default' => ['svg', ['format' => 'jpg'], 'image/svg+xml'];
|
|
}
|
|
|
|
#[Test, DataProvider('provideRequestsWithSize')]
|
|
public function imageIsReturnedWithExpectedSize(
|
|
QrCodeOptions $defaultOptions,
|
|
ServerRequestInterface $req,
|
|
int $expectedSize,
|
|
): void {
|
|
$code = 'abc123';
|
|
$this->urlResolver->method('resolveEnabledShortUrl')->with(
|
|
ShortUrlIdentifier::fromShortCodeAndDomain($code, ''),
|
|
)->willReturn(ShortUrl::createFake());
|
|
$handler = $this->createMock(RequestHandlerInterface::class);
|
|
|
|
$resp = $this->action($defaultOptions)->process($req->withAttribute('shortCode', $code), $handler);
|
|
$result = getimagesizefromstring($resp->getBody()->__toString());
|
|
self::assertNotFalse($result);
|
|
|
|
[$size] = $result;
|
|
self::assertEquals($expectedSize, $size);
|
|
}
|
|
|
|
public static function provideRequestsWithSize(): iterable
|
|
{
|
|
yield 'different margin and size defaults' => [
|
|
new QrCodeOptions(size: 660, margin: 40),
|
|
ServerRequestFactory::fromGlobals(),
|
|
740,
|
|
];
|
|
yield 'no size' => [new QrCodeOptions(), ServerRequestFactory::fromGlobals(), 300];
|
|
yield 'no size, different default' => [new QrCodeOptions(size: 500), ServerRequestFactory::fromGlobals(), 500];
|
|
yield 'size in query' => [
|
|
new QrCodeOptions(),
|
|
ServerRequestFactory::fromGlobals()->withQueryParams(['size' => '123']),
|
|
123,
|
|
];
|
|
yield 'size in query, default margin' => [
|
|
new QrCodeOptions(margin: 25),
|
|
ServerRequestFactory::fromGlobals()->withQueryParams(['size' => '123']),
|
|
173,
|
|
];
|
|
yield 'margin' => [
|
|
new QrCodeOptions(),
|
|
ServerRequestFactory::fromGlobals()->withQueryParams(['margin' => '35']),
|
|
370,
|
|
];
|
|
yield 'margin and different default' => [
|
|
new QrCodeOptions(size: 400),
|
|
ServerRequestFactory::fromGlobals()->withQueryParams(['margin' => '35']),
|
|
470,
|
|
];
|
|
yield 'margin and size' => [
|
|
new QrCodeOptions(),
|
|
ServerRequestFactory::fromGlobals()->withQueryParams(['margin' => '100', 'size' => '200']),
|
|
400,
|
|
];
|
|
yield 'negative margin' => [
|
|
new QrCodeOptions(),
|
|
ServerRequestFactory::fromGlobals()->withQueryParams(['margin' => '-50']),
|
|
300,
|
|
];
|
|
yield 'negative margin, default margin' => [
|
|
new QrCodeOptions(margin: 10),
|
|
ServerRequestFactory::fromGlobals()->withQueryParams(['margin' => '-50']),
|
|
300,
|
|
];
|
|
yield 'non-numeric margin' => [
|
|
new QrCodeOptions(),
|
|
ServerRequestFactory::fromGlobals()->withQueryParams(['margin' => 'foo']),
|
|
300,
|
|
];
|
|
yield 'negative margin and size' => [
|
|
new QrCodeOptions(),
|
|
ServerRequestFactory::fromGlobals()->withQueryParams(['margin' => '-1', 'size' => '150']),
|
|
150,
|
|
];
|
|
yield 'negative margin and size, default margin' => [
|
|
new QrCodeOptions(margin: 5),
|
|
ServerRequestFactory::fromGlobals()->withQueryParams(['margin' => '-1', 'size' => '150']),
|
|
150,
|
|
];
|
|
yield 'non-numeric margin and size' => [
|
|
new QrCodeOptions(),
|
|
ServerRequestFactory::fromGlobals()->withQueryParams(['margin' => 'foo', 'size' => '538']),
|
|
538,
|
|
];
|
|
}
|
|
|
|
#[Test, DataProvider('provideRoundBlockSize')]
|
|
public function imageCanRemoveExtraMarginWhenBlockRoundIsDisabled(
|
|
QrCodeOptions $defaultOptions,
|
|
string|null $roundBlockSize,
|
|
int $expectedColor,
|
|
): void {
|
|
$code = 'abc123';
|
|
$req = ServerRequestFactory::fromGlobals()
|
|
->withQueryParams(['size' => 250, 'roundBlockSize' => $roundBlockSize])
|
|
->withAttribute('shortCode', $code);
|
|
|
|
$this->urlResolver->method('resolveEnabledShortUrl')->with(
|
|
ShortUrlIdentifier::fromShortCodeAndDomain($code, ''),
|
|
)->willReturn(ShortUrl::withLongUrl('https://shlink.io'));
|
|
$handler = $this->createMock(RequestHandlerInterface::class);
|
|
|
|
$resp = $this->action($defaultOptions)->process($req, $handler);
|
|
$image = imagecreatefromstring($resp->getBody()->__toString());
|
|
self::assertNotFalse($image);
|
|
|
|
$color = imagecolorat($image, 1, 1);
|
|
self::assertEquals($expectedColor, $color);
|
|
}
|
|
|
|
public static function provideRoundBlockSize(): iterable
|
|
{
|
|
yield 'no round block param' => [new QrCodeOptions(), null, self::WHITE];
|
|
yield 'no round block param, but disabled by default' => [
|
|
new QrCodeOptions(roundBlockSize: false),
|
|
null,
|
|
self::BLACK,
|
|
];
|
|
yield 'round block: "true"' => [new QrCodeOptions(), 'true', self::WHITE];
|
|
yield 'round block: "true", but disabled by default' => [
|
|
new QrCodeOptions(roundBlockSize: false),
|
|
'true',
|
|
self::WHITE,
|
|
];
|
|
yield 'round block: "false"' => [new QrCodeOptions(), 'false', self::BLACK];
|
|
yield 'round block: "false", but enabled by default' => [
|
|
new QrCodeOptions(roundBlockSize: true),
|
|
'false',
|
|
self::BLACK,
|
|
];
|
|
}
|
|
|
|
#[Test, DataProvider('provideColors')]
|
|
public function properColorsAreUsed(string|null $queryColor, string|null $optionsColor, int $expectedColor): void
|
|
{
|
|
$code = 'abc123';
|
|
$req = ServerRequestFactory::fromGlobals()
|
|
->withQueryParams(['color' => $queryColor])
|
|
->withAttribute('shortCode', $code);
|
|
|
|
$this->urlResolver->method('resolveEnabledShortUrl')->with(
|
|
ShortUrlIdentifier::fromShortCodeAndDomain($code),
|
|
)->willReturn(ShortUrl::withLongUrl('https://shlink.io'));
|
|
$handler = $this->createMock(RequestHandlerInterface::class);
|
|
|
|
$resp = $this->action(
|
|
new QrCodeOptions(size: 250, roundBlockSize: false, color: $optionsColor ?? DEFAULT_QR_CODE_COLOR),
|
|
)->process($req, $handler);
|
|
$image = imagecreatefromstring($resp->getBody()->__toString());
|
|
self::assertNotFalse($image);
|
|
|
|
$resultingColor = imagecolorat($image, 1, 1);
|
|
self::assertEquals($expectedColor, $resultingColor);
|
|
}
|
|
|
|
public static function provideColors(): iterable
|
|
{
|
|
yield 'no query, no default' => [null, null, self::BLACK];
|
|
yield '6-char-query black' => ['000000', null, self::BLACK];
|
|
yield '6-char-query white' => ['ffffff', null, self::WHITE];
|
|
yield '6-char-query red' => ['ff0000', null, (int) hexdec('ff0000')];
|
|
yield '3-char-query black' => ['000', null, self::BLACK];
|
|
yield '3-char-query white' => ['fff', null, self::WHITE];
|
|
yield '3-char-query red' => ['f00', null, (int) hexdec('ff0000')];
|
|
yield '3-char-default red' => [null, 'f00', (int) hexdec('ff0000')];
|
|
yield 'invalid color in query' => ['zzzzzzzz', null, self::BLACK];
|
|
yield 'invalid color in query with default' => ['zzzzzzzz', 'aa88cc', self::BLACK];
|
|
yield 'invalid color in default' => [null, 'zzzzzzzz', self::BLACK];
|
|
}
|
|
|
|
#[Test, DataProvider('provideEnabled')]
|
|
public function qrCodeIsResolvedBasedOnOptions(bool $enabledForDisabledShortUrls): void
|
|
{
|
|
if ($enabledForDisabledShortUrls) {
|
|
$this->urlResolver->expects($this->once())->method('resolvePublicShortUrl')->willThrowException(
|
|
ShortUrlNotFoundException::fromNotFound(ShortUrlIdentifier::fromShortCodeAndDomain('')),
|
|
);
|
|
$this->urlResolver->expects($this->never())->method('resolveEnabledShortUrl');
|
|
} else {
|
|
$this->urlResolver->expects($this->once())->method('resolveEnabledShortUrl')->willThrowException(
|
|
ShortUrlNotFoundException::fromNotFound(ShortUrlIdentifier::fromShortCodeAndDomain('')),
|
|
);
|
|
$this->urlResolver->expects($this->never())->method('resolvePublicShortUrl');
|
|
}
|
|
|
|
$options = new QrCodeOptions(enabledForDisabledShortUrls: $enabledForDisabledShortUrls);
|
|
$this->action($options)->process(
|
|
ServerRequestFactory::fromGlobals(),
|
|
$this->createMock(RequestHandlerInterface::class),
|
|
);
|
|
}
|
|
|
|
#[Test]
|
|
public function logoIsAddedToQrCodeIfOptionIsDefined(): void
|
|
{
|
|
$logoUrl = 'https://avatars.githubusercontent.com/u/20341790?v=4'; // Shlink logo
|
|
$code = 'abc123';
|
|
$req = ServerRequestFactory::fromGlobals()->withAttribute('shortCode', $code);
|
|
|
|
$this->urlResolver->method('resolveEnabledShortUrl')->with(
|
|
ShortUrlIdentifier::fromShortCodeAndDomain($code),
|
|
)->willReturn(ShortUrl::withLongUrl('https://shlink.io'));
|
|
$handler = $this->createMock(RequestHandlerInterface::class);
|
|
|
|
$resp = $this->action(new QrCodeOptions(size: 250, logoUrl: $logoUrl))->process($req, $handler);
|
|
$image = imagecreatefromstring($resp->getBody()->__toString());
|
|
self::assertNotFalse($image);
|
|
|
|
// At around 100x100 px we can already find the logo, which has Shlink's brand color
|
|
$resultingColor = imagecolorat($image, 100, 100);
|
|
self::assertEquals(hexdec('4696E5'), $resultingColor);
|
|
}
|
|
|
|
public static function provideEnabled(): iterable
|
|
{
|
|
yield 'always enabled' => [true];
|
|
yield 'only enabled short URLs' => [false];
|
|
}
|
|
|
|
public function action(QrCodeOptions|null $options = null): QrCodeAction
|
|
{
|
|
return new QrCodeAction(
|
|
$this->urlResolver,
|
|
new ShortUrlStringifier(),
|
|
new NullLogger(),
|
|
$options ?? new QrCodeOptions(enabledForDisabledShortUrls: false),
|
|
);
|
|
}
|
|
}
|