mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-11-24 05:38:06 +03:00
Code Issues Projects Releases Packages Wiki Activity

Migrated ExtraPathRedirectMiddlewareTest to use PHPUnit mocks

Browse source
This commit is contained in:
Alejandro Celaya 2022-10-23 17:53:09 +02:00
parent 168c839cf1
commit 1fbcea7a06
1 changed files with 51 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

111
module/Core/test/ShortUrl/Middleware/ExtraPathRedirectMiddlewareTest.php
View file

@ -9,10 +9,8 @@ use Laminas\Diactoros\ServerRequestFactory;
use Laminas\Diactoros\Uri; use Laminas\Diactoros\Uri;
use Mezzio\Router\Route; use Mezzio\Router\Route;
use Mezzio\Router\RouteResult; use Mezzio\Router\RouteResult;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Prophecy\Prophecy\ObjectProphecy;
use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface; use Psr\Http\Server\RequestHandlerInterface;
@ -32,22 +30,20 @@ use function str_starts_with;
class ExtraPathRedirectMiddlewareTest extends TestCase class ExtraPathRedirectMiddlewareTest extends TestCase
{ {
use ProphecyTrait; private MockObject $resolver;
private MockObject $requestTracker;
private ObjectProphecy $resolver; private MockObject $redirectionBuilder;
private ObjectProphecy $requestTracker; private MockObject $redirectResponseHelper;
private ObjectProphecy $redirectionBuilder; private MockObject $handler;
private ObjectProphecy $redirectResponseHelper;
private ObjectProphecy $handler;
protected function setUp(): void protected function setUp(): void
{ {
$this->resolver = $this->prophesize(ShortUrlResolverInterface::class); $this->resolver = $this->createMock(ShortUrlResolverInterface::class);
$this->requestTracker = $this->prophesize(RequestTrackerInterface::class); $this->requestTracker = $this->createMock(RequestTrackerInterface::class);
$this->redirectionBuilder = $this->prophesize(ShortUrlRedirectionBuilderInterface::class); $this->redirectionBuilder = $this->createMock(ShortUrlRedirectionBuilderInterface::class);
$this->redirectResponseHelper = $this->prophesize(RedirectResponseHelperInterface::class); $this->redirectResponseHelper = $this->createMock(RedirectResponseHelperInterface::class);
$this->handler = $this->prophesize(RequestHandlerInterface::class); $this->handler = $this->createMock(RequestHandlerInterface::class);
$this->handler->handle(Argument::cetera())->willReturn(new RedirectResponse('')); $this->handler->method('handle')->willReturn(new RedirectResponse(''));
} }
/** /**
@ -63,14 +59,13 @@ class ExtraPathRedirectMiddlewareTest extends TestCase
appendExtraPath: $appendExtraPath, appendExtraPath: $appendExtraPath,
multiSegmentSlugsEnabled: $multiSegmentEnabled, multiSegmentSlugsEnabled: $multiSegmentEnabled,
); );
$this->resolver->expects($this->never())->method('resolveEnabledShortUrl');
$this->requestTracker->expects($this->never())->method('trackIfApplicable');
$this->redirectionBuilder->expects($this->never())->method('buildShortUrlRedirect');
$this->redirectResponseHelper->expects($this->never())->method('buildRedirectResponse');
$this->handler->expects($this->once())->method('handle');
$this->middleware($options)->process($request, $this->handler->reveal()); $this->middleware($options)->process($request, $this->handler);
$this->handler->handle($request)->shouldHaveBeenCalledOnce();
$this->resolver->resolveEnabledShortUrl(Argument::cetera())->shouldNotHaveBeenCalled();
$this->requestTracker->trackIfApplicable(Argument::cetera())->shouldNotHaveBeenCalled();
$this->redirectionBuilder->buildShortUrlRedirect(Argument::cetera())->shouldNotHaveBeenCalled();
$this->redirectResponseHelper->buildRedirectResponse(Argument::cetera())->shouldNotHaveBeenCalled();
} }
public function provideNonRedirectingRequests(): iterable public function provideNonRedirectingRequests(): iterable
@ -89,7 +84,7 @@ class ExtraPathRedirectMiddlewareTest extends TestCase
RouteResult::class, RouteResult::class,
RouteResult::fromRoute(new Route( RouteResult::fromRoute(new Route(
'/foo', '/foo',
$this->prophesize(MiddlewareInterface::class)->reveal(), $this->createMock(MiddlewareInterface::class),
['GET'], ['GET'],
RedirectAction::class, RedirectAction::class,
)), )),
@ -115,22 +110,20 @@ class ExtraPathRedirectMiddlewareTest extends TestCase
): void { ): void {
$options = new UrlShortenerOptions(appendExtraPath: true, multiSegmentSlugsEnabled: $multiSegmentEnabled); $options = new UrlShortenerOptions(appendExtraPath: true, multiSegmentSlugsEnabled: $multiSegmentEnabled);
$type = $this->prophesize(NotFoundType::class); $type = $this->createMock(NotFoundType::class);
$type->isRegularNotFound()->willReturn(true); $type->method('isRegularNotFound')->willReturn(true);
$type->isInvalidShortUrl()->willReturn(true); $type->method('isInvalidShortUrl')->willReturn(true);
$request = ServerRequestFactory::fromGlobals()->withAttribute(NotFoundType::class, $type->reveal()) $request = ServerRequestFactory::fromGlobals()->withAttribute(NotFoundType::class, $type)
->withUri(new Uri('/shortCode/bar/baz')); ->withUri(new Uri('/shortCode/bar/baz'));
$resolve = $this->resolver->resolveEnabledShortUrl( $this->resolver->expects($this->exactly($expectedResolveCalls))->method('resolveEnabledShortUrl')->with(
Argument::that(fn (ShortUrlIdentifier $identifier) => str_starts_with($identifier->shortCode, 'shortCode')), $this->callback(fn (ShortUrlIdentifier $id) => str_starts_with($id->shortCode, 'shortCode')),
)->willThrow(ShortUrlNotFoundException::class); )->willThrowException(ShortUrlNotFoundException::fromNotFound(ShortUrlIdentifier::fromShortCodeAndDomain('')));
$this->requestTracker->expects($this->never())->method('trackIfApplicable');
$this->redirectionBuilder->expects($this->never())->method('buildShortUrlRedirect');
$this->redirectResponseHelper->expects($this->never())->method('buildRedirectResponse');
$this->middleware($options)->process($request, $this->handler->reveal()); $this->middleware($options)->process($request, $this->handler);
$resolve->shouldHaveBeenCalledTimes($expectedResolveCalls);
$this->requestTracker->trackIfApplicable(Argument::cetera())->shouldNotHaveBeenCalled();
$this->redirectionBuilder->buildShortUrlRedirect(Argument::cetera())->shouldNotHaveBeenCalled();
$this->redirectResponseHelper->buildRedirectResponse(Argument::cetera())->shouldNotHaveBeenCalled();
} }
/** /**
@ -144,18 +137,17 @@ class ExtraPathRedirectMiddlewareTest extends TestCase
): void { ): void {
$options = new UrlShortenerOptions(appendExtraPath: true, multiSegmentSlugsEnabled: $multiSegmentEnabled); $options = new UrlShortenerOptions(appendExtraPath: true, multiSegmentSlugsEnabled: $multiSegmentEnabled);
$type = $this->prophesize(NotFoundType::class); $type = $this->createMock(NotFoundType::class);
$type->isRegularNotFound()->willReturn(true); $type->method('isRegularNotFound')->willReturn(true);
$type->isInvalidShortUrl()->willReturn(true); $type->method('isInvalidShortUrl')->willReturn(true);
$request = ServerRequestFactory::fromGlobals()->withAttribute(NotFoundType::class, $type->reveal()) $request = ServerRequestFactory::fromGlobals()->withAttribute(NotFoundType::class, $type)
->withUri(new Uri('https://doma.in/shortCode/bar/baz')); ->withUri(new Uri('https://doma.in/shortCode/bar/baz'));
$shortUrl = ShortUrl::withLongUrl(''); $shortUrl = ShortUrl::withLongUrl('');
$identifier = Argument::that(
fn (ShortUrlIdentifier $identifier) => str_starts_with($identifier->shortCode, 'shortCode'),
);
$currentIteration = 1; $currentIteration = 1;
$resolve = $this->resolver->resolveEnabledShortUrl($identifier)->will( $this->resolver->expects($this->exactly($expectedResolveCalls))->method('resolveEnabledShortUrl')->with(
$this->callback(fn (ShortUrlIdentifier $id) => str_starts_with($id->shortCode, 'shortCode')),
)->willReturnCallback(
function () use ($shortUrl, &$currentIteration, $expectedResolveCalls): ShortUrl { function () use ($shortUrl, &$currentIteration, $expectedResolveCalls): ShortUrl {
if ($expectedResolveCalls === $currentIteration) { if ($expectedResolveCalls === $currentIteration) {
return $shortUrl; return $shortUrl;
@ -165,18 +157,17 @@ class ExtraPathRedirectMiddlewareTest extends TestCase
throw ShortUrlNotFoundException::fromNotFound(ShortUrlIdentifier::fromShortUrl($shortUrl)); throw ShortUrlNotFoundException::fromNotFound(ShortUrlIdentifier::fromShortUrl($shortUrl));
}, },
); );
$buildLongUrl = $this->redirectionBuilder->buildShortUrlRedirect($shortUrl, [], $expectedExtraPath) $this->redirectionBuilder->expects($this->once())->method('buildShortUrlRedirect')->with(
->willReturn('the_built_long_url'); $shortUrl,
$buildResp = $this->redirectResponseHelper->buildRedirectResponse('the_built_long_url')->willReturn( [],
new RedirectResponse(''), $expectedExtraPath,
); )->willReturn('the_built_long_url');
$this->redirectResponseHelper->expects($this->once())->method('buildRedirectResponse')->with(
'the_built_long_url',
)->willReturn(new RedirectResponse(''));
$this->requestTracker->expects($this->once())->method('trackIfApplicable')->with($shortUrl, $request);
$this->middleware($options)->process($request, $this->handler->reveal()); $this->middleware($options)->process($request, $this->handler);
$resolve->shouldHaveBeenCalledTimes($expectedResolveCalls);
$buildLongUrl->shouldHaveBeenCalledOnce();
$buildResp->shouldHaveBeenCalledOnce();
$this->requestTracker->trackIfApplicable($shortUrl, $request)->shouldHaveBeenCalledOnce();
} }
public function provideResolves(): iterable public function provideResolves(): iterable
@ -188,10 +179,10 @@ class ExtraPathRedirectMiddlewareTest extends TestCase
private function middleware(?UrlShortenerOptions $options = null): ExtraPathRedirectMiddleware private function middleware(?UrlShortenerOptions $options = null): ExtraPathRedirectMiddleware
{ {
return new ExtraPathRedirectMiddleware( return new ExtraPathRedirectMiddleware(
$this->resolver->reveal(), $this->resolver,
$this->requestTracker->reveal(), $this->requestTracker,
$this->redirectionBuilder->reveal(), $this->redirectionBuilder,
$this->redirectResponseHelper->reveal(), $this->redirectResponseHelper,
$options ?? new UrlShortenerOptions(appendExtraPath: true), $options ?? new UrlShortenerOptions(appendExtraPath: true),
); );
} }