Merge remote-tracking branch 'origin/master' into upgrade-sf5

2025-09-02 13:03:50 +00:00 · 2024-04-04 18:45:01 +02:00
parent d6a6cc2572 8fd6986c47
commit 931c69eee4
162 changed files with 3849 additions and 713 deletions
--- a/src/Bundle/ChillDocGeneratorBundle/tests/Service/Context/Generator/GeneratorTest.php
+++ b/src/Bundle/ChillDocGeneratorBundle/tests/Service/Context/Generator/GeneratorTest.php
@@ -20,7 +20,9 @@ use Chill\DocGeneratorBundle\Service\Generator\ObjectReadyException;
 use Chill\DocGeneratorBundle\Service\Generator\RelatedEntityNotFoundException;
 use Chill\DocStoreBundle\Entity\StoredObject;
 use Chill\DocStoreBundle\Service\StoredObjectManagerInterface;
+use Chill\MainBundle\Entity\User;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\Persistence\ManagerRegistry;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
@@ -66,7 +68,11 @@ class GeneratorTest extends TestCase
        $entityManager->find('DummyClass', Argument::type('int'))
            ->willReturn($entity);
        $entityManager->clear()->shouldBeCalled();
-        $entityManager->flush()->shouldBeCalled();
+        $entityManager->flush()->shouldNotBeCalled();
+
+        $managerRegistry = $this->prophesize(ManagerRegistry::class);
+        $managerRegistry->getManagerForClass('DummyClass')->willReturn($entityManager->reveal());
+        $managerRegistry->getManagerForClass(StoredObject::class)->willReturn($entityManager->reveal());

        $storedObjectManager = $this->prophesize(StoredObjectManagerInterface::class);
        $storedObjectManager->read($templateStoredObject)->willReturn('template');
@@ -75,7 +81,7 @@ class GeneratorTest extends TestCase
        $generator = new Generator(
            $contextManagerInterface->reveal(),
            $driver->reveal(),
-            $entityManager->reveal(),
+            $managerRegistry->reveal(),
            new NullLogger(),
            $storedObjectManager->reveal()
        );
@@ -84,7 +90,8 @@ class GeneratorTest extends TestCase
            $template,
            1,
            [],
-            $destinationStoredObject
+            $destinationStoredObject,
+            new User()
        );
    }

@@ -95,7 +102,7 @@ class GeneratorTest extends TestCase
        $generator = new Generator(
            $this->prophesize(ContextManagerInterface::class)->reveal(),
            $this->prophesize(DriverInterface::class)->reveal(),
-            $this->prophesize(EntityManagerInterface::class)->reveal(),
+            $this->prophesize(ManagerRegistry::class)->reveal(),
            new NullLogger(),
            $this->prophesize(StoredObjectManagerInterface::class)->reveal()
        );
@@ -108,7 +115,8 @@ class GeneratorTest extends TestCase
            $template,
            1,
            [],
-            $destinationStoredObject
+            $destinationStoredObject,
+            new User()
        );
    }

@@ -136,10 +144,14 @@ class GeneratorTest extends TestCase
        $entityManager->find(Argument::type('string'), Argument::type('int'))
            ->willReturn(null);

+        $managerRegistry = $this->prophesize(ManagerRegistry::class);
+        $managerRegistry->getManagerForClass('DummyClass')->willReturn($entityManager->reveal());
+        $managerRegistry->getManagerForClass(StoredObject::class)->willReturn($entityManager->reveal());
+
        $generator = new Generator(
            $contextManagerInterface->reveal(),
            $this->prophesize(DriverInterface::class)->reveal(),
-            $entityManager->reveal(),
+            $managerRegistry->reveal(),
            new NullLogger(),
            $this->prophesize(StoredObjectManagerInterface::class)->reveal()
        );
@@ -148,7 +160,8 @@ class GeneratorTest extends TestCase
            $template,
            1,
            [],
-            $destinationStoredObject
+            $destinationStoredObject,
+            new User()
        );
    }
 }
--- a/src/Bundle/ChillDocGeneratorBundle/tests/Service/Messenger/OnAfterMessageHandledClearStoredObjectCacheTest.php
+++ b/src/Bundle/ChillDocGeneratorBundle/tests/Service/Messenger/OnAfterMessageHandledClearStoredObjectCacheTest.php
@@ -0,0 +1,107 @@
+<?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 Chill\DocGeneratorBundle\tests\Service\Messenger;
+
+use Chill\DocGeneratorBundle\Entity\DocGeneratorTemplate;
+use Chill\DocGeneratorBundle\Service\Messenger\OnAfterMessageHandledClearStoredObjectCache;
+use Chill\DocGeneratorBundle\Service\Messenger\RequestGenerationMessage;
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Service\StoredObjectManagerInterface;
+use Chill\MainBundle\Entity\User;
+use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Psr\Log\NullLogger;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
+use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class OnAfterMessageHandledClearStoredObjectCacheTest extends TestCase
+{
+    use ProphecyTrait;
+
+    public function testThatNotGenerationMessageDoesNotCallAClearCache(): void
+    {
+        $storedObjectManager = $this->prophesize(StoredObjectManagerInterface::class);
+        $storedObjectManager->clearCache()->shouldNotBeCalled();
+
+        $eventSubscriber = $this->buildEventSubscriber($storedObjectManager->reveal());
+
+        $eventSubscriber->afterHandling($this->buildEventSuccess(new \stdClass()));
+        $eventSubscriber->afterFails($this->buildEventFailed(new \stdClass()));
+    }
+
+    public function testThatConcernedEventCallAClearCache(): void
+    {
+        $storedObjectManager = $this->prophesize(StoredObjectManagerInterface::class);
+        $storedObjectManager->clearCache()->shouldBeCalledTimes(2);
+
+        $eventSubscriber = $this->buildEventSubscriber($storedObjectManager->reveal());
+
+        $eventSubscriber->afterHandling($this->buildEventSuccess($this->buildRequestGenerationMessage()));
+        $eventSubscriber->afterFails($this->buildEventFailed($this->buildRequestGenerationMessage()));
+    }
+
+    private function buildRequestGenerationMessage(
+    ): RequestGenerationMessage {
+        $creator = new User();
+        $creator->setEmail('fake@example.com');
+
+        $class = new \ReflectionClass($creator);
+        $property = $class->getProperty('id');
+        $property->setAccessible(true);
+        $property->setValue($creator, 1);
+
+        $template ??= new DocGeneratorTemplate();
+        $class = new \ReflectionClass($template);
+        $property = $class->getProperty('id');
+        $property->setAccessible(true);
+        $property->setValue($template, 2);
+
+        $destinationStoredObject = new StoredObject();
+        $class = new \ReflectionClass($destinationStoredObject);
+        $property = $class->getProperty('id');
+        $property->setAccessible(true);
+        $property->setValue($destinationStoredObject, 3);
+
+        return new RequestGenerationMessage(
+            $creator,
+            $template,
+            1,
+            $destinationStoredObject,
+            [],
+        );
+    }
+
+    private function buildEventSubscriber(StoredObjectManagerInterface $storedObjectManager): OnAfterMessageHandledClearStoredObjectCache
+    {
+        return new OnAfterMessageHandledClearStoredObjectCache($storedObjectManager, new NullLogger());
+    }
+
+    private function buildEventFailed(object $message): WorkerMessageFailedEvent
+    {
+        $envelope = new Envelope($message);
+
+        return new WorkerMessageFailedEvent($envelope, 'testing', new \RuntimeException());
+    }
+
+    private function buildEventSuccess(object $message): WorkerMessageHandledEvent
+    {
+        $envelope = new Envelope($message);
+
+        return new WorkerMessageHandledEvent($envelope, 'test_receiver');
+    }
+}
--- a/src/Bundle/ChillDocGeneratorBundle/tests/Service/Messenger/OnGenerationFailsTest.php
+++ b/src/Bundle/ChillDocGeneratorBundle/tests/Service/Messenger/OnGenerationFailsTest.php
@@ -0,0 +1,226 @@
+<?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 Chill\DocGeneratorBundle\tests\Service\Messenger;
+
+use Chill\DocGeneratorBundle\Entity\DocGeneratorTemplate;
+use Chill\DocGeneratorBundle\Repository\DocGeneratorTemplateRepositoryInterface;
+use Chill\DocGeneratorBundle\Service\Messenger\OnGenerationFails;
+use Chill\DocGeneratorBundle\Service\Messenger\RequestGenerationMessage;
+use Chill\DocStoreBundle\Entity\StoredObject;
+use Chill\DocStoreBundle\Repository\StoredObjectRepositoryInterface;
+use Chill\MainBundle\Entity\User;
+use Chill\MainBundle\Repository\UserRepositoryInterface;
+use Doctrine\ORM\EntityManagerInterface;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Psr\Log\NullLogger;
+use Symfony\Component\Mailer\MailerInterface;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
+use Symfony\Component\Mime\Email;
+use Symfony\Component\Mime\RawMessage;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class OnGenerationFailsTest extends TestCase
+{
+    use ProphecyTrait;
+
+    public function testNotConcernedMessageAreNotHandled(): void
+    {
+        $entityManager = $this->prophesize(EntityManagerInterface::class);
+        $entityManager->flush()->shouldNotBeCalled();
+
+        $mailer = $this->prophesize(MailerInterface::class);
+        $mailer->send()->shouldNotBeCalled();
+
+        $eventSubscriber = $this->buildOnGenerationFailsEventSubscriber(
+            entityManager: $entityManager->reveal(),
+            mailer: $mailer->reveal()
+        );
+
+        $event = $this->buildEvent(new \stdClass());
+
+        $eventSubscriber->onMessageFailed($event);
+    }
+
+    public function testMessageThatWillBeRetriedAreNotHandled(): void
+    {
+        $storedObject = new StoredObject();
+
+        $entityManager = $this->prophesize(EntityManagerInterface::class);
+        $entityManager->flush()->shouldNotBeCalled();
+
+        $mailer = $this->prophesize(MailerInterface::class);
+        $mailer->send()->shouldNotBeCalled();
+
+        $eventSubscriber = $this->buildOnGenerationFailsEventSubscriber(
+            entityManager: $entityManager->reveal(),
+            mailer: $mailer->reveal()
+        );
+
+        $event = $this->buildEvent($this->buildRequestGenerationMessage($storedObject));
+        $event->setForRetry();
+
+        $eventSubscriber->onMessageFailed($event);
+    }
+
+    public function testThatANotRetriyableEventWillMarkObjectAsFailed(): void
+    {
+        $storedObject = new StoredObject();
+
+        $entityManager = $this->prophesize(EntityManagerInterface::class);
+        $entityManager->flush()->shouldBeCalled();
+
+        $mailer = $this->prophesize(MailerInterface::class);
+        $mailer->send(Argument::type(RawMessage::class), Argument::any())->shouldBeCalled();
+
+        $eventSubscriber = $this->buildOnGenerationFailsEventSubscriber(
+            entityManager: $entityManager->reveal(),
+            mailer: $mailer->reveal(),
+            storedObject: $storedObject
+        );
+
+        $event = $this->buildEvent($this->buildRequestGenerationMessage($storedObject));
+
+        $eventSubscriber->onMessageFailed($event);
+
+        self::assertEquals(StoredObject::STATUS_FAILURE, $storedObject->getStatus());
+    }
+
+    public function testThatANonRetryableEventSendAnEmail(): void
+    {
+        $storedObject = new StoredObject();
+
+        $entityManager = $this->prophesize(EntityManagerInterface::class);
+        $entityManager->flush()->shouldBeCalled();
+
+        $mailer = $this->prophesize(MailerInterface::class);
+        $mailer->send(
+            Argument::that(function ($arg): bool {
+                if (!$arg instanceof Email) {
+                    return false;
+                }
+
+                foreach ($arg->getTo() as $to) {
+                    if ('test@test.com' === $to->getAddress()) {
+                        return true;
+                    }
+                }
+
+                return false;
+            }),
+            Argument::any()
+        )
+            ->shouldBeCalled();
+
+        $eventSubscriber = $this->buildOnGenerationFailsEventSubscriber(
+            entityManager: $entityManager->reveal(),
+            mailer: $mailer->reveal(),
+            storedObject: $storedObject
+        );
+
+        $event = $this->buildEvent($this->buildRequestGenerationMessage($storedObject, sendResultToEmail: 'test@test.com'));
+
+        $eventSubscriber->onMessageFailed($event);
+    }
+
+    private function buildRequestGenerationMessage(
+        StoredObject $destinationStoredObject,
+        ?User $creator = null,
+        ?DocGeneratorTemplate $template = null,
+        array $contextGenerationData = [],
+        bool $isTest = false,
+        ?string $sendResultToEmail = null,
+    ): RequestGenerationMessage {
+        if (null === $creator) {
+            $creator = new User();
+            $creator->setEmail('fake@example.com');
+        }
+
+        if (null === $creator->getId()) {
+            $class = new \ReflectionClass($creator);
+            $property = $class->getProperty('id');
+            $property->setAccessible(true);
+            $property->setValue($creator, 1);
+        }
+
+        $template ??= new DocGeneratorTemplate();
+        $class = new \ReflectionClass($template);
+        $property = $class->getProperty('id');
+        $property->setAccessible(true);
+        $property->setValue($template, 2);
+
+        $class = new \ReflectionClass($destinationStoredObject);
+        $property = $class->getProperty('id');
+        $property->setAccessible(true);
+        $property->setValue($destinationStoredObject, 3);
+
+        return new RequestGenerationMessage(
+            $creator,
+            $template,
+            1,
+            $destinationStoredObject,
+            $contextGenerationData,
+            $isTest,
+            $sendResultToEmail
+        );
+    }
+
+    private function buildOnGenerationFailsEventSubscriber(
+        ?StoredObject $storedObject = null,
+        ?EntityManagerInterface $entityManager = null,
+        ?MailerInterface $mailer = null,
+    ): OnGenerationFails {
+        $storedObjectRepository = $this->prophesize(StoredObjectRepositoryInterface::class);
+        $storedObjectRepository->find(Argument::type('int'))->willReturn($storedObject ?? new StoredObject());
+
+        if (null === $entityManager) {
+            $entityManagerProphecy = $this->prophesize(EntityManagerInterface::class);
+        }
+
+        if (null === $mailer) {
+            $mailerProphecy = $this->prophesize(MailerInterface::class);
+        }
+
+        $translator = $this->prophesize(TranslatorInterface::class);
+        $translator->trans(Argument::type('string'))->will(fn ($args) => $args[0]);
+
+        $userRepository = $this->prophesize(UserRepositoryInterface::class);
+        $userRepository->find(Argument::type('int'))->willReturn(new User());
+
+        $docGeneratorTemplateRepository = $this->prophesize(DocGeneratorTemplateRepositoryInterface::class);
+        $docGeneratorTemplateRepository->find(Argument::type('int'))->willReturn(new DocGeneratorTemplate());
+
+        return new OnGenerationFails(
+            $docGeneratorTemplateRepository->reveal(),
+            $entityManager ?? $entityManagerProphecy->reveal(),
+            new NullLogger(),
+            $mailer ?? $mailerProphecy->reveal(),
+            $storedObjectRepository->reveal(),
+            $translator->reveal(),
+            $userRepository->reveal()
+        );
+    }
+
+    private function buildEvent(object $message): WorkerMessageFailedEvent
+    {
+        $envelope = new Envelope($message);
+
+        return new WorkerMessageFailedEvent($envelope, 'testing', new \RuntimeException());
+    }
+}