feat: add secretmanager sample for ConsumeEventNotification (#8138)

* feat: add secretmanager sample for ConsumeEventNotification

* lint fix

* update acc to review

* update acc to review

Author: Sita04

secretmanager/pom.xml

@@ -61,6 +61,13 @@
       <artifactId>protobuf-java-util</artifactId>
     </dependency>
 
+    <dependency>
+      <groupId>org.projectlombok</groupId>
+      <artifactId>lombok</artifactId>
+      <version>1.18.26</version>
+      <scope>provided</scope>
+    </dependency>
+
     <!-- test dependencies -->
     <dependency>
       <groupId>junit</groupId>
@@ -75,4 +82,26 @@
       <scope>test</scope>
     </dependency>
   </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>3.10.1</version>
+        <configuration>
+          <source>11</source> <!-- depending on your project -->
+          <target>11</target> <!-- depending on your project -->
+          <annotationProcessorPaths>
+            <path>
+              <groupId>org.projectlombok</groupId>
+              <artifactId>lombok</artifactId>
+              <version>1.18.26</version>
+            </path>
+          </annotationProcessorPaths>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+
 </project>

secretmanager/src/main/java/secretmanager/ConsumeEventNotification.java

@@ -0,0 +1,56 @@
+/*
+ *  Copyright 2023 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_consume_event_notification]
+
+import java.util.Base64;
+import java.util.Map;
+import java.util.logging.Logger;
+import lombok.Data;
+
+// Demonstrates how to consume and process a Pub/Sub notification from Secret Manager. Triggered
+// by a message on a Cloud Pub/Sub topic.
+// Ideally the class should implement a background function that accepts a Pub/Sub message.
+// public class ConsumeEventNotification implements BackgroundFunction<PubSubMessage> { }
+public class ConsumeEventNotification {
+
+  // You can configure the logs to print the message in Cloud Logging.
+  private static final Logger logger = Logger.getLogger(ConsumeEventNotification.class.getName());
+
+  // Accepts a message from a Pub/Sub topic and writes it to logger.
+  public static String accept(PubSubMessage message) {
+    String eventType = message.attributes.get("eventType");
+    String secretId = message.attributes.get("secretId");
+    String data = new String(Base64.getDecoder().decode(message.data));
+    String log = String.format("Received %s for %s. New metadata: %s", eventType, secretId, data);
+    logger.info(log);
+    return log;
+  }
+
+  // Event payload. Mock of the actual Pub/Sub message.
+  @Data
+  public static class PubSubMessage {
+
+    byte[] data;
+    Map<String, String> attributes;
+    String messageId;
+    String publishTime;
+    String orderingKey;
+  }
+}
+// [END secretmanager_consume_event_notification]

secretmanager/src/test/java/secretmanager/SnippetsIT.java

@@ -21,9 +21,7 @@
 import com.google.cloud.secretmanager.v1.AddSecretVersionRequest;
 import com.google.cloud.secretmanager.v1.CreateSecretRequest;
 import com.google.cloud.secretmanager.v1.DeleteSecretRequest;
-import com.google.cloud.secretmanager.v1.DestroySecretVersionRequest;
 import com.google.cloud.secretmanager.v1.DisableSecretVersionRequest;
-import com.google.cloud.secretmanager.v1.EnableSecretVersionRequest;
 import com.google.cloud.secretmanager.v1.ProjectName;
 import com.google.cloud.secretmanager.v1.Replication;
 import com.google.cloud.secretmanager.v1.Secret;
@@ -37,8 +35,12 @@
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
+import java.util.Base64;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Random;
 import org.junit.After;
 import org.junit.AfterClass;
@@ -48,11 +50,15 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
+import secretmanager.ConsumeEventNotification.PubSubMessage;
 
-/** Integration (system) tests for {@link Snippets}. */
+/**
+ * Integration (system) tests for {@link Snippets}.
+ */
 @RunWith(JUnit4.class)
 @SuppressWarnings("checkstyle:AbbreviationAsWordInName")
 public class SnippetsIT {
+
   private static final String IAM_USER =
       "serviceAccount:iam-samples@java-docs-samples-testing.iam.gserviceaccount.com";
   private static final String PROJECT_ID = System.getenv("GOOGLE_CLOUD_PROJECT");
@@ -122,7 +128,7 @@ public static void afterAll() throws IOException {
 
   private static String randomSecretId() {
     Random random = new Random();
-    return "java-" + String.valueOf(random.nextLong());
+    return "java-" + random.nextLong();
   }
 
   private static Secret createSecret() throws IOException {
@@ -376,12 +382,29 @@ public void testUpdateSecret() throws IOException {
 
     assertThat(stdOut.toString()).contains("Updated secret");
   }
-  
+
   @Test
   public void testUpdateSecretWithAlias() throws IOException {
     SecretName name = SecretName.parse(TEST_SECRET_WITH_VERSIONS.getName());
     UpdateSecretWithAlias.updateSecret(name.getProject(), name.getSecret());
 
     assertThat(stdOut.toString()).contains("test");
   }
+
+  @Test
+  public void testConsumeEventNotification() {
+    String message = "hello!";
+    byte[] base64Bytes = Base64.getEncoder().encode(message.getBytes(StandardCharsets.UTF_8));
+    Map<String, String> attributes = new HashMap<>();
+    attributes.put("eventType", "SECRET_UPDATE");
+    attributes.put("secretId", "projects/p/secrets/s");
+
+    PubSubMessage pubSubMessage = new PubSubMessage();
+    pubSubMessage.setData(base64Bytes);
+    pubSubMessage.setAttributes(attributes);
+
+    String log = ConsumeEventNotification.accept(pubSubMessage);
+    assertThat(log).isEqualTo(
+        "Received SECRET_UPDATE for projects/p/secrets/s. New metadata: hello!");
+  }
 }