feat(bigtable): Add DeletionProtection support for Logical Views (#2539)

ron-gal · web-flow · commit d9ba32b8e579 · 2025-05-12T13:58:35.000-04:00
* feat(bigtable): Add DeletionProtection support for Logical Views

* fix tests

* fix build

* fix test

* enable tests
diff --git a/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/CreateLogicalViewRequest.java b/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/CreateLogicalViewRequest.java
@@ -28,7 +28,7 @@
  * <pre>{@code
  * LogicalView existingLogicalView = ...;
  * CreateLogicalViewRequest logicalViewRequest = CreateLogicalViewRequest.of("my-instance", "my-new-logical-view")
- *   .setQuery("...");
+ *   .setQuery("...").setDeletionProtection(true);
  * }</pre>
  *
  * @see LogicalView for more details
@@ -56,6 +56,13 @@ public CreateLogicalViewRequest setQuery(@Nonnull String query) {
     return this;
   }
 
+  /** Configures if the logical view is deletion protected. */
+  @SuppressWarnings("WeakerAccess")
+  public CreateLogicalViewRequest setDeletionProtection(boolean value) {
+    proto.getLogicalViewBuilder().setDeletionProtection(value);
+    return this;
+  }
+
   @Override
   public boolean equals(Object o) {
     if (this == o) {
diff --git a/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/LogicalView.java b/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/LogicalView.java
@@ -75,6 +75,11 @@ public String getQuery() {
     return proto.getQuery();
   }
 
+  /** Returns whether this logical view is deletion protected. */
+  public boolean isDeletionProtected() {
+    return proto.getDeletionProtection();
+  }
+
   /**
    * Creates the request protobuf. This method is considered an internal implementation detail and
    * not meant to be used by applications.
diff --git a/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/UpdateLogicalViewRequest.java b/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/UpdateLogicalViewRequest.java
@@ -80,6 +80,13 @@ public UpdateLogicalViewRequest setQuery(String query) {
     return this;
   }
 
+  /** Changes the deletion protection of an existing logical view. */
+  public UpdateLogicalViewRequest setDeletionProtection(boolean deletionProtection) {
+    requestBuilder.getLogicalViewBuilder().setDeletionProtection(deletionProtection);
+    updateFieldMask(com.google.bigtable.admin.v2.LogicalView.DELETION_PROTECTION_FIELD_NUMBER);
+    return this;
+  }
+
   private void updateFieldMask(int fieldNumber) {
     FieldMask newMask =
         FieldMaskUtil.fromFieldNumbers(com.google.bigtable.admin.v2.LogicalView.class, fieldNumber);
diff --git a/google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/it/BigtableLogicalViewIT.java b/google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/it/BigtableLogicalViewIT.java
@@ -20,6 +20,7 @@
 import static com.google.common.truth.TruthJUnit.assume;
 import static org.junit.Assert.fail;
 
+import com.google.api.gax.rpc.FailedPreconditionException;
 import com.google.api.gax.rpc.NotFoundException;
 import com.google.cloud.bigtable.admin.v2.BigtableInstanceAdminClient;
 import com.google.cloud.bigtable.admin.v2.BigtableTableAdminClient;
@@ -37,14 +38,12 @@
 import org.junit.Before;
 import org.junit.BeforeClass;
 import org.junit.ClassRule;
-import org.junit.Ignore;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
 
 @RunWith(JUnit4.class)
-@Ignore("Not fully working yet in production")
 public class BigtableLogicalViewIT {
   @ClassRule public static final TestEnvRule testEnvRule = new TestEnvRule();
   @Rule public final PrefixGenerator prefixGenerator = new PrefixGenerator();
@@ -77,12 +76,17 @@ public void createLogicalViewAndGetLogicalViewTest() {
     String logicalViewId = prefixGenerator.newPrefix();
 
     CreateLogicalViewRequest request =
-        CreateLogicalViewRequest.of(instanceId, logicalViewId).setQuery(getQuery());
+        CreateLogicalViewRequest.of(instanceId, logicalViewId)
+            .setQuery(getQuery())
+            .setDeletionProtection(false);
     try {
       LogicalView response = client.createLogicalView(request);
       assertWithMessage("Got wrong logical view Id in CreateLogicalView")
           .that(response.getId())
           .isEqualTo(logicalViewId);
+      assertWithMessage("Got wrong deletion protection in CreateLogicalView")
+          .that(response.isDeletionProtected())
+          .isFalse();
       assertWithMessage("Got wrong query in CreateLogicalView")
           .that(response.getQuery())
           .isEqualTo(getQuery());
@@ -91,6 +95,9 @@ public void createLogicalViewAndGetLogicalViewTest() {
       assertWithMessage("Got wrong logical view Id in getLogicalView")
           .that(response.getId())
           .isEqualTo(logicalViewId);
+      assertWithMessage("Got wrong deletion protection in getLogicalView")
+          .that(response.isDeletionProtected())
+          .isFalse();
       assertWithMessage("Got wrong query in getLogicalView")
           .that(response.getQuery())
           .isEqualTo(getQuery());
@@ -119,15 +126,33 @@ public void listLogicalViewsTest() {
   public void updateLogicalViewAndDeleteLogicalViewTest() throws InterruptedException {
     String logicalViewId = prefixGenerator.newPrefix();
 
-    // Create a logical view.
-    CreateLogicalViewRequest request = createLogicalViewRequest(logicalViewId);
+    // Create a deletion-protected logical view.
+    CreateLogicalViewRequest request =
+        createLogicalViewRequest(logicalViewId).setDeletionProtection(true);
 
     LogicalView response = client.createLogicalView(request);
+    assertWithMessage("Got wrong deletion protection in CreateLogicalView")
+        .that(response.isDeletionProtected())
+        .isTrue();
+
+    // We should not be able to delete the logical view.
+    try {
+      client.deleteLogicalView(instanceId, logicalViewId);
+      fail("A delete-protected logical view should not have been able to be deleted");
+    } catch (FailedPreconditionException e) {
+      assertWithMessage("Incorrect exception type")
+          .that(e.getCause())
+          .isInstanceOf(StatusRuntimeException.class);
+    }
 
-    // Update the query of the logical view.
+    // Update the deletion protection bit and query of the logical view.
     String query = "SELECT 1 AS value";
-    UpdateLogicalViewRequest updateRequest = UpdateLogicalViewRequest.of(response).setQuery(query);
+    UpdateLogicalViewRequest updateRequest =
+        UpdateLogicalViewRequest.of(response).setQuery(query).setDeletionProtection(false);
     response = client.updateLogicalView(updateRequest);
+    assertWithMessage("Got wrong deletion protection in UpdateLogicalView")
+        .that(response.isDeletionProtected())
+        .isFalse();
     assertWithMessage("Got wrong query in UpdateLogicalView")
         .that(response.getQuery())
         .isEqualTo(query);
diff --git a/google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/models/CreateLogicalViewRequestTest.java b/google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/models/CreateLogicalViewRequestTest.java
@@ -33,44 +33,61 @@ public class CreateLogicalViewRequestTest {
   public void testToProto() {
     String query = "SELECT * FROM Table";
     CreateLogicalViewRequest request =
-        CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery(query);
+        CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
+            .setQuery(query)
+            .setDeletionProtection(true);
 
     com.google.bigtable.admin.v2.CreateLogicalViewRequest requestProto =
         com.google.bigtable.admin.v2.CreateLogicalViewRequest.newBuilder()
             .setParent(NameUtil.formatInstanceName(PROJECT_ID, INSTANCE_ID))
             .setLogicalViewId(LOGICAL_VIEW_ID)
-            .setLogicalView(com.google.bigtable.admin.v2.LogicalView.newBuilder().setQuery(query))
+            .setLogicalView(
+                com.google.bigtable.admin.v2.LogicalView.newBuilder()
+                    .setQuery(query)
+                    .setDeletionProtection(true))
             .build();
     assertThat(request.toProto(PROJECT_ID)).isEqualTo(requestProto);
   }
 
   @Test
   public void testEquality() {
     CreateLogicalViewRequest request =
-        CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("test 1");
+        CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
+            .setQuery("test 1")
+            .setDeletionProtection(true);
 
     assertThat(request)
-        .isEqualTo(CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("test 1"));
+        .isEqualTo(
+            CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
+                .setQuery("test 1")
+                .setDeletionProtection(true));
 
     assertThat(request)
-        .isNotEqualTo(CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("test 2"));
+        .isNotEqualTo(
+            CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
+                .setQuery("test 2")
+                .setDeletionProtection(true));
   }
 
   @Test
   public void testHashCode() {
     CreateLogicalViewRequest request =
-        CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("test 1");
+        CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
+            .setQuery("test 1")
+            .setDeletionProtection(true);
 
     assertThat(request.hashCode())
         .isEqualTo(
             CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
                 .setQuery("test 1")
+                .setDeletionProtection(true)
                 .hashCode());
 
     assertThat(request.hashCode())
         .isNotEqualTo(
             CreateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
                 .setQuery("test 2")
+                .setDeletionProtection(true)
                 .hashCode());
   }
 }
diff --git a/google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/models/LogicalViewTest.java b/google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/models/LogicalViewTest.java
@@ -37,12 +37,14 @@ public void testFromProto() {
         com.google.bigtable.admin.v2.LogicalView.newBuilder()
             .setName(logicalViewName.toString())
             .setQuery("SELECT 1 from Table")
+            .setDeletionProtection(true)
             .build();
 
     LogicalView result = LogicalView.fromProto(logicalViewProto);
 
     assertThat(result.getId()).isEqualTo(LOGICAL_VIEW_ID);
     assertThat(result.getQuery()).isEqualTo("SELECT 1 from Table");
+    assertThat(result.isDeletionProtected()).isEqualTo(true);
   }
 
   @Test
@@ -70,6 +72,7 @@ public void testEquality() {
         com.google.bigtable.admin.v2.LogicalView.newBuilder()
             .setName(logicalViewName.toString())
             .setQuery("SELECT 1 FROM Table")
+            .setDeletionProtection(true)
             .build();
     LogicalView logicalView = LogicalView.fromProto(proto);
 
@@ -80,6 +83,7 @@ public void testEquality() {
             com.google.bigtable.admin.v2.LogicalView.newBuilder()
                 .setName(logicalViewName.toString())
                 .setQuery("SELECT 2 FROM Table")
+                .setDeletionProtection(true)
                 .build());
   }
 
@@ -90,6 +94,7 @@ public void testHashCode() {
         com.google.bigtable.admin.v2.LogicalView.newBuilder()
             .setName(logicalViewName.toString())
             .setQuery("SELECT 1 FROM Table")
+            .setDeletionProtection(true)
             .build();
     LogicalView logicalView = LogicalView.fromProto(proto);
 
@@ -100,6 +105,7 @@ public void testHashCode() {
             com.google.bigtable.admin.v2.LogicalView.newBuilder()
                 .setName(logicalViewName.toString())
                 .setQuery("SELECT 2 FROM Table")
+                .setDeletionProtection(true)
                 .build()
                 .hashCode());
   }
diff --git a/google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/models/UpdateLogicalViewRequestTest.java b/google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/models/UpdateLogicalViewRequestTest.java
@@ -33,48 +33,63 @@ public class UpdateLogicalViewRequestTest {
   @Test
   public void testToProto() {
     UpdateLogicalViewRequest request =
-        UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("query 1");
+        UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
+            .setQuery("query 1")
+            .setDeletionProtection(true);
 
     com.google.bigtable.admin.v2.UpdateLogicalViewRequest requestProto =
         com.google.bigtable.admin.v2.UpdateLogicalViewRequest.newBuilder()
             .setLogicalView(
                 com.google.bigtable.admin.v2.LogicalView.newBuilder()
                     .setQuery("query 1")
+                    .setDeletionProtection(true)
                     .setName(
                         NameUtil.formatLogicalViewName(PROJECT_ID, INSTANCE_ID, LOGICAL_VIEW_ID)))
-            .setUpdateMask(FieldMask.newBuilder().addPaths("query").build())
+            .setUpdateMask(
+                FieldMask.newBuilder().addPaths("deletion_protection").addPaths("query").build())
             .build();
     assertThat(request.toProto(PROJECT_ID)).isEqualTo(requestProto);
   }
 
   @Test
   public void testEquality() {
     UpdateLogicalViewRequest request =
-        UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("query 1");
+        UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
+            .setQuery("query 1")
+            .setDeletionProtection(true);
 
     assertThat(request)
-        .isEqualTo(UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("query 1"));
+        .isEqualTo(
+            UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
+                .setQuery("query 1")
+                .setDeletionProtection(true));
 
     assertThat(request)
         .isNotEqualTo(
-            UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("query 2"));
+            UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
+                .setQuery("query 2")
+                .setDeletionProtection(true));
   }
 
   @Test
   public void testHashCode() {
     UpdateLogicalViewRequest request =
-        UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID).setQuery("query 1");
+        UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
+            .setQuery("query 1")
+            .setDeletionProtection(true);
 
     assertThat(request.hashCode())
         .isEqualTo(
             UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
                 .setQuery("query 1")
+                .setDeletionProtection(true)
                 .hashCode());
 
     assertThat(request.hashCode())
         .isNotEqualTo(
             UpdateLogicalViewRequest.of(INSTANCE_ID, LOGICAL_VIEW_ID)
                 .setQuery("query 2")
+                .setDeletionProtection(true)
                 .hashCode());
   }
 }
