diff --git a/spanner/src/copy_backup_with_mr_cmek.php b/spanner/src/copy_backup_with_mr_cmek.php new file mode 100644 index 000000000..ffd55ea15 --- /dev/null +++ b/spanner/src/copy_backup_with_mr_cmek.php @@ -0,0 +1,110 @@ +setSeconds((new \DateTime('+8 hours'))->getTimestamp()); + $sourceBackupFullName = DatabaseAdminClient::backupName($projectId, $sourceInstanceId, $sourceBackupId); + $request = new CopyBackupRequest([ + 'source_backup' => $sourceBackupFullName, + 'parent' => $destInstanceFullName, + 'backup_id' => $destBackupId, + 'expire_time' => $expireTime, + 'encryption_config' => new CopyBackupEncryptionConfig([ + 'kms_key_names' => $kmsKeyNames, + 'encryption_type' => CopyBackupEncryptionConfig\EncryptionType::CUSTOMER_MANAGED_ENCRYPTION + ]) + ]); + + $operationResponse = $databaseAdminClient->copyBackup($request); + $operationResponse->pollUntilComplete(); + + if (!$operationResponse->operationSucceeded()) { + $error = $operationResponse->getError(); + printf('Backup not created due to error: %s.' . PHP_EOL, $error->getMessage()); + return; + } + $destBackupInfo = $operationResponse->getResult(); + $kmsKeyVersions = []; + foreach ($destBackupInfo->getEncryptionInformation() as $encryptionInfo) { + $kmsKeyVersions[] = $encryptionInfo->getKmsKeyVersion(); + } + printf( + 'Backup %s of size %d bytes was copied at %d from the source backup %s using encryption keys %s' . PHP_EOL, + basename($destBackupInfo->getName()), + $destBackupInfo->getSizeBytes(), + $destBackupInfo->getCreateTime()->getSeconds(), + $sourceBackupId, + print_r($kmsKeyVersions, true) + ); + printf('Version time of the copied backup: %d' . PHP_EOL, $destBackupInfo->getVersionTime()->getSeconds()); +} +// [END spanner_copy_backup_with_MR_CMEK] + +// The following 2 lines are only needed to run the samples +require_once __DIR__ . '/../../testing/sample_helpers.php'; +\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv); diff --git a/spanner/src/create_backup_with_mr_cmek.php b/spanner/src/create_backup_with_mr_cmek.php new file mode 100644 index 000000000..3b7ff230e --- /dev/null +++ b/spanner/src/create_backup_with_mr_cmek.php @@ -0,0 +1,101 @@ +setSeconds((new \DateTime('+14 days'))->getTimestamp()); + $request = new CreateBackupRequest([ + 'parent' => $instanceFullName, + 'backup_id' => $backupId, + 'encryption_config' => new CreateBackupEncryptionConfig([ + 'kms_key_names' => $kmsKeyNames, + 'encryption_type' => CreateBackupEncryptionConfig\EncryptionType::CUSTOMER_MANAGED_ENCRYPTION + ]), + 'backup' => new Backup([ + 'database' => $databaseFullName, + 'expire_time' => $expireTime + ]) + ]); + + $operation = $databaseAdminClient->createBackup($request); + + print('Waiting for operation to complete...' . PHP_EOL); + $operation->pollUntilComplete(); + + $request = new GetBackupRequest(); + $request->setName($databaseAdminClient->backupName($projectId, $instanceId, $backupId)); + $info = $databaseAdminClient->getBackup($request); + if (State::name($info->getState()) == 'READY') { + $kmsKeyVersions = []; + foreach ($info->getEncryptionInformation() as $encryptionInfo) { + $kmsKeyVersions[] = $encryptionInfo->getKmsKeyVersion(); + } + printf( + 'Backup %s of size %d bytes was created at %d using encryption keys %s' . PHP_EOL, + basename($info->getName()), + $info->getSizeBytes(), + $info->getCreateTime()->getSeconds(), + print_r($kmsKeyVersions, true) + ); + } else { + print('Backup is not ready!' . PHP_EOL); + } +} +// [END spanner_create_backup_with_MR_CMEK] + +// The following 2 lines are only needed to run the samples +require_once __DIR__ . '/../../testing/sample_helpers.php'; +\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv); diff --git a/spanner/src/create_database_with_mr_cmek.php b/spanner/src/create_database_with_mr_cmek.php new file mode 100644 index 000000000..e53bf0504 --- /dev/null +++ b/spanner/src/create_database_with_mr_cmek.php @@ -0,0 +1,97 @@ +setParent($instanceName); + $createDatabaseRequest->setCreateStatement(sprintf('CREATE DATABASE `%s`', $databaseId)); + $createDatabaseRequest->setExtraStatements([ + 'CREATE TABLE Singers ( + SingerId INT64 NOT NULL, + FirstName STRING(1024), + LastName STRING(1024), + SingerInfo BYTES(MAX) + ) PRIMARY KEY (SingerId)', + 'CREATE TABLE Albums ( + SingerId INT64 NOT NULL, + AlbumId INT64 NOT NULL, + AlbumTitle STRING(MAX) + ) PRIMARY KEY (SingerId, AlbumId), + INTERLEAVE IN PARENT Singers ON DELETE CASCADE' + ]); + + if (!empty($kmsKeyNames)) { + $encryptionConfig = new EncryptionConfig(); + $encryptionConfig->setKmsKeyNames($kmsKeyNames); + $createDatabaseRequest->setEncryptionConfig($encryptionConfig); + } + + $operationResponse = $databaseAdminClient->createDatabase($createDatabaseRequest); + printf('Waiting for operation to complete...' . PHP_EOL); + $operationResponse->pollUntilComplete(); + + if ($operationResponse->operationSucceeded()) { + $database = $operationResponse->getResult(); + printf( + 'Created database %s on instance %s with encryption keys %s' . PHP_EOL, + $databaseId, + $instanceId, + print_r($database->getEncryptionConfig()->getKmsKeyNames(), true) + ); + } else { + $error = $operationResponse->getError(); + printf('Failed to create encrypted database: %s' . PHP_EOL, $error->getMessage()); + } +} +// [END spanner_create_database_with_MR_CMEK] + +// The following 2 lines are only needed to run the samples +require_once __DIR__ . '/../../testing/sample_helpers.php'; +\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv); diff --git a/spanner/src/restore_backup_with_mr_cmek.php b/spanner/src/restore_backup_with_mr_cmek.php new file mode 100644 index 000000000..6d82480d3 --- /dev/null +++ b/spanner/src/restore_backup_with_mr_cmek.php @@ -0,0 +1,85 @@ + $instanceFullName, + 'database_id' => $databaseId, + 'backup' => $backupFullName, + 'encryption_config' => new RestoreDatabaseEncryptionConfig([ + 'kms_key_names' => $kmsKeyNames, + 'encryption_type' => RestoreDatabaseEncryptionConfig\EncryptionType::CUSTOMER_MANAGED_ENCRYPTION + ]) + ]); + + // Create restore operation + $operation = $databaseAdminClient->restoreDatabase($request); + + print('Waiting for operation to complete...' . PHP_EOL); + $operation->pollUntilComplete(); + + // Reload new database and get restore info + $database = $operation->operationSucceeded() ? $operation->getResult() : null; + $restoreInfo = $database->getRestoreInfo(); + $backupInfo = $restoreInfo->getBackupInfo(); + $sourceDatabase = $backupInfo->getSourceDatabase(); + $sourceBackup = $backupInfo->getBackup(); + $encryptionConfig = $database->getEncryptionConfig(); + printf( + 'Database %s restored from backup %s using encryption keys %s' . PHP_EOL, + $sourceDatabase, $sourceBackup, print_r($encryptionConfig->getKmsKeyNames(), true) + ); +} +// [END spanner_restore_backup_with_MR_CMEK] + +// The following 2 lines are only needed to run the samples +require_once __DIR__ . '/../../testing/sample_helpers.php'; +\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv); diff --git a/spanner/test/spannerBackupTest.php b/spanner/test/spannerBackupTest.php index 5e738ff8f..b51d7e8df 100644 --- a/spanner/test/spannerBackupTest.php +++ b/spanner/test/spannerBackupTest.php @@ -47,6 +47,9 @@ class spannerBackupTest extends TestCase /** @var string encryptedBackupId */ protected static $encryptedBackupId; + /** @var string encryptedMrCmekBackupId */ + protected static $encryptedMrCmekBackupId; + /** @var string databaseId */ protected static $databaseId; @@ -59,12 +62,21 @@ class spannerBackupTest extends TestCase /** @var string encryptedRestoredDatabaseId */ protected static $encryptedRestoredDatabaseId; + /** @var string encryptedMrCmekRestoredDatabaseId */ + protected static $encryptedMrCmekRestoredDatabaseId; + /** @var $instance Instance */ protected static $instance; /** @var string kmsKeyName */ protected static $kmsKeyName; + /** @var string kmsKeyName2 */ + protected static $kmsKeyName2; + + /** @var string kmsKeyName3 */ + protected static $kmsKeyName3; + public static function setUpBeforeClass(): void { self::checkProjectEnvVars(); @@ -85,12 +97,18 @@ public static function setUpBeforeClass(): void self::$databaseId = 'test-' . time() . rand(); self::$backupId = 'backup-' . self::$databaseId; self::$encryptedBackupId = 'en-backup-' . self::$databaseId; + self::$encryptedMrCmekBackupId = 'mr-backup-' . self::$databaseId; self::$restoredDatabaseId = self::$databaseId . '-r'; self::$encryptedRestoredDatabaseId = self::$databaseId . '-en-r'; + self::$encryptedMrCmekRestoredDatabaseId = self::$databaseId . '-mr-r'; self::$instance = $spanner->instance(self::$instanceId); self::$kmsKeyName = 'projects/' . self::$projectId . '/locations/us-central1/keyRings/spanner-test-keyring/cryptoKeys/spanner-test-cmek'; + self::$kmsKeyName2 = + 'projects/' . self::$projectId . '/locations/us-east1/keyRings/spanner-test-keyring2/cryptoKeys/spanner-test-cmek2'; + self::$kmsKeyName3 = + 'projects/' . self::$projectId . '/locations/us-east4/keyRings/spanner-test-keyring3/cryptoKeys/spanner-test-cmek3'; } public function testCreateDatabaseWithVersionRetentionPeriod() @@ -113,6 +131,37 @@ public function testCreateBackupWithEncryptionKey() $this->assertStringContainsString(self::$backupId, $output); } + public function testCreateBackupWithMrCmek() + { + $spanner = new SpannerClient([ + 'projectId' => self::$projectId, + ]); + $mrCmekInstanceId = 'test-mr-' . time() . rand(); + $instanceConfig = $spanner->instanceConfiguration('nam3'); + $operation = $spanner->createInstance( + $instanceConfig, + $mrCmekInstanceId, + [ + 'displayName' => 'Mr Cmek test.', + 'nodeCount' => 1, + 'labels' => [ + 'cloud_spanner_samples' => true, + ] + ] + ); + $operation->pollUntilComplete(); + + $kmsKeyNames = array(self::$kmsKeyName, self::$kmsKeyName2, self::$kmsKeyName3); + $output = $this->runFunctionSnippet('create_backup_with_mr_cmek', [ + self::$projectId, + $mrCmekInstanceId, + self::$databaseId, + self::$encryptedMrCmekBackupId, + $kmsKeyNames, + ]); + $this->assertStringContainsString(self::$encryptedMrCmekBackupId, $output); + } + /** * @depends testCreateDatabaseWithVersionRetentionPeriod */ @@ -173,6 +222,44 @@ public function testCopyBackup() $this->assertMatchesRegularExpression(sprintf($regex, $newBackupId, self::$backupId), $output); } + /** + * @depends testCreateBackup + */ + public function testCopyBackupWithMrCmek() + { + $spanner = new SpannerClient([ + 'projectId' => self::$projectId, + ]); + $mrCmekInstanceId = 'test-mr-' . time() . rand(); + $instanceConfig = $spanner->instanceConfiguration('nam3'); + $operation = $spanner->createInstance( + $instanceConfig, + $mrCmekInstanceId, + [ + 'displayName' => 'Mr Cmek test.', + 'nodeCount' => 1, + 'labels' => [ + 'cloud_spanner_samples' => true, + ] + ] + ); + $operation->pollUntilComplete(); + $kmsKeyNames = array(self::$kmsKeyName, self::$kmsKeyName2, self::$kmsKeyName3); + $newBackupId = 'copy-' . self::$backupId . '-' . time(); + + $output = $this->runFunctionSnippet('copy_backup_with_mr_cmek', [ + self::$projectId, + $mrCmekInstanceId, + $newBackupId, + $mrCmekInstanceId, + self::$backupId, + $kmsKeyNames + ]); + + $regex = '/Backup %s of size \d+ bytes was copied at (.+) from the source backup %s/'; + $this->assertMatchesRegularExpression(sprintf($regex, $newBackupId, self::$backupId), $output); + } + /** * @depends testCreateBackup */ @@ -218,6 +305,41 @@ public function testRestoreBackupWithEncryptionKey() $this->assertStringContainsString(self::$databaseId, $output); } + /** + * @depends testCreateBackupWithMrCmek + */ + public function testRestoreBackupWithMrCmek() + { + $spanner = new SpannerClient([ + 'projectId' => self::$projectId, + ]); + $mrCmekInstanceId = 'test-mr-' . time() . rand(); + $instanceConfig = $spanner->instanceConfiguration('nam3'); + $operation = $spanner->createInstance( + $instanceConfig, + $mrCmekInstanceId, + [ + 'displayName' => 'Mr Cmek test.', + 'nodeCount' => 1, + 'labels' => [ + 'cloud_spanner_samples' => true, + ] + ] + ); + $operation->pollUntilComplete(); + + $kmsKeyNames = array(self::$kmsKeyName, self::$kmsKeyName2, self::$kmsKeyName3); + $output = $this->runFunctionSnippet('restore_backup_with_mr_cmek', [ + self::$projectId, + $mrCmekInstanceId, + self::$encryptedMrCmekRestoredDatabaseId, + self::$encryptedMrCmekBackupId, + $kmsKeyNames, + ]); + $this->assertStringContainsString(self::$encryptedMrCmekBackupId, $output); + $this->assertStringContainsString(self::$databaseId, $output); + } + /** * @depends testRestoreBackupWithEncryptionKey */ diff --git a/spanner/test/spannerTest.php b/spanner/test/spannerTest.php index b279c2af1..eb06bb2e9 100644 --- a/spanner/test/spannerTest.php +++ b/spanner/test/spannerTest.php @@ -62,6 +62,9 @@ class spannerTest extends TestCase /** @var string encryptedDatabaseId */ protected static $encryptedDatabaseId; + /** @var string $encryptedMrCmekDatabaseId */ + protected static $encryptedMrCmekDatabaseId; + /** @var string backupId */ protected static $backupId; @@ -89,6 +92,12 @@ class spannerTest extends TestCase /** @var string kmsKeyName */ protected static $kmsKeyName; + /** @var string kmsKeyName2 */ + protected static $kmsKeyName2; + + /** @var string kmsKeyName3 */ + protected static $kmsKeyName3; + /** * Low cost instance with less than 1000 processing units. * @@ -133,10 +142,15 @@ public static function setUpBeforeClass(): void self::$instancePartitionInstance = $spanner->instance(self::$instancePartitionInstanceId); self::$databaseId = 'test-' . time() . rand(); self::$encryptedDatabaseId = 'en-test-' . time() . rand(); + self::$encryptedMrCmekDatabaseId = 'mr-test-' . time() . rand(); self::$backupId = 'backup-' . self::$databaseId; self::$instance = $spanner->instance(self::$instanceId); self::$kmsKeyName = 'projects/' . self::$projectId . '/locations/us-central1/keyRings/spanner-test-keyring/cryptoKeys/spanner-test-cmek'; + self::$kmsKeyName2 = + 'projects/' . self::$projectId . '/locations/us-east1/keyRings/spanner-test-keyring2/cryptoKeys/spanner-test-cmek2'; + self::$kmsKeyName3 = + 'projects/' . self::$projectId . '/locations/us-east4/keyRings/spanner-test-keyring3/cryptoKeys/spanner-test-cmek3'; self::$lowCostInstance = $spanner->instance(self::$lowCostInstanceId); self::$multiInstanceId = 'kokoro-multi-instance'; @@ -296,6 +310,36 @@ public function testCreateDatabaseWithEncryptionKey() $this->assertStringContainsString('Created database en-test-', $output); } + public function testCreateDatabaseWithMrCmek() + { + $spanner = new SpannerClient([ + 'projectId' => self::$projectId, + ]); + $mrCmekInstanceId = 'test-mr-' . time() . rand(); + $instanceConfig = $spanner->instanceConfiguration('nam3'); + $operation = $spanner->createInstance( + $instanceConfig, + $mrCmekInstanceId, + [ + 'displayName' => 'Mr Cmek test.', + 'nodeCount' => 1, + 'labels' => [ + 'cloud_spanner_samples' => true, + ] + ] + ); + $operation->pollUntilComplete(); + $kmsKeyNames = array(self::$kmsKeyName, self::$kmsKeyName2, self::$kmsKeyName3); + $output = $this->runAdminFunctionSnippet('create_database_with_mr_cmek', [ + self::$projectId, + $mrCmekInstanceId, + self::$encryptedMrCmekDatabaseId, + $kmsKeyNames, + ]); + $this->assertStringContainsString('Waiting for operation to complete...', $output); + $this->assertStringContainsString('Created database mr-test-', $output); + } + /** * @depends testCreateDatabase */