Merge pull request #102 from silinternational/develop

Release 2.9.0: Add batching simulation to mock
silinternational · Jun 24, 2024 · efa3d4d · efa3d4d
2 parents 1b804ee + eeff34b
commit efa3d4d
Show file tree

Hide file tree

Showing 8 changed files with 178 additions and 50 deletions.
diff --git a/SilMock/Google/Http/Batch.php b/SilMock/Google/Http/Batch.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace SilMock\Google\Http;
+
+class Batch
+{
+    public array $batch = [];
+
+    public function add($result, string $key)
+    {
+        $this->batch[$key] = $result;
+    }
+
+    public function execute()
+    {
+        return $this->batch;
+    }
+}
diff --git a/SilMock/Google/Service/Directory.php b/SilMock/Google/Service/Directory.php
@@ -2,6 +2,8 @@
 
 namespace SilMock\Google\Service;
 
+use Google\Client;
+use SilMock\Google\Http\Batch;
 use SilMock\Google\Service\Directory\Asps;
 use SilMock\Google\Service\Directory\Resource\Groups;
 use SilMock\Google\Service\Directory\Resource\Members;
@@ -10,6 +12,7 @@
 use SilMock\Google\Service\Directory\UsersAliasesResource;
 use SilMock\Google\Service\Directory\UsersResource;
 use SilMock\Google\Service\Directory\VerificationCodesResource;
+use Webmozart\Assert\Assert;
 
 class Directory
 {
@@ -21,7 +24,8 @@ class Directory
     public $users_aliases;
     public $verificationCodes;
     public $twoStepVerification;
-
+    public Client $client;
+
     /**
      * Sets the users and users_aliases properties to be instances of
      *    the corresponding mock classes.
@@ -39,5 +43,17 @@ public function __construct($client, ?string $dbFile = null)
         $this->users_aliases = new UsersAliasesResource($dbFile);
         $this->verificationCodes = new VerificationCodesResource($dbFile);
         $this->twoStepVerification = new TwoStepVerification($dbFile);
+        $this->client = new Client();
+        Assert::notEmpty($client, 'Expecting a client to be passed!');
+    }
+
+    public function getClient()
+    {
+        return $this->client;
+    }
+
+    public function createBatch()
+    {
+        return new Batch();
     }
 }
diff --git a/SilMock/Google/Service/Directory/Resource/Members.php b/SilMock/Google/Service/Directory/Resource/Members.php
@@ -69,8 +69,8 @@ public function listMembers($groupKey, $optParams = [])
         $this->validateGroupExists($groupKey);
         $pageSize = $optParams['pageSize'] ?? 10;
         $pageToken = $optParams['pageToken'] ?? 0;
-        $query = $optParams['query'] ?? null;
-        $expectedRoles = $this->extractRoles($query);
+        $roles = $optParams['roles'] ?? null;
+        $expectedRoles = $this->extractRoles($roles);
         $members = new GoogleDirectory_Members();
         $directoryMemberRecords = $this->getRecords();
         $memberCounter = 0;
@@ -81,8 +81,8 @@ public function listMembers($groupKey, $optParams = [])
                 && $memberCounter >= ($pageToken * $pageSize)    // Matches the subsection of all the members
                 && (empty($expectedRoles) || in_array($memberData['member']['role'], $expectedRoles)) // Matches role
             ) {
-                        $memberCounter = $memberCounter + 1;
-                        $this->addToMembers($memberData, $members);
+                $memberCounter = $memberCounter + 1;
+                $this->addToMembers($memberData, $members);
             }
             $currentMembers = $members->getMembers();
             $currentResultSize = count($currentMembers);
@@ -98,17 +98,11 @@ public function listMembers($groupKey, $optParams = [])
         return $members;
     }
 
-    protected function extractRoles(?string $query): array
+    protected function extractRoles(?string $roles): array
     {
-        if (! empty($query) && str_contains($query, 'roles')) {
-            $roleSegmentStart = substr($query, strpos($query, 'roles'));
-            $roleSegmentEnd = strrpos($roleSegmentStart, ' ');
-            if ($roleSegmentEnd === false) {
-                $roleSegmentEnd = strlen($roleSegmentStart);
-            }
-            $roleSegment = trim(substr($roleSegmentStart, 0, $roleSegmentEnd));
-            $roleValue = substr($roleSegment, 6); // roles= is 0-5
-            $expectedRoles = explode(',', $roleValue);
+        if (! empty($roles)) {
+            $allExpectedRoles = explode(',', $roles);
+            $expectedRoles = array_map(function ($role) { return mb_strtoupper(trim($role)); }, $allExpectedRoles);
         } else {
             $expectedRoles = [];
         }

diff --git a/SilMock/tests/Google/Http/BatchTest.php b/SilMock/tests/Google/Http/BatchTest.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace Http;
+
+use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\TestCase;
+use SilMock\Google\Http\Batch;
+
+class BatchTest extends TestCase
+{
+    public string $dataFile = DATAFILE5;
+    public const GROUP_EMAIL_ADDRESS = '[email protected]';
+
+    public function testAddAndExecute()
+    {
+        $batch = new Batch();
+        $batch->add('RESULT', 'key');
+        $results = $batch->execute();
+        $expected = [
+            'key' => 'RESULT',
+        ];
+        Assert::assertEquals($expected, $results);
+    }
+}
diff --git a/SilMock/tests/Google/Service/Directory/Resource/MembersTest.php b/SilMock/tests/Google/Service/Directory/Resource/MembersTest.php
@@ -98,7 +98,7 @@ public function testListMembersOnlyMember()
             $members = $mockGoogleServiceDirectory->members->listMembers(
                 $groupEmailAddress,
                 [
-                    'query' => 'roles=MEMBER'
+                    'roles' => 'MEMBER'
                 ]
             );
         } catch (Exception $exception) {
@@ -119,7 +119,7 @@ public function testListMembersOnlyOwner()
             $members = $mockGoogleServiceDirectory->members->listMembers(
                 $groupEmailAddress,
                 [
-                    'query' => 'roles=OWNER'
+                    'roles' => 'OWNER'
                 ]
             );
         } catch (Exception $exception) {

diff --git a/SilMock/tests/Google/Service/DirectoryTest.php b/SilMock/tests/Google/Service/DirectoryTest.php
@@ -2,9 +2,12 @@
 
 namespace SilMock\tests\Google\Service;
 
+use Google\Client;
+use Google\Service\Directory\Alias as Google_Service_Directory_Alias;
+use Google\Service\Directory\User as  Google_Service_Directory_User;
+use PHPUnit\Framework\Assert;
 use PHPUnit\Framework\TestCase;
-use Google_Service_Directory_Alias;
-use Google_Service_Directory_User;
+use SilMock\Google\Http\Batch;
 use SilMock\Google\Service\Directory;
 use SilMock\Google\Service\Directory\ObjectUtils;
 use SilMock\DataStore\Sqlite\SqliteUtils;
@@ -43,6 +46,12 @@ public function getProperties($object, $propKeys = null): array
         return $outArray;
     }
 
+    public function testCreateBatch()
+    {
+        $batch = new Batch();
+        self::assertInstanceOf(Batch::class, $batch);
+    }
+
     public function testDirectory()
     {
         $expectedKeys = [
@@ -54,7 +63,7 @@ public function testDirectory()
         ];
         $errorMessage = " *** Directory was not initialized properly";
 
-        $directory = new Directory('whatever', $this->dataFile);
+        $directory = new Directory('anyclient', $this->dataFile);
 
         $directoryAsJson = json_encode($directory);
         $directoryInfo = json_decode($directoryAsJson, true);
@@ -64,6 +73,13 @@ public function testDirectory()
         }
     }
 
+    public function testGetClient()
+    {
+        $dir = new Directory('anyclient', $this->dataFile);
+        $client = $dir->getClient();
+        Assert::assertInstanceOf(Client::class, $client);
+    }
+
     public function testUsersInsert()
     {
         $newUser = $this->setupSampleUser($this->dataFile);

diff --git a/composer.json b/composer.json
@@ -27,7 +27,8 @@
         "ext-mbstring": "*",
         "ext-pdo": "*",
         "google/apiclient": "^v2.15.0",
-        "google/apiclient-services": "^v0.312.0"
+        "google/apiclient-services": "^v0.312.0",
+        "webmozart/assert": "1.11.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.0",