Fix Canceling of stale workflow cronjob

Refactor workflow cancellation logic to encapsulate transition checks in a dedicated method, and update CronJob handling to use entity workflows instead of IDs. Enhance test coverage to ensure proper handling and instantiate mocks for EntityManagerInterface.
This commit is contained in:
2024-10-21 17:39:31 +02:00
parent 1d708a481d
commit 527cf23d4f
6 changed files with 73 additions and 29 deletions

View File

@@ -12,6 +12,7 @@ declare(strict_types=1);
namespace ChillMainBundle\Tests\Repository;
use Chill\MainBundle\Entity\User;
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
use Chill\MainBundle\Repository\Workflow\EntityWorkflowRepository;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
@@ -40,9 +41,13 @@ class EntityWorkflowRepositoryTest extends KernelTestCase
{
$repository = new EntityWorkflowRepository($this->em);
$actual = $repository->findWorkflowsWithoutFinalStepAndOlderThan(new \DateTimeImmutable('10 years ago'));
$actual = $repository->findWorkflowsWithoutFinalStepAndOlderThan((new \DateTimeImmutable('now'))->add(new \DateInterval('P10Y')));
self::assertIsArray($actual, 'check that the query is successful');
self::assertIsIterable($actual, 'check that the query is successful');
foreach ($actual as $entityWorkflow) {
self::assertInstanceOf(EntityWorkflow::class, $entityWorkflow);
}
}
public function testCountQueryByDest(): void

View File

@@ -9,12 +9,14 @@ declare(strict_types=1);
* the LICENSE file that was distributed with this source code.
*/
namespace Services\Workflow;
namespace ChillMainBundle\Tests\Services\Workflow;
use Chill\MainBundle\Entity\CronJobExecution;
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
use Chill\MainBundle\Repository\Workflow\EntityWorkflowRepository;
use Chill\MainBundle\Service\Workflow\CancelStaleWorkflowCronJob;
use Chill\MainBundle\Service\Workflow\CancelStaleWorkflowMessage;
use Doctrine\ORM\EntityManagerInterface;
use PHPUnit\Framework\MockObject\Exception;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;
@@ -39,8 +41,9 @@ class CancelStaleWorkflowCronJobTest extends TestCase
{
$clock = new MockClock(new \DateTimeImmutable('2024-01-01 00:00:00', new \DateTimeZone('+00:00')));
$logger = $this->createMock(LoggerInterface::class);
$entityManager = $this->createMock(EntityManagerInterface::class);
$cronJob = new CancelStaleWorkflowCronJob($this->createMock(EntityWorkflowRepository::class), $clock, $this->buildMessageBus(), $logger);
$cronJob = new CancelStaleWorkflowCronJob($this->createMock(EntityWorkflowRepository::class), $clock, $this->buildMessageBus(), $logger, $entityManager);
self::assertEquals($expected, $cronJob->canRun($cronJobExecution));
}
@@ -54,11 +57,16 @@ class CancelStaleWorkflowCronJobTest extends TestCase
{
$clock = new MockClock((new \DateTimeImmutable('now', new \DateTimeZone('+00:00')))->add(new \DateInterval('P120D')));
$workflowRepository = $this->createMock(EntityWorkflowRepository::class);
$entityManager = $this->createMock(EntityManagerInterface::class);
$workflowRepository->method('findWorkflowsWithoutFinalStepAndOlderThan')->willReturn([1, 3, 2]);
$workflowRepository->method('findWorkflowsWithoutFinalStepAndOlderThan')->willReturn([
$this->buildEntityWorkflow(1),
$this->buildEntityWorkflow(3),
$this->buildEntityWorkflow(2),
]);
$messageBus = $this->buildMessageBus(true);
$cronJob = new CancelStaleWorkflowCronJob($workflowRepository, $clock, $messageBus, new NullLogger());
$cronJob = new CancelStaleWorkflowCronJob($workflowRepository, $clock, $messageBus, new NullLogger(), $entityManager);
$results = $cronJob->run([]);
@@ -67,6 +75,16 @@ class CancelStaleWorkflowCronJobTest extends TestCase
self::assertEquals(3, $results['last-canceled-workflow-id']);
}
private function buildEntityWorkflow(int $id): EntityWorkflow
{
$entityWorkflow = new EntityWorkflow();
$reflectionClass = new \ReflectionClass($entityWorkflow);
$idProperty = $reflectionClass->getProperty('id');
$idProperty->setValue($entityWorkflow, $id);
return $entityWorkflow;
}
/**
* @throws \Exception
*/

View File

@@ -131,18 +131,22 @@ class CancelStaleWorkflowHandlerTest extends TestCase
->setInitialPlaces('initial')
->addPlaces(['initial', 'step1', 'canceled', 'final'])
->addTransition(new Transition('to_step1', 'initial', 'step1'))
->addTransition($cancelInit = new Transition('cancel', 'initial', 'canceled'))
->addTransition($finalizeInit = new Transition('finalize', 'initial', 'final'))
->addTransition($cancelStep1 = new Transition('cancel', 'step1', 'canceled'))
->addTransition($finalizeStep1 = new Transition('finalize', 'step1', 'final'));
->addTransition(new Transition('cancel', 'initial', 'canceled'))
->addTransition(new Transition('finalize', 'initial', 'final'))
->addTransition(new Transition('cancel', 'step1', 'canceled'))
->addTransition(new Transition('finalize', 'step1', 'final'));
$transitionStorage = new \SplObjectStorage();
$transitionStorage->attach($finalizeInit, ['isFinal' => true, 'isFinalPositive' => true]);
$transitionStorage->attach($cancelInit, ['isFinal' => true, 'isFinalPositive' => false]);
$transitionStorage->attach($finalizeStep1, ['isFinal' => true, 'isFinalPositive' => true]);
$transitionStorage->attach($cancelStep1, ['isFinal' => true, 'isFinalPositive' => false]);
$definitionBuilder->setMetadataStore(new InMemoryMetadataStore(placesMetadata: [
'canceled' => [
'isFinal' => true,
'isFinalPositive' => false,
],
'final' => [
'isFinal' => true,
'isFinalPositive', true,
],
]));
$definitionBuilder->setMetadataStore(new InMemoryMetadataStore([], [], $transitionStorage));
$workflow = new Workflow($definitionBuilder->build(), new EntityWorkflowMarkingStore(), null, 'dummy_workflow');
$supports =
new class () implements WorkflowSupportStrategyInterface {