Merge branch '246-do-not-show-confidential-in-list' into 'master'

Filter confidential courses from list of accompanying periods and related Closes #246 See merge request Chill-Projet/chill-bundles!633
2025-09-03 21:34:59 +00:00 · 2023-12-11 16:22:38 +00:00
parent 33d187f329 8cc93a8b07
commit 2adb6105eb
15 changed files with 380 additions and 199 deletions
--- a/src/Bundle/ChillPersonBundle/Tests/Export/Export/ListAccompanyingPeriodTest.php
+++ b/src/Bundle/ChillPersonBundle/Tests/Export/Export/ListAccompanyingPeriodTest.php
@@ -11,14 +11,23 @@ declare(strict_types=1);

 namespace Chill\PersonBundle\Tests\Export\Export;

+use Chill\MainBundle\Entity\Center;
+use Chill\MainBundle\Entity\User;
 use Chill\MainBundle\Repository\CenterRepositoryInterface;
+use Chill\MainBundle\Repository\ScopeRepositoryInterface;
+use Chill\MainBundle\Security\Authorization\AuthorizationHelperForCurrentUserInterface;
 use Chill\MainBundle\Service\RollingDate\RollingDate;
 use Chill\MainBundle\Service\RollingDate\RollingDateConverterInterface;
 use Chill\MainBundle\Test\Export\AbstractExportTest;
 use Chill\PersonBundle\Export\Declarations;
 use Chill\PersonBundle\Export\Export\ListAccompanyingPeriod;
+use Chill\PersonBundle\Export\Helper\FilterListAccompanyingPeriodHelper;
 use Chill\PersonBundle\Export\Helper\ListAccompanyingPeriodHelper;
+use Chill\PersonBundle\Security\Authorization\AccompanyingPeriodVoter;
 use Doctrine\ORM\EntityManagerInterface;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Symfony\Component\Security\Core\Security;

 /**
 * @internal
@@ -27,6 +36,8 @@ use Doctrine\ORM\EntityManagerInterface;
 */
 class ListAccompanyingPeriodTest extends AbstractExportTest
 {
+    use ProphecyTrait;
+
    private readonly ListAccompanyingPeriod $listAccompanyingPeriod;

    private readonly CenterRepositoryInterface $centerRepository;
@@ -39,12 +50,54 @@ class ListAccompanyingPeriodTest extends AbstractExportTest

    public function getExport()
    {
+        /** @var EntityManagerInterface::class $em */
        $em = self::$container->get(EntityManagerInterface::class);
        $rollingDateConverter = self::$container->get(RollingDateConverterInterface::class);
        $listAccompanyingPeriodHelper = self::$container->get(ListAccompanyingPeriodHelper::class);
+        $centerRepository = self::$container->get(CenterRepositoryInterface::class);
+        $scopeRepository = self::$container->get(ScopeRepositoryInterface::class);

-        yield new ListAccompanyingPeriod($em, $rollingDateConverter, $listAccompanyingPeriodHelper, $this->getParameters(true));
-        yield new ListAccompanyingPeriod($em, $rollingDateConverter, $listAccompanyingPeriodHelper, $this->getParameters(false));
+        // mock security
+        $user = $em->createQuery('SELECT u FROM '.User::class.' u')
+            ->setMaxResults(1)->getSingleResult();
+        if (null === $user) {
+            throw new \RuntimeException('no user found');
+        }
+        $security = $this->prophesize(Security::class);
+        $security->getUser()->willReturn($user);
+
+        // mock authorization helper
+        $scopes = $scopeRepository->findAll();
+        $scopesConfidentials = [] !== $scopes ? [$scopes[0]] : [];
+        $authorizationHelper = $this->prophesize(AuthorizationHelperForCurrentUserInterface::class);
+        $authorizationHelper->getReachableScopes(AccompanyingPeriodVoter::SEE_DETAILS, Argument::type(Center::class))
+            ->willReturn($scopes);
+        $authorizationHelper->getReachableScopes(AccompanyingPeriodVoter::SEE_CONFIDENTIAL_ALL, Argument::type(Center::class))
+            ->willReturn($scopesConfidentials);
+
+        yield new ListAccompanyingPeriod(
+            $em,
+            $rollingDateConverter,
+            $listAccompanyingPeriodHelper,
+            new FilterListAccompanyingPeriodHelper(
+                $security->reveal(),
+                $centerRepository,
+                $authorizationHelper->reveal(),
+                $this->getParameters(true)
+            )
+        );
+
+        yield new ListAccompanyingPeriod(
+            $em,
+            $rollingDateConverter,
+            $listAccompanyingPeriodHelper,
+            new FilterListAccompanyingPeriodHelper(
+                $security->reveal(),
+                $centerRepository,
+                $authorizationHelper->reveal(),
+                $this->getParameters(false)
+            )
+        );
    }

    public function getFormData()
--- a/src/Bundle/ChillPersonBundle/Tests/Export/Export/ListAccompanyingPeriodWorkAssociatePersonOnAccompanyingPeriodTest.php
+++ b/src/Bundle/ChillPersonBundle/Tests/Export/Export/ListAccompanyingPeriodWorkAssociatePersonOnAccompanyingPeriodTest.php
@@ -20,6 +20,7 @@ use Chill\MainBundle\Service\RollingDate\RollingDateConverterInterface;
 use Chill\MainBundle\Test\Export\AbstractExportTest;
 use Chill\PersonBundle\Export\Declarations;
 use Chill\PersonBundle\Export\Export\ListAccompanyingPeriodWorkAssociatePersonOnAccompanyingPeriod;
+use Chill\PersonBundle\Export\Helper\FilterListAccompanyingPeriodHelperInterface;
 use Chill\PersonBundle\Export\Helper\LabelPersonHelper;
 use Chill\PersonBundle\Repository\SocialWork\SocialActionRepository;
 use Chill\PersonBundle\Repository\SocialWork\SocialIssueRepository;
@@ -27,6 +28,7 @@ use Chill\PersonBundle\Templating\Entity\SocialActionRender;
 use Chill\PersonBundle\Templating\Entity\SocialIssueRender;
 use Chill\ThirdPartyBundle\Export\Helper\LabelThirdPartyHelper;
 use Doctrine\ORM\EntityManagerInterface;
+use Prophecy\PhpUnit\ProphecyTrait;

 /**
 * @internal
@@ -35,6 +37,8 @@ use Doctrine\ORM\EntityManagerInterface;
 */
 class ListAccompanyingPeriodWorkAssociatePersonOnAccompanyingPeriodTest extends AbstractExportTest
 {
+    use ProphecyTrait;
+
    protected function setUp(): void
    {
        parent::setUp();
@@ -55,6 +59,7 @@ class ListAccompanyingPeriodWorkAssociatePersonOnAccompanyingPeriodTest extends
        $rollingDateConverter = self::$container->get(RollingDateConverterInterface::class);
        $aggregateStringHelper = self::$container->get(AggregateStringHelper::class);
        $socialActionRepository = self::$container->get(SocialActionRepository::class);
+        $filterListAccompanyingPeriodHelper = $this->prophesize(FilterListAccompanyingPeriodHelperInterface::class);

        yield new ListAccompanyingPeriodWorkAssociatePersonOnAccompanyingPeriod(
            $entityManager,
@@ -69,23 +74,7 @@ class ListAccompanyingPeriodWorkAssociatePersonOnAccompanyingPeriodTest extends
            $rollingDateConverter,
            $aggregateStringHelper,
            $socialActionRepository,
-            $this->getParameters(true),
-        );
-
-        yield new ListAccompanyingPeriodWorkAssociatePersonOnAccompanyingPeriod(
-            $entityManager,
-            $dateTimeHelper,
-            $userHelper,
-            $personHelper,
-            $thirdPartyHelper,
-            $translatableStringExportLabelHelper,
-            $socialIssueRender,
-            $socialIssueRepository,
-            $socialActionRender,
-            $rollingDateConverter,
-            $aggregateStringHelper,
-            $socialActionRepository,
-            $this->getParameters(false),
+            $filterListAccompanyingPeriodHelper->reveal(),
        );
    }

--- a/src/Bundle/ChillPersonBundle/Tests/Export/Export/ListAccompanyingPeriodWorkAssociatePersonOnWorkTest.php
+++ b/src/Bundle/ChillPersonBundle/Tests/Export/Export/ListAccompanyingPeriodWorkAssociatePersonOnWorkTest.php
@@ -20,6 +20,7 @@ use Chill\MainBundle\Service\RollingDate\RollingDateConverterInterface;
 use Chill\MainBundle\Test\Export\AbstractExportTest;
 use Chill\PersonBundle\Export\Declarations;
 use Chill\PersonBundle\Export\Export\ListAccompanyingPeriodWorkAssociatePersonOnWork;
+use Chill\PersonBundle\Export\Helper\FilterListAccompanyingPeriodHelperInterface;
 use Chill\PersonBundle\Export\Helper\LabelPersonHelper;
 use Chill\PersonBundle\Repository\SocialWork\SocialActionRepository;
 use Chill\PersonBundle\Repository\SocialWork\SocialIssueRepository;
@@ -27,6 +28,7 @@ use Chill\PersonBundle\Templating\Entity\SocialActionRender;
 use Chill\PersonBundle\Templating\Entity\SocialIssueRender;
 use Chill\ThirdPartyBundle\Export\Helper\LabelThirdPartyHelper;
 use Doctrine\ORM\EntityManagerInterface;
+use Prophecy\PhpUnit\ProphecyTrait;

 /**
 * @internal
@@ -35,6 +37,8 @@ use Doctrine\ORM\EntityManagerInterface;
 */
 class ListAccompanyingPeriodWorkAssociatePersonOnWorkTest extends AbstractExportTest
 {
+    use ProphecyTrait;
+
    protected function setUp(): void
    {
        parent::setUp();
@@ -55,6 +59,7 @@ class ListAccompanyingPeriodWorkAssociatePersonOnWorkTest extends AbstractExport
        $rollingDateConverter = self::$container->get(RollingDateConverterInterface::class);
        $aggregateStringHelper = self::$container->get(AggregateStringHelper::class);
        $socialActionRepository = self::$container->get(SocialActionRepository::class);
+        $filterHelper = $this->prophesize(FilterListAccompanyingPeriodHelperInterface::class);

        yield new ListAccompanyingPeriodWorkAssociatePersonOnWork(
            $entityManager,
@@ -69,23 +74,7 @@ class ListAccompanyingPeriodWorkAssociatePersonOnWorkTest extends AbstractExport
            $rollingDateConverter,
            $aggregateStringHelper,
            $socialActionRepository,
-            $this->getParameters(true),
-        );
-
-        yield new ListAccompanyingPeriodWorkAssociatePersonOnWork(
-            $entityManager,
-            $dateTimeHelper,
-            $userHelper,
-            $personHelper,
-            $thirdPartyHelper,
-            $translatableStringExportLabelHelper,
-            $socialIssueRender,
-            $socialIssueRepository,
-            $socialActionRender,
-            $rollingDateConverter,
-            $aggregateStringHelper,
-            $socialActionRepository,
-            $this->getParameters(false),
+            $filterHelper->reveal(),
        );
    }

--- a/src/Bundle/ChillPersonBundle/Tests/Export/Export/ListEvaluationTest.php
+++ b/src/Bundle/ChillPersonBundle/Tests/Export/Export/ListEvaluationTest.php
@@ -11,7 +11,6 @@ declare(strict_types=1);

 namespace Chill\PersonBundle\Tests\Export\Export;

-use Chill\MainBundle\Entity\Center;
 use Chill\MainBundle\Export\Helper\AggregateStringHelper;
 use Chill\MainBundle\Export\Helper\DateTimeHelper;
 use Chill\MainBundle\Export\Helper\TranslatableStringExportLabelHelper;
@@ -22,13 +21,14 @@ use Chill\MainBundle\Service\RollingDate\RollingDateConverterInterface;
 use Chill\MainBundle\Test\Export\AbstractExportTest;
 use Chill\PersonBundle\Export\Declarations;
 use Chill\PersonBundle\Export\Export\ListEvaluation;
+use Chill\PersonBundle\Export\Helper\FilterListAccompanyingPeriodHelperInterface;
 use Chill\PersonBundle\Export\Helper\LabelPersonHelper;
 use Chill\PersonBundle\Repository\SocialWork\SocialActionRepository;
 use Chill\PersonBundle\Repository\SocialWork\SocialIssueRepository;
 use Chill\PersonBundle\Templating\Entity\SocialActionRender;
 use Chill\PersonBundle\Templating\Entity\SocialIssueRender;
-use Doctrine\ORM\AbstractQuery;
 use Doctrine\ORM\EntityManagerInterface;
+use Prophecy\PhpUnit\ProphecyTrait;

 /**
 * @internal
@@ -37,7 +37,7 @@ use Doctrine\ORM\EntityManagerInterface;
 */
 class ListEvaluationTest extends AbstractExportTest
 {
-    private ListEvaluation $listEvaluation;
+    use ProphecyTrait;

    private CenterRepositoryInterface $centerRepository;

@@ -46,7 +46,6 @@ class ListEvaluationTest extends AbstractExportTest
        parent::setUp();
        self::bootKernel();

-        $this->listEvaluation = self::$container->get(ListEvaluation::class);
        $this->centerRepository = self::$container->get(CenterRepositoryInterface::class);
    }

@@ -63,6 +62,7 @@ class ListEvaluationTest extends AbstractExportTest
        $rollingDateConverter = self::$container->get(RollingDateConverterInterface::class);
        $aggregateStringHelper = self::$container->get(AggregateStringHelper::class);
        $socialActionRepository = self::$container->get(SocialActionRepository::class);
+        $filterListHelper = $this->prophesize(FilterListAccompanyingPeriodHelperInterface::class);

        yield new ListEvaluation(
            $entityManager,
@@ -76,22 +76,7 @@ class ListEvaluationTest extends AbstractExportTest
            $translatableStringExportLabelHelper,
            $aggregateStringHelper,
            $rollingDateConverter,
-            $this->getParameters(true),
-        );
-
-        yield new ListEvaluation(
-            $entityManager,
-            $socialIssueRender,
-            $socialIssueRepository,
-            $socialActionRender,
-            $socialActionRepository,
-            $userHelper,
-            $personHelper,
-            $dateTimeHelper,
-            $translatableStringExportLabelHelper,
-            $aggregateStringHelper,
-            $rollingDateConverter,
-            $this->getParameters(false),
+            $filterListHelper->reveal(),
        );
    }

@@ -104,14 +89,4 @@ class ListEvaluationTest extends AbstractExportTest
    {
        return [[Declarations::ACP_TYPE]];
    }
-
-    public function testQuery(): void
-    {
-        $centers = $this->centerRepository->findAll();
-
-        $query = $this->listEvaluation->initiateQuery([], array_map(fn (Center $c) => ['center' => $c], $centers), ['calc_date' => new RollingDate(RollingDate::T_TODAY)]);
-        $query->setMaxResults(1);
-
-        self::assertIsArray($query->getQuery()->getResult(AbstractQuery::HYDRATE_ARRAY));
-    }
 }
--- a/src/Bundle/ChillPersonBundle/Tests/Export/Export/ListPersonWithAccompanyingPeriodDetailsTest.php
+++ b/src/Bundle/ChillPersonBundle/Tests/Export/Export/ListPersonWithAccompanyingPeriodDetailsTest.php
@@ -16,9 +16,11 @@ use Chill\MainBundle\Service\RollingDate\RollingDateConverterInterface;
 use Chill\MainBundle\Test\Export\AbstractExportTest;
 use Chill\PersonBundle\Export\Declarations;
 use Chill\PersonBundle\Export\Export\ListPersonWithAccompanyingPeriodDetails;
+use Chill\PersonBundle\Export\Helper\FilterListAccompanyingPeriodHelperInterface;
 use Chill\PersonBundle\Export\Helper\ListAccompanyingPeriodHelper;
 use Chill\PersonBundle\Export\Helper\ListPersonHelper;
 use Doctrine\ORM\EntityManagerInterface;
+use Prophecy\PhpUnit\ProphecyTrait;

 /**
 * @internal
@@ -27,6 +29,8 @@ use Doctrine\ORM\EntityManagerInterface;
 */
 class ListPersonWithAccompanyingPeriodDetailsTest extends AbstractExportTest
 {
+    use ProphecyTrait;
+
    protected function setUp(): void
    {
        parent::setUp();
@@ -39,21 +43,14 @@ class ListPersonWithAccompanyingPeriodDetailsTest extends AbstractExportTest
        $listAccompanyingPeriodHelper = self::$container->get(ListAccompanyingPeriodHelper::class);
        $entityManager = self::$container->get(EntityManagerInterface::class);
        $rollingDateConverter = self::$container->get(RollingDateConverterInterface::class);
+        $filterHelper = $this->prophesize(FilterListAccompanyingPeriodHelperInterface::class);

        yield new ListPersonWithAccompanyingPeriodDetails(
            $listPersonHelper,
            $listAccompanyingPeriodHelper,
            $entityManager,
            $rollingDateConverter,
-            $this->getParameters(true),
-        );
-
-        yield new ListPersonWithAccompanyingPeriodDetails(
-            $listPersonHelper,
-            $listAccompanyingPeriodHelper,
-            $entityManager,
-            $rollingDateConverter,
-            $this->getParameters(false),
+            $filterHelper->reveal()
        );
    }

--- a/src/Bundle/ChillPersonBundle/Tests/Export/Helper/FilterListAccompanyingPeriodHelperTest.php
+++ b/src/Bundle/ChillPersonBundle/Tests/Export/Helper/FilterListAccompanyingPeriodHelperTest.php
@@ -0,0 +1,137 @@
+<?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\PersonBundle\Tests\Export\Helper;
+
+use Chill\MainBundle\Entity\Center;
+use Chill\MainBundle\Entity\Scope;
+use Chill\MainBundle\Entity\User;
+use Chill\MainBundle\Repository\CenterRepositoryInterface;
+use Chill\MainBundle\Repository\ScopeRepositoryInterface;
+use Chill\MainBundle\Security\Authorization\AuthorizationHelperForCurrentUserInterface;
+use Chill\PersonBundle\Entity\AccompanyingPeriod;
+use Chill\PersonBundle\Export\Helper\FilterListAccompanyingPeriodHelper;
+use Chill\PersonBundle\Security\Authorization\AccompanyingPeriodVoter;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\QueryBuilder;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+use Symfony\Component\Security\Core\Security;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+final class FilterListAccompanyingPeriodHelperTest extends KernelTestCase
+{
+    use ProphecyTrait;
+
+    private CenterRepositoryInterface $centerRepository;
+    private ScopeRepositoryInterface $scopeRepository;
+    private EntityManagerInterface $entityManager;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        self::bootKernel();
+
+        $this->centerRepository = self::$container->get(CenterRepositoryInterface::class);
+        $this->scopeRepository = self::$container->get(ScopeRepositoryInterface::class);
+        $this->entityManager = self::$container->get(EntityManagerInterface::class);
+    }
+
+    /**
+     * @dataProvider dataProviderTestAddFilterAccompanyingPeriod
+     */
+    public function testAddFilterAccompanyingPeriod(QueryBuilder $qb, ParameterBagInterface $parameterBag): void
+    {
+        // mock security
+        $user = $this->entityManager->createQuery('SELECT u FROM '.User::class.' u')
+            ->setMaxResults(1)->getSingleResult();
+        if (null === $user) {
+            throw new \RuntimeException('no user found');
+        }
+        $security = $this->prophesize(Security::class);
+        $security->getUser()->willReturn($user);
+
+        // mock authorization helper
+        $scopes = $this->scopeRepository->findAll();
+        $scopesConfidentials = [] !== $scopes ? [$scopes[0]] : [];
+        $authorizationHelper = $this->prophesize(AuthorizationHelperForCurrentUserInterface::class);
+        $authorizationHelper->getReachableScopes(AccompanyingPeriodVoter::SEE_DETAILS, Argument::type(Center::class))
+            ->willReturn($scopes);
+        $authorizationHelper->getReachableScopes(AccompanyingPeriodVoter::SEE_CONFIDENTIAL_ALL, Argument::type(Center::class))
+            ->willReturn($scopesConfidentials);
+
+        $filter = new FilterListAccompanyingPeriodHelper(
+            $security->reveal(),
+            $this->centerRepository,
+            $authorizationHelper->reveal(),
+            $parameterBag
+        );
+
+        $filter->addFilterAccompanyingPeriods($qb, [], $this->getACL(), []);
+
+        $qb->setMaxResults(1);
+        $result = $qb->getQuery()->getResult();
+
+        self::assertIsArray($result);
+    }
+
+    public function dataProviderTestAddFilterAccompanyingPeriod(): iterable
+    {
+        self::setUp();
+        $qb = $this->entityManager->createQueryBuilder();
+
+        $qb
+            ->select('acp.id')
+            ->from(AccompanyingPeriod::class, 'acp');
+
+        yield [
+            $qb,
+            new ParameterBag(['chill_main' => ['acl' => ['filter_stats_by_center' => true]]]),
+        ];
+
+        yield [
+            $qb,
+            new ParameterBag(['chill_main' => ['acl' => ['filter_stats_by_center' => false]]]),
+        ];
+    }
+
+    /**
+     * @return list<array{center: Center, circles: list<Scope>}> the ACL, structured as an array
+     *
+     * @throws \RuntimeException when no center or circle is found
+     */
+    private function getACL(): array
+    {
+        $centers = $this->centerRepository->findAll();
+        $circles = $this->scopeRepository->findAll();
+
+        if (0 === \count($centers)) {
+            throw new \RuntimeException('No center found. Did you forget to run `doctrine:fixtures:load` command before ?');
+        }
+
+        if (0 === \count($circles)) {
+            throw new \RuntimeException('No circle found. Did you forget to run `doctrine:fixtures:load` command before ?');
+        }
+
+        return [[
+            'center' => $centers[0],
+            'circles' => [
+                $circles,
+            ], ]];
+    }
+}