feat(secretmanager): added samples for annotations (#9513)

vipul7499 · web-flow · commit 4697d0d12035 · 2024-10-10T20:24:26.000+05:30
* feat(secretmanager): added samples for annotations

* fix:resolved comments

* fix: lint fix
diff --git a/secretmanager/src/main/java/secretmanager/CreateSecretWithAnnotations.java b/secretmanager/src/main/java/secretmanager/CreateSecretWithAnnotations.java
@@ -0,0 +1,74 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package secretmanager;
+
+// [START secretmanager_create_secret_with_annotations]
+import com.google.cloud.secretmanager.v1.ProjectName;
+import com.google.cloud.secretmanager.v1.Replication;
+import com.google.cloud.secretmanager.v1.Secret;
+import com.google.cloud.secretmanager.v1.SecretManagerServiceClient;
+import java.io.IOException;
+
+public class CreateSecretWithAnnotations {
+
+  public static void createSecretWithAnnotations() throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    
+    // This is the id of the GCP project
+    String projectId = "your-project-id";
+    // This is the id of the secret to act on
+    String secretId = "your-secret-id";
+    // This is the key of the annotation to be added
+    String annotationKey = "your-annotation-key";
+    // This is the value of the annotation to be added
+    String annotationValue = "your-annotation-value";
+    createSecretWithAnnotations(projectId, secretId, annotationKey, annotationValue);
+  }
+
+  // Create a secret with annotations.
+  public static Secret createSecretWithAnnotations(
+       String projectId,
+       String secretId,
+       String annotationKey,
+       String annotationValue
+  ) throws IOException {
+
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests.
+    try (SecretManagerServiceClient client = SecretManagerServiceClient.create()) {
+      
+      // Build the name.
+      ProjectName projectName = ProjectName.of(projectId);
+
+      // Build the secret to create with labels.
+      Secret secret =
+          Secret.newBuilder()
+                  .setReplication(
+                  Replication.newBuilder()
+                      .setAutomatic(Replication.Automatic.newBuilder().build())
+                      .build())
+                  .putAnnotations(annotationKey, annotationValue)
+              .build();
+
+      // Create the secret.
+      Secret createdSecret = client.createSecret(projectName, secretId, secret);
+      System.out.printf("Created secret %s\n", createdSecret.getName());
+      return createdSecret;
+    }
+  }
+}
+// [END secretmanager_create_secret_with_annotations]
diff --git a/secretmanager/src/main/java/secretmanager/EditSecretAnnotations.java b/secretmanager/src/main/java/secretmanager/EditSecretAnnotations.java
@@ -0,0 +1,86 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package secretmanager;
+
+// [START secretmanager_edit_secret_annotations]
+import com.google.cloud.secretmanager.v1.Secret;
+import com.google.cloud.secretmanager.v1.SecretManagerServiceClient;
+import com.google.cloud.secretmanager.v1.SecretName;
+import com.google.protobuf.FieldMask;
+import com.google.protobuf.util.FieldMaskUtil;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+public class EditSecretAnnotations {
+
+  public static void editSecretAnnotations() throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    
+    // This is the id of the GCP project
+    String projectId = "your-project-id";
+    // This is the id of the secret to act on
+    String secretId = "your-secret-id";
+    // This is the key of the annotation to be added/updated
+    String annotationKey = "your-annotation-key";
+    // This is the value of the annotation to be added/updated
+    String annotationValue = "your-annotation-value";
+    editSecretAnnotations(projectId, secretId, annotationKey, annotationValue);
+  }
+
+  // Update an existing secret, by creating a new annotation or updating an existing annotation.
+  public static Secret editSecretAnnotations(
+       String projectId,
+       String secretId,
+       String annotationKey,
+       String annotationValue
+  ) throws IOException {
+
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests.
+    try (SecretManagerServiceClient client = SecretManagerServiceClient.create()) {
+      // Build the name.
+      SecretName secretName = SecretName.of(projectId, secretId);
+
+      // Get the existing secret
+      Secret existingSecret = client.getSecret(secretName);
+
+      Map<String, String> existingAnnotationsMap = 
+                      new HashMap<String, String>(existingSecret.getAnnotationsMap());
+
+      // Add a new annotation key and value.
+      existingAnnotationsMap.put(annotationKey, annotationValue);
+
+      // Build the updated secret.
+      Secret secret =
+          Secret.newBuilder()
+              .setName(secretName.toString())
+              .putAllAnnotations(existingAnnotationsMap)
+              .build();
+
+      // Build the field mask.
+      FieldMask fieldMask = FieldMaskUtil.fromString("annotations");
+
+      // Update the secret.
+      Secret updatedSecret = client.updateSecret(secret, fieldMask);
+      System.out.printf("Updated secret %s\n", updatedSecret.getName());
+
+      return updatedSecret;
+    }
+  }
+}
+// [END secretmanager_edit_secret_annotations]
diff --git a/secretmanager/src/main/java/secretmanager/ViewSecretAnnotations.java b/secretmanager/src/main/java/secretmanager/ViewSecretAnnotations.java
@@ -0,0 +1,65 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package secretmanager;
+
+// [START secretmanager_view_secret_annotations]
+import com.google.cloud.secretmanager.v1.Secret;
+import com.google.cloud.secretmanager.v1.SecretManagerServiceClient;
+import com.google.cloud.secretmanager.v1.SecretName;
+import java.io.IOException;
+import java.util.Map;
+
+public class ViewSecretAnnotations {
+
+  public static void viewSecretAnnotations() throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    
+    // This is the id of the GCP project
+    String projectId = "your-project-id";
+    // This is the id of the secret whose annotations to view
+    String secretId = "your-secret-id";
+    viewSecretAnnotations(projectId, secretId);
+  }
+
+  // View the annotations of an existing secret.
+  public static Map<String, String> viewSecretAnnotations(
+      String projectId,
+      String secretId
+  ) throws IOException {
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests.
+    try (SecretManagerServiceClient client = SecretManagerServiceClient.create()) {
+      // Build the name.
+      SecretName secretName = SecretName.of(projectId, secretId);
+
+      // Create the secret.
+      Secret secret = client.getSecret(secretName);
+      
+      Map<String, String> annotations = secret.getAnnotationsMap();
+
+      System.out.printf("Secret %s \n", secret.getName());
+
+      for (Map.Entry<String, String> annotation : annotations.entrySet()) {
+        System.out.printf("Annotation key : %s, Annotation Value : %s\n", 
+            annotation.getKey(), annotation.getValue());
+      }
+
+      return secret.getAnnotationsMap();
+    }
+  }
+}
+// [END secretmanager_view_secret_annotations]
diff --git a/secretmanager/src/test/java/secretmanager/SnippetsIT.java b/secretmanager/src/test/java/secretmanager/SnippetsIT.java
@@ -18,7 +18,6 @@
 
 import static com.google.common.truth.Truth.assertThat;
 import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNull;
 
 import com.google.cloud.secretmanager.v1.AddSecretVersionRequest;
 import com.google.cloud.secretmanager.v1.CreateSecretRequest;
@@ -68,13 +67,18 @@ public class SnippetsIT {
   private static final String LABEL_VALUE = "examplelabelvalue";
   private static final String UPDATED_LABEL_KEY = "updatedlabelkey";
   private static final String UPDATED_LABEL_VALUE = "updatedlabelvalue";
+  private static final String ANNOTATION_KEY = "exampleannotationkey";
+  private static final String ANNOTATION_VALUE = "exampleannotationvalue";
+  private static final String UPDATED_ANNOTATION_KEY = "updatedannotationkey";
+  private static final String UPDATED_ANNOTATION_VALUE = "updatedannotationvalue";
 
   private static Secret TEST_SECRET;
   private static Secret TEST_SECRET_TO_DELETE;
   private static Secret TEST_SECRET_TO_DELETE_WITH_ETAG;
   private static Secret TEST_SECRET_WITH_VERSIONS;
   private static SecretName TEST_SECRET_TO_CREATE_NAME;
   private static SecretName TEST_SECRET_WITH_LABEL_TO_CREATE_NAME;
+  private static SecretName TEST_SECRET_WITH_ANNOTATION_TO_CREATE_NAME;
   private static SecretName TEST_UMMR_SECRET_TO_CREATE_NAME;
   private static SecretVersion TEST_SECRET_VERSION;
   private static SecretVersion TEST_SECRET_VERSION_TO_DESTROY;
@@ -90,13 +94,14 @@ public class SnippetsIT {
   public static void beforeAll() throws IOException {
     Assert.assertFalse("missing GOOGLE_CLOUD_PROJECT", Strings.isNullOrEmpty(PROJECT_ID));
 
-    TEST_SECRET = createSecret();
-    TEST_SECRET_TO_DELETE = createSecret();
-    TEST_SECRET_TO_DELETE_WITH_ETAG = createSecret();
-    TEST_SECRET_WITH_VERSIONS = createSecret();
+    TEST_SECRET = createSecret(true);
+    TEST_SECRET_TO_DELETE = createSecret(false);
+    TEST_SECRET_TO_DELETE_WITH_ETAG = createSecret(false);
+    TEST_SECRET_WITH_VERSIONS = createSecret(false);
     TEST_SECRET_TO_CREATE_NAME = SecretName.of(PROJECT_ID, randomSecretId());
     TEST_UMMR_SECRET_TO_CREATE_NAME = SecretName.of(PROJECT_ID, randomSecretId());
     TEST_SECRET_WITH_LABEL_TO_CREATE_NAME = SecretName.of(PROJECT_ID, randomSecretId());
+    TEST_SECRET_WITH_ANNOTATION_TO_CREATE_NAME = SecretName.of(PROJECT_ID, randomSecretId());
 
     TEST_SECRET_VERSION = addSecretVersion(TEST_SECRET_WITH_VERSIONS);
     TEST_SECRET_VERSION_TO_DESTROY = addSecretVersion(TEST_SECRET_WITH_VERSIONS);
@@ -129,6 +134,7 @@ public static void afterAll() throws IOException {
     deleteSecret(TEST_SECRET.getName());
     deleteSecret(TEST_SECRET_TO_CREATE_NAME.toString());
     deleteSecret(TEST_SECRET_WITH_LABEL_TO_CREATE_NAME.toString());
+    deleteSecret(TEST_SECRET_WITH_ANNOTATION_TO_CREATE_NAME.toString());
     deleteSecret(TEST_UMMR_SECRET_TO_CREATE_NAME.toString());
     deleteSecret(TEST_SECRET_TO_DELETE.getName());
     deleteSecret(TEST_SECRET_TO_DELETE_WITH_ETAG.getName());
@@ -140,28 +146,42 @@ private static String randomSecretId() {
     return "java-" + random.nextLong();
   }
 
-  private static Secret createSecret() throws IOException {
+  private static Secret createSecret(boolean addAnnotation) throws IOException {
     ProjectName parent = ProjectName.of(PROJECT_ID);
 
+    Secret secret;
+    if (addAnnotation) {
+      secret = Secret.newBuilder()
+      .setReplication(
+        Replication.newBuilder()
+            .setAutomatic(Replication.Automatic.newBuilder().build())
+            .build())
+      .putLabels(LABEL_KEY, LABEL_VALUE)
+      .putAnnotations(ANNOTATION_KEY, ANNOTATION_VALUE)
+      .build();
+    } else {
+      secret = Secret.newBuilder()
+      .setReplication(
+        Replication.newBuilder()
+            .setAutomatic(Replication.Automatic.newBuilder().build())
+            .build())
+      .putLabels(LABEL_KEY, LABEL_VALUE)
+      .build();
+    }
+
     CreateSecretRequest request =
         CreateSecretRequest.newBuilder()
             .setParent(parent.toString())
             .setSecretId(randomSecretId())
-            .setSecret(
-                Secret.newBuilder()
-                    .setReplication(
-                        Replication.newBuilder()
-                            .setAutomatic(Replication.Automatic.newBuilder().build())
-                            .build())
-                    .putLabels(LABEL_KEY, LABEL_VALUE)
-                    .build())
+            .setSecret(secret)
             .build();
 
     try (SecretManagerServiceClient client = SecretManagerServiceClient.create()) {
       return client.createSecret(request);
     }
   }
 
+
   private static SecretVersion addSecretVersion(Secret secret) throws IOException {
     SecretName parent = SecretName.parse(secret.getName());
 
@@ -237,6 +257,15 @@ public void testCreateSecretWithLabel() throws IOException {
     assertThat(secret.getLabelsMap()).containsEntry(LABEL_KEY, LABEL_VALUE);
   }
 
+  @Test
+  public void testCreateSecretWithAnnotations() throws IOException {
+    SecretName name = TEST_SECRET_WITH_ANNOTATION_TO_CREATE_NAME;
+    Secret secret = CreateSecretWithAnnotations.createSecretWithAnnotations(
+        name.getProject(), name.getSecret(), ANNOTATION_KEY, ANNOTATION_VALUE);
+
+    assertThat(secret.getAnnotationsMap()).containsEntry(ANNOTATION_KEY, ANNOTATION_VALUE);
+  }
+
   @Test
   public void testCreateSecretWithUserManagedReplication() throws IOException {
     SecretName name = TEST_UMMR_SECRET_TO_CREATE_NAME;
@@ -361,6 +390,15 @@ public void testViewSecretLabels() throws IOException {
     assertThat(labels).containsEntry(LABEL_KEY, LABEL_VALUE);
   }
 
+  @Test
+  public void testViewSecretAnnotations() throws IOException {
+    SecretName name = SecretName.parse(TEST_SECRET.getName());
+    Map<String, String> annotations = 
+        ViewSecretAnnotations.viewSecretAnnotations(name.getProject(), name.getSecret());
+
+    assertThat(annotations).containsEntry(ANNOTATION_KEY, ANNOTATION_VALUE);
+  }
+
 
   @Test
   public void testIamGrantAccess() throws IOException {
@@ -432,6 +470,16 @@ public void testCreateUpdateSecretLabel() throws IOException {
         UPDATED_LABEL_KEY, UPDATED_LABEL_VALUE);
   }
 
+  @Test
+  public void testEditSecretAnnotations() throws IOException {
+    SecretName name = SecretName.parse(TEST_SECRET.getName());
+    Secret updatedSecret = EditSecretAnnotations.editSecretAnnotations(
+        name.getProject(), name.getSecret(), UPDATED_ANNOTATION_KEY, UPDATED_ANNOTATION_VALUE);
+
+    assertThat(updatedSecret.getAnnotationsMap()).containsEntry(
+        UPDATED_ANNOTATION_KEY, UPDATED_ANNOTATION_VALUE);
+  }
+
   @Test
   public void testUpdateSecretWithAlias() throws IOException {
     SecretName name = SecretName.parse(TEST_SECRET_WITH_VERSIONS.getName());
