OilfieldToolsNet/shlink
4
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-11-22 08:56:42 -06:00
Code Issues Packages Projects Releases Wiki Activity

Created DownloadGeoLiteDbCommandTest

Browse Source
This commit is contained in:
Alejandro Celaya 2021-04-08 13:34:14 +02:00
parent f7b6f4ba19
commit 1f8994ca8b
4 changed files with 122 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
module/CLI/src/Command/Visit/DownloadGeoLiteDbCommand.php
View File

@ -51,11 +51,11 @@ class DownloadGeoLiteDbCommand extends Command
$this->progressBar->setProgress($downloaded);
});
if ($this->progressBar !== null) {
if ($this->progressBar === null) {
$io->info('GeoLite2 db file is up to date.');
} else {
$this->progressBar->finish();
$io->success('GeoLite2 db file properly downloaded.');
} else {
$io->info('GeoLite2 db file is up to date.');
}
return ExitCodes::EXIT_SUCCESS;

12
module/CLI/test/CliTestUtilsTrait.php
View File

@ -9,6 +9,7 @@ use Prophecy\PhpUnit\ProphecyTrait;
use Prophecy\Prophecy\ObjectProphecy;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Tester\CommandTester;
trait CliTestUtilsTrait
{
@ -29,4 +30,15 @@ trait CliTestUtilsTrait
return $command;
}
private function testerForCommand(Command $mainCommand, Command ...$extraCommands): CommandTester
{
$app = new Application();
$app->add($mainCommand);
foreach ($extraCommands as $command) {
$app->add($command);
}
return new CommandTester($mainCommand);
}
}

107
module/CLI/test/Command/Visit/DownloadGeoLiteDbCommandTest.php Normal file
View File

@ -0,0 +1,107 @@
<?php
declare(strict_types=1);
namespace ShlinkioTest\Shlink\CLI\Command\Visit;
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
use Prophecy\Prophecy\ObjectProphecy;
use Shlinkio\Shlink\CLI\Command\Visit\DownloadGeoLiteDbCommand;
use Shlinkio\Shlink\CLI\Exception\GeolocationDbUpdateFailedException;
use Shlinkio\Shlink\CLI\Util\ExitCodes;
use Shlinkio\Shlink\CLI\Util\GeolocationDbUpdaterInterface;
use ShlinkioTest\Shlink\CLI\CliTestUtilsTrait;
use Symfony\Component\Console\Tester\CommandTester;
use function sprintf;
class DownloadGeoLiteDbCommandTest extends TestCase
{
use CliTestUtilsTrait;
private CommandTester $commandTester;
private ObjectProphecy $dbUpdater;
protected function setUp(): void
{
$this->dbUpdater = $this->prophesize(GeolocationDbUpdaterInterface::class);
$this->commandTester = $this->testerForCommand(new DownloadGeoLiteDbCommand($this->dbUpdater->reveal()));
}
/**
* @test
* @dataProvider provideFailureParams
*/
public function showsProperMessageWhenGeoLiteUpdateFails(
bool $olderDbExists,
string $expectedMessage,
int $expectedExitCode
): void {
$checkDbUpdate = $this->dbUpdater->checkDbUpdate(Argument::cetera())->will(
function (array $args) use ($olderDbExists): void {
[$beforeDownload, $handleProgress] = $args;
$beforeDownload($olderDbExists);
$handleProgress(100, 50);
throw $olderDbExists
? GeolocationDbUpdateFailedException::withOlderDb()
: GeolocationDbUpdateFailedException::withoutOlderDb();
},
);
$this->commandTester->execute([]);
$output = $this->commandTester->getDisplay();
$exitCode = $this->commandTester->getStatusCode();
self::assertStringContainsString(
sprintf('%s GeoLite2 db file...', $olderDbExists ? 'Updating' : 'Downloading'),
$output,
);
self::assertStringContainsString($expectedMessage, $output);
self::assertSame($expectedExitCode, $exitCode);
$checkDbUpdate->shouldHaveBeenCalledOnce();
}
public function provideFailureParams(): iterable
{
yield 'existing db' => [
true,
'[WARNING] GeoLite2 db file update failed. Visits will continue to be located',
ExitCodes::EXIT_WARNING,
];
yield 'not existing db' => [
false,
'[ERROR] GeoLite2 db file download failed. It will not be possible to locate',
ExitCodes::EXIT_FAILURE,
];
}
/**
* @test
* @dataProvider provideSuccessParams
*/
public function printsExpectedMessageWhenNoErrorOccurs(callable $checkUpdateBehavior, string $expectedMessage): void
{
$checkDbUpdate = $this->dbUpdater->checkDbUpdate(Argument::cetera())->will($checkUpdateBehavior);
$this->commandTester->execute([]);
$output = $this->commandTester->getDisplay();
$exitCode = $this->commandTester->getStatusCode();
self::assertStringContainsString($expectedMessage, $output);
self::assertSame(ExitCodes::EXIT_SUCCESS, $exitCode);
$checkDbUpdate->shouldHaveBeenCalledOnce();
}
public function provideSuccessParams(): iterable
{
yield 'up to date db' => [function (): void {
}, '[INFO] GeoLite2 db file is up to date.'];
yield 'outdated db' => [function (array $args): void {
[$beforeDownload] = $args;
$beforeDownload(true);
}, '[OK] GeoLite2 db file properly downloaded.'];
}
}

39
module/CLI/test/Command/Visit/LocateVisitsCommandTest.php
View File

@ -216,45 +216,6 @@ class LocateVisitsCommandTest extends TestCase
$this->visitService->locateUnlocatedVisits(Argument::cetera())->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 db file...', $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
{