Skip to content

Commit 335977c

Browse files
TracyCuiCanTracy Cuigcf-owl-bot[bot]
authored
feat: implement cross-project table restore (#1536)
* feat: implement cross-project table restore * move test case around. * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Tracy Cui <[email protected]> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 7f7c478 commit 335977c

File tree

3 files changed

+139
-10
lines changed

3 files changed

+139
-10
lines changed

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/RestoreTableRequest.java

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,37 +29,57 @@ public final class RestoreTableRequest {
2929
private final String sourceBackupId;
3030
private final String sourceClusterId;
3131
private final String sourceInstanceId;
32+
private final String sourceProjectId;
3233

3334
/**
3435
* Create a {@link RestoreTableRequest} object. It assumes the source backup locates in the same
35-
* instance as the destination table. To restore a table from a backup in another instance, use
36-
* {@link #of(String, String, String) of} method.
36+
* instance and project as the destination table. To restore a table from a backup in another
37+
* instance, use {@link #of(String, String, String) of} method. To restore a table from a backup
38+
* in another project, use {@link #of(String, String, String, String) of} method.
3739
*/
3840
public static RestoreTableRequest of(String sourceClusterId, String sourceBackupId) {
39-
RestoreTableRequest request = new RestoreTableRequest(null, sourceClusterId, sourceBackupId);
41+
RestoreTableRequest request =
42+
new RestoreTableRequest(null, sourceClusterId, sourceBackupId, null);
4043
return request;
4144
}
4245

4346
/**
44-
* Create a {@link RestoreTableRequest} object. The source backup could locate in a the same or a
45-
* different instance.
47+
* Create a {@link RestoreTableRequest} object. The source backup could locate in the same or a
48+
* different instance but the same project as the destination table. To restore a table from a
49+
* backup in another project, use {@link #of(String, String, String, String) of} method.
4650
*/
4751
public static RestoreTableRequest of(
4852
String sourceInstanceId, String sourceClusterId, String sourceBackupId) {
4953
RestoreTableRequest request =
50-
new RestoreTableRequest(sourceInstanceId, sourceClusterId, sourceBackupId);
54+
new RestoreTableRequest(sourceInstanceId, sourceClusterId, sourceBackupId, null);
55+
return request;
56+
}
57+
58+
/**
59+
* Create a {@link RestoreTableRequest} object. The source backup could locate in the same or a
60+
* different instance and/or project.
61+
*/
62+
public static RestoreTableRequest of(
63+
String sourceInstanceId,
64+
String sourceClusterId,
65+
String sourceBackupId,
66+
String sourceProjectId) {
67+
RestoreTableRequest request =
68+
new RestoreTableRequest(sourceInstanceId, sourceClusterId, sourceBackupId, sourceProjectId);
5169
return request;
5270
}
5371

5472
private RestoreTableRequest(
5573
@Nullable String sourceInstanceId,
5674
@Nonnull String sourceClusterId,
57-
@Nonnull String sourceBackupId) {
75+
@Nonnull String sourceBackupId,
76+
@Nullable String sourceProjectId) {
5877
Preconditions.checkNotNull(sourceClusterId);
5978
Preconditions.checkNotNull(sourceBackupId);
6079
this.sourceBackupId = sourceBackupId;
6180
this.sourceInstanceId = sourceInstanceId;
6281
this.sourceClusterId = sourceClusterId;
82+
this.sourceProjectId = sourceProjectId;
6383
}
6484

6585
public RestoreTableRequest setTableId(String tableId) {
@@ -80,13 +100,18 @@ public boolean equals(Object o) {
80100
return Objects.equal(requestBuilder.getTableId(), that.requestBuilder.getTableId())
81101
&& Objects.equal(sourceInstanceId, that.sourceInstanceId)
82102
&& Objects.equal(sourceClusterId, that.sourceClusterId)
83-
&& Objects.equal(sourceBackupId, that.sourceBackupId);
103+
&& Objects.equal(sourceBackupId, that.sourceBackupId)
104+
&& Objects.equal(sourceProjectId, that.sourceProjectId);
84105
}
85106

86107
@Override
87108
public int hashCode() {
88109
return Objects.hashCode(
89-
requestBuilder.getTableId(), sourceInstanceId, sourceClusterId, sourceBackupId);
110+
requestBuilder.getTableId(),
111+
sourceInstanceId,
112+
sourceClusterId,
113+
sourceBackupId,
114+
sourceProjectId);
90115
}
91116

92117
@InternalApi
@@ -99,7 +124,7 @@ public com.google.bigtable.admin.v2.RestoreTableRequest toProto(
99124
.setParent(NameUtil.formatInstanceName(projectId, instanceId))
100125
.setBackup(
101126
NameUtil.formatBackupName(
102-
projectId,
127+
sourceProjectId == null ? projectId : sourceProjectId,
103128
sourceInstanceId == null ? instanceId : sourceInstanceId,
104129
sourceClusterId,
105130
sourceBackupId))

‎google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/BigtableTableAdminClientTests.java

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -613,6 +613,54 @@ public void testRestoreTable() throws ExecutionException, InterruptedException {
613613
assertThat(actualResult.getTable().getId()).isEqualTo(TABLE_ID);
614614
}
615615

616+
@Test
617+
public void testRestoreTableCrossProject() throws ExecutionException, InterruptedException {
618+
// Setup
619+
Mockito.when(mockStub.restoreTableOperationCallable())
620+
.thenReturn(mockRestoreTableOperationCallable);
621+
622+
Timestamp startTime = Timestamp.newBuilder().setSeconds(1234).build();
623+
Timestamp endTime = Timestamp.newBuilder().setSeconds(5678).build();
624+
String operationName = "my-operation";
625+
626+
// Use existing adminClient as destination project:
627+
String dstProjectId = PROJECT_ID;
628+
String dstInstanceId = INSTANCE_ID;
629+
String dstTableName = TABLE_NAME;
630+
631+
// Create RestoreTableRequest from different source project:
632+
String srcProjectId = "src-project";
633+
String srcInstanceId = "src-instance";
634+
String srcClusterId = "src-cluster";
635+
636+
RestoreTableRequest req =
637+
RestoreTableRequest.of(srcInstanceId, srcClusterId, BACKUP_ID, srcProjectId)
638+
.setTableId(TABLE_ID);
639+
mockOperationResult(
640+
mockRestoreTableOperationCallable,
641+
req.toProto(dstProjectId, dstInstanceId),
642+
com.google.bigtable.admin.v2.Table.newBuilder().setName(dstTableName).build(),
643+
RestoreTableMetadata.newBuilder()
644+
.setName(dstTableName)
645+
.setOptimizeTableOperationName(operationName)
646+
.setSourceType(RestoreSourceType.BACKUP)
647+
.setBackupInfo(
648+
BackupInfo.newBuilder()
649+
.setBackup(BACKUP_ID)
650+
.setSourceTable(NameUtil.formatTableName(srcProjectId, srcInstanceId, TABLE_ID))
651+
.setStartTime(startTime)
652+
.setEndTime(endTime)
653+
.build())
654+
.build());
655+
656+
// Execute
657+
RestoredTableResult actualResult = adminClient.restoreTable(req);
658+
659+
// Verify
660+
assertThat(actualResult.getTable().getId()).isEqualTo(TABLE_ID);
661+
assertThat(actualResult.getTable().getInstanceId()).isEqualTo(dstInstanceId);
662+
}
663+
616664
@Test
617665
public void testDeleteBackup() {
618666
// Setup

‎google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/models/RestoreTableRequestTest.java

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ public class RestoreTableRequestTest {
3131
private static final String INSTANCE_ID = "my-instance";
3232
private static final String CLUSTER_ID = "my-cluster";
3333
private static final String SOURCE_INSTANCE_ID = "source-instance-id";
34+
private static final String SOURCE_PROJECT_ID = "source-project-id";
3435

3536
@Test
3637
public void testToProto() {
@@ -61,6 +62,23 @@ public void testToProtoCrossInstance() {
6162
assertThat(request.toProto(PROJECT_ID, INSTANCE_ID)).isEqualTo(requestProto);
6263
}
6364

65+
@Test
66+
public void testToProtoCrossProject() {
67+
RestoreTableRequest request =
68+
RestoreTableRequest.of(SOURCE_INSTANCE_ID, CLUSTER_ID, BACKUP_ID, SOURCE_PROJECT_ID)
69+
.setTableId(TABLE_ID);
70+
71+
com.google.bigtable.admin.v2.RestoreTableRequest requestProto =
72+
com.google.bigtable.admin.v2.RestoreTableRequest.newBuilder()
73+
.setParent(NameUtil.formatInstanceName(PROJECT_ID, INSTANCE_ID))
74+
.setBackup(
75+
NameUtil.formatBackupName(
76+
SOURCE_PROJECT_ID, SOURCE_INSTANCE_ID, CLUSTER_ID, BACKUP_ID))
77+
.setTableId(TABLE_ID)
78+
.build();
79+
assertThat(request.toProto(PROJECT_ID, INSTANCE_ID)).isEqualTo(requestProto);
80+
}
81+
6482
@Test
6583
public void testEquality() {
6684
RestoreTableRequest request =
@@ -88,6 +106,24 @@ public void testEqualityCrossInstance() {
88106
.setTableId("another-table"));
89107
}
90108

109+
@Test
110+
public void testEqualityCrossProject() {
111+
RestoreTableRequest request =
112+
RestoreTableRequest.of(SOURCE_INSTANCE_ID, CLUSTER_ID, BACKUP_ID, SOURCE_PROJECT_ID)
113+
.setTableId(TABLE_ID);
114+
115+
assertThat(request)
116+
.isEqualTo(
117+
RestoreTableRequest.of(SOURCE_INSTANCE_ID, CLUSTER_ID, BACKUP_ID, SOURCE_PROJECT_ID)
118+
.setTableId(TABLE_ID));
119+
assertThat(request)
120+
.isNotEqualTo(RestoreTableRequest.of(CLUSTER_ID, BACKUP_ID).setTableId(TABLE_ID));
121+
assertThat(request)
122+
.isNotEqualTo(
123+
RestoreTableRequest.of(SOURCE_INSTANCE_ID, CLUSTER_ID, BACKUP_ID, SOURCE_PROJECT_ID)
124+
.setTableId("another-table"));
125+
}
126+
91127
@Test
92128
public void testHashCode() {
93129
RestoreTableRequest request =
@@ -117,4 +153,24 @@ public void testHashCodeCrossInstance() {
117153
.setTableId("another-table")
118154
.hashCode());
119155
}
156+
157+
@Test
158+
public void testHashCodeCrossProject() {
159+
RestoreTableRequest request =
160+
RestoreTableRequest.of(SOURCE_INSTANCE_ID, CLUSTER_ID, BACKUP_ID, SOURCE_PROJECT_ID)
161+
.setTableId(TABLE_ID);
162+
assertThat(request.hashCode())
163+
.isEqualTo(
164+
RestoreTableRequest.of(SOURCE_INSTANCE_ID, CLUSTER_ID, BACKUP_ID, SOURCE_PROJECT_ID)
165+
.setTableId(TABLE_ID)
166+
.hashCode());
167+
assertThat(request.hashCode())
168+
.isNotEqualTo(
169+
RestoreTableRequest.of(CLUSTER_ID, BACKUP_ID).setTableId(TABLE_ID).hashCode());
170+
assertThat(request.hashCode())
171+
.isNotEqualTo(
172+
RestoreTableRequest.of(SOURCE_INSTANCE_ID, CLUSTER_ID, BACKUP_ID, SOURCE_PROJECT_ID)
173+
.setTableId("another-table")
174+
.hashCode());
175+
}
120176
}

0 commit comments

Comments
 (0)