Skip to content

test: moves PITR backup tests #956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thiagotnunes merged 3 commits into from
Mar 15, 2021
Merged

test: moves PITR backup tests #956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a37c00c
test: moves PITR backup tests
thiagotnunes Mar 15, 2021
e30a333
test: fixes tests
thiagotnunes Mar 15, 2021
a038b11
test: addresses PR comments
thiagotnunes Mar 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
175 changes: 121 additions & 54 deletions google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITBackupTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,15 @@
import com.google.cloud.spanner.ErrorCode;
import com.google.cloud.spanner.Instance;
import com.google.cloud.spanner.InstanceAdminClient;
import com.google.cloud.spanner.InstanceId;
import com.google.cloud.spanner.IntegrationTestEnv;
import com.google.cloud.spanner.Mutation;
import com.google.cloud.spanner.Options;
import com.google.cloud.spanner.ParallelIntegrationTest;
import com.google.cloud.spanner.ResultSet;
import com.google.cloud.spanner.SpannerException;
import com.google.cloud.spanner.SpannerExceptionFactory;
import com.google.cloud.spanner.Statement;
import com.google.cloud.spanner.testing.RemoteSpannerHelper;
import com.google.common.base.Predicate;
import com.google.common.base.Stopwatch;
Expand Down Expand Up @@ -92,6 +95,8 @@ public class ITBackupTest {
private List<String> databases = new ArrayList<>();
private List<String> backups = new ArrayList<>();
private final Random random = new Random();
private String projectId;
private String instanceId;

@BeforeClass
public static void doNotRunOnEmulator() {
Expand All @@ -105,6 +110,8 @@ public void setUp() {
dbAdminClient = testHelper.getClient().getDatabaseAdminClient();
instanceAdminClient = testHelper.getClient().getInstanceAdminClient();
instance = instanceAdminClient.getInstance(testHelper.getInstanceId().getInstance());
projectId = testHelper.getInstanceId().getProject();
instanceId = testHelper.getInstanceId().getInstance();
logger.info("Finished setup");

// Cancel any backup operation that has been started by this integration test if it has been
Expand Down Expand Up @@ -226,19 +233,25 @@ public void testBackups() throws InterruptedException, ExecutionException {
String backupId1 = testHelper.getUniqueBackupId() + "_bck1";
String backupId2 = testHelper.getUniqueBackupId() + "_bck2";
Timestamp expireTime = afterDays(7);
Timestamp versionTime = getCurrentTimestamp(client);
logger.info(String.format("Creating backups %s and %s in parallel", backupId1, backupId2));
OperationFuture<Backup, CreateBackupMetadata> op1 =
dbAdminClient.createBackup(
testHelper.getInstanceId().getInstance(),
backupId1,
db1.getId().getDatabase(),
expireTime);
OperationFuture<Backup, CreateBackupMetadata> op2 =
dbAdminClient.createBackup(
testHelper.getInstanceId().getInstance(),
backupId2,
db2.getId().getDatabase(),
expireTime);
// This backup has the version time specified as the server's current timestamp
final Backup backupToCreate1 =
dbAdminClient
.newBackupBuilder(BackupId.of(projectId, instanceId, backupId1))
.setDatabase(db1.getId())
.setExpireTime(expireTime)
.setVersionTime(versionTime)
.build();
// This backup has no version time specified
final Backup backupToCreate2 =
dbAdminClient
.newBackupBuilder(BackupId.of(projectId, instanceId, backupId2))
.setDatabase(db2.getId())
.setExpireTime(expireTime)
.build();
OperationFuture<Backup, CreateBackupMetadata> op1 = dbAdminClient.createBackup(backupToCreate1);
OperationFuture<Backup, CreateBackupMetadata> op2 = dbAdminClient.createBackup(backupToCreate2);
backups.add(backupId1);
backups.add(backupId2);

Expand Down Expand Up @@ -274,9 +287,13 @@ public void testBackups() throws InterruptedException, ExecutionException {
"Backup2 still not finished. Test is giving up waiting for it.");
}
logger.info("Long-running operations finished. Getting backups by id.");
backup1 = dbAdminClient.getBackup(instance.getId().getInstance(), backupId1);
backup2 = dbAdminClient.getBackup(instance.getId().getInstance(), backupId2);
backup1 = dbAdminClient.getBackup(this.instance.getId().getInstance(), backupId1);
backup2 = dbAdminClient.getBackup(this.instance.getId().getInstance(), backupId2);
}

// Verifies that backup version time is the specified one
testBackupVersionTime(backup1, versionTime);

// Insert some more data into db2 to get a timestamp from the server.
Timestamp commitTs =
client.writeAtLeastOnce(
Expand All @@ -291,54 +308,40 @@ public void testBackups() throws InterruptedException, ExecutionException {
// Test listing operations.
// List all backups.
logger.info("Listing all backups");
assertThat(instance.listBackups().iterateAll()).containsAtLeast(backup1, backup2);
assertThat(this.instance.listBackups().iterateAll()).containsAtLeast(backup1, backup2);
// List all backups whose names contain 'bck1'.
logger.info("Listing backups with name bck1");
assertThat(
dbAdminClient
.listBackups(
testHelper.getInstanceId().getInstance(),
Options.filter(String.format("name:%s", backup1.getId().getName())))
instanceId, Options.filter(String.format("name:%s", backup1.getId().getName())))
.iterateAll())
.containsExactly(backup1);
logger.info("Listing ready backups");
Iterable<Backup> readyBackups =
dbAdminClient
.listBackups(testHelper.getInstanceId().getInstance(), Options.filter("state:READY"))
.iterateAll();
dbAdminClient.listBackups(instanceId, Options.filter("state:READY")).iterateAll();
assertThat(readyBackups).containsAtLeast(backup1, backup2);
// List all backups for databases whose names contain 'db1'.
logger.info("Listing backups for database db1");
assertThat(
dbAdminClient
.listBackups(
testHelper.getInstanceId().getInstance(),
Options.filter(String.format("database:%s", db1.getId().getName())))
instanceId, Options.filter(String.format("database:%s", db1.getId().getName())))
.iterateAll())
.containsExactly(backup1);
// List all backups that were created before a certain time.
Timestamp ts = Timestamp.ofTimeSecondsAndNanos(commitTs.getSeconds(), 0);
logger.info(String.format("Listing backups created before %s", ts));
assertThat(
dbAdminClient
.listBackups(
testHelper.getInstanceId().getInstance(),
Options.filter(String.format("create_time<\"%s\"", ts)))
.listBackups(instanceId, Options.filter(String.format("create_time<\"%s\"", ts)))
.iterateAll())
.containsAtLeast(backup1, backup2);
// List all backups with a size > 0.
logger.info("Listing backups with size>0");
assertThat(
dbAdminClient
.listBackups(
testHelper.getInstanceId().getInstance(), Options.filter("size_bytes>0"))
.iterateAll())
assertThat(dbAdminClient.listBackups(instanceId, Options.filter("size_bytes>0")).iterateAll())
.contains(backup2);
assertThat(
dbAdminClient
.listBackups(
testHelper.getInstanceId().getInstance(), Options.filter("size_bytes>0"))
.iterateAll())
assertThat(dbAdminClient.listBackups(instanceId, Options.filter("size_bytes>0")).iterateAll())
.doesNotContain(backup1);

// Test pagination.
Expand All @@ -349,14 +352,79 @@ public void testBackups() throws InterruptedException, ExecutionException {
testGetBackup(db2, backupId2, expireTime);
testUpdateBackup(backup1);
testCreateInvalidExpirationDate(db1);
testRestore(backup1, op1);
testRestore(backup1, op1, versionTime);

testDelete(backupId2);
testCancelBackupOperation(db1);
// Finished all tests.
logger.info("Finished all backup tests");
}

@Test(expected = SpannerException.class)
public void backupCreationWithVersionTimeTooFarInThePastFails() throws Exception {
final Database testDatabase = testHelper.createTestDatabase();
final DatabaseId databaseId = testDatabase.getId();
final InstanceId instanceId = databaseId.getInstanceId();
final String backupId = testHelper.getUniqueBackupId();
final Timestamp expireTime = afterDays(7);
final Timestamp versionTime = daysAgo(30);
final Backup backupToCreate =
dbAdminClient
.newBackupBuilder(BackupId.of(instanceId, backupId))
.setDatabase(databaseId)
.setExpireTime(expireTime)
.setVersionTime(versionTime)
.build();

getOrThrow(dbAdminClient.createBackup(backupToCreate));
}

@Test(expected = SpannerException.class)
public void backupCreationWithVersionTimeInTheFutureFails() throws Exception {
final Database testDatabase = testHelper.createTestDatabase();
final DatabaseId databaseId = testDatabase.getId();
final InstanceId instanceId = databaseId.getInstanceId();
final String backupId = testHelper.getUniqueBackupId();
final Timestamp expireTime = afterDays(7);
final Timestamp versionTime = afterDays(1);
final Backup backupToCreate =
dbAdminClient
.newBackupBuilder(BackupId.of(instanceId, backupId))
.setDatabase(databaseId)
.setExpireTime(expireTime)
.setVersionTime(versionTime)
.build();

getOrThrow(dbAdminClient.createBackup(backupToCreate));
}

private <T> T getOrThrow(OperationFuture<T, ?> operation)
throws InterruptedException, ExecutionException {
try {
return operation.get();
} catch (ExecutionException e) {
if (e.getCause() instanceof SpannerException) {
throw (SpannerException) e.getCause();
} else {
throw e;
}
}
}

private Timestamp getCurrentTimestamp(DatabaseClient client) {
try (ResultSet resultSet =
client.singleUse().executeQuery(Statement.of("SELECT CURRENT_TIMESTAMP()"))) {
resultSet.next();
return resultSet.getTimestamp(0);
}
}

private void testBackupVersionTime(Backup backup, Timestamp versionTime) {
logger.info("Verifying backup version time for " + backup.getId());
assertThat(backup.getVersionTime()).isEqualTo(versionTime);
logger.info("Done verifying backup version time for " + backup.getId());
}

private void testMetadata(
OperationFuture<Backup, CreateBackupMetadata> op1,
OperationFuture<Backup, CreateBackupMetadata> op2,
Expand Down Expand Up @@ -391,11 +459,7 @@ private void testCreateInvalidExpirationDate(Database db) throws InterruptedExce
String backupId = testHelper.getUniqueBackupId();
logger.info(String.format("Creating backup %s with invalid expiration date", backupId));
OperationFuture<Backup, CreateBackupMetadata> op =
dbAdminClient.createBackup(
testHelper.getInstanceId().getInstance(),
backupId,
db.getId().getDatabase(),
expireTime);
dbAdminClient.createBackup(instanceId, backupId, db.getId().getDatabase(), expireTime);
backups.add(backupId);
try {
op.get();
Expand All @@ -414,11 +478,7 @@ private void testCancelBackupOperation(Database db)
String backupId = testHelper.getUniqueBackupId();
logger.info(String.format("Starting to create backup %s", backupId));
OperationFuture<Backup, CreateBackupMetadata> op =
dbAdminClient.createBackup(
testHelper.getInstanceId().getInstance(),
backupId,
db.getId().getDatabase(),
expireTime);
dbAdminClient.createBackup(instanceId, backupId, db.getId().getDatabase(), expireTime);
backups.add(backupId);
// Cancel the backup operation.
logger.info(String.format("Cancelling the creation of backup %s", backupId));
Expand All @@ -428,8 +488,7 @@ private void testCancelBackupOperation(Database db)
for (Operation operation :
dbAdminClient
.listBackupOperations(
testHelper.getInstanceId().getInstance(),
Options.filter(String.format("name:%s", op.getName())))
instanceId, Options.filter(String.format("name:%s", op.getName())))
.iterateAll()) {
assertThat(operation.getError().getCode()).isEqualTo(Status.Code.CANCELLED.value());
operationFound = true;
Expand Down Expand Up @@ -481,18 +540,15 @@ private void testPagination(int expectedMinimumTotalBackups) {
logger.info("Listing backups using pagination");
int numBackups = 0;
logger.info("Fetching first page");
Page<Backup> page =
dbAdminClient.listBackups(testHelper.getInstanceId().getInstance(), Options.pageSize(1));
Page<Backup> page = dbAdminClient.listBackups(instanceId, Options.pageSize(1));
assertThat(page.getValues()).hasSize(1);
numBackups++;
assertThat(page.hasNextPage()).isTrue();
while (page.hasNextPage()) {
logger.info(String.format("Fetching page %d", numBackups + 1));
page =
dbAdminClient.listBackups(
testHelper.getInstanceId().getInstance(),
Options.pageToken(page.getNextPageToken()),
Options.pageSize(1));
instanceId, Options.pageToken(page.getNextPageToken()), Options.pageSize(1));
assertThat(page.getValues()).hasSize(1);
numBackups++;
}
Expand Down Expand Up @@ -521,7 +577,8 @@ private void testDelete(String backupId) throws InterruptedException {
logger.info("Finished delete tests");
}

private void testRestore(Backup backup, OperationFuture<Backup, CreateBackupMetadata> backupOp)
private void testRestore(
Backup backup, OperationFuture<Backup, CreateBackupMetadata> backupOp, Timestamp versionTime)
throws InterruptedException, ExecutionException {
// Restore the backup to a new database.
String restoredDb = testHelper.getUniqueDatabaseId();
Expand Down Expand Up @@ -565,6 +622,8 @@ private void testRestore(Backup backup, OperationFuture<Backup, CreateBackupMeta
assertThat(metadata.getSourceType()).isEqualTo(RestoreSourceType.BACKUP);
assertThat(metadata.getName())
.isEqualTo(DatabaseId.of(testHelper.getInstanceId(), restoredDb).getName());
assertThat(Timestamp.fromProto(metadata.getBackupInfo().getVersionTime()))
.isEqualTo(versionTime);

// Ensure the operations show up in the right collections.
// TODO: Re-enable when it is clear why this fails on the CI environment.
Expand All @@ -573,6 +632,14 @@ private void testRestore(Backup backup, OperationFuture<Backup, CreateBackupMeta
// Wait until the restore operation has finished successfully.
Database database = restoreOp.get();
assertThat(database.getId().getDatabase()).isEqualTo(restoredDb);

// Reloads the database
final Database reloadedDatabase = database.reload();
assertThat(
Timestamp.fromProto(
reloadedDatabase.getProto().getRestoreInfo().getBackupInfo().getVersionTime()))
.isEqualTo(versionTime);

// Restoring the backup to an existing database should fail.
try {
logger.info(
Expand Down
Loading