Improved GetShortUrlVisitsCommand test

2026-03-06 23:33:13 +08:00 · 2022-05-24 17:43:13 +02:00
parent 353ac0fc0c
commit fba7b36245
1 changed files with 21 additions and 11 deletions
--- a/module/CLI/test/Command/ShortUrl/GetShortUrlVisitsCommandTest.php
+++ b/module/CLI/test/Command/ShortUrl/GetShortUrlVisitsCommandTest.php
@@ -0,0 +1,131 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink\CLI\Command\ShortUrl;
+
+use Cake\Chronos\Chronos;
+use Pagerfanta\Adapter\ArrayAdapter;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\Prophecy\ObjectProphecy;
+use Shlinkio\Shlink\CLI\Command\ShortUrl\GetShortUrlVisitsCommand;
+use Shlinkio\Shlink\Common\Paginator\Paginator;
+use Shlinkio\Shlink\Common\Util\DateRange;
+use Shlinkio\Shlink\Core\Entity\ShortUrl;
+use Shlinkio\Shlink\Core\Entity\Visit;
+use Shlinkio\Shlink\Core\Entity\VisitLocation;
+use Shlinkio\Shlink\Core\Model\ShortUrlIdentifier;
+use Shlinkio\Shlink\Core\Model\Visitor;
+use Shlinkio\Shlink\Core\Model\VisitsParams;
+use Shlinkio\Shlink\Core\Visit\VisitsStatsHelperInterface;
+use Shlinkio\Shlink\IpGeolocation\Model\Location;
+use ShlinkioTest\Shlink\CLI\CliTestUtilsTrait;
+use Symfony\Component\Console\Tester\CommandTester;
+
+use function Shlinkio\Shlink\Common\buildDateRange;
+use function sprintf;
+
+class GetShortUrlVisitsCommandTest extends TestCase
+{
+    use CliTestUtilsTrait;
+
+    private CommandTester $commandTester;
+    private ObjectProphecy $visitsHelper;
+
+    public function setUp(): void
+    {
+        $this->visitsHelper = $this->prophesize(VisitsStatsHelperInterface::class);
+        $command = new GetShortUrlVisitsCommand($this->visitsHelper->reveal());
+        $this->commandTester = $this->testerForCommand($command);
+    }
+
+    /** @test */
+    public function noDateFlagsTriesToListWithoutDateRange(): void
+    {
+        $shortCode = 'abc123';
+        $this->visitsHelper->visitsForShortUrl(
+            ShortUrlIdentifier::fromShortCodeAndDomain($shortCode),
+            new VisitsParams(DateRange::emptyInstance()),
+        )
+            ->willReturn(new Paginator(new ArrayAdapter([])))
+            ->shouldBeCalledOnce();
+
+        $this->commandTester->execute(['shortCode' => $shortCode]);
+    }
+
+    /** @test */
+    public function providingDateFlagsTheListGetsFiltered(): void
+    {
+        $shortCode = 'abc123';
+        $startDate = '2016-01-01';
+        $endDate = '2016-02-01';
+        $this->visitsHelper->visitsForShortUrl(
+            ShortUrlIdentifier::fromShortCodeAndDomain($shortCode),
+            new VisitsParams(buildDateRange(Chronos::parse($startDate), Chronos::parse($endDate))),
+        )
+            ->willReturn(new Paginator(new ArrayAdapter([])))
+            ->shouldBeCalledOnce();
+
+        $this->commandTester->execute([
+            'shortCode' => $shortCode,
+            '--start-date' => $startDate,
+            '--end-date' => $endDate,
+        ]);
+    }
+
+    /** @test */
+    public function providingInvalidDatesPrintsWarning(): void
+    {
+        $shortCode = 'abc123';
+        $startDate = 'foo';
+        $info = $this->visitsHelper->visitsForShortUrl(
+            ShortUrlIdentifier::fromShortCodeAndDomain($shortCode),
+            new VisitsParams(DateRange::emptyInstance()),
+        )->willReturn(new Paginator(new ArrayAdapter([])));
+
+        $this->commandTester->execute([
+            'shortCode' => $shortCode,
+            '--start-date' => $startDate,
+        ]);
+        $output = $this->commandTester->getDisplay();
+
+        $info->shouldHaveBeenCalledOnce();
+        self::assertStringContainsString(
+            sprintf('Ignored provided "start-date" since its value "%s" is not a valid date', $startDate),
+            $output,
+        );
+    }
+
+    /** @test */
+    public function outputIsProperlyGenerated(): void
+    {
+        $visit = Visit::forValidShortUrl(ShortUrl::createEmpty(), new Visitor('bar', 'foo', '', ''))->locate(
+            VisitLocation::fromGeolocation(new Location('', 'Spain', '', 'Madrid', 0, 0, '')),
+        );
+        $shortCode = 'abc123';
+        $this->visitsHelper->visitsForShortUrl(
+            ShortUrlIdentifier::fromShortCodeAndDomain($shortCode),
+            Argument::any(),
+        )->willReturn(
+            new Paginator(new ArrayAdapter([$visit])),
+        )->shouldBeCalledOnce();
+
+        $this->commandTester->execute(['shortCode' => $shortCode]);
+        $output = $this->commandTester->getDisplay();
+
+        echo $output;
+
+        self::assertEquals(
+            <<<OUTPUT
+            +---------+---------------------------+------------+---------+--------+
+            | Referer | Date                      | User agent | Country | City   |
+            +---------+---------------------------+------------+---------+--------+
+            | foo     | {$visit->getDate()->toAtomString()} | bar        | Spain   | Madrid |
+            +---------+---------------------------+------------+---------+--------+
+
+            OUTPUT,
+            $output,
+        );
+    }
+}