Merge pull request #89 from synolia/feature/plan-command-once

plan command once

Author: oallain

src/Planner/ScheduledCommandPlanner.php

@@ -9,18 +9,31 @@
 use Sylius\Component\Resource\Factory\FactoryInterface;
 use Synolia\SyliusSchedulerCommandPlugin\Entity\CommandInterface;
 use Synolia\SyliusSchedulerCommandPlugin\Entity\ScheduledCommandInterface;
+use Synolia\SyliusSchedulerCommandPlugin\Enum\ScheduledCommandStateEnum;
+use Synolia\SyliusSchedulerCommandPlugin\Repository\ScheduledCommandRepository;
 
 class ScheduledCommandPlanner implements ScheduledCommandPlannerInterface
 {
     public function __construct(
         private FactoryInterface $scheduledCommandFactory,
         private EntityManagerInterface $entityManager,
+        private ScheduledCommandRepository $scheduledCommandRepository,
         private LoggerInterface $logger,
     ) {
     }
 
     public function plan(CommandInterface $command): ScheduledCommandInterface
     {
+        /** @var ScheduledCommandInterface[] $scheduledCommands */
+        $scheduledCommands = $this->scheduledCommandRepository->findBy([
+            'command' => $command->getCommand(),
+            'state' => ScheduledCommandStateEnum::WAITING,
+        ]);
+
+        if (0 !== count($scheduledCommands)) {
+            return array_shift($scheduledCommands);
+        }
+
         /** @var ScheduledCommandInterface $scheduledCommand */
         $scheduledCommand = $this->scheduledCommandFactory->createNew();
 

tests/PHPUnit/AbstractIsDueTest.php

@@ -17,11 +17,15 @@ abstract class AbstractIsDueTest extends KernelTestCase
     /** @var EntityManagerInterface */
     protected $entityManager;
 
-    public function setUp(): void
+    public static function setUpBeforeClass(): void
     {
-        parent::setUp();
         $kernel = self::bootKernel();
         self::initDatabase($kernel);
+    }
+
+    public function setUp(): void
+    {
+        parent::setUp();
 
         $this->entityManager = static::getContainer()->get(EntityManagerInterface::class);
         $this->entityManager->beginTransaction();

tests/PHPUnit/Command/PurgeScheduledCommandCommandTest.php

@@ -25,10 +25,15 @@ final class PurgeScheduledCommandCommandTest extends KernelTestCase
 
     private ReflectionClass $reflectionClass;
 
-    public function setUp(): void
+    public static function setUpBeforeClass(): void
     {
-        $kernel = static::bootKernel();
+        $kernel = self::bootKernel();
         self::initDatabase($kernel);
+    }
+
+    public function setUp(): void
+    {
+        parent::setUp();
 
         $this->entityManager = static::getContainer()->get(EntityManagerInterface::class);
         $this->entityManager->beginTransaction();

tests/PHPUnit/Command/SynoliaSchedulerRunCommandTest.php

@@ -23,10 +23,15 @@ final class SynoliaSchedulerRunCommandTest extends KernelTestCase
 
     private ?EntityManagerInterface $entityManager = null;
 
-    public function setUp(): void
+    public static function setUpBeforeClass(): void
     {
-        $kernel = static::bootKernel();
+        $kernel = self::bootKernel();
         self::initDatabase($kernel);
+    }
+
+    public function setUp(): void
+    {
+        parent::setUp();
 
         $this->entityManager = static::getContainer()->get(EntityManagerInterface::class);
         $this->entityManager->beginTransaction();

tests/PHPUnit/Planner/ScheduledCommandPlannerTest.php

@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Synolia\SyliusSchedulerCommandPlugin\PHPUnit\Planner;
+
+use function Amp\Promise\first;
+use Doctrine\ORM\EntityManagerInterface;
+use Sylius\Component\Resource\Factory\Factory;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Synolia\SyliusSchedulerCommandPlugin\Entity\Command;
+use Synolia\SyliusSchedulerCommandPlugin\Entity\ScheduledCommandInterface;
+use Synolia\SyliusSchedulerCommandPlugin\Enum\ScheduledCommandStateEnum;
+use Synolia\SyliusSchedulerCommandPlugin\Planner\ScheduledCommandPlannerInterface;
+use Tests\Synolia\SyliusSchedulerCommandPlugin\PHPUnit\WithDatabaseTrait;
+
+class ScheduledCommandPlannerTest extends KernelTestCase
+{
+    use WithDatabaseTrait;
+
+    private EntityManagerInterface $entityManager;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+        $kernel = self::bootKernel();
+        self::initDatabase($kernel);
+        $this->entityManager = static::getContainer()->get(EntityManagerInterface::class);
+    }
+
+    public function testPlanACommand(): void
+    {
+        $command = $this->getCommand();
+
+        /** @var ScheduledCommandPlannerInterface $planner */
+        $planner = static::getContainer()->get(ScheduledCommandPlannerInterface::class);
+        $scheduledCommand = $planner->plan($command);
+
+        $count = $this->entityManager->getRepository(ScheduledCommandInterface::class)->count([]);
+        $this->assertEquals(1, $count);
+
+        $scheduledCommandsOnDatabase = $this->entityManager->getRepository(ScheduledCommandInterface::class)->findBy([
+            'command' => 'about',
+            'state' => ScheduledCommandStateEnum::WAITING,
+        ]);
+        $this->assertCount(1, $scheduledCommandsOnDatabase);
+        /** @var ScheduledCommandInterface $scheduledCommandOnDatabase */
+        $scheduledCommandOnDatabase = $scheduledCommandsOnDatabase[0];
+        $this->assertSame($scheduledCommand->getCommand(), $scheduledCommandOnDatabase->getCommand());
+    }
+
+    public function testPlanACommandTwice(): void
+    {
+        $command = $this->getCommand();
+
+        /** @var ScheduledCommandPlannerInterface $planner */
+        $planner = static::getContainer()->get(ScheduledCommandPlannerInterface::class);
+        // first plan
+        $planner->plan($command);
+        // seconde plan
+        $planner->plan($command);
+
+        $scheduledCommandsOnDatabase = $this->entityManager->getRepository(ScheduledCommandInterface::class)->findBy([
+            'command' => 'about',
+            'state' => ScheduledCommandStateEnum::WAITING,
+        ]);
+
+        // Command must by scheduled only once time
+        $this->assertCount(1, $scheduledCommandsOnDatabase);
+    }
+
+    private function getCommand(): Command
+    {
+        /** @var Command $command */
+        $command = (new Factory(Command::class))->createNew();
+        $command
+            ->setName('Plan Command')
+            ->setCommand('about')
+        ;
+
+        $this->entityManager->persist($command);
+        $this->entityManager->flush();
+
+        return $command;
+    }
+}

tests/PHPUnit/Service/ExecuteScheduleCommandTest.php

@@ -20,11 +20,15 @@ class ExecuteScheduleCommandTest extends WebTestCase
 
     private ?EntityManagerInterface $entityManager = null;
 
-    public function setUp(): void
+    public static function setUpBeforeClass(): void
     {
-        parent::setUp();
         $kernel = self::bootKernel();
         self::initDatabase($kernel);
+    }
+
+    public function setUp(): void
+    {
+        parent::setUp();
 
         $this->scheduleCommandRunner = static::getContainer()->get(ScheduleCommandRunnerInterface::class);
         $this->entityManager = static::getContainer()->get(EntityManagerInterface::class);

tests/PHPUnit/WithDatabaseTrait.php

@@ -5,6 +5,8 @@
 namespace Tests\Synolia\SyliusSchedulerCommandPlugin\PHPUnit;
 
 use Doctrine\ORM\Tools\SchemaTool;
+use Sylius\Bundle\FixturesBundle\Loader\SuiteLoaderInterface;
+use Sylius\Bundle\FixturesBundle\Suite\SuiteRegistryInterface;
 use Symfony\Component\HttpKernel\KernelInterface;
 
 trait WithDatabaseTrait
@@ -24,6 +26,12 @@ public static function initDatabase(KernelInterface $kernel)
         $schemaTool = new SchemaTool($entityManager);
         $schemaTool->updateSchema($metadatas);
 
-        // If you are using the Doctrine Fixtures Bundle you could load these here
+        /** @var SuiteRegistryInterface $suiteRegistry */
+        $suiteRegistry = $kernel->getContainer()->get(SuiteRegistryInterface::class);
+        $suite = $suiteRegistry->getSuite('default');
+
+        /** @var SuiteLoaderInterface $suiteLoader */
+        $suiteLoader = $kernel->getContainer()->get(SuiteLoaderInterface::class);
+        $suiteLoader->load($suite);
     }
 }