Format Fix for Agentspace Example (#1483)

CYarros10 · web-flow · commit df9d9d43bced · 2025-04-11T12:42:12.000-05:00
* formatting fix

* formatting fix 2

* exclude
diff --git a/examples/cloud-agentspace-wif-dwd/src/main/java/com/google/cloud/pso/OauthApplication.java b/examples/cloud-agentspace-wif-dwd/src/main/java/com/google/cloud/pso/OauthApplication.java
@@ -1,23 +1,18 @@
 /**
- * 
- *  Copyright 2025 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.
-
-*/
+ * Copyright 2025 Google LLC
+ *
+ * <p>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
+ *
+ * <p>http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * <p>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.pso;
 
-
 import com.google.api.client.googleapis.auth.oauth2.GoogleTokenResponse;
 import com.google.api.client.http.*;
 import com.google.api.client.http.javanet.NetHttpTransport;
@@ -33,25 +28,23 @@
 import com.google.cloud.iam.credentials.v1.IamCredentialsClient;
 import com.google.cloud.iam.credentials.v1.SignJwtRequest;
 import com.google.cloud.iam.credentials.v1.SignJwtResponse;
-
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.concurrent.ExecutionException;
 
 /**
- * This sample demonstrates how to authenticate GCP AgentSapce and discovery API using Domain
- * Wide Delegation to impersonate the user
- * when using WIF credentials
+ * This sample demonstrates how to authenticate GCP AgentSapce and discovery API using Domain Wide
+ * Delegation to impersonate the user when using WIF credentials
  */
 public class OauthApplication {
 
   public static void main(String[] args) {
 
     /*
      * Configuration details
-     * 
+     *
      */
 
     String projectId = "project-id"; // Project ID .
@@ -60,12 +53,21 @@ public static void main(String[] args) {
     String engineId = "ws-search_engine"; // Engine ID.
     String servingConfigId = "default_search"; // Serving configuration. Options: "default_search"
     String searchUserEmail = "email@domain.com"; // Email-id of the user to impersonate
-    String serviceAccountId = "service-account@projectid.iam.gserviceaccount.com"; // Service account with the permission on the WIF
+    String serviceAccountId =
+        "service-account@projectid.iam.gserviceaccount.com"; // Service account with the permission
+    // on the WIF
 
     String searchQuery = "Sample Search Query"; // Search Query for the data store.
     try {
-      search(projectId, location, collectionId, engineId, servingConfigId, searchQuery,
-          searchUserEmail, serviceAccountId);
+      search(
+          projectId,
+          location,
+          collectionId,
+          engineId,
+          servingConfigId,
+          searchQuery,
+          searchUserEmail,
+          serviceAccountId);
     } catch (IOException | ExecutionException e) {
       throw new RuntimeException(e);
     }
@@ -74,16 +76,16 @@ public static void main(String[] args) {
   /**
    * Performs a search operation in the Google Cloud Discovery Engine.
    *
-   * @param projectId       The project ID.
-   * @param location        The location of the data store.
-   * @param collectionId    The collection containing the data store.
-   * @param engineId        The engine ID.
+   * @param projectId The project ID.
+   * @param location The location of the data store.
+   * @param collectionId The collection containing the data store.
+   * @param engineId The engine ID.
    * @param servingConfigId The serving configuration ID.
-   * @param searchQuery     The search query.
+   * @param searchQuery The search query.
    * @param searchUserEmail The email of the user to impersonate.
-   * @param serviceAccount  The service account with the necessary permissions,
-   *                        should be same one from credentials.
-   * @throws IOException        If an I/O error occurs.
+   * @param serviceAccount The service account with the necessary permissions, should be same one
+   *     from credentials.
+   * @throws IOException If an I/O error occurs.
    * @throws ExecutionException If an execution error occurs.
    */
   public static void search(
@@ -103,17 +105,19 @@ public static void search(
       HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);
       HttpTransport transport = new NetHttpTransport.Builder().build();
       transport.createRequestFactory(requestInitializer);
-      settings = SearchServiceSettings.newBuilder()
-          .setCredentialsProvider(FixedCredentialsProvider.create(credentials))
-          .build();
+      settings =
+          SearchServiceSettings.newBuilder()
+              .setCredentialsProvider(FixedCredentialsProvider.create(credentials))
+              .build();
       SearchServiceClient searchServiceClient = SearchServiceClient.create(settings);
-      SearchRequest request = SearchRequest.newBuilder()
-          .setServingConfig(
-              ServingConfigName.formatProjectLocationCollectionEngineServingConfigName(
-                  projectId, location, collectionId, engineId, servingConfigId))
-          .setQuery(searchQuery)
-          .setPageSize(10)
-          .build();
+      SearchRequest request =
+          SearchRequest.newBuilder()
+              .setServingConfig(
+                  ServingConfigName.formatProjectLocationCollectionEngineServingConfigName(
+                      projectId, location, collectionId, engineId, servingConfigId))
+              .setQuery(searchQuery)
+              .setPageSize(10)
+              .build();
       Object o = searchServiceClient.search(request).getPage().getResponse();
       System.out.println("Response Object: " + o);
       SearchResponse response = searchServiceClient.search(request).getPage().getResponse();
@@ -130,7 +134,7 @@ public static void search(
   /**
    * Generates credentials for a given user email and service account.
    *
-   * @param userEmail        The email of the user.
+   * @param userEmail The email of the user.
    * @param serviceAccountId The service account ID.
    * @return A Credentials object containing the OAuth2 credentials.
    * @throws IOException If an I/O error occurs during credentials generation.
@@ -170,14 +174,13 @@ private static String getAccessToken(String signedJWT) throws IOException {
     HttpResponse tokenResponse = tokenRequest.execute();
     GoogleTokenResponse googleTokenResponse = tokenResponse.parseAs(GoogleTokenResponse.class);
     return googleTokenResponse.getAccessToken();
-
   }
 
   /**
-   * Generates a signed JWT for a given user email and service account using
-   * Google IAM Credentials API.
+   * Generates a signed JWT for a given user email and service account using Google IAM Credentials
+   * API.
    *
-   * @param userEmail        The email of the user.
+   * @param userEmail The email of the user.
    * @param serviceAccountId The service account ID.
    * @return The signed JWT.
    * @throws IOException If an I/O error occurs during JWT generation.
@@ -188,23 +191,31 @@ private static String generateSingedJwt(String userEmail, String serviceAccountI
     long nowSeconds = System.currentTimeMillis() / 1000;
     long expSeconds = nowSeconds + 1800; // 30 minutes
 
-    String jsonPayload = "{\"aud\":\"https://oauth2.googleapis.com/token\""
-        + ",\"exp\":" + expSeconds
-        + ",\"iat\":" + nowSeconds
-        + ",\"iss\":\"" + serviceAccountId + "\""
-        + ",\"sub\":\"" + userEmail + "\""
-        + ",\"scope\":\"https://www.googleapis.com/auth/cloud-platform\"}";
+    String jsonPayload =
+        "{\"aud\":\"https://oauth2.googleapis.com/token\""
+            + ",\"exp\":"
+            + expSeconds
+            + ",\"iat\":"
+            + nowSeconds
+            + ",\"iss\":\""
+            + serviceAccountId
+            + "\""
+            + ",\"sub\":\""
+            + userEmail
+            + "\""
+            + ",\"scope\":\"https://www.googleapis.com/auth/cloud-platform\"}";
     System.out.println(jsonPayload);
 
-    SignJwtRequest request = SignJwtRequest.newBuilder()
-        .setName("projects/-/serviceAccounts/" + serviceAccountId)
-        .addAllDelegates(new ArrayList<String>())
-        .setPayload(jsonPayload)
-        .build();
+    SignJwtRequest request =
+        SignJwtRequest.newBuilder()
+            .setName("projects/-/serviceAccounts/" + serviceAccountId)
+            .addAllDelegates(new ArrayList<String>())
+            .setPayload(jsonPayload)
+            .build();
 
     SignJwtResponse response = iamCredentialsClient.signJwt(request);
     System.out.println("response: " + response);
 
     return response.getSignedJwt();
   }
-}
+}
diff --git a/examples/cloud-agentspace-wif-dwd/src/test/java/com/google/cloud/pso/OauthApplicationTest.java b/examples/cloud-agentspace-wif-dwd/src/test/java/com/google/cloud/pso/OauthApplicationTest.java
@@ -1,20 +1,16 @@
 /**
- * 
- *  Copyright 2025 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.
-
-*/
+ * Copyright 2025 Google LLC
+ *
+ * <p>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
+ *
+ * <p>http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * <p>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.pso;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -29,7 +25,6 @@
 import com.google.api.client.http.HttpRequestFactory;
 import com.google.api.client.http.HttpResponse;
 import com.google.api.client.http.HttpTransport;
-import com.google.api.client.json.JsonFactory;
 import com.google.cloud.discoveryengine.v1alpha.SearchRequest;
 import com.google.cloud.discoveryengine.v1alpha.SearchResponse;
 import com.google.cloud.discoveryengine.v1alpha.SearchServiceClient;
@@ -72,7 +67,8 @@ void testSearchSuccess() throws Exception {
     IamCredentialsClient mockIamCredentialsClient = mock(IamCredentialsClient.class);
     SignJwtResponse mockSignJwtResponse = mock(SignJwtResponse.class);
     when(mockSignJwtResponse.getSignedJwt()).thenReturn("mockedSignedJwt");
-    when(mockIamCredentialsClient.signJwt(any(SignJwtRequest.class))).thenReturn(mockSignJwtResponse);
+    when(mockIamCredentialsClient.signJwt(any(SignJwtRequest.class)))
+        .thenReturn(mockSignJwtResponse);
 
     // Mocking getAccessToken
     GoogleTokenResponse mockGoogleTokenResponse = mock(GoogleTokenResponse.class);
@@ -82,7 +78,8 @@ void testSearchSuccess() throws Exception {
     HttpRequest mockHttpRequest = mock(HttpRequest.class);
     when(mockHttpRequest.execute()).thenReturn(mockHttpResponse);
     HttpRequestFactory mockHttpRequestFactory = mock(HttpRequestFactory.class);
-    when(mockHttpRequestFactory.buildPostRequest(any(GenericUrl.class), any())).thenReturn(mockHttpRequest);
+    when(mockHttpRequestFactory.buildPostRequest(any(GenericUrl.class), any()))
+        .thenReturn(mockHttpRequest);
     HttpTransport mockHttpTransport = mock(HttpTransport.class);
     when(mockHttpTransport.createRequestFactory()).thenReturn(mockHttpRequestFactory);
 
@@ -91,34 +88,58 @@ void testSearchSuccess() throws Exception {
     SearchResponse mockSearchResponse = mock(SearchResponse.class);
     SearchResponse.SearchResult mockSearchResult = mock(SearchResponse.SearchResult.class);
     when(mockSearchResult.toString()).thenReturn("Mocked Search Result");
-    when(mockSearchResponse.getResultsList()).thenReturn(java.util.Collections.singletonList(mockSearchResult));
+    when(mockSearchResponse.getResultsList())
+        .thenReturn(java.util.Collections.singletonList(mockSearchResult));
     when(mockSearchResponse.getResultsCount()).thenReturn(1);
-    SearchServiceClient.SearchPagedResponse mockPagedResponse = mock(SearchServiceClient.SearchPagedResponse.class);
-    when(mockPagedResponse.getPage()).thenReturn(new SearchResponse.SearchResult.Page() {
-      @Override
-      public SearchResponse getResponse() {
-        return mockSearchResponse;
-      }
-    });
+    SearchServiceClient.SearchPagedResponse mockPagedResponse =
+        mock(SearchServiceClient.SearchPagedResponse.class);
+    when(mockPagedResponse.getPage())
+        .thenReturn(
+            new SearchResponse.SearchResult.Page() {
+              @Override
+              public SearchResponse getResponse() {
+                return mockSearchResponse;
+              }
+            });
     when(mockSearchServiceClient.search(any(SearchRequest.class))).thenReturn(mockPagedResponse);
 
-    try (MockedStatic<IamCredentialsClient> mockedIamCredentialsClient = Mockito.mockStatic(IamCredentialsClient.class);
-         MockedStatic<SearchServiceClient> mockedSearchServiceClient = Mockito.mockStatic(SearchServiceClient.class);
-         MockedStatic<OauthApplication> mockedOauthApplication = Mockito.mockStatic(OauthApplication.class);
-         MockedStatic<HttpTransport> mockedHttpTransport = Mockito.mockStatic(HttpTransport.class)) {
-
-      mockedIamCredentialsClient.when(IamCredentialsClient::create).thenReturn(mockIamCredentialsClient);
-      mockedSearchServiceClient.when(() -> SearchServiceClient.create(any(SearchServiceSettings.class))).thenReturn(mockSearchServiceClient);
+    try (MockedStatic<IamCredentialsClient> mockedIamCredentialsClient =
+            Mockito.mockStatic(IamCredentialsClient.class);
+        MockedStatic<SearchServiceClient> mockedSearchServiceClient =
+            Mockito.mockStatic(SearchServiceClient.class);
+        MockedStatic<OauthApplication> mockedOauthApplication =
+            Mockito.mockStatic(OauthApplication.class);
+        MockedStatic<HttpTransport> mockedHttpTransport = Mockito.mockStatic(HttpTransport.class)) {
+
+      mockedIamCredentialsClient
+          .when(IamCredentialsClient::create)
+          .thenReturn(mockIamCredentialsClient);
+      mockedSearchServiceClient
+          .when(() -> SearchServiceClient.create(any(SearchServiceSettings.class)))
+          .thenReturn(mockSearchServiceClient);
       mockedHttpTransport.when(HttpTransport::new).thenReturn(mockHttpTransport);
       when(mockHttpTransport.createRequestFactory()).thenReturn(mockHttpRequestFactory);
-      when(mockHttpRequestFactory.buildPostRequest(any(GenericUrl.class), any())).thenReturn(mockHttpRequest);
+      when(mockHttpRequestFactory.buildPostRequest(any(GenericUrl.class), any()))
+          .thenReturn(mockHttpRequest);
       when(mockHttpRequest.execute()).thenReturn(mockHttpResponse);
       when(mockHttpResponse.parseAs(GoogleTokenResponse.class)).thenReturn(mockGoogleTokenResponse);
 
-      mockedOauthApplication.when(() -> OauthApplication.generateSingedJwt(searchUserEmail, serviceAccountId)).thenReturn("mockedSignedJwt");
-      mockedOauthApplication.when(() -> OauthApplication.getAccessToken("mockedSignedJwt")).thenReturn("mockedAccessToken");
-
-      OauthApplication.search(projectId, location, collectionId, engineId, servingConfigId, searchQuery, searchUserEmail, serviceAccountId);
+      mockedOauthApplication
+          .when(() -> OauthApplication.generateSingedJwt(searchUserEmail, serviceAccountId))
+          .thenReturn("mockedSignedJwt");
+      mockedOauthApplication
+          .when(() -> OauthApplication.getAccessToken("mockedSignedJwt"))
+          .thenReturn("mockedAccessToken");
+
+      OauthApplication.search(
+          projectId,
+          location,
+          collectionId,
+          engineId,
+          servingConfigId,
+          searchQuery,
+          searchUserEmail,
+          serviceAccountId);
 
       // Verify that the search method executed without throwing an exception.  More specific
       // verification would be ideal, but this at least confirms the happy path.
@@ -133,10 +154,14 @@ void testGenerateSingedJwtSuccess() throws IOException {
     IamCredentialsClient mockIamCredentialsClient = mock(IamCredentialsClient.class);
     SignJwtResponse mockSignJwtResponse = mock(SignJwtResponse.class);
     when(mockSignJwtResponse.getSignedJwt()).thenReturn("mockedSignedJwt");
-    when(mockIamCredentialsClient.signJwt(any(SignJwtRequest.class))).thenReturn(mockSignJwtResponse);
+    when(mockIamCredentialsClient.signJwt(any(SignJwtRequest.class)))
+        .thenReturn(mockSignJwtResponse);
 
-    try (MockedStatic<IamCredentialsClient> mockedIamCredentialsClient = Mockito.mockStatic(IamCredentialsClient.class)) {
-      mockedIamCredentialsClient.when(IamCredentialsClient::create).thenReturn(mockIamCredentialsClient);
+    try (MockedStatic<IamCredentialsClient> mockedIamCredentialsClient =
+        Mockito.mockStatic(IamCredentialsClient.class)) {
+      mockedIamCredentialsClient
+          .when(IamCredentialsClient::create)
+          .thenReturn(mockIamCredentialsClient);
 
       String signedJwt = OauthApplication.generateSingedJwt(searchUserEmail, serviceAccountId);
 
@@ -155,14 +180,17 @@ void testGetAccessTokenSuccess() throws IOException {
     HttpRequest mockHttpRequest = mock(HttpRequest.class);
     when(mockHttpRequest.execute()).thenReturn(mockHttpResponse);
     HttpRequestFactory mockHttpRequestFactory = mock(HttpRequestFactory.class);
-    when(mockHttpRequestFactory.buildPostRequest(any(GenericUrl.class), any())).thenReturn(mockHttpRequest);
+    when(mockHttpRequestFactory.buildPostRequest(any(GenericUrl.class), any()))
+        .thenReturn(mockHttpRequest);
     HttpTransport mockHttpTransport = mock(HttpTransport.class);
     when(mockHttpTransport.createRequestFactory()).thenReturn(mockHttpRequestFactory);
 
-    try (MockedStatic<HttpTransport> mockedHttpTransport = Mockito.mockStatic(HttpTransport.class)) {
+    try (MockedStatic<HttpTransport> mockedHttpTransport =
+        Mockito.mockStatic(HttpTransport.class)) {
       mockedHttpTransport.when(HttpTransport::new).thenReturn(mockHttpTransport);
       when(mockHttpTransport.createRequestFactory()).thenReturn(mockHttpRequestFactory);
-      when(mockHttpRequestFactory.buildPostRequest(any(GenericUrl.class), any())).thenReturn(mockHttpRequest);
+      when(mockHttpRequestFactory.buildPostRequest(any(GenericUrl.class), any()))
+          .thenReturn(mockHttpRequest);
       when(mockHttpRequest.execute()).thenReturn(mockHttpResponse);
       when(mockHttpResponse.parseAs(GoogleTokenResponse.class)).thenReturn(mockGoogleTokenResponse);
 
diff --git a/helpers/exclusion_list.txt b/helpers/exclusion_list.txt
