feat(Spanner): Support Emulator via env in Spanner Admin Client

[ajupazhamayil]

This PR introduces emulator support in the Spanner Admin Client via an environment variable. These changes will simplify future similar requirements.

[vishwarajanand]

Test failures look unrelated, potential fix: #688

[ajupazhamayil]

Referred: #688

[ajupazhamayil]

@bshaffer Thank you for the quick review, I have resolved your comments.

[ajupazhamayil]

I have checked the following test to understand it is in fact working for the Spanner Admin Client.

$diff tests/Integration/goldens/spanner/src/V1/Client/DatabaseAdminClient.php ../google-cloud-php/Spanner/src/Admin/Database/V1/Client/DatabaseAdminClient.php

<  * Copyright 2024 Google LLC
---
>  * Copyright 2023 Google LLC
38d37
< use Google\Cloud\Core\InsecureCredentialsWrapper;
71d69
< use Grpc\ChannelCredentials;
375c373
<         $clientOptions = $this->buildClientOptions($options + $this->getDefaultEmulatorConfig());
---
>         $clientOptions = $this->buildClientOptions($options);
1037,1062d1034
<     }
< 
<     /** Configure the gapic configuration to use a service emulator. */
<     private function getDefaultEmulatorConfig(): array
<     {
<         $emulatorHost = getenv('SPANNER_EMULATOR_HOST');
<         if (empty($emulatorHost)) {
<             return [];
<         }
< 
<         if ($scheme = parse_url($emulatorHost, PHP_URL_SCHEME)) {
<             $search = $scheme . '://';
<             $emulatorHost = str_replace($search, '', $emulatorHost);
<         }
< 
<         return [
<             'apiEndpoint' => $emulatorHost,
<             'transportConfig' => [
<                 'grpc' => [
<                     'stubOpts' => [
<                         'credentials' => ChannelCredentials::createInsecure(),
<                     ],
<                 ],
<             ],
<             'credentials' => new InsecureCredentialsWrapper(),
<         ];

[snippet-bot]

Here is the summary of changes.

You are about to add 20 region tags.

• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/copy_backup.php:25, tag spanner_v1_generated_DatabaseAdmin_CopyBackup_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/create_backup.php:25, tag spanner_v1_generated_DatabaseAdmin_CreateBackup_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/create_database.php:25, tag spanner_v1_generated_DatabaseAdmin_CreateDatabase_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/delete_backup.php:25, tag spanner_v1_generated_DatabaseAdmin_DeleteBackup_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/drop_database.php:25, tag spanner_v1_generated_DatabaseAdmin_DropDatabase_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/get_backup.php:25, tag spanner_v1_generated_DatabaseAdmin_GetBackup_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/get_database.php:25, tag spanner_v1_generated_DatabaseAdmin_GetDatabase_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/get_database_ddl.php:25, tag spanner_v1_generated_DatabaseAdmin_GetDatabaseDdl_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/get_iam_policy.php:25, tag spanner_v1_generated_DatabaseAdmin_GetIamPolicy_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/list_backup_operations.php:25, tag spanner_v1_generated_DatabaseAdmin_ListBackupOperations_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/list_backups.php:25, tag spanner_v1_generated_DatabaseAdmin_ListBackups_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/list_database_operations.php:25, tag spanner_v1_generated_DatabaseAdmin_ListDatabaseOperations_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/list_database_roles.php:25, tag spanner_v1_generated_DatabaseAdmin_ListDatabaseRoles_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/list_databases.php:25, tag spanner_v1_generated_DatabaseAdmin_ListDatabases_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/restore_database.php:25, tag spanner_v1_generated_DatabaseAdmin_RestoreDatabase_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/set_iam_policy.php:25, tag spanner_v1_generated_DatabaseAdmin_SetIamPolicy_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/test_iam_permissions.php:25, tag spanner_v1_generated_DatabaseAdmin_TestIamPermissions_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/update_backup.php:25, tag spanner_v1_generated_DatabaseAdmin_UpdateBackup_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/update_database.php:25, tag spanner_v1_generated_DatabaseAdmin_UpdateDatabase_sync
• tests/Integration/goldens/spanner/samples/V1/DatabaseAdminClient/update_database_ddl.php:25, tag spanner_v1_generated_DatabaseAdmin_UpdateDatabaseDdl_sync

---

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

• Refresh this comment

[bshaffer]

One minor suggestion, otherwise this is looking great. Would also love some eyeballs from @noahdietz

[noahdietz]

One comment on the integration test but otherwise, LGTM

[bshaffer]

@ajupazhamayil nit, but we only use tags like feat(Spanner) in google-cloud-php. It doesn't make sense in the generator here because this generator applies to all GAPIC APIs, and shouldn't be thought of as applying to a specific one. Even though this feature is only going to roll out to Spanner, it's a generic feature which could apply to any package/API.

[ajupazhamayil]

@ajupazhamayil nit, but we only use tags like feat(Spanner) in google-cloud-php. It doesn't make sense in the generator here because this generator applies to all GAPIC APIs, and shouldn't be thought of as applying to a specific one. Even though this feature is only going to roll out to Spanner, it's a generic feature which could apply to any package/API.

Sure @bshaffer, Will take care of this from next time onwards. Thank you for the information.