chore(Spanner): updates to support new Spanner emulator

.github/workflows/emulator-system-tests-spanner.yaml

@@ -18,7 +18,7 @@ jobs:
     runs-on: 'ubuntu-24.04'
     services:
       emulator:
-        image: gcr.io/cloud-spanner-emulator/emulator:1.5.34
+        image: gcr.io/cloud-spanner-emulator/emulator:1.5.42
         ports:
           - 9010:9010
           - 9020:9020
@@ -41,7 +41,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.4'
           ini-values: grpc.enable_fork_support=1
           tools: pecl
           extensions: bcmath, grpc, pcntl

Core/src/Testing/System/SystemTestCase.php

@@ -28,7 +28,6 @@
 use Google\Cloud\Storage\StorageClient;
 use Google\Cloud\Core\Testing\System\DeletionQueue;
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 
 /**
  * SystemTestCase can be extended to implement system tests
@@ -287,11 +286,4 @@ public static function skipIfEmulatorUsed($reason = null)
             self::markTestSkipped($reason ?: 'This test is not supported by the emulator.');
         }
     }
-
-    protected static function getCacheItemPool()
-    {
-        return new FilesystemAdapter(
-            directory: __DIR__ . '/../../../../.cache'
-        );
-    }
 }

Spanner/src/Result.php

@@ -520,7 +520,7 @@ private function setSnapshotOrTransaction(array $result): void
                     [],
                     $this->mapper
                 );
-                if (isset($result['precommitToken'])) {
+                if (isset($result['precommitToken']['precommitToken'])) {
                     // @TODO: Can we move this logic to the serializer or value mapper?
                     $this->transaction->setPrecommitToken(
                         (new MultiplexedSessionPrecommitToken())

Spanner/tests/System/AdminTest.php

@@ -19,6 +19,7 @@
 
 use Google\Cloud\Core\Exception\FailedPreconditionException;
 use Google\Cloud\Core\LongRunning\LongRunningOperation;
+use Google\Cloud\Core\Testing\System\SystemTestCase;
 use Google\Cloud\Spanner\Admin\Database\V1\Client\DatabaseAdminClient;
 use Google\Cloud\Spanner\Admin\Database\V1\DatabaseDialect;
 use Google\Cloud\Spanner\Admin\Instance\V1\Client\InstanceAdminClient;
@@ -31,8 +32,10 @@
  * @group spanner
  * @group admin
  */
-class AdminTest extends SpannerTestCase
+class AdminTest extends SystemTestCase
 {
+    use SystemTestCaseTrait;
+
     /**
      * @beforeClass
      */
@@ -123,15 +126,7 @@ public function testDatabase()
 
         $this->assertInstanceOf(Database::class, current($database));
         $this->assertTrue($db->exists());
-
-        $expectedDatabaseDialect = DatabaseDialect::GOOGLE_STANDARD_SQL;
-
-        // TODO: Remove this, when the emulator supports PGSQL
-        if ((bool) getenv('SPANNER_EMULATOR_HOST')) {
-            $expectedDatabaseDialect = DatabaseDialect::DATABASE_DIALECT_UNSPECIFIED;
-        }
-
-        $this->assertEquals($db->info()['databaseDialect'], $expectedDatabaseDialect);
+        $this->assertEquals($db->info()['databaseDialect'], DatabaseDialect::GOOGLE_STANDARD_SQL);
 
         $stmt = "CREATE TABLE Ids (\n" .
             "  id INT64 NOT NULL,\n" .

Spanner/tests/System/BackupTest.php

@@ -20,6 +20,7 @@
 use Google\Cloud\Core\Exception\BadRequestException;
 use Google\Cloud\Core\Exception\ConflictException;
 use Google\Cloud\Core\LongRunning\LongRunningOperation;
+use Google\Cloud\Core\Testing\System\SystemTestCase;
 use Google\Cloud\Spanner\Admin\Database\V1\Client\DatabaseAdminClient;
 use Google\Cloud\Spanner\Admin\Database\V1\CreateBackupEncryptionConfig;
 use Google\Cloud\Spanner\Admin\Database\V1\EncryptionInfo\Type;
@@ -30,8 +31,10 @@
 /**
  * @group spanner
  */
-class BackupTest extends SpannerTestCase
+class BackupTest extends SystemTestCase
 {
+    use SystemTestCaseTrait;
+
     const BACKUP_PREFIX = 'spanner_backup_';
 
     protected static $backupId1;
@@ -47,7 +50,7 @@ class BackupTest extends SpannerTestCase
 
     protected static $project;
 
-    private static $hasSetUp = false;
+    private static $hasSetUpBackup = false;
 
     /**
      * @beforeClass
@@ -59,7 +62,7 @@ public static function setUpTestFixtures(): void
         self::emulatorOnly();
 
         self::setUpTestDatabase();
-        if (self::$hasSetUp) {
+        if (self::$hasSetUpBackup) {
             return;
         }
 
@@ -112,7 +115,7 @@ public static function setUpTestFixtures(): void
         self::$backupId1 = uniqid(self::BACKUP_PREFIX);
         self::$backupId2 = uniqid('users-');
         self::$copyBackupId = uniqid('copy-');
-        self::$hasSetUp = true;
+        self::$hasSetUpBackup = true;
     }
 
     public function testCreateBackup()

Spanner/tests/System/BatchTest.php

@@ -18,6 +18,7 @@
 namespace Google\Cloud\Spanner\Tests\System;
 
 use Google\Cloud\Core\Exception\ServiceException;
+use Google\Cloud\Core\Testing\System\SystemTestCase;
 use Google\Cloud\Spanner\Admin\Database\V1\DatabaseDialect;
 use Google\Cloud\Spanner\Batch\BatchClient;
 use Google\Cloud\Spanner\Batch\BatchSnapshot;
@@ -28,8 +29,9 @@
  * @group spanner
  * @group spanner-batch
  */
-class BatchTest extends SpannerTestCase
+class BatchTest extends SystemTestCase
 {
+    use SystemTestCaseTrait;
     use DatabaseRoleTrait;
 
     private static $tableName;
@@ -56,26 +58,26 @@ public static function setUpTestFixtures(): void
         ))->pollUntilComplete();
 
         if (self::$database->info()['databaseDialect'] == DatabaseDialect::GOOGLE_STANDARD_SQL) {
-            self::$database->updateDdlBatch([
-                sprintf(
-                    'CREATE ROLE %s',
-                    self::$dbRole
-                ),
-                sprintf(
-                    'CREATE ROLE %s',
-                    self::$restrictiveDbRole
-                ),
-                sprintf(
+            $statements = [
+                sprintf('CREATE ROLE %s', self::$dbRole),
+                sprintf('CREATE ROLE %s', self::$restrictiveDbRole),
+            ];
+
+            if (!self::isEmulatorUsed()) {
+                $statements[] = sprintf(
                     'GRANT SELECT(id) ON TABLE %s TO ROLE %s',
                     self::$tableName,
                     self::$restrictiveDbRole
-                ),
-                sprintf(
-                    'GRANT SELECT ON TABLE %s TO ROLE %s',
-                    self::$tableName,
-                    self::$dbRole
-                )
-            ])->pollUntilComplete();
+                );
+            }
+
+            $statements[] = sprintf(
+                'GRANT SELECT ON TABLE %s TO ROLE %s',
+                self::$tableName,
+                self::$dbRole
+            );
+
+            self::$database->updateDdlBatch($statements)->pollUntilComplete();
         }
 
         self::seedTable();

Spanner/tests/System/BatchWriteTest.php

@@ -18,12 +18,15 @@
 namespace Google\Cloud\Spanner\Tests\System;
 
 use Google\Rpc\Code;
+use Google\Cloud\Core\Testing\System\SystemTestCase;
 
 /**
  * @group spanner
  */
-class BatchWriteTest extends SpannerTestCase
+class BatchWriteTest extends SystemTestCase
 {
+    use SystemTestCaseTrait;
+
     const TABLE_NAME = 'BatchWrites';
     /**
      * @beforeClass

Spanner/tests/System/DatabaseRoleTrait.php

@@ -46,7 +46,7 @@ public function insertDbProvider()
                 self::getDbWithRestrictiveRole(),
                 [
                     'id' => rand(1, 346464),
-                    'name' => uniqid(SpannerTestCase::TESTING_PREFIX),
+                    'name' => uniqid(self::TESTING_PREFIX),
                     'birthday' => new Date(new \DateTime('2000-01-01'))
                 ],
                 'PERMISSION_DENIED'
@@ -55,7 +55,7 @@ public function insertDbProvider()
                 self::getDbWithRestrictiveRole(),
                 [
                     'id' => rand(1, 346464),
-                    'name' => uniqid(SpannerTestCase::TESTING_PREFIX)
+                    'name' => uniqid(self::TESTING_PREFIX)
                 ],
                 null
             ]

Spanner/tests/System/GeneratedAdminEmulatorTest.php

@@ -17,6 +17,7 @@
 
 namespace Google\Cloud\Spanner\Tests\System;
 
+use Google\Cloud\Core\Testing\System\SystemTestCase;
 use Google\Cloud\Spanner\Admin\Database\V1\Client\DatabaseAdminClient;
 use Google\Cloud\Spanner\Admin\Database\V1\CreateDatabaseRequest;
 use Google\Cloud\Spanner\Admin\Database\V1\GetDatabaseRequest;
@@ -28,8 +29,10 @@
 /**
  * @group spanner
  */
-class GeneratedAdminEmulatorTest extends SpannerTestCase
+class GeneratedAdminEmulatorTest extends SystemTestCase
 {
+    use SystemTestCaseTrait;
+
     private static $projectId;
 
     /**
@@ -42,9 +45,7 @@ public static function setUpTestFixtures(): void
 
     public function testAdminClientEmulatorSupport()
     {
-        if (!getenv('SPANNER_EMULATOR_HOST')) {
-            self::markTestSkipped('This test is required to run only in the emulator.');
-        }
+        self::emulatorOnly();
 
         $instanceId = uniqid(self::INSTANCE_NAME);
         $databaseId = uniqid(self::TESTING_PREFIX);

Spanner/tests/System/LargeReadTest.php

@@ -17,15 +17,18 @@
 
 namespace Google\Cloud\Spanner\Tests\System;
 
+use Google\Cloud\Core\Testing\System\SystemTestCase;
 use Google\Cloud\Spanner\Bytes;
 use Google\Cloud\Spanner\KeySet;
 
 /**
  * @group spanner
  * @group spanner-large-read
  */
-class LargeReadTest extends SpannerTestCase
+class LargeReadTest extends SystemTestCase
 {
+    use SystemTestCaseTrait;
+
     private static $tableName;
     private static $row = [];
 

Spanner/tests/System/OperationsTest.php

@@ -17,16 +17,18 @@
 
 namespace Google\Cloud\Spanner\Tests\System;
 
+use Google\Cloud\Core\Testing\System\SystemTestCase;
 use Google\Cloud\Core\Exception\ServiceException;
 use Google\Cloud\Spanner\Date;
 use Google\Cloud\Spanner\Timestamp;
 
 /**
  * @group spanner
  */
-class OperationsTest extends SpannerTestCase
+class OperationsTest extends SystemTestCase
 {
     use DatabaseRoleTrait;
+    use SystemTestCaseTrait;
 
     private static $id1;
     private static $id2;

Spanner/tests/System/PartitionedDmlTest.php

@@ -17,12 +17,16 @@
 
 namespace Google\Cloud\Spanner\Tests\System;
 
+use Google\Cloud\Core\Testing\System\SystemTestCase;
+
 /**
  * @group spanner
  * @group spanner-pdml
  */
-class PartitionedDmlTest extends SpannerTestCase
+class PartitionedDmlTest extends SystemTestCase
 {
+    use SystemTestCaseTrait;
+
     const PDML_TABLE = 'partitionedDml';
 
     /**

Spanner/tests/System/PgBatchTest.php

@@ -18,6 +18,7 @@
 namespace Google\Cloud\Spanner\Tests\System;
 
 use Google\Cloud\Core\Exception\ServiceException;
+use Google\Cloud\Core\Testing\System\SystemTestCase;
 use Google\Cloud\Spanner\Admin\Database\V1\DatabaseDialect;
 use Google\Cloud\Spanner\Batch\BatchClient;
 use Google\Cloud\Spanner\Batch\BatchSnapshot;
@@ -27,19 +28,24 @@
  * @group spanner-batch
  * @group spanner-postgres
  */
-class PgBatchTest extends SpannerPgTestCase
+class PgBatchTest extends SystemTestCase
 {
+    use PgSystemTestCaseTrait;
     use DatabaseRoleTrait;
 
     private static $tableName;
-    private static $isSetup = false;
+    private static $hasSetupBatch = false;
 
     /**
      * @beforeClass
      */
     public static function setUpTestFixtures(): void
     {
-        if (self::$isSetup) {
+        // Skip setting up fixutres for the emulator as there's only one test which does not suppport the emulator.
+        // NOTE: remove this if new tests tests are added which support the emulator.
+        self::skipEmulatorTests();
+
+        if (self::$hasSetupBatch) {
             return;
         }
         self::setUpTestDatabase();
@@ -55,30 +61,29 @@ public static function setUpTestFixtures(): void
         ))->pollUntilComplete();
 
         if (self::$database->info()['databaseDialect'] == DatabaseDialect::POSTGRESQL) {
-            self::$database->updateDdlBatch([
-                sprintf(
-                    'CREATE ROLE %s',
-                    self::$dbRole
-                ),
-                sprintf(
-                    'CREATE ROLE %s',
-                    self::$restrictiveDbRole
-                ),
-                sprintf(
+            $statements = [
+                sprintf('CREATE ROLE %s', self::$dbRole),
+                sprintf('CREATE ROLE %s', self::$restrictiveDbRole),
+            ];
+
+            if (!self::isEmulatorUsed()) {
+                $statements[] = sprintf(
                     'GRANT SELECT(id) ON TABLE %s TO %s',
                     self::$tableName,
                     self::$restrictiveDbRole
-                ),
-                sprintf(
+                );
+                $statements[] = sprintf(
                     'GRANT SELECT ON TABLE %s TO %s',
                     self::$tableName,
                     self::$dbRole
-                )
-            ])->pollUntilComplete();
+                );
+            }
+
+            self::$database->updateDdlBatch($statements)->pollUntilComplete();
         }
 
         self::seedTable();
-        self::$isSetup = true;
+        self::$hasSetupBatch = true;
     }
 
     /**