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

Migrated NotifyNewShortUrlToRabbitMqTest to use PHPUnit mocks

Browse source
This commit is contained in:
Alejandro Celaya 2022-10-22 18:49:43 +02:00
parent d58f89aa26
commit a15e9c29c8
1 changed files with 49 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

101
module/Core/test/EventDispatcher/RabbitMq/NotifyNewShortUrlToRabbitMqTest.php
View file

@ -7,10 +7,8 @@ namespace ShlinkioTest\Shlink\Core\EventDispatcher\RabbitMq;
use Doctrine\ORM\EntityManagerInterface; use Doctrine\ORM\EntityManagerInterface;
use DomainException; use DomainException;
use Exception; use Exception;
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\Log\LoggerInterface; use Psr\Log\LoggerInterface;
use RuntimeException; use RuntimeException;
use Shlinkio\Shlink\Common\UpdatePublishing\PublishingHelperInterface; use Shlinkio\Shlink\Common\UpdatePublishing\PublishingHelperInterface;
@ -25,48 +23,46 @@ use Throwable;
class NotifyNewShortUrlToRabbitMqTest extends TestCase class NotifyNewShortUrlToRabbitMqTest extends TestCase
{ {
use ProphecyTrait; private MockObject $helper;
private MockObject $updatesGenerator;
private ObjectProphecy $helper; private MockObject $em;
private ObjectProphecy $updatesGenerator; private MockObject $logger;
private ObjectProphecy $em;
private ObjectProphecy $logger;
protected function setUp(): void protected function setUp(): void
{ {
$this->helper = $this->prophesize(PublishingHelperInterface::class); $this->helper = $this->createMock(PublishingHelperInterface::class);
$this->updatesGenerator = $this->prophesize(PublishingUpdatesGeneratorInterface::class); $this->updatesGenerator = $this->createMock(PublishingUpdatesGeneratorInterface::class);
$this->em = $this->prophesize(EntityManagerInterface::class); $this->em = $this->createMock(EntityManagerInterface::class);
$this->logger = $this->prophesize(LoggerInterface::class); $this->logger = $this->createMock(LoggerInterface::class);
} }
/** @test */ /** @test */
public function doesNothingWhenTheFeatureIsNotEnabled(): void public function doesNothingWhenTheFeatureIsNotEnabled(): void
{ {
($this->listener(false))(new ShortUrlCreated('123')); $this->helper->expects($this->never())->method('publishUpdate');
$this->em->expects($this->never())->method('find');
$this->logger->expects($this->never())->method('warning');
$this->logger->expects($this->never())->method('debug');
$this->em->find(Argument::cetera())->shouldNotHaveBeenCalled(); ($this->listener(false))(new ShortUrlCreated('123'));
$this->logger->warning(Argument::cetera())->shouldNotHaveBeenCalled();
$this->logger->debug(Argument::cetera())->shouldNotHaveBeenCalled();
$this->helper->publishUpdate(Argument::cetera())->shouldNotHaveBeenCalled();
} }
/** @test */ /** @test */
public function notificationsAreNotSentWhenShortUrlCannotBeFound(): void public function notificationsAreNotSentWhenShortUrlCannotBeFound(): void
{ {
$shortUrlId = '123'; $shortUrlId = '123';
$find = $this->em->find(ShortUrl::class, $shortUrlId)->willReturn(null); $this->em->expects($this->once())->method('find')->with(
$logWarning = $this->logger->warning( $this->equalTo(ShortUrl::class),
'Tried to notify {name} for new short URL with id "{shortUrlId}", but it does not exist.', $this->equalTo($shortUrlId),
['shortUrlId' => $shortUrlId, 'name' => 'RabbitMQ'], )->willReturn(null);
$this->logger->expects($this->once())->method('warning')->with(
$this->equalTo('Tried to notify {name} for new short URL with id "{shortUrlId}", but it does not exist.'),
$this->equalTo(['shortUrlId' => $shortUrlId, 'name' => 'RabbitMQ']),
); );
$this->logger->expects($this->never())->method('debug');
$this->helper->expects($this->never())->method('publishUpdate');
($this->listener())(new ShortUrlCreated($shortUrlId)); ($this->listener())(new ShortUrlCreated($shortUrlId));
$find->shouldHaveBeenCalledOnce();
$logWarning->shouldHaveBeenCalledOnce();
$this->logger->debug(Argument::cetera())->shouldNotHaveBeenCalled();
$this->helper->publishUpdate(Argument::cetera())->shouldNotHaveBeenCalled();
} }
/** @test */ /** @test */
@ -74,17 +70,17 @@ class NotifyNewShortUrlToRabbitMqTest extends TestCase
{ {
$shortUrlId = '123'; $shortUrlId = '123';
$update = Update::forTopicAndPayload(Topic::NEW_SHORT_URL->value, []); $update = Update::forTopicAndPayload(Topic::NEW_SHORT_URL->value, []);
$find = $this->em->find(ShortUrl::class, $shortUrlId)->willReturn(ShortUrl::withLongUrl('')); $this->em->expects($this->once())->method('find')->with(
$generateUpdate = $this->updatesGenerator->newShortUrlUpdate(Argument::type(ShortUrl::class))->willReturn( $this->equalTo(ShortUrl::class),
$update, $this->equalTo($shortUrlId),
); )->willReturn(ShortUrl::withLongUrl(''));
$this->updatesGenerator->expects($this->once())->method('newShortUrlUpdate')->with(
$this->isInstanceOf(ShortUrl::class),
)->willReturn($update);
$this->helper->expects($this->once())->method('publishUpdate')->with($this->equalTo($update));
$this->logger->expects($this->never())->method('debug');
($this->listener())(new ShortUrlCreated($shortUrlId)); ($this->listener())(new ShortUrlCreated($shortUrlId));
$find->shouldHaveBeenCalledOnce();
$generateUpdate->shouldHaveBeenCalledOnce();
$this->helper->publishUpdate($update)->shouldHaveBeenCalledOnce();
$this->logger->debug(Argument::cetera())->shouldNotHaveBeenCalled();
} }
/** /**
@ -95,21 +91,22 @@ class NotifyNewShortUrlToRabbitMqTest extends TestCase
{ {
$shortUrlId = '123'; $shortUrlId = '123';
$update = Update::forTopicAndPayload(Topic::NEW_SHORT_URL->value, []); $update = Update::forTopicAndPayload(Topic::NEW_SHORT_URL->value, []);
$find = $this->em->find(ShortUrl::class, $shortUrlId)->willReturn(ShortUrl::withLongUrl('')); $this->em->expects($this->once())->method('find')->with(
$generateUpdate = $this->updatesGenerator->newShortUrlUpdate(Argument::type(ShortUrl::class))->willReturn( $this->equalTo(ShortUrl::class),
$update, $this->equalTo($shortUrlId),
)->willReturn(ShortUrl::withLongUrl(''));
$this->updatesGenerator->expects($this->once())->method('newShortUrlUpdate')->with(
$this->isInstanceOf(ShortUrl::class),
)->willReturn($update);
$this->helper->expects($this->once())->method('publishUpdate')->with(
$this->equalTo($update),
)->willThrowException($e);
$this->logger->expects($this->once())->method('debug')->with(
$this->equalTo('Error while trying to notify {name} with new short URL. {e}'),
$this->equalTo(['e' => $e, 'name' => 'RabbitMQ']),
); );
$publish = $this->helper->publishUpdate($update)->willThrow($e);
($this->listener())(new ShortUrlCreated($shortUrlId)); ($this->listener())(new ShortUrlCreated($shortUrlId));
$this->logger->debug(
'Error while trying to notify {name} with new short URL. {e}',
['e' => $e, 'name' => 'RabbitMQ'],
)->shouldHaveBeenCalledOnce();
$find->shouldHaveBeenCalledOnce();
$generateUpdate->shouldHaveBeenCalledOnce();
$publish->shouldHaveBeenCalledOnce();
} }
public function provideExceptions(): iterable public function provideExceptions(): iterable
@ -122,10 +119,10 @@ class NotifyNewShortUrlToRabbitMqTest extends TestCase
private function listener(bool $enabled = true): NotifyNewShortUrlToRabbitMq private function listener(bool $enabled = true): NotifyNewShortUrlToRabbitMq
{ {
return new NotifyNewShortUrlToRabbitMq( return new NotifyNewShortUrlToRabbitMq(
$this->helper->reveal(), $this->helper,
$this->updatesGenerator->reveal(), $this->updatesGenerator,
$this->em->reveal(), $this->em,
$this->logger->reveal(), $this->logger,
new RabbitMqOptions($enabled), new RabbitMqOptions($enabled),
); );
} }