test: Deleting stale encrypted instances (#1986)

test: Deleting encrypted instances that were created to run the tests but not deleted due to system interrupts or timeout Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Rajat Bhatta <93644539+rajatbhatta@users.noreply.github.com>

Author: 3 people

samples/snippets/src/test/java/com/example/spanner/SpannerSampleIT.java

@@ -26,10 +26,12 @@
 import com.google.cloud.spanner.DatabaseAdminClient;
 import com.google.cloud.spanner.DatabaseId;
 import com.google.cloud.spanner.ErrorCode;
+import com.google.cloud.spanner.Instance;
 import com.google.cloud.spanner.InstanceAdminClient;
 import com.google.cloud.spanner.InstanceConfigId;
 import com.google.cloud.spanner.InstanceId;
 import com.google.cloud.spanner.InstanceInfo;
+import com.google.cloud.spanner.Options;
 import com.google.cloud.spanner.Spanner;
 import com.google.cloud.spanner.SpannerException;
 import com.google.cloud.spanner.SpannerExceptionFactory;
@@ -68,6 +70,8 @@ public class SpannerSampleIT {
  private static final String encryptedDatabaseId = formatForTest(baseDbId);
  private static final String encryptedBackupId = formatForTest(baseDbId);
  private static final String encryptedRestoreId = formatForTest(baseDbId);
+ private static final long STALE_INSTANCE_THRESHOLD_SECS =
+ TimeUnit.SECONDS.convert(24L, TimeUnit.HOURS);
  static Spanner spanner;
  static DatabaseId dbId;
  static DatabaseAdminClient dbClient;
@@ -93,10 +97,41 @@ public static void setUp() throws Exception {
  dbId = DatabaseId.of(options.getProjectId(), instanceId, databaseId);
  // Delete stale test databases that have been created earlier by this test, but not deleted.
  deleteStaleTestDatabases(instanceId, baseDbId);
- key = String.format("projects/%s/locations/%s/keyRings/%s/cryptoKeys/%s",
- options.getProjectId(), keyLocation, keyRing, keyName);
+ key =
+ String.format(
+ "projects/%s/locations/%s/keyRings/%s/cryptoKeys/%s",
+ options.getProjectId(), keyLocation, keyRing, keyName);
+
+ /*
+ * Delete stale instances that have been created earlier by this test but not deleted.
+ * Backups needed to be deleted from the instance first, as the instance can only be
+ * deleted once all backups have been deleted.
+ * */
+ deleteStaleEncryptedTestInstances();
  }
- 
+
+ /**
+ * Deleting all the test instances with name starting with 'encrypted-test-' and were created
+ * before 24 hours.
+ *
+ * @throws InterruptedException If Thread.sleep() interrupted
+ */
+ private static void deleteStaleEncryptedTestInstances() throws InterruptedException {
+ Timestamp now = Timestamp.now();
+
+ for (Instance instance :
+ spanner
+ .getInstanceAdminClient()
+ .listInstances(Options.filter("name:encrypted-test-"))
+ .iterateAll()) {
+ if ((now.getSeconds() - instance.getCreateTime().getSeconds())
+ > STALE_INSTANCE_THRESHOLD_SECS) {
+ deleteAllBackups(instanceId);
+ instance.delete();
+ }
+ }
+ }
+
  static void deleteStaleTestDatabases(String instanceId, String baseDbId) {
  Timestamp now = Timestamp.now();
  Pattern samplePattern = getTestDbIdPattern(baseDbId);
@@ -410,7 +445,7 @@ public void testSample() throws Exception {
  out = runSample("deletebackup");
  assertThat(out).contains("Deleted backup [" + backupId + "]");
  }
- 
+
  @Test
  public void testEncryptedDatabaseAndBackupSamples() throws Exception {
  String projectId = spanner.getOptions().getProjectId();
@@ -459,7 +494,7 @@ public void testEncryptedDatabaseAndBackupSamples() throws Exception {
  }
  }
 
- private void deleteAllBackups(String instanceId) throws InterruptedException {
+ private static void deleteAllBackups(String instanceId) throws InterruptedException {
  for (Backup backup : dbClient.listBackups(instanceId).iterateAll()) {
  int attempts = 0;
  while (attempts < 30) {
@@ -513,7 +548,7 @@ public void testCreateInstanceSample() {
  private static int countOccurrences(String input, String search) {
  return input.split(search).length - 1;
  }
- 
+
  private static String toComparableId(String baseId, String existingId) {
  String zeroUuid = "00000000-0000-0000-0000-0000-00000000";
  int shouldBeLength = (baseId + "-" + zeroUuid).length();
@@ -526,7 +561,7 @@ private static Pattern getTestDbIdPattern(String baseDbId) {
  baseDbId + "-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{8}",
  Pattern.CASE_INSENSITIVE);
  }
- 
+
  static String formatForTest(String name) {
  return name + "-" + UUID.randomUUID().toString().substring(0, DBID_LENGTH);
  }