Command to remove old session tokens

Author: tatevikg1

config/services/commands.yml

@@ -8,3 +8,6 @@ services:
     resource: '../../src/Domain/Messaging/Command'
     tags: ['console.command']
 
+  PhpList\Core\Domain\Identity\Command\:
+    resource: '../../src/Domain/Identity/Command'
+    tags: ['console.command']

src/Domain/Identity/Command/CleanUpOldSessionTokens.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Identity\Command;
+
+use PhpList\Core\Domain\Identity\Repository\AdministratorTokenRepository;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Throwable;
+
+#[AsCommand(
+    name: 'phplist:clean-up-old-session-tokens',
+    description: 'Removes expired administrator session tokens.'
+)]
+class CleanUpOldSessionTokens extends Command
+{
+    private AdministratorTokenRepository $tokenRepository;
+
+    public function __construct(AdministratorTokenRepository $tokenRepository)
+    {
+        parent::__construct();
+        $this->tokenRepository = $tokenRepository;
+    }
+
+    /**
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        try {
+            $deletedCount = $this->tokenRepository->removeExpired();
+            $output->writeln(sprintf('Successfully removed %d expired session token(s).', $deletedCount));
+        } catch (Throwable $throwable) {
+            $output->writeln(sprintf('Error removing expired session tokens: %s', $throwable->getMessage()));
+            return Command::FAILURE;
+        }
+
+        return Command::SUCCESS;
+    }
+}

tests/Unit/Domain/Identity/Command/CleanUpOldSessionTokensTest.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Tests\Unit\Domain\Identity\Command;
+
+use Exception;
+use PhpList\Core\Domain\Identity\Command\CleanUpOldSessionTokens;
+use PhpList\Core\Domain\Identity\Repository\AdministratorTokenRepository;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Tester\CommandTester;
+
+class CleanUpOldSessionTokensTest extends TestCase
+{
+    private AdministratorTokenRepository&MockObject $tokenRepository;
+    private CommandTester $commandTester;
+
+    protected function setUp(): void
+    {
+        $this->tokenRepository = $this->createMock(AdministratorTokenRepository::class);
+
+        $command = new CleanUpOldSessionTokens($this->tokenRepository);
+
+        $application = new Application();
+        $application->add($command);
+
+        $this->commandTester = new CommandTester($command);
+    }
+
+    public function testExecuteSuccessfully(): void
+    {
+        $this->tokenRepository->expects($this->once())
+            ->method('removeExpired')
+            ->willReturn(5);
+
+        $this->commandTester->execute([]);
+
+        $output = $this->commandTester->getDisplay();
+        $this->assertStringContainsString('Successfully removed 5 expired session token(s)', $output);
+        $this->assertEquals(0, $this->commandTester->getStatusCode());
+    }
+
+    public function testExecuteWithNoExpiredTokens(): void
+    {
+        $this->tokenRepository->expects($this->once())
+            ->method('removeExpired')
+            ->willReturn(0);
+
+        $this->commandTester->execute([]);
+
+        $output = $this->commandTester->getDisplay();
+        $this->assertStringContainsString('Successfully removed 0 expired session token(s)', $output);
+        $this->assertEquals(0, $this->commandTester->getStatusCode());
+    }
+
+    public function testExecuteWithException(): void
+    {
+        $this->tokenRepository->expects($this->once())
+            ->method('removeExpired')
+            ->willThrowException(new Exception('Test exception'));
+
+        $this->commandTester->execute([]);
+
+        $output = $this->commandTester->getDisplay();
+        $this->assertStringContainsString('Error removing expired session tokens: Test exception', $output);
+        $this->assertEquals(1, $this->commandTester->getStatusCode());
+    }
+}