test: Fix Spanner Backup tests (GoogleCloudPlatform#1052)

Author: bshaffer

spanner/test/spannerBackupTest.php

@@ -0,0 +1,237 @@
+<?php
+/**
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Google\Cloud\Samples\Spanner;
+
+use Google\Cloud\Spanner\Database;
+use Google\Cloud\Spanner\Backup;
+use Google\Cloud\Spanner\SpannerClient;
+use Google\Cloud\Spanner\Instance;
+use Google\Cloud\TestUtils\ExecuteCommandTrait;
+use Google\Cloud\TestUtils\EventuallyConsistentTestTrait;
+use Google\Cloud\TestUtils\TestTrait;
+use PHPUnitRetry\RetryTrait;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @retryAttempts 3
+ */
+class spannerBackupTest extends TestCase
+{
+    use RetryTrait, TestTrait, EventuallyConsistentTestTrait;
+    use ExecuteCommandTrait {
+        ExecuteCommandTrait::runCommand as traitRunCommand;
+    }
+
+    private static $commandFile = __DIR__ . '/../spanner.php';
+
+    /** @var string instanceId */
+    protected static $instanceId;
+
+    /** @var string backupId */
+    protected static $backupId;
+
+    /** @var string databaseId */
+    protected static $databaseId;
+
+    /** @var $instance Instance */
+    protected static $instance;
+
+    public static function setUpBeforeClass()
+    {
+        self::checkProjectEnvVars();
+
+        if (!extension_loaded('grpc')) {
+            self::markTestSkipped('Must enable grpc extension.');
+        }
+        self::$instanceId = self::requireEnv('GOOGLE_SPANNER_INSTANCE_ID');
+
+        $spanner = new SpannerClient([
+            'projectId' => self::$projectId,
+        ]);
+
+        self::$databaseId = 'test-' . time() . rand();
+        self::$backupId = 'backup-' . self::$databaseId;
+        self::$instance = $spanner->instance(self::$instanceId);
+        self::$instance->database(self::$databaseId)->create();
+    }
+
+    public function testCancelBackup()
+    {
+        $output = $this->runCommand('cancel-backup', [
+            'database_id' => self::$databaseId,
+        ]);
+        $this->assertContains('Cancel backup operation complete', $output);
+    }
+
+    public function testCreateBackup()
+    {
+        $output = $this->traitRunCommand('create-backup', [
+            'instance_id' => self::$instanceId,
+            'database_id' => self::$databaseId,
+            'backup_id' => self::$backupId,
+        ]);
+        $this->assertContains(self::$backupId, $output);
+    }
+
+    /**
+     * @depends testCreateBackup
+     */
+    public function testListBackupOperations()
+    {
+        $databaseId2 = self::$databaseId . '-2';
+        $database2 = self::$instance->database($databaseId2);
+        // DB may already exist if the test timed out and retried
+        if (!$database2->exists()) {
+            $database2->create();
+        }
+        $backup = self::$instance->backup(self::$backupId . '-pro');
+        $lro = $backup->create($databaseId2, new \DateTime('+7 hours'));
+        $output = $this->runCommand('list-backup-operations', [
+            'database_id' => self::$databaseId,
+        ]);
+        $this->assertContains(basename($lro->name()), $output);
+        $lro->pollUntilComplete();
+    }
+
+    /**
+     * @depends testCreateBackup
+     */
+    public function testListBackups()
+    {
+        $output = $this->runCommand('list-backups');
+        $this->assertContains(self::$backupId, $output);
+    }
+
+    /**
+     * @depends testCreateBackup
+     */
+    public function testUpdateBackup()
+    {
+        $output = $this->runCommand('update-backup', [
+            'backup_id' => self::$backupId,
+        ]);
+        $this->assertContains(self::$backupId, $output);
+    }
+
+    /**
+     * @depends testUpdateBackup
+     */
+    public function testRestoreBackup()
+    {
+        $output = $this->runCommand('restore-backup', [
+            'database_id' => self::$databaseId . '-res',
+            'backup_id' => self::$backupId,
+        ]);
+        $this->assertContains(self::$backupId, $output);
+        $this->assertContains(self::$databaseId, $output);
+    }
+
+
+    /**
+     * @depends testRestoreBackup
+     */
+    public function testListDatabaseOperations()
+    {
+        $output = $this->runCommand('list-database-operations');
+        $this->assertContains('Running optimize operation', $output);
+    }
+
+    /**
+     * @depends testListBackups
+     */
+    public function testDeleteBackup()
+    {
+        self::waitForOperations();
+        $output = $this->runCommand('delete-backup', [
+            'backup_id' => self::$backupId,
+        ]);
+        $this->assertContains(self::$backupId, $output);
+    }
+
+    private static function waitForOperations()
+    {
+        //  Wait for backup operations
+        $filter = '(metadata.@type:type.googleapis.com/' .
+            'google.spanner.admin.database.v1.%s)';
+
+        $backupOperations = self::$instance->backupOperations([
+            'filter' => sprintf($filter, 'CreateBackupMetadata')
+        ]);
+
+        $dbOperations = self::$instance->databaseOperations([
+            'filter' => sprintf($filter, 'OptimizeRestoredDatabaseMetadata')
+        ]);
+
+        foreach ($backupOperations as $operation) {
+            if (!$operation->done()) {
+                $operation->pollUntilComplete();
+            }
+        }
+        foreach ($dbOperations as $operation) {
+            if (!$operation->done()) {
+                $operation->pollUntilComplete();
+            }
+        }
+    }
+
+    private function runCommand($commandName, $params = [])
+    {
+        return $this->traitRunCommand($commandName, $params + [
+            'instance_id' => self::$instanceId,
+        ]);
+    }
+
+    public static function tearDownAfterClass()
+    {
+        if (!self::$instance->exists()) {
+            return;
+        }
+
+        self::waitForOperations();
+
+        $exceptions = [];
+
+        $dbs = self::$instance->databases();
+        /** @var Database $db */
+        foreach ($dbs as $db) {
+            if (strstr($db->name(), self::$databaseId) !== false) {
+                try {
+                    $db->drop();
+                } catch (\Exception $e) {
+                    $exceptions[] = $e;
+                }
+            }
+        }
+
+        $backups = self::$instance->backups();
+        /** @var Backup $backup */
+        foreach ($backups as $backup) {
+            if (strstr($backup->name(), self::$databaseId) !== false) {
+                try {
+                    $backup->delete();
+                } catch (\Exception $e) {
+                    $exceptions[] = $e;
+                }
+            }
+        }
+
+        if ($exceptions) {
+            throw new \RuntimeException(PHP_EOL . implode(PHP_EOL, $exceptions));
+        }
+    }
+}