Skip to content

Commit d9ba32b

Browse files
ron-galron-gal
authored
feat(bigtable): Add DeletionProtection support for Logical Views (#2539)
* feat(bigtable): Add DeletionProtection support for Logical Views * fix tests * fix build * fix test * enable tests
1 parent ea19c85 commit d9ba32b

File tree

7 files changed

+102
-20
lines changed

7 files changed

+102
-20
lines changed

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
* <pre>{@code
2929
* LogicalView existingLogicalView = ...;
3030
* CreateLogicalViewRequest logicalViewRequest = CreateLogicalViewRequest.of("my-instance", "my-new-logical-view")
31-
* .setQuery("...");
31+
* .setQuery("...").setDeletionProtection(true);
3232
* }</pre>
3333
*
3434
* @see LogicalView for more details
@@ -56,6 +56,13 @@ public CreateLogicalViewRequest setQuery(@Nonnull String query) {
5656
return this;
5757
}
5858

59+
/** Configures if the logical view is deletion protected. */
60+
@SuppressWarnings("WeakerAccess")
61+
public CreateLogicalViewRequest setDeletionProtection(boolean value) {
62+
proto.getLogicalViewBuilder().setDeletionProtection(value);
63+
return this;
64+
}
65+
5966
@Override
6067
public boolean equals(Object o) {
6168
if (this == o) {

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,11 @@ public String getQuery() {
7575
return proto.getQuery();
7676
}
7777

78+
/** Returns whether this logical view is deletion protected. */
79+
public boolean isDeletionProtected() {
80+
return proto.getDeletionProtection();
81+
}
82+
7883
/**
7984
* Creates the request protobuf. This method is considered an internal implementation detail and
8085
* not meant to be used by applications.

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,13 @@ public UpdateLogicalViewRequest setQuery(String query) {
8080
return this;
8181
}
8282

83+
/** Changes the deletion protection of an existing logical view. */
84+
public UpdateLogicalViewRequest setDeletionProtection(boolean deletionProtection) {
85+
requestBuilder.getLogicalViewBuilder().setDeletionProtection(deletionProtection);
86+
updateFieldMask(com.google.bigtable.admin.v2.LogicalView.DELETION_PROTECTION_FIELD_NUMBER);
87+
return this;
88+
}
89+
8390
private void updateFieldMask(int fieldNumber) {
8491
FieldMask newMask =
8592
FieldMaskUtil.fromFieldNumbers(com.google.bigtable.admin.v2.LogicalView.class, fieldNumber);

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

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import static com.google.common.truth.TruthJUnit.assume;
2121
import static org.junit.Assert.fail;
2222

23+
import com.google.api.gax.rpc.FailedPreconditionException;
2324
import com.google.api.gax.rpc.NotFoundException;
2425
import com.google.cloud.bigtable.admin.v2.BigtableInstanceAdminClient;
2526
import com.google.cloud.bigtable.admin.v2.BigtableTableAdminClient;
@@ -37,14 +38,12 @@
3738
import org.junit.Before;
3839
import org.junit.BeforeClass;
3940
import org.junit.ClassRule;
40-
import org.junit.Ignore;
4141
import org.junit.Rule;
4242
import org.junit.Test;
4343
import org.junit.runner.RunWith;
4444
import org.junit.runners.JUnit4;
4545

4646
@RunWith(JUnit4.class)
47-
@Ignore("Not fully working yet in production")
4847
public class BigtableLogicalViewIT {
4948
@ClassRule public static final TestEnvRule testEnvRule = new TestEnvRule();
5049
@Rule public final PrefixGenerator prefixGenerator = new PrefixGenerator();
@@ -77,12 +76,17 @@ public void createLogicalViewAndGetLogicalViewTest() {
7776
String logicalViewId = prefixGenerator.newPrefix();
7877

7978
CreateLogicalViewRequest request =
80-
CreateLogicalViewRequest.of(instanceId, logicalViewId).setQuery(getQuery());
79+
CreateLogicalViewRequest.of(instanceId, logicalViewId)
80+
.setQuery(getQuery())
81+
.setDeletionProtection(false);
8182
try {
8283
LogicalView response = client.createLogicalView(request);
8384
assertWithMessage("Got wrong logical view Id in CreateLogicalView")
8485
.that(response.getId())
8586
.isEqualTo(logicalViewId);
87+
assertWithMessage("Got wrong deletion protection in CreateLogicalView")
88+
.that(response.isDeletionProtected())
89+
.isFalse();
8690
assertWithMessage("Got wrong query in CreateLogicalView")
8791
.that(response.getQuery())
8892
.isEqualTo(getQuery());
@@ -91,6 +95,9 @@ public void createLogicalViewAndGetLogicalViewTest() {
9195
assertWithMessage("Got wrong logical view Id in getLogicalView")
9296
.that(response.getId())
9397
.isEqualTo(logicalViewId);
98+
assertWithMessage("Got wrong deletion protection in getLogicalView")
99+
.that(response.isDeletionProtected())
100+
.isFalse();
94101
assertWithMessage("Got wrong query in getLogicalView")
95102
.that(response.getQuery())
96103
.isEqualTo(getQuery());
@@ -119,15 +126,33 @@ public void listLogicalViewsTest() {
119126
public void updateLogicalViewAndDeleteLogicalViewTest() throws InterruptedException {
120127
String logicalViewId = prefixGenerator.newPrefix();
121128

122-
// Create a logical view.
123-
CreateLogicalViewRequest request = createLogicalViewRequest(logicalViewId);
129+
// Create a deletion-protected logical view.
130+
CreateLogicalViewRequest request =
131+
createLogicalViewRequest(logicalViewId).setDeletionProtection(true);
124132

125133
LogicalView response = client.createLogicalView(request);
134+
assertWithMessage("Got wrong deletion protection in CreateLogicalView")
135+
.that(response.isDeletionProtected())
136+
.isTrue();
137+
138+
// We should not be able to delete the logical view.
139+
try {
140+
client.deleteLogicalView(instanceId, logicalViewId);
141+
fail("A delete-protected logical view should not have been able to be deleted");
142+
} catch (FailedPreconditionException e) {
143+
assertWithMessage("Incorrect exception type")
144+
.that(e.getCause())
145+
.isInstanceOf(StatusRuntimeException.class);
146+
}
126147

127-
// Update the query of the logical view.
148+
// Update the deletion protection bit and query of the logical view.
128149
String query = "SELECT 1 AS value";
129-
UpdateLogicalViewRequest updateRequest = UpdateLogicalViewRequest.of(response).setQuery(query);
150+
UpdateLogicalViewRequest updateRequest =
151+
UpdateLogicalViewRequest.of(response).setQuery(query).setDeletionProtection(false);
130152
response = client.updateLogicalView(updateRequest);
153+
assertWithMessage("Got wrong deletion protection in UpdateLogicalView")
154+
.that(response.isDeletionProtected())
155+
.isFalse();
131156
assertWithMessage("Got wrong query in UpdateLogicalView")
132157
.that(response.getQuery())
133158
.isEqualTo(query);

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

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,44 +33,61 @@ public class CreateLogicalViewRequestTest {
3333
public void testToProto() {
3434
String query = "SELECT * FROM Table";
3535
CreateLogicalViewRequest request =
36-
CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery(query);
36+
CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
37+
.setQuery(query)
38+
.setDeletionProtection(true);
3739

3840
com.google.bigtable.admin.v2.CreateLogicalViewRequest requestProto =
3941
com.google.bigtable.admin.v2.CreateLogicalViewRequest.newBuilder()
4042
.setParent(NameUtil.formatInstanceName(PROJECT_ID, INSTANCE_ID))
4143
.setLogicalViewId(LOGICAL_VIEW_ID)
42-
.setLogicalView(com.google.bigtable.admin.v2.LogicalView.newBuilder().setQuery(query))
44+
.setLogicalView(
45+
com.google.bigtable.admin.v2.LogicalView.newBuilder()
46+
.setQuery(query)
47+
.setDeletionProtection(true))
4348
.build();
4449
assertThat(request.toProto(PROJECT_ID)).isEqualTo(requestProto);
4550
}
4651

4752
@Test
4853
public void testEquality() {
4954
CreateLogicalViewRequest request =
50-
CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("test 1");
55+
CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
56+
.setQuery("test 1")
57+
.setDeletionProtection(true);
5158

5259
assertThat(request)
53-
.isEqualTo(CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("test 1"));
60+
.isEqualTo(
61+
CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
62+
.setQuery("test 1")
63+
.setDeletionProtection(true));
5464

5565
assertThat(request)
56-
.isNotEqualTo(CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("test 2"));
66+
.isNotEqualTo(
67+
CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
68+
.setQuery("test 2")
69+
.setDeletionProtection(true));
5770
}
5871

5972
@Test
6073
public void testHashCode() {
6174
CreateLogicalViewRequest request =
62-
CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("test 1");
75+
CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
76+
.setQuery("test 1")
77+
.setDeletionProtection(true);
6378

6479
assertThat(request.hashCode())
6580
.isEqualTo(
6681
CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
6782
.setQuery("test 1")
83+
.setDeletionProtection(true)
6884
.hashCode());
6985

7086
assertThat(request.hashCode())
7187
.isNotEqualTo(
7288
CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
7389
.setQuery("test 2")
90+
.setDeletionProtection(true)
7491
.hashCode());
7592
}
7693
}

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,14 @@ public void testFromProto() {
3737
com.google.bigtable.admin.v2.LogicalView.newBuilder()
3838
.setName(logicalViewName.toString())
3939
.setQuery("SELECT 1 from Table")
40+
.setDeletionProtection(true)
4041
.build();
4142

4243
LogicalView result = LogicalView.fromProto(logicalViewProto);
4344

4445
assertThat(result.getId()).isEqualTo(LOGICAL_VIEW_ID);
4546
assertThat(result.getQuery()).isEqualTo("SELECT 1 from Table");
47+
assertThat(result.isDeletionProtected()).isEqualTo(true);
4648
}
4749

4850
@Test
@@ -70,6 +72,7 @@ public void testEquality() {
7072
com.google.bigtable.admin.v2.LogicalView.newBuilder()
7173
.setName(logicalViewName.toString())
7274
.setQuery("SELECT 1 FROM Table")
75+
.setDeletionProtection(true)
7376
.build();
7477
LogicalView logicalView = LogicalView.fromProto(proto);
7578

@@ -80,6 +83,7 @@ public void testEquality() {
8083
com.google.bigtable.admin.v2.LogicalView.newBuilder()
8184
.setName(logicalViewName.toString())
8285
.setQuery("SELECT 2 FROM Table")
86+
.setDeletionProtection(true)
8387
.build());
8488
}
8589

@@ -90,6 +94,7 @@ public void testHashCode() {
9094
com.google.bigtable.admin.v2.LogicalView.newBuilder()
9195
.setName(logicalViewName.toString())
9296
.setQuery("SELECT 1 FROM Table")
97+
.setDeletionProtection(true)
9398
.build();
9499
LogicalView logicalView = LogicalView.fromProto(proto);
95100

@@ -100,6 +105,7 @@ public void testHashCode() {
100105
com.google.bigtable.admin.v2.LogicalView.newBuilder()
101106
.setName(logicalViewName.toString())
102107
.setQuery("SELECT 2 FROM Table")
108+
.setDeletionProtection(true)
103109
.build()
104110
.hashCode());
105111
}

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

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,48 +33,63 @@ public class UpdateLogicalViewRequestTest {
3333
@Test
3434
public void testToProto() {
3535
UpdateLogicalViewRequest request =
36-
UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("query 1");
36+
UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
37+
.setQuery("query 1")
38+
.setDeletionProtection(true);
3739

3840
com.google.bigtable.admin.v2.UpdateLogicalViewRequest requestProto =
3941
com.google.bigtable.admin.v2.UpdateLogicalViewRequest.newBuilder()
4042
.setLogicalView(
4143
com.google.bigtable.admin.v2.LogicalView.newBuilder()
4244
.setQuery("query 1")
45+
.setDeletionProtection(true)
4346
.setName(
4447
NameUtil.formatLogicalViewName(PROJECT_ID, INSTANCE_ID, LOGICAL_VIEW_ID)))
45-
.setUpdateMask(FieldMask.newBuilder().addPaths("query").build())
48+
.setUpdateMask(
49+
FieldMask.newBuilder().addPaths("deletion_protection").addPaths("query").build())
4650
.build();
4751
assertThat(request.toProto(PROJECT_ID)).isEqualTo(requestProto);
4852
}
4953

5054
@Test
5155
public void testEquality() {
5256
UpdateLogicalViewRequest request =
53-
UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("query 1");
57+
UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
58+
.setQuery("query 1")
59+
.setDeletionProtection(true);
5460

5561
assertThat(request)
56-
.isEqualTo(UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("query 1"));
62+
.isEqualTo(
63+
UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
64+
.setQuery("query 1")
65+
.setDeletionProtection(true));
5766

5867
assertThat(request)
5968
.isNotEqualTo(
60-
UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("query 2"));
69+
UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
70+
.setQuery("query 2")
71+
.setDeletionProtection(true));
6172
}
6273

6374
@Test
6475
public void testHashCode() {
6576
UpdateLogicalViewRequest request =
66-
UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("query 1");
77+
UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
78+
.setQuery("query 1")
79+
.setDeletionProtection(true);
6780

6881
assertThat(request.hashCode())
6982
.isEqualTo(
7083
UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
7184
.setQuery("query 1")
85+
.setDeletionProtection(true)
7286
.hashCode());
7387

7488
assertThat(request.hashCode())
7589
.isNotEqualTo(
7690
UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
7791
.setQuery("query 2")
92+
.setDeletionProtection(true)
7893
.hashCode());
7994
}
8095
}

0 commit comments

Comments
 (0)