[Test Proxy] Maps Geolocation migration (Azure#35871)

* Added exports statements to POM required for local testing.

* Changed test classes to use TestProxyTestBase and refactored tests to include the user of a user agent, retry logic and better HTTP logging.

* Re-recorded tests.

* Migrated test recordings to assets repo.

* Applied PR feedback.

* Removed unused import.

* Applied more PR feedback.

Author: vcolin7

sdk/maps/azure-maps-geolocation/assets.json

@@ -0,0 +1,6 @@
+{
+  "AssetsRepo": "Azure/azure-sdk-assets",
+  "AssetsRepoPrefixPath": "java",
+  "TagPrefix": "java/maps/azure-maps-geolocation",
+  "Tag": "java/maps/azure-maps-geolocation_0f5507c629"
+}

sdk/maps/azure-maps-geolocation/pom.xml

@@ -44,6 +44,11 @@
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <legal><![CDATA[[INFO] Any downloads listed may be third party software.  Microsoft grants you no rights for third party software.]]></legal>
+    <!-- Configures the Java 9+ run to perform the required module exports, opens, and reads that are necessary for testing but shouldn't be part of the module-info. -->
+    <javaModulesSurefireArgLine>
+      --add-exports com.azure.core/com.azure.core.implementation.http=ALL-UNNAMED
+      --add-exports com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
+    </javaModulesSurefireArgLine>
   </properties>
 
   <dependencies>

sdk/maps/azure-maps-geolocation/src/main/java/com/azure/maps/geolocation/GeolocationClient.java

@@ -35,21 +35,21 @@ public final class GeolocationClient {
     /**
      * Initializes an instance of GeolocationClient client.
      *
-     * @param serviceClient the service client implementation.
+     * @param asyncClient the service client implementation.
      */
     GeolocationClient(GeolocationAsyncClient asyncClient) {
         this.asyncClient = asyncClient;
     }
 
     /**
      * Get Location
-     * 
+     *
      * <!-- src_embed com.azure.maps.geolocation.sync.get_ip_to_location -->
      * <pre>
      * client.getLocation&#40;&quot;131.107.0.89&quot;&#41;;
      * </pre>
      * <!-- end com.azure.maps.geolocation.sync.get_ip_to_location -->
-     * 
+     *
      * **Applies to**: S0 and S1 pricing tiers.
      *
      * <p>This service will return the ISO country code for the provided IP address. Developers can use this information
@@ -68,13 +68,13 @@ public IpAddressToLocationResult getLocation(String ipAddress) {
 
     /**
      * Get Location
-     * 
+     *
      * <!-- src_embed com.azure.maps.geolocation.sync.get_ip_to_location -->
      * <pre>
      * client.getLocation&#40;&quot;131.107.0.89&quot;&#41;;
      * </pre>
      * <!-- end com.azure.maps.geolocation.sync.get_ip_to_location -->
-     * 
+     *
      * **Applies to**: S0 and S1 pricing tiers.
      *
      * <p>This service will return the ISO country code for the provided IP address. Developers can use this information

sdk/maps/azure-maps-geolocation/src/main/java/com/azure/maps/geolocation/GeolocationClientBuilder.java

@@ -67,13 +67,14 @@ public final class GeolocationClientBuilder implements AzureKeyCredentialTrait<G
     // constants
     private static final String SDK_NAME = "name";
     private static final String SDK_VERSION = "version";
-    private static final String GEOLOCATION_SUBSCRIPTION_KEY = "subscription-key";
     private static final String X_MS_CLIENT_ID = "x-ms-client-id";
-    //subscription-key
-
-    // instance fields
     private static final ClientLogger LOGGER = new ClientLogger(GeolocationClientBuilder.class);
     private final Map<String, String> properties = new HashMap<>();
+
+    // subscription-key
+    static final String GEOLOCATION_SUBSCRIPTION_KEY = "subscription-key";
+
+    // instance fields
     private String endpoint;
     private GeolocationServiceVersion serviceVersion;
     /*

sdk/maps/azure-maps-geolocation/src/test/java/com/azure/maps/geolocation/GeolocationClientTestBase.java

@@ -3,95 +3,114 @@
 
 package com.azure.maps.geolocation;
 
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertNotNull;
-
-import java.time.Duration;
-import java.util.ArrayList;
-import java.util.List;
-
 import com.azure.core.credential.AzureKeyCredential;
-import com.azure.core.credential.TokenCredential;
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.HttpPipeline;
 import com.azure.core.http.HttpPipelineBuilder;
-import com.azure.core.http.policy.BearerTokenAuthenticationPolicy;
+import com.azure.core.http.policy.AzureKeyCredentialPolicy;
+import com.azure.core.http.policy.ExponentialBackoff;
 import com.azure.core.http.policy.HttpLogDetailLevel;
 import com.azure.core.http.policy.HttpLogOptions;
+import com.azure.core.http.policy.HttpLoggingPolicy;
 import com.azure.core.http.policy.HttpPipelinePolicy;
+import com.azure.core.http.policy.HttpPolicyProviders;
+import com.azure.core.http.policy.RetryPolicy;
+import com.azure.core.http.policy.UserAgentPolicy;
 import com.azure.core.http.rest.Response;
 import com.azure.core.test.InterceptorManager;
-import com.azure.core.test.TestBase;
-import com.azure.core.test.TestMode;
+import com.azure.core.test.TestProxyTestBase;
+import com.azure.core.test.models.CustomMatcher;
+import com.azure.core.test.models.TestProxyRequestMatcher;
+import com.azure.core.test.models.TestProxySanitizer;
+import com.azure.core.test.models.TestProxySanitizerType;
 import com.azure.core.util.Configuration;
-import com.azure.identity.EnvironmentCredentialBuilder;
 import com.azure.maps.geolocation.models.IpAddressToLocationResult;
 
-public class GeolocationClientTestBase extends TestBase {
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+public class GeolocationClientTestBase extends TestProxyTestBase {
+    private static final String SDK_NAME = "client_name";
+    private static final String SDK_VERSION = "client_version";
+
     static final String FAKE_API_KEY = "fakeKeyPlaceholder";
 
-    private final String endpoint = Configuration.getGlobalConfiguration().get("API-LEARN_ENDPOINT");
-    Duration durationTestMode;
     static InterceptorManager interceptorManagerTestBase;
 
+    Duration durationTestMode;
+
     @Override
     protected void beforeTest() {
         if (interceptorManager.isPlaybackMode()) {
             durationTestMode = Duration.ofMillis(1);
         } else {
             durationTestMode = TestUtils.DEFAULT_POLL_INTERVAL;
         }
+
         interceptorManagerTestBase = interceptorManager;
     }
 
-    GeolocationClientBuilder getGeoLocationAsyncClientBuilder(HttpClient httpClient, GeolocationServiceVersion serviceVersion) {
+    GeolocationClientBuilder getGeoLocationAsyncClientBuilder(HttpClient httpClient,
+                                                              GeolocationServiceVersion serviceVersion) {
         GeolocationClientBuilder builder = new GeolocationClientBuilder()
+            .pipeline(getHttpPipeline(httpClient))
             .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
             .serviceVersion(serviceVersion);
-        String endpoint = getEndpoint();
-        if (getEndpoint() != null) {
-            builder.endpoint(endpoint);
-        }
-        if (getTestMode() == TestMode.RECORD) {
-            builder.addPolicy(interceptorManager.getRecordPolicy());
-        }
-        if (getTestMode() == TestMode.PLAYBACK) {
-            builder.credential(new AzureKeyCredential(FAKE_API_KEY)).httpClient(interceptorManager.getPlaybackClient());
-        } else {
-            builder.credential((new AzureKeyCredential(
-                Configuration.getGlobalConfiguration().get("SUBSCRIPTION_KEY"))));
+
+        if (interceptorManager.isPlaybackMode()) {
+            builder.endpoint("https://localhost:8080");
         }
+
         return builder;
     }
 
     HttpPipeline getHttpPipeline(HttpClient httpClient) {
-        TokenCredential credential = null;
+        httpClient = interceptorManager.isPlaybackMode() ? interceptorManager.getPlaybackClient() : httpClient;
 
-        if (!interceptorManager.isPlaybackMode()) {
-            credential = new EnvironmentCredentialBuilder().httpClient(httpClient).build();
+        if (interceptorManager.isRecordMode()) {
+            interceptorManager.addSanitizers(
+                Collections.singletonList(
+                    new TestProxySanitizer("subscription-key", ".+", "REDACTED", TestProxySanitizerType.HEADER)));
         }
 
-        final List<HttpPipelinePolicy> policies = new ArrayList<>();
-        if (credential != null) {
-            policies.add(new BearerTokenAuthenticationPolicy(credential, endpoint.replaceFirst("/$", "") + "/.default"));
+        if (interceptorManager.isPlaybackMode()) {
+            List<TestProxyRequestMatcher> customMatchers = new ArrayList<>();
+
+            customMatchers.add(new CustomMatcher().setHeadersKeyOnlyMatch(Collections.singletonList("subscription-key")));
+            interceptorManager.addMatchers(customMatchers);
         }
 
-        if (getTestMode() == TestMode.RECORD) {
+        final List<HttpPipelinePolicy> policies = new ArrayList<>();
+
+        policies.add(new UserAgentPolicy(null, SDK_NAME, SDK_VERSION, Configuration.getGlobalConfiguration().clone()));
+
+        HttpPolicyProviders.addBeforeRetryPolicies(policies);
+
+        policies.add(new RetryPolicy(new ExponentialBackoff(5, Duration.ofSeconds(2), Duration.ofSeconds(16))));
+        policies.add(
+            new AzureKeyCredentialPolicy(
+                GeolocationClientBuilder.GEOLOCATION_SUBSCRIPTION_KEY,
+                new AzureKeyCredential(interceptorManager.isPlaybackMode()
+                    ? FAKE_API_KEY
+                    : Configuration.getGlobalConfiguration().get("SUBSCRIPTION_KEY"))));
+
+        HttpPolicyProviders.addAfterRetryPolicies(policies);
+
+        policies.add(new HttpLoggingPolicy(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS)));
+
+        if (interceptorManager.isRecordMode()) {
             policies.add(interceptorManager.getRecordPolicy());
         }
 
-        HttpPipeline pipeline = new HttpPipelineBuilder()
+        return new HttpPipelineBuilder()
             .policies(policies.toArray(new HttpPipelinePolicy[0]))
-            .httpClient(httpClient == null ? interceptorManager.getPlaybackClient() : httpClient)
+            .httpClient(interceptorManager.isPlaybackMode() ? interceptorManager.getPlaybackClient() : httpClient)
             .build();
-
-        return pipeline;
-    }
-
-    String getEndpoint() {
-        return interceptorManager.isPlaybackMode()
-            ? "https://localhost:8080"
-            : endpoint;
     }
 
     static void validateGetLocation(IpAddressToLocationResult expected, IpAddressToLocationResult actual) {
@@ -101,7 +120,8 @@ static void validateGetLocation(IpAddressToLocationResult expected, IpAddressToL
         assertEquals(expected.getIpAddress(), actual.getIpAddress());
     }
 
-    static void validateGetLocationWithResponse(IpAddressToLocationResult expected, int expectedStatusCode, Response<IpAddressToLocationResult> response) {
+    static void validateGetLocationWithResponse(IpAddressToLocationResult expected, int expectedStatusCode,
+                                                Response<IpAddressToLocationResult> response) {
         assertNotNull(response);
         assertEquals(expectedStatusCode, response.getStatusCode());
         validateGetLocation(expected, response.getValue());