fix: added check for organisations with no op admin VOL-5955 (#503)

dvsa · Dec 11, 2024 · ce43147 · ce43147
1 parent 68e8e6f
commit ce43147
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 24 deletions.
diff --git a/app/api/module/Api/src/Domain/QueryHandler/Organisation/Organisation.php b/app/api/module/Api/src/Domain/QueryHandler/Organisation/Organisation.php
@@ -1,21 +1,10 @@
 <?php
 
-/**
- * Organisation
- *
- * @author Rob Caiger <[email protected]>
- */
-
 namespace Dvsa\Olcs\Api\Domain\QueryHandler\Organisation;
 
 use Dvsa\Olcs\Api\Domain\QueryHandler\AbstractQueryHandler;
 use Dvsa\Olcs\Transfer\Query\QueryInterface;
 
-/**
- * Organisation
- *
- * @author Rob Caiger <[email protected]>
- */
 class Organisation extends AbstractQueryHandler
 {
     protected $repoServiceName = 'Organisation';
@@ -37,6 +26,7 @@ public function handleQuery(QueryInterface $query)
                 'isDisqualified' => $organisation->getDisqualifications()->count() > 0,
                 'taValueOptions' => $this->getTrafficAreaValueOptions($allowedOperatorLocation),
                 'allowedOperatorLocation' => $allowedOperatorLocation,
+                'hasOperatorAdmin' => $organisation->hasOperatorAdmin()
             ]
         );
     }

diff --git a/app/api/module/Api/src/Entity/Organisation/Organisation.php b/app/api/module/Api/src/Entity/Organisation/Organisation.php
@@ -529,6 +529,20 @@ public function getAdministratorUsers()
         return $this->organisationUsers->matching($criteria);
     }
 
+    public function hasOperatorAdmin(): bool
+    {
+        $administratorUsers = $this->getAdministratorUsers();
+
+        /** @var OrganisationUserEntity $orgUser */
+        foreach ($administratorUsers as $orgUser) {
+            if ($orgUser->getUser()->isOperatorAdministrator()) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
     /**
      * can only delete operator admin if more than one exists
      */

diff --git a/app/api/test/module/Api/src/Domain/QueryHandler/Organisation/OrganisationTest.php b/app/api/test/module/Api/src/Domain/QueryHandler/Organisation/OrganisationTest.php
@@ -1,10 +1,6 @@
 <?php
 
-/**
- * Organisation Test
- *
- * @author Rob Caiger <[email protected]>
- */
+declare(strict_types=1);
 
 namespace Dvsa\OlcsTest\Api\Domain\QueryHandler\Organisation;
 
@@ -14,13 +10,7 @@
 use Dvsa\Olcs\Api\Domain\Repository\TrafficArea as TrafficAreaRepo;
 use Dvsa\Olcs\Transfer\Query\Organisation\Organisation as Qry;
 use Mockery as m;
-use SAML2\Utilities\ArrayCollection;
 
-/**
- * Organisation Test
- *
- * @author Rob Caiger <[email protected]>
- */
 class OrganisationTest extends QueryHandlerTestCase
 {
     public function setUp(): void
@@ -32,14 +22,15 @@ public function setUp(): void
         parent::setUp();
     }
 
-    public function testHandleQueryDisqualified()
+    public function testHandleQueryDisqualified(): void
     {
         $query = Qry::create(['id' => 111]);
 
         $mockOrganisation = m::mock(\Dvsa\Olcs\Api\Entity\Organisation\Organisation::class)->makePartial();
         $mockOrganisation->shouldReceive('serialize')->andReturn(['foo' => 'bar']);
         $mockOrganisation->shouldReceive('getDisqualifications->count')->andReturn(2);
         $mockOrganisation->shouldReceive('getAllowedOperatorLocation')->andReturn('GB')->once();
+        $mockOrganisation->expects('hasOperatorAdmin')->withNoArgs()->andReturnTrue();
 
         $mockTa = m::mock()
             ->shouldReceive('getId')
@@ -64,20 +55,22 @@ public function testHandleQueryDisqualified()
             'foo' => 'bar',
             'isDisqualified' => true,
             'allowedOperatorLocation' => 'GB',
+            'hasOperatorAdmin' => true,
             'taValueOptions' => [1 => 'foo'],
         ];
 
         $this->assertEquals($expected, $this->sut->handleQuery($query)->serialize());
     }
 
-    public function testHandleQueryNotDisqualified()
+    public function testHandleQueryNotDisqualified(): void
     {
         $query = Qry::create(['id' => 111]);
 
         $mockOrganisation = m::mock(\Dvsa\Olcs\Api\Entity\Organisation\Organisation::class)->makePartial();
         $mockOrganisation->shouldReceive('serialize')->andReturn(['foo' => 'bar']);
         $mockOrganisation->shouldReceive('getDisqualifications->count')->andReturn(0);
         $mockOrganisation->shouldReceive('getAllowedOperatorLocation')->andReturn('GB')->once();
+        $mockOrganisation->expects('hasOperatorAdmin')->withNoArgs()->andReturnFalse();
 
         $mockTa = m::mock()
             ->shouldReceive('getId')
@@ -102,6 +95,7 @@ public function testHandleQueryNotDisqualified()
             'foo' => 'bar',
             'isDisqualified' => false,
             'allowedOperatorLocation' => 'GB',
+            'hasOperatorAdmin' => false,
             'taValueOptions' => [1 => 'foo'],
         ];
 

diff --git a/app/api/test/module/Api/src/Entity/Organisation/OrganisationEntityTest.php b/app/api/test/module/Api/src/Entity/Organisation/OrganisationEntityTest.php
@@ -689,6 +689,50 @@ public function testCanDeleteOperatorAdminFalse(): void
         $this->assertFalse($entity->canDeleteOperatorAdmin());
     }
 
+    /**
+     * first user not op admin, 2nd user is op admin, 3rd user doesn't need to be checked
+     */
+    public function testHasOperatorAdminTrue(): void
+    {
+        $entity = new Entity();
+
+        $user1 = m::mock(OrganisationUser::class)->makePartial();
+        $user1->setIsAdministrator('Y');
+        $user1->expects('getUser->isOperatorAdministrator')->withNoArgs()->andReturnFalse();
+
+        $user2 = m::mock(OrganisationUser::class)->makePartial();
+        $user2->setIsAdministrator('Y');
+        $user2->expects('getUser->isOperatorAdministrator')->withNoArgs()->andReturnTrue();
+
+        $user3 = m::mock(OrganisationUser::class)->makePartial();
+        $user3->setIsAdministrator('Y');
+        $user3->expects('getUser->isOperatorAdministrator')->never();
+
+        $entity->setOrganisationUsers(new ArrayCollection([$user1, $user2, $user3]));
+
+        $this->assertTrue($entity->hasOperatorAdmin());
+    }
+
+    /**
+     * no operator admins are found
+     */
+    public function testHasOperatorAdminFalse(): void
+    {
+        $entity = new Entity();
+
+        $user1 = m::mock(OrganisationUser::class)->makePartial();
+        $user1->setIsAdministrator('Y');
+        $user1->expects('getUser->isOperatorAdministrator')->withNoArgs()->andReturnFalse();
+
+        $user2 = m::mock(OrganisationUser::class)->makePartial();
+        $user2->setIsAdministrator('Y');
+        $user2->expects('getUser->isOperatorAdministrator')->withNoArgs()->andReturnFalse();
+
+        $entity->setOrganisationUsers(new ArrayCollection([$user1, $user2]));
+
+        $this->assertFalse($entity->hasOperatorAdmin());
+    }
+
     /**
      *  test if org user not found due to soft delete
      */