feat: Java SDK Api Key authorization sample (GoogleCloudPlatform#9586)

ldetmer · web-flow · commit 51748e838a70 · 2024-10-24T07:41:20.000-04:00
* feat: create java sample for authorizing in google cloud using api key credentials

* formatting fix

* code cleanup from linter

* code cleanup from linter

* code cleanup from unintentional formatting changes

* moved test into separate file

* added tests

* removed unnecessary return

* removed extra newline

* do not pass in arguments to main + auto create api key for unit tests

* add java doc to new class

* fixed license header

* enclosed key creation in try + delete in finally
diff --git a/auth/README.md b/auth/README.md
@@ -35,6 +35,14 @@ You can then run a given `ClassName` via:
     mvn exec:java -Dexec.mainClass=com.google.cloud.auth.samples.AuthExample
         -Dexec.args="compute"
 
+### Analyze text sentiment using LanguageService API with API key authentication
+
+Create an API key via the [Google Cloud console:](https://developers.google.com/workspace/guides/create-credentials#api-key)
+
+Once you have an API key replace it in the main function in ApiKeyAuthExample and run the following command
+
+    mvn exec:java -Dexec.mainClass=com.google.cloud.auth.samples.ApiKeyAuthExample
+
 ## Downscoping with Credential Access Boundaries
 
 The same configuration above applies. 
@@ -44,7 +52,7 @@ you must provide both a bucket name and object name under the TODO(developer): i
 
 You can then run `DownscopingExample` via:
 
-	mvn exec:exec
+	mvn exec:java -Dexec.mainClass=com.google.cloud.auth.samples.DownscopingExample
 
 ## Tests
 Run all tests:
diff --git a/auth/pom.xml b/auth/pom.xml
@@ -48,7 +48,7 @@ limitations under the License.
       <dependency>
         <groupId>com.google.cloud</groupId>
         <artifactId>libraries-bom</artifactId>
-        <version>26.32.0</version>
+        <version>26.49.0</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
@@ -72,6 +72,10 @@ limitations under the License.
       <groupId>com.google.cloud</groupId>
       <artifactId>google-cloud-apikeys</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-language</artifactId>
+    </dependency>
     <!-- END dependencies -->
     <dependency>
       <groupId>junit</groupId>
@@ -104,11 +108,6 @@ limitations under the License.
         </executions>
         <configuration>
           <executable>java</executable>
-          <arguments>
-            <argument>-classpath</argument>
-            <classpath />
-            <argument>com.google.cloud.auth.samples.DownscopingExample</argument>
-          </arguments>
         </configuration>
       </plugin>
     </plugins>
diff --git a/auth/src/main/java/com/google/cloud/auth/samples/ApiKeyAuthExample.java b/auth/src/main/java/com/google/cloud/auth/samples/ApiKeyAuthExample.java
@@ -0,0 +1,58 @@
+/*
+ * 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 com.google.cloud.auth.samples;
+
+// [START auth_cloud_api_key]
+import com.google.cloud.language.v2.AnalyzeSentimentResponse;
+import com.google.cloud.language.v2.Document;
+import com.google.cloud.language.v2.LanguageServiceClient;
+import com.google.cloud.language.v2.LanguageServiceSettings;
+import java.io.IOException;
+
+// [END auth_cloud_api_key]
+
+/**
+ * Demonstrate how to authenticate requests using an API Key using the Language API as an example.
+ */
+public class ApiKeyAuthExample {
+
+  // [START auth_cloud_api_key]
+  static String authenticateUsingApiKey(String apiKey) throws IOException {
+    LanguageServiceSettings settings =
+        LanguageServiceSettings.newBuilder().setApiKey(apiKey).build();
+    try (LanguageServiceClient client = LanguageServiceClient.create(settings)) {
+      Document document =
+          Document.newBuilder()
+              .setContent("Hello World!")
+              .setType(Document.Type.PLAIN_TEXT)
+              .build();
+
+      AnalyzeSentimentResponse actualResponse = client.analyzeSentiment(document);
+
+      return actualResponse.getDocumentSentiment().toString();
+    }
+  }
+  // [END auth_cloud_api_key]
+
+  public static void main(String[] args) throws IOException {
+    // TODO(Developer): Before running this sample, replace the variable(s) below.
+    // API key created in developer's project.
+    String apiKey = "api-key";
+
+    authenticateUsingApiKey(apiKey);
+  }
+}
diff --git a/auth/src/test/java/com/google/cloud/auth/samples/AuthExampleIT.java b/auth/src/test/java/com/google/cloud/auth/samples/AuthExampleIT.java
@@ -19,6 +19,8 @@
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
 
+import com.google.api.apikeys.v2.Key;
+import com.google.cloud.ServiceOptions;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.PrintStream;
@@ -57,4 +59,24 @@ public void testAuthExplicitNoPath() throws IOException {
     String output = bout.toString();
     assertTrue(output.contains("Buckets:"));
   }
+
+  @Test
+  public void testAuthApiKey() throws IOException, IllegalStateException {
+    String projectId = ServiceOptions.getDefaultProjectId();
+    String keyDisplayName = "Test API Key";
+    String service = "language.googleapis.com";
+    String method = "google.cloud.language.v2.LanguageService.AnalyzeSentiment";
+    Key apiKey = null;
+    try {
+      apiKey = AuthTestUtils.createTestApiKey(projectId, keyDisplayName, service, method);
+
+      String output = ApiKeyAuthExample.authenticateUsingApiKey(apiKey.getKeyString());
+
+      assertTrue(output.contains("magnitude:"));
+    } finally {
+      if (apiKey != null) {
+        AuthTestUtils.deleteTestApiKey(apiKey.getName());
+      }
+    }
+  }
 }
diff --git a/auth/src/test/java/com/google/cloud/auth/samples/AuthTestUtils.java b/auth/src/test/java/com/google/cloud/auth/samples/AuthTestUtils.java
@@ -0,0 +1,64 @@
+/*
+ * 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 com.google.cloud.auth.samples;
+
+import com.google.api.apikeys.v2.ApiKeysClient;
+import com.google.api.apikeys.v2.ApiTarget;
+import com.google.api.apikeys.v2.CreateKeyRequest;
+import com.google.api.apikeys.v2.Key;
+import com.google.api.apikeys.v2.LocationName;
+import com.google.api.apikeys.v2.Restrictions;
+import java.io.IOException;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * Utility methods to setup data for IT auth tests.
+ */
+public class AuthTestUtils {
+
+  public static Key createTestApiKey(
+      String projectId, String keyDisplayName, String service, String method)
+      throws IllegalStateException {
+    try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
+      Key key =
+          Key.newBuilder()
+              .setDisplayName(keyDisplayName)
+              .setRestrictions(
+                  Restrictions.newBuilder()
+                      .addApiTargets(
+                          ApiTarget.newBuilder().setService(service).addMethods(method).build())
+                      .build())
+              .build();
+
+      CreateKeyRequest createKeyRequest =
+          CreateKeyRequest.newBuilder()
+              // API keys can only be global.
+              .setParent(LocationName.of(projectId, "global").toString())
+              .setKey(key)
+              .build();
+      return apiKeysClient.createKeyAsync(createKeyRequest).get(3, TimeUnit.MINUTES);
+    } catch (Exception e) {
+      throw new IllegalStateException("Error trying to create API Key " + e.getMessage());
+    }
+  }
+
+  public static void deleteTestApiKey(String keyName) throws IOException {
+    try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
+      apiKeysClient.deleteKeyAsync(keyName);
+    }
+  }
+}
