123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272 |
- <?php
- declare(strict_types=1);
- namespace ShlinkioTest\Shlink\CLI\Command\Visit;
- use PHPUnit\Framework\TestCase;
- use Prophecy\Argument;
- use Prophecy\PhpUnit\ProphecyTrait;
- use Prophecy\Prophecy\ObjectProphecy;
- use Shlinkio\Shlink\CLI\Command\Visit\LocateVisitsCommand;
- use Shlinkio\Shlink\CLI\Exception\GeolocationDbUpdateFailedException;
- use Shlinkio\Shlink\CLI\Util\GeolocationDbUpdaterInterface;
- use Shlinkio\Shlink\Common\Util\IpAddress;
- use Shlinkio\Shlink\Core\Entity\ShortUrl;
- use Shlinkio\Shlink\Core\Entity\Visit;
- use Shlinkio\Shlink\Core\Entity\VisitLocation;
- use Shlinkio\Shlink\Core\Model\Visitor;
- use Shlinkio\Shlink\Core\Visit\VisitGeolocationHelperInterface;
- use Shlinkio\Shlink\Core\Visit\VisitLocator;
- use Shlinkio\Shlink\IpGeolocation\Exception\WrongIpException;
- use Shlinkio\Shlink\IpGeolocation\Model\Location;
- use Shlinkio\Shlink\IpGeolocation\Resolver\IpLocationResolverInterface;
- use Symfony\Component\Console\Application;
- use Symfony\Component\Console\Exception\RuntimeException;
- use Symfony\Component\Console\Output\OutputInterface;
- use Symfony\Component\Console\Tester\CommandTester;
- use Symfony\Component\Lock;
- use function sprintf;
- use const PHP_EOL;
- class LocateVisitsCommandTest extends TestCase
- {
- use ProphecyTrait;
- private CommandTester $commandTester;
- private ObjectProphecy $visitService;
- private ObjectProphecy $ipResolver;
- private ObjectProphecy $lock;
- private ObjectProphecy $dbUpdater;
- public function setUp(): void
- {
- $this->visitService = $this->prophesize(VisitLocator::class);
- $this->ipResolver = $this->prophesize(IpLocationResolverInterface::class);
- $this->dbUpdater = $this->prophesize(GeolocationDbUpdaterInterface::class);
- $locker = $this->prophesize(Lock\LockFactory::class);
- $this->lock = $this->prophesize(Lock\LockInterface::class);
- $this->lock->acquire(false)->willReturn(true);
- $this->lock->release()->will(function (): void {
- });
- $locker->createLock(Argument::type('string'), 600.0, false)->willReturn($this->lock->reveal());
- $command = new LocateVisitsCommand(
- $this->visitService->reveal(),
- $this->ipResolver->reveal(),
- $locker->reveal(),
- $this->dbUpdater->reveal(),
- );
- $app = new Application();
- $app->add($command);
- $this->commandTester = new CommandTester($command);
- }
- /**
- * @test
- * @dataProvider provideArgs
- */
- public function expectedSetOfVisitsIsProcessedBasedOnArgs(
- int $expectedUnlocatedCalls,
- int $expectedEmptyCalls,
- int $expectedAllCalls,
- bool $expectWarningPrint,
- array $args
- ): void {
- $visit = Visit::forValidShortUrl(ShortUrl::createEmpty(), new Visitor('', '', '1.2.3.4', ''));
- $location = new VisitLocation(Location::emptyInstance());
- $mockMethodBehavior = $this->invokeHelperMethods($visit, $location);
- $locateVisits = $this->visitService->locateUnlocatedVisits(Argument::cetera())->will($mockMethodBehavior);
- $locateEmptyVisits = $this->visitService->locateVisitsWithEmptyLocation(Argument::cetera())->will(
- $mockMethodBehavior,
- );
- $locateAllVisits = $this->visitService->locateAllVisits(Argument::cetera())->will($mockMethodBehavior);
- $resolveIpLocation = $this->ipResolver->resolveIpLocation(Argument::any())->willReturn(
- Location::emptyInstance(),
- );
- $this->commandTester->setInputs(['y']);
- $this->commandTester->execute($args);
- $output = $this->commandTester->getDisplay();
- self::assertStringContainsString('Processing IP 1.2.3.0', $output);
- if ($expectWarningPrint) {
- self::assertStringContainsString('Continue at your own', $output);
- } else {
- self::assertStringNotContainsString('Continue at your own', $output);
- }
- $locateVisits->shouldHaveBeenCalledTimes($expectedUnlocatedCalls);
- $locateEmptyVisits->shouldHaveBeenCalledTimes($expectedEmptyCalls);
- $locateAllVisits->shouldHaveBeenCalledTimes($expectedAllCalls);
- $resolveIpLocation->shouldHaveBeenCalledTimes(
- $expectedUnlocatedCalls + $expectedEmptyCalls + $expectedAllCalls,
- );
- }
- public function provideArgs(): iterable
- {
- yield 'no args' => [1, 0, 0, false, []];
- yield 'retry' => [1, 1, 0, false, ['--retry' => true]];
- yield 'all' => [0, 0, 1, true, ['--retry' => true, '--all' => true]];
- }
- /**
- * @test
- * @dataProvider provideIgnoredAddresses
- */
- public function localhostAndEmptyAddressesAreIgnored(?string $address, string $message): void
- {
- $visit = Visit::forValidShortUrl(ShortUrl::createEmpty(), new Visitor('', '', $address, ''));
- $location = new VisitLocation(Location::emptyInstance());
- $locateVisits = $this->visitService->locateUnlocatedVisits(Argument::cetera())->will(
- $this->invokeHelperMethods($visit, $location),
- );
- $resolveIpLocation = $this->ipResolver->resolveIpLocation(Argument::any())->willReturn(
- Location::emptyInstance(),
- );
- $this->commandTester->execute([], ['verbosity' => OutputInterface::VERBOSITY_VERBOSE]);
- $output = $this->commandTester->getDisplay();
- self::assertStringContainsString($message, $output);
- if (empty($address)) {
- self::assertStringNotContainsString('Processing IP', $output);
- } else {
- self::assertStringContainsString('Processing IP', $output);
- }
- $locateVisits->shouldHaveBeenCalledOnce();
- $resolveIpLocation->shouldNotHaveBeenCalled();
- }
- public function provideIgnoredAddresses(): iterable
- {
- yield 'with empty address' => ['', 'Ignored visit with no IP address'];
- yield 'with null address' => [null, 'Ignored visit with no IP address'];
- yield 'with localhost address' => [IpAddress::LOCALHOST, 'Ignored localhost address'];
- }
- /** @test */
- public function errorWhileLocatingIpIsDisplayed(): void
- {
- $visit = Visit::forValidShortUrl(ShortUrl::createEmpty(), new Visitor('', '', '1.2.3.4', ''));
- $location = new VisitLocation(Location::emptyInstance());
- $locateVisits = $this->visitService->locateUnlocatedVisits(Argument::cetera())->will(
- $this->invokeHelperMethods($visit, $location),
- );
- $resolveIpLocation = $this->ipResolver->resolveIpLocation(Argument::any())->willThrow(WrongIpException::class);
- $this->commandTester->execute([], ['verbosity' => OutputInterface::VERBOSITY_VERBOSE]);
- $output = $this->commandTester->getDisplay();
- self::assertStringContainsString('An error occurred while locating IP. Skipped', $output);
- $locateVisits->shouldHaveBeenCalledOnce();
- $resolveIpLocation->shouldHaveBeenCalledOnce();
- }
- private function invokeHelperMethods(Visit $visit, VisitLocation $location): callable
- {
- return function (array $args) use ($visit, $location): void {
- /** @var VisitGeolocationHelperInterface $helper */
- [$helper] = $args;
- $helper->geolocateVisit($visit);
- $helper->onVisitLocated($location, $visit);
- };
- }
- /** @test */
- public function noActionIsPerformedIfLockIsAcquired(): void
- {
- $this->lock->acquire(false)->willReturn(false);
- $locateVisits = $this->visitService->locateUnlocatedVisits(Argument::cetera())->will(function (): void {
- });
- $resolveIpLocation = $this->ipResolver->resolveIpLocation(Argument::any())->willReturn([]);
- $this->commandTester->execute([], ['verbosity' => OutputInterface::VERBOSITY_VERBOSE]);
- $output = $this->commandTester->getDisplay();
- self::assertStringContainsString(
- sprintf('Command "%s" is already in progress. Skipping.', LocateVisitsCommand::NAME),
- $output,
- );
- $locateVisits->shouldNotHaveBeenCalled();
- $resolveIpLocation->shouldNotHaveBeenCalled();
- }
- /**
- * @test
- * @dataProvider provideParams
- */
- public function showsProperMessageWhenGeoLiteUpdateFails(bool $olderDbExists, string $expectedMessage): void
- {
- $locateVisits = $this->visitService->locateUnlocatedVisits(Argument::cetera())->will(function (): void {
- });
- $checkDbUpdate = $this->dbUpdater->checkDbUpdate(Argument::cetera())->will(
- function (array $args) use ($olderDbExists): void {
- [$mustBeUpdated, $handleProgress] = $args;
- $mustBeUpdated($olderDbExists);
- $handleProgress(100, 50);
- throw $olderDbExists
- ? GeolocationDbUpdateFailedException::withOlderDb()
- : GeolocationDbUpdateFailedException::withoutOlderDb();
- },
- );
- $this->commandTester->execute([]);
- $output = $this->commandTester->getDisplay();
- self::assertStringContainsString(
- sprintf('%s GeoLite2 database...', $olderDbExists ? 'Updating' : 'Downloading'),
- $output,
- );
- self::assertStringContainsString($expectedMessage, $output);
- $locateVisits->shouldHaveBeenCalledTimes((int) $olderDbExists);
- $checkDbUpdate->shouldHaveBeenCalledOnce();
- }
- public function provideParams(): iterable
- {
- yield [true, '[Warning] GeoLite2 database update failed. Proceeding with old version.'];
- yield [false, 'GeoLite2 database download failed. It is not possible to locate visits.'];
- }
- /** @test */
- public function providingAllFlagOnItsOwnDisplaysNotice(): void
- {
- $this->commandTester->execute(['--all' => true]);
- $output = $this->commandTester->getDisplay();
- self::assertStringContainsString('The --all flag has no effect on its own', $output);
- }
- /**
- * @test
- * @dataProvider provideAbortInputs
- */
- public function processingAllCancelsCommandIfUserDoesNotActivelyAgreeToConfirmation(array $inputs): void
- {
- $this->expectException(RuntimeException::class);
- $this->expectExceptionMessage('Execution aborted');
- $this->commandTester->setInputs($inputs);
- $this->commandTester->execute(['--all' => true, '--retry' => true]);
- }
- public function provideAbortInputs(): iterable
- {
- yield 'n' => [['n']];
- yield 'no' => [['no']];
- yield 'default' => [[PHP_EOL]];
- }
- }
|