[cron-job] allow a cronjob to pass data from one execution to another

When a cronjob is executed, it may return an array of data.

This data will be passed as parameter on the next execution

src/Bundle/ChillMainBundle/Tests/Cron/CronJobDatabaseInteractionTest.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Cron;
+
+use Chill\MainBundle\Cron\CronJobInterface;
+use Chill\MainBundle\Cron\CronManager;
+use Chill\MainBundle\Entity\CronJobExecution;
+use Chill\MainBundle\Repository\CronJobExecutionRepository;
+use Doctrine\ORM\EntityManagerInterface;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Psr\Log\NullLogger;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+class CronJobDatabaseInteractionTest extends KernelTestCase
+{
+    use ProphecyTrait;
+
+    private EntityManagerInterface $entityManager;
+
+    private CronJobExecutionRepository $cronJobExecutionRepository;
+
+    protected function setUp(): void
+    {
+        self::bootKernel();
+        $this->entityManager = self::$container->get(EntityManagerInterface::class);
+        $this->cronJobExecutionRepository = self::$container->get(CronJobExecutionRepository::class);
+    }
+
+    public function testCompleteLifeCycle(): void
+    {
+        $cronjob = $this->prophesize(CronJobInterface::class);
+        $cronjob->canRun(null)->willReturn(true);
+        $cronjob->canRun(Argument::type(CronJobExecution::class))->willReturn(true);
+        $cronjob->getKey()->willReturn('test-with-data');
+        $cronjob->run([])->willReturn(['test' => 'execution-0']);
+        $cronjob->run(['test' => 'execution-0'])->willReturn(['test' => 'execution-1']);
+
+        $cronjob->run([])->shouldBeCalledOnce();
+        $cronjob->run(['test' => 'execution-0'])->shouldBeCalledOnce();
+
+        $manager = new CronManager(
+            $this->cronJobExecutionRepository,
+            $this->entityManager,
+            [$cronjob->reveal()],
+            new NullLogger()
+        );
+
+        // run a first time
+        $manager->run();
+
+        // run a second time
+        $manager->run();
+    }
+
+}
+
+class JobWithReturn implements CronJobInterface
+{
+    public function canRun(?CronJobExecution $cronJobExecution): bool
+    {
+        return true;
+    }
+
+    public function getKey(): string
+    {
+        return 'with-data';
+    }
+
+    public function run(array $lastExecutionData): null|array
+    {
+        return ['data' => 'test'];
+    }
+}

src/Bundle/ChillMainBundle/Tests/Cron/CronManagerTest.php

@@ -40,7 +40,7 @@ final class CronManagerTest extends TestCase
         $jobToExecute = $this->prophesize(CronJobInterface::class);
         $jobToExecute->getKey()->willReturn('to-exec');
         $jobToExecute->canRun(Argument::type(CronJobExecution::class))->willReturn(true);
-        $jobToExecute->run()->shouldBeCalled();
+        $jobToExecute->run([])->shouldBeCalled();
 
         $executions = [
             ['key' => $jobOld1->getKey(), 'lastStart' => new DateTimeImmutable('yesterday'), 'lastEnd' => new DateTimeImmutable('1 hours ago'), 'lastStatus' => CronJobExecution::SUCCESS],
@@ -64,7 +64,7 @@ final class CronManagerTest extends TestCase
         $jobAlreadyExecuted = new JobCanRun('k');
         $jobNeverExecuted = $this->prophesize(CronJobInterface::class);
         $jobNeverExecuted->getKey()->willReturn('never-executed');
-        $jobNeverExecuted->run()->shouldBeCalled();
+        $jobNeverExecuted->run([])->shouldBeCalled();
         $jobNeverExecuted->canRun(null)->willReturn(true);
 
         $executions = [
@@ -86,7 +86,7 @@ final class CronManagerTest extends TestCase
         $jobAlreadyExecuted = new JobCanRun('k');
         $jobNeverExecuted = $this->prophesize(CronJobInterface::class);
         $jobNeverExecuted->getKey()->willReturn('never-executed');
-        $jobNeverExecuted->run()->shouldBeCalled();
+        $jobNeverExecuted->run([])->shouldBeCalled();
         $jobNeverExecuted->canRun(null)->willReturn(true);
 
         $executions = [
@@ -178,8 +178,9 @@ class JobCanRun implements CronJobInterface
         return $this->key;
     }
 
-    public function run(): void
+    public function run(array $lastExecutionData): null|array
     {
+        return null;
     }
 }
 
@@ -195,7 +196,8 @@ class JobCannotRun implements CronJobInterface
         return 'job-b';
     }
 
-    public function run(): void
+    public function run(array $lastExecutionData): null|array
     {
+        return null;
     }
 }