Skip to content
Permalink
Browse files
feat: add backup support (#100)
  • Loading branch information
olavloite committed Mar 19, 2020
1 parent ae22ac3 commit ed3874afcf55fe7381354e03dab3a3b97d7eb520
Showing with 4,308 additions and 64 deletions.
  1. +136 −0 google-cloud-spanner/clirr-ignored-differences.xml
  2. +32 −9 google-cloud-spanner/pom.xml
  3. +203 −0 google-cloud-spanner/src/main/java/com/google/cloud/spanner/Backup.java
  4. +107 −0 google-cloud-spanner/src/main/java/com/google/cloud/spanner/BackupId.java
  5. +196 −0 google-cloud-spanner/src/main/java/com/google/cloud/spanner/BackupInfo.java
  6. +73 −1 google-cloud-spanner/src/main/java/com/google/cloud/spanner/Database.java
  7. +151 −0 google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseAdminClient.java
  8. +236 −1 google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseAdminClientImpl.java
  9. +100 −4 google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseInfo.java
  10. +24 −2 google-cloud-spanner/src/main/java/com/google/cloud/spanner/Instance.java
  11. +7 −0 google-cloud-spanner/src/main/java/com/google/cloud/spanner/Options.java
  12. +134 −0 google-cloud-spanner/src/main/java/com/google/cloud/spanner/RestoreInfo.java
  13. +84 −1 google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java
  14. +177 −0 google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpc.java
  15. +52 −0 google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/SpannerRpc.java
  16. +4 −1 google-cloud-spanner/src/main/java/com/google/cloud/spanner/testing/RemoteSpannerHelper.java
  17. +55 −0 google-cloud-spanner/src/test/java/com/google/cloud/spanner/BackupIdTest.java
  18. +298 −0 google-cloud-spanner/src/test/java/com/google/cloud/spanner/BackupTest.java
  19. +101 −5 google-cloud-spanner/src/test/java/com/google/cloud/spanner/DatabaseAdminClientImplTest.java
  20. +628 −1 google-cloud-spanner/src/test/java/com/google/cloud/spanner/DatabaseAdminClientTest.java
  21. +33 −0 google-cloud-spanner/src/test/java/com/google/cloud/spanner/DatabaseTest.java
  22. +2 −1 google-cloud-spanner/src/test/java/com/google/cloud/spanner/GceTestEnvConfig.java
  23. +32 −0 google-cloud-spanner/src/test/java/com/google/cloud/spanner/InstanceTest.java
  24. +566 −5 google-cloud-spanner/src/test/java/com/google/cloud/spanner/MockDatabaseAdminServiceImpl.java
  25. +249 −0 google-cloud-spanner/src/test/java/com/google/cloud/spanner/MockDatabaseAdminServiceImplTest.java
  26. +17 −1 google-cloud-spanner/src/test/java/com/google/cloud/spanner/MockOperationsServiceImpl.java
  27. +20 −0 google-cloud-spanner/src/test/java/com/google/cloud/spanner/ParallelIntegrationTest.java
  28. +559 −0 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITBackupTest.java
  29. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITBatchDmlTest.java
  30. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITBatchReadTest.java
  31. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITClosedSessionTest.java
  32. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITCommitTimestampTest.java
  33. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITDMLTest.java
  34. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITDatabaseAdminTest.java
  35. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITDatabaseTest.java
  36. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITLargeReadTest.java
  37. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITQueryOptionsTest.java
  38. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITQueryTest.java
  39. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITReadOnlyTxnTest.java
  40. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITReadTest.java
  41. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITSpannerOptionsTest.java
  42. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITTransactionManagerTest.java
  43. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITTransactionTest.java
  44. +2 −2 google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITWriteTest.java
@@ -11,4 +11,140 @@
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
<method>* asyncDeleteSession(*)</method>
</difference>

<!-- Adding Backup feature -->
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>void cancelOperation(java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.api.gax.longrunning.OperationFuture createBackup(java.lang.String, java.lang.String, java.lang.String, com.google.cloud.Timestamp)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>void deleteBackup(java.lang.String, java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.cloud.spanner.Backup getBackup(java.lang.String, java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.cloud.spanner.Backup getBackup(java.lang.String, java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.cloud.Policy getBackupIAMPolicy(java.lang.String, java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.longrunning.Operation getOperation(java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.api.gax.paging.Page listBackupOperations(java.lang.String, com.google.cloud.spanner.Options$ListOption[])</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.api.gax.paging.Page listBackups(java.lang.String, com.google.cloud.spanner.Options$ListOption[])</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.api.gax.paging.Page listDatabaseOperations(java.lang.String, com.google.cloud.spanner.Options$ListOption[])</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.cloud.spanner.Backup$Builder newBackupBuilder(com.google.cloud.spanner.BackupId)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.cloud.spanner.Backup$Builder newBackupBuilder(com.google.cloud.spanner.BackupId)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.api.gax.longrunning.OperationFuture restoreDatabase(java.lang.String, java.lang.String, java.lang.String, java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.cloud.Policy setBackupIAMPolicy(java.lang.String, java.lang.String, com.google.cloud.Policy)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>java.lang.Iterable testBackupIAMPermissions(java.lang.String, java.lang.String, java.lang.Iterable)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
<method>com.google.cloud.spanner.Backup updateBackup(java.lang.String, java.lang.String, com.google.cloud.Timestamp)</method>
</difference>

<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
<method>void cancelOperation(java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
<method>com.google.api.gax.longrunning.OperationFuture createBackup(java.lang.String, java.lang.String, com.google.spanner.admin.database.v1.Backup)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
<method>void deleteBackup(java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
<method>com.google.spanner.admin.database.v1.Backup getBackup(java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
<method>com.google.cloud.spanner.spi.v1.SpannerRpc$Paginated listBackupOperations(java.lang.String, int, java.lang.String, java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
<method>com.google.cloud.spanner.spi.v1.SpannerRpc$Paginated listBackups(java.lang.String, int, java.lang.String, java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
<method>com.google.cloud.spanner.spi.v1.SpannerRpc$Paginated listDatabaseOperations(java.lang.String, int, java.lang.String, java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
<method>com.google.api.gax.longrunning.OperationFuture restoreDatabase(java.lang.String, java.lang.String, java.lang.String)</method>
</difference>
<difference>
<differenceType>7012</differenceType>
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
<method>com.google.spanner.admin.database.v1.Backup updateBackup(com.google.spanner.admin.database.v1.Backup, com.google.protobuf.FieldMask)</method>
</difference>

<difference>
<differenceType>7004</differenceType>
<className>com/google/cloud/spanner/Instance</className>
<!-- Added varargs (ListOption... options) -->
<method>com.google.api.gax.paging.Page listDatabases()</method>
</difference>

</differences>
@@ -62,6 +62,38 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<configuration>
<systemPropertyVariables>
<spanner.testenv.config.class>com.google.cloud.spanner.GceTestEnvConfig</spanner.testenv.config.class>
<spanner.testenv.instance>projects/gcloud-devel/instances/spanner-testing</spanner.testenv.instance>
</systemPropertyVariables>
<forkedProcessTimeoutInSeconds>3000</forkedProcessTimeoutInSeconds>
</configuration>
<executions>
<execution>
<id>default</id>
<configuration>
<groups>com.google.cloud.spanner.IntegrationTest</groups>
<excludedGroups>com.google.cloud.spanner.FlakyTest,com.google.cloud.spanner.TracerTest,com.google.cloud.spanner.ParallelIntegrationTest</excludedGroups>
</configuration>
</execution>
<execution>
<id>parallel-integration-test</id>
<goals>
<goal>integration-test</goal>
</goals>
<configuration>
<groups>com.google.cloud.spanner.ParallelIntegrationTest</groups>
<excludedGroups>com.google.cloud.spanner.FlakyTest,com.google.cloud.spanner.TracerTest,com.google.cloud.spanner.IntegrationTest</excludedGroups>
<forkCount>8</forkCount>
<reuseForks>true</reuseForks>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
<pluginManagement>
<plugins>
@@ -74,15 +106,6 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<version>3.0.0-M4</version>
<configuration>
<systemPropertyVariables>
<spanner.testenv.config.class>com.google.cloud.spanner.GceTestEnvConfig</spanner.testenv.config.class>
<spanner.testenv.instance>projects/gcloud-devel/instances/spanner-testing</spanner.testenv.instance>
</systemPropertyVariables>
<groups>com.google.cloud.spanner.IntegrationTest</groups>
<excludedGroups>com.google.cloud.spanner.FlakyTest,com.google.cloud.spanner.TracerTest</excludedGroups>
<forkedProcessTimeoutInSeconds>2400</forkedProcessTimeoutInSeconds>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -0,0 +1,203 @@
/*
* 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.
*/

package com.google.cloud.spanner;

import static com.google.common.base.Preconditions.checkArgument;

import com.google.api.client.util.Preconditions;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.Page;
import com.google.cloud.Policy;
import com.google.cloud.Timestamp;
import com.google.longrunning.Operation;
import com.google.spanner.admin.database.v1.CreateBackupMetadata;
import com.google.spanner.admin.database.v1.RestoreDatabaseMetadata;

/**
* Represents a Cloud Spanner database backup. {@code Backup} adds a layer of service related
* functionality over {@code BackupInfo}.
*/
public class Backup extends BackupInfo {
public static class Builder extends BackupInfo.BuilderImpl {
private final DatabaseAdminClient dbClient;

Builder(DatabaseAdminClient dbClient, BackupId backupId) {
super(backupId);
this.dbClient = Preconditions.checkNotNull(dbClient);
}

private Builder(Backup backup) {
super(backup);
this.dbClient = backup.dbClient;
}

@Override
public Backup build() {
return new Backup(this);
}
}

private static final String FILTER_BACKUP_OPERATIONS_TEMPLATE = "name:backups/%s";
private final DatabaseAdminClient dbClient;

Backup(Builder builder) {
super(builder);
this.dbClient = Preconditions.checkNotNull(builder.dbClient);
}

/** Creates a backup on the server based on the source of this {@link Backup} instance. */
public OperationFuture<Backup, CreateBackupMetadata> create() {
Preconditions.checkState(
getExpireTime() != null, "Cannot create a backup without an expire time");
Preconditions.checkState(
getDatabase() != null, "Cannot create a backup without a source database");
return dbClient.createBackup(instance(), backup(), sourceDatabase(), getExpireTime());
}

/**
* Returns <code>true</code> if a backup with the id of this {@link Backup} exists on Cloud
* Spanner.
*/
public boolean exists() {
try {
dbClient.getBackup(instance(), backup());
} catch (SpannerException e) {
if (e.getErrorCode() == ErrorCode.NOT_FOUND) {
return false;
}
throw e;
}
return true;
}

/**
* Returns <code>true</code> if this backup is ready to use. The value returned by this method
* could be out-of-sync with the value returned by {@link #getState()}, as this method will make a
* round-trip to the server and return a value based on the response from the server.
*/
public boolean isReady() {
return reload().getState() == State.READY;
}

/**
* Fetches the backup's current information and returns a new {@link Backup} instance. It does not
* update this instance.
*/
public Backup reload() throws SpannerException {
return dbClient.getBackup(instance(), backup());
}

/** Deletes this backup on Cloud Spanner. */
public void delete() throws SpannerException {
dbClient.deleteBackup(instance(), backup());
}

/**
* Updates the expire time of this backup on Cloud Spanner. If this {@link Backup} does not have
* an expire time, the method will throw an {@link IllegalStateException}.
*/
public void updateExpireTime() {
Preconditions.checkState(getExpireTime() != null, "This backup has no expire time");
dbClient.updateBackup(instance(), backup(), getExpireTime());
}

/**
* Restores this backup to the specified database. The database must not already exist and will be
* created by this call. The database may be created in a different instance than where the backup
* is stored.
*/
public OperationFuture<Database, RestoreDatabaseMetadata> restore(DatabaseId database) {
Preconditions.checkNotNull(database);
return dbClient.restoreDatabase(
instance(), backup(), database.getInstanceId().getInstance(), database.getDatabase());
}

/** Returns all long-running backup operations for this {@link Backup}. */
public Page<Operation> listBackupOperations() {
return dbClient.listBackupOperations(
instance(), Options.filter(String.format(FILTER_BACKUP_OPERATIONS_TEMPLATE, backup())));
}

/** Returns the IAM {@link Policy} for this backup. */
public Policy getIAMPolicy() {
return dbClient.getBackupIAMPolicy(instance(), backup());
}

/**
* Updates the IAM policy for this backup and returns the resulting policy. It is highly
* recommended to first get the current policy and base the updated policy on the returned policy.
* See {@link Policy.Builder#setEtag(String)} for information on the recommended read-modify-write
* cycle.
*/
public Policy setIAMPolicy(Policy policy) {
return dbClient.setBackupIAMPolicy(instance(), backup(), policy);
}

/**
* Tests for the given permissions on this backup for the caller.
*
* @param permissions the permissions to test for. Permissions with wildcards (such as '*',
* 'spanner.*', 'spanner.instances.*') are not allowed.
* @return the subset of the tested permissions that the caller is allowed.
*/
public Iterable<String> testIAMPermissions(Iterable<String> permissions) {
return dbClient.testBackupIAMPermissions(instance(), backup(), permissions);
}

public Builder toBuilder() {
return new Builder(this);
}

private String instance() {
return getInstanceId().getInstance();
}

private String backup() {
return getId().getBackup();
}

private String sourceDatabase() {
return getDatabase().getDatabase();
}

static Backup fromProto(
com.google.spanner.admin.database.v1.Backup proto, DatabaseAdminClient client) {
checkArgument(!proto.getName().isEmpty(), "Missing expected 'name' field");
checkArgument(!proto.getDatabase().isEmpty(), "Missing expected 'database' field");
return new Backup.Builder(client, BackupId.of(proto.getName()))
.setState(fromProtoState(proto.getState()))
.setSize(proto.getSizeBytes())
.setExpireTime(Timestamp.fromProto(proto.getExpireTime()))
.setDatabase(DatabaseId.of(proto.getDatabase()))
.setProto(proto)
.build();
}

static BackupInfo.State fromProtoState(
com.google.spanner.admin.database.v1.Backup.State protoState) {
switch (protoState) {
case STATE_UNSPECIFIED:
return BackupInfo.State.UNSPECIFIED;
case CREATING:
return BackupInfo.State.CREATING;
case READY:
return BackupInfo.State.READY;
default:
throw new IllegalArgumentException("Unrecognized state " + protoState);
}
}
}

0 comments on commit ed3874a

Please sign in to comment.