Add a way for JobExecution storage to be setup before used (#107)

* Add a way for JobExecution storage to be setup before used

* Fixed code style

* Test DoctrineDBALJobExecutionStorage::createSchema deprecated method

* Fixed wrong usage of magic constants

* Removed deprecation test

* Proper test without deprecation

Author: yann-eugone

src/SetupStorageCommand.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Bridge\Symfony\Console;
+
+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 Symfony\Component\Console\Style\SymfonyStyle;
+use Yokai\Batch\Storage\JobExecutionStorageInterface;
+use Yokai\Batch\Storage\SetupableJobExecutionStorageInterface;
+
+/**
+ * Prepare the required infrastructure for the job execution storage.
+ */
+#[AsCommand(name: 'yokai:batch:setup-storage', description: 'Prepare the required infrastructure for the storage')]
+final class SetupStorageCommand extends Command
+{
+    public function __construct(
+        private JobExecutionStorageInterface $storage,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this
+            ->setHelp(
+                <<<EOF
+The <info>%command.name%</info> command setups the job execution storage:
+
+    <info>php %command.full_name%</info>
+EOF
+            )
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        if ($this->storage instanceof SetupableJobExecutionStorageInterface) {
+            $this->storage->setup();
+            $io->success('The storage was set up successfully.');
+        } else {
+            $io->note('The storage does not support setup.');
+        }
+
+        return self::SUCCESS;
+    }
+}

tests/SetupStorageCommandTest.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Tests\Bridge\Symfony\Console;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Tester\CommandTester;
+use Yokai\Batch\Bridge\Symfony\Console\SetupStorageCommand;
+use Yokai\Batch\Exception\JobExecutionNotFoundException;
+use Yokai\Batch\JobExecution;
+use Yokai\Batch\Storage\JobExecutionStorageInterface;
+use Yokai\Batch\Storage\SetupableJobExecutionStorageInterface;
+
+final class SetupStorageCommandTest extends TestCase
+{
+    public function testSetupRequired(): void
+    {
+        $this->execute(
+            $storage = new class() implements
+                JobExecutionStorageInterface,
+                SetupableJobExecutionStorageInterface {
+                public bool $wasSetup = false;
+
+                public function setup(): void
+                {
+                    $this->wasSetup = true;
+                }
+
+                public function store(JobExecution $execution): void
+                {
+                }
+
+                public function remove(JobExecution $execution): void
+                {
+                }
+
+                public function retrieve(string $jobName, string $executionId): JobExecution
+                {
+                    throw new JobExecutionNotFoundException($jobName, $executionId);
+                }
+            },
+            '[OK] The storage was set up successfully.',
+        );
+        self::assertTrue($storage->wasSetup);
+    }
+
+    public function testSetupNotRequired(): void
+    {
+        $this->execute(
+            new class() implements JobExecutionStorageInterface {
+                public function store(JobExecution $execution): void
+                {
+                }
+
+                public function remove(JobExecution $execution): void
+                {
+                }
+
+                public function retrieve(string $jobName, string $executionId): JobExecution
+                {
+                    throw new JobExecutionNotFoundException($jobName, $executionId);
+                }
+            },
+            '! [NOTE] The storage does not support setup.',
+        );
+    }
+
+    private function execute(JobExecutionStorageInterface $storage, string $expected): void
+    {
+        $tester = new CommandTester(new SetupStorageCommand($storage));
+        $tester->execute([]);
+        $tester->assertCommandIsSuccessful();
+        self::assertSame($expected, \trim($tester->getDisplay(true)));
+    }
+}