OilfieldToolsNet/shlink
4
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2025-01-05 05:34:58 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fixed LocateVisitTest

Browse Source
This commit is contained in:
Alejandro Celaya 2021-04-07 11:52:50 +02:00
parent 77d06b4b03
commit 5de706e0fe
1 changed files with 91 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

156
module/Core/test/EventDispatcher/LocateVisitTest.php
View File

@ -11,8 +11,6 @@ use Prophecy\PhpUnit\ProphecyTrait;
use Prophecy\Prophecy\ObjectProphecy; use Prophecy\Prophecy\ObjectProphecy;
use Psr\EventDispatcher\EventDispatcherInterface; use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Log\LoggerInterface; use Psr\Log\LoggerInterface;
use Shlinkio\Shlink\CLI\Exception\GeolocationDbUpdateFailedException;
use Shlinkio\Shlink\CLI\Util\GeolocationDbUpdaterInterface;
use Shlinkio\Shlink\Common\Util\IpAddress; use Shlinkio\Shlink\Common\Util\IpAddress;
use Shlinkio\Shlink\Core\Entity\ShortUrl; use Shlinkio\Shlink\Core\Entity\ShortUrl;
use Shlinkio\Shlink\Core\Entity\Visit; use Shlinkio\Shlink\Core\Entity\Visit;
@ -22,6 +20,7 @@ use Shlinkio\Shlink\Core\EventDispatcher\Event\VisitLocated;
use Shlinkio\Shlink\Core\EventDispatcher\LocateVisit; use Shlinkio\Shlink\Core\EventDispatcher\LocateVisit;
use Shlinkio\Shlink\Core\Model\Visitor; use Shlinkio\Shlink\Core\Model\Visitor;
use Shlinkio\Shlink\IpGeolocation\Exception\WrongIpException; use Shlinkio\Shlink\IpGeolocation\Exception\WrongIpException;
use Shlinkio\Shlink\IpGeolocation\GeoLite2\DbUpdaterInterface;
use Shlinkio\Shlink\IpGeolocation\Model\Location; use Shlinkio\Shlink\IpGeolocation\Model\Location;
use Shlinkio\Shlink\IpGeolocation\Resolver\IpLocationResolverInterface; use Shlinkio\Shlink\IpGeolocation\Resolver\IpLocationResolverInterface;
@ -41,9 +40,11 @@ class LocateVisitTest extends TestCase
$this->ipLocationResolver = $this->prophesize(IpLocationResolverInterface::class); $this->ipLocationResolver = $this->prophesize(IpLocationResolverInterface::class);
$this->em = $this->prophesize(EntityManagerInterface::class); $this->em = $this->prophesize(EntityManagerInterface::class);
$this->logger = $this->prophesize(LoggerInterface::class); $this->logger = $this->prophesize(LoggerInterface::class);
$this->dbUpdater = $this->prophesize(GeolocationDbUpdaterInterface::class);
$this->eventDispatcher = $this->prophesize(EventDispatcherInterface::class); $this->eventDispatcher = $this->prophesize(EventDispatcherInterface::class);
$this->dbUpdater = $this->prophesize(DbUpdaterInterface::class);
$this->dbUpdater->databaseFileExists()->willReturn(true);
$this->locateVisit = new LocateVisit( $this->locateVisit = new LocateVisit(
$this->ipLocationResolver->reveal(), $this->ipLocationResolver->reveal(),
$this->em->reveal(), $this->em->reveal(),
@ -73,6 +74,31 @@ class LocateVisitTest extends TestCase
$dispatch->shouldNotHaveBeenCalled(); $dispatch->shouldNotHaveBeenCalled();
} }
/** @test */
public function nonExistingGeoLiteDbLogsWarning(): void
{
$event = new UrlVisited('123');
$findVisit = $this->em->find(Visit::class, '123')->willReturn(
Visit::forValidShortUrl(ShortUrl::createEmpty(), new Visitor('', '', '1.2.3.4', '')),
);
$dbExists = $this->dbUpdater->databaseFileExists()->willReturn(false);
$logWarning = $this->logger->warning(
'Tried to locate visit with id "{visitId}", but a GeoLite2 db was not found.',
['visitId' => 123],
);
$dispatch = $this->eventDispatcher->dispatch(new VisitLocated('123'))->will(function (): void {
});
($this->locateVisit)($event);
$findVisit->shouldHaveBeenCalledOnce();
$dbExists->shouldHaveBeenCalledOnce();
$this->em->flush()->shouldNotHaveBeenCalled();
$this->ipLocationResolver->resolveIpLocation(Argument::cetera())->shouldNotHaveBeenCalled();
$logWarning->shouldHaveBeenCalled();
$dispatch->shouldNotHaveBeenCalled();
}
/** @test */ /** @test */
public function invalidAddressLogsWarning(): void public function invalidAddressLogsWarning(): void
{ {
@ -174,66 +200,66 @@ class LocateVisitTest extends TestCase
yield 'regular not found' => [Visit::forRegularNotFound(new Visitor('', '', '1.2.3.4', '')), '1.2.3.4']; yield 'regular not found' => [Visit::forRegularNotFound(new Visitor('', '', '1.2.3.4', '')), '1.2.3.4'];
} }
/** @test */ // /** @test */
public function errorWhenUpdatingGeoLiteWithExistingCopyLogsWarning(): void // public function errorWhenUpdatingGeoLiteWithExistingCopyLogsWarning(): void
{ // {
$e = GeolocationDbUpdateFailedException::withOlderDb(); // $e = GeolocationDbUpdateFailedException::withOlderDb();
$ipAddr = '1.2.3.0'; // $ipAddr = '1.2.3.0';
$visit = Visit::forValidShortUrl(ShortUrl::createEmpty(), new Visitor('', '', $ipAddr, '')); // $visit = Visit::forValidShortUrl(ShortUrl::createEmpty(), new Visitor('', '', $ipAddr, ''));
$location = new Location('', '', '', '', 0.0, 0.0, ''); // $location = new Location('', '', '', '', 0.0, 0.0, '');
$event = new UrlVisited('123'); // $event = new UrlVisited('123');
//
$findVisit = $this->em->find(Visit::class, '123')->willReturn($visit); // $findVisit = $this->em->find(Visit::class, '123')->willReturn($visit);
$flush = $this->em->flush()->will(function (): void { // $flush = $this->em->flush()->will(function (): void {
}); // });
$resolveIp = $this->ipLocationResolver->resolveIpLocation($ipAddr)->willReturn($location); // $resolveIp = $this->ipLocationResolver->resolveIpLocation($ipAddr)->willReturn($location);
$checkUpdateDb = $this->dbUpdater->checkDbUpdate(Argument::cetera())->willThrow($e); // $checkUpdateDb = $this->dbUpdater->checkDbUpdate(Argument::cetera())->willThrow($e);
$dispatch = $this->eventDispatcher->dispatch(new VisitLocated('123'))->will(function (): void { // $dispatch = $this->eventDispatcher->dispatch(new VisitLocated('123'))->will(function (): void {
}); // });
//
($this->locateVisit)($event); // ($this->locateVisit)($event);
//
self::assertEquals($visit->getVisitLocation(), new VisitLocation($location)); // self::assertEquals($visit->getVisitLocation(), new VisitLocation($location));
$findVisit->shouldHaveBeenCalledOnce(); // $findVisit->shouldHaveBeenCalledOnce();
$flush->shouldHaveBeenCalledOnce(); // $flush->shouldHaveBeenCalledOnce();
$resolveIp->shouldHaveBeenCalledOnce(); // $resolveIp->shouldHaveBeenCalledOnce();
$checkUpdateDb->shouldHaveBeenCalledOnce(); // $checkUpdateDb->shouldHaveBeenCalledOnce();
$this->logger->warning( // $this->logger->warning(
'GeoLite2 database update failed. Proceeding with old version. {e}', // 'GeoLite2 database update failed. Proceeding with old version. {e}',
['e' => $e], // ['e' => $e],
)->shouldHaveBeenCalledOnce(); // )->shouldHaveBeenCalledOnce();
$dispatch->shouldHaveBeenCalledOnce(); // $dispatch->shouldHaveBeenCalledOnce();
} // }
//
/** @test */ // /** @test */
public function errorWhenDownloadingGeoLiteCancelsLocation(): void // public function errorWhenDownloadingGeoLiteCancelsLocation(): void
{ // {
$e = GeolocationDbUpdateFailedException::withoutOlderDb(); // $e = GeolocationDbUpdateFailedException::withoutOlderDb();
$ipAddr = '1.2.3.0'; // $ipAddr = '1.2.3.0';
$visit = Visit::forValidShortUrl(ShortUrl::createEmpty(), new Visitor('', '', $ipAddr, '')); // $visit = Visit::forValidShortUrl(ShortUrl::createEmpty(), new Visitor('', '', $ipAddr, ''));
$location = new Location('', '', '', '', 0.0, 0.0, ''); // $location = new Location('', '', '', '', 0.0, 0.0, '');
$event = new UrlVisited('123'); // $event = new UrlVisited('123');
//
$findVisit = $this->em->find(Visit::class, '123')->willReturn($visit); // $findVisit = $this->em->find(Visit::class, '123')->willReturn($visit);
$flush = $this->em->flush()->will(function (): void { // $flush = $this->em->flush()->will(function (): void {
}); // });
$resolveIp = $this->ipLocationResolver->resolveIpLocation($ipAddr)->willReturn($location); // $resolveIp = $this->ipLocationResolver->resolveIpLocation($ipAddr)->willReturn($location);
$checkUpdateDb = $this->dbUpdater->checkDbUpdate(Argument::cetera())->willThrow($e); // $checkUpdateDb = $this->dbUpdater->checkDbUpdate(Argument::cetera())->willThrow($e);
$logError = $this->logger->error( // $logError = $this->logger->error(
'GeoLite2 database download failed. It is not possible to locate visit with id {visitId}. {e}', // 'GeoLite2 database download failed. It is not possible to locate visit with id {visitId}. {e}',
['e' => $e, 'visitId' => 123], // ['e' => $e, 'visitId' => 123],
); // );
$dispatch = $this->eventDispatcher->dispatch(new VisitLocated('123'))->will(function (): void { // $dispatch = $this->eventDispatcher->dispatch(new VisitLocated('123'))->will(function (): void {
}); // });
//
($this->locateVisit)($event); // ($this->locateVisit)($event);
//
self::assertNull($visit->getVisitLocation()); // self::assertNull($visit->getVisitLocation());
$findVisit->shouldHaveBeenCalledOnce(); // $findVisit->shouldHaveBeenCalledOnce();
$flush->shouldNotHaveBeenCalled(); // $flush->shouldNotHaveBeenCalled();
$resolveIp->shouldNotHaveBeenCalled(); // $resolveIp->shouldNotHaveBeenCalled();
$checkUpdateDb->shouldHaveBeenCalledOnce(); // $checkUpdateDb->shouldHaveBeenCalledOnce();
$logError->shouldHaveBeenCalledOnce(); // $logError->shouldHaveBeenCalledOnce();
$dispatch->shouldHaveBeenCalledOnce(); // $dispatch->shouldHaveBeenCalledOnce();
} // }
} }