Adding Java vendor to user agent and using it everywhere

spfink · spfink · commit 019cca1fc78e · 2019-03-19T11:06:01.000-07:00
diff --git a/.changes/next-release/feature-AWSSDKforJavav2-caed172.json b/.changes/next-release/feature-AWSSDKforJavav2-caed172.json
@@ -0,0 +1,5 @@
+{
+    "category": "AWS SDK for Java v2", 
+    "type": "feature", 
+    "description": "Adds the Java vendor the user agent as well as using the updated user agent for all HTTP calls"
+}
diff --git a/core/auth/src/test/java/software/amazon/awssdk/auth/credentials/ContainerCredentialsProviderTest.java b/core/auth/src/test/java/software/amazon/awssdk/auth/credentials/ContainerCredentialsProviderTest.java
@@ -16,6 +16,7 @@
 package software.amazon.awssdk.auth.credentials;
 
 import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
+import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;
 import static com.github.tomakehurst.wiremock.client.WireMock.get;
 import static com.github.tomakehurst.wiremock.client.WireMock.stubFor;
 import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
@@ -30,6 +31,7 @@
 import org.junit.ClassRule;
 import org.junit.Test;
 import software.amazon.awssdk.core.exception.SdkClientException;
+import software.amazon.awssdk.core.internal.util.UserAgentUtils;
 import software.amazon.awssdk.regions.util.ResourcesEndpointProvider;
 import software.amazon.awssdk.testutils.EnvironmentVariableHelper;
 
@@ -93,6 +95,7 @@ public void testGetCredentialsReturnsValidResponseFromEcsEndpoint() {
     private void stubForSuccessResponse() {
         stubFor(
             get(urlPathEqualTo(CREDENTIALS_PATH))
+                .withHeader("User-Agent", equalTo(UserAgentUtils.getUserAgent()))
                 .willReturn(aResponse()
                                 .withStatus(200)
                                 .withHeader("Content-Type", "application/json")
diff --git a/core/auth/src/test/java/software/amazon/awssdk/auth/credentials/HttpCredentialsProviderTest.java b/core/auth/src/test/java/software/amazon/awssdk/auth/credentials/HttpCredentialsProviderTest.java
@@ -16,6 +16,7 @@
 package software.amazon.awssdk.auth.credentials;
 
 import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
+import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;
 import static com.github.tomakehurst.wiremock.client.WireMock.get;
 import static com.github.tomakehurst.wiremock.client.WireMock.stubFor;
 import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
@@ -34,6 +35,7 @@
 import org.junit.ClassRule;
 import org.junit.Test;
 import software.amazon.awssdk.core.exception.SdkClientException;
+import software.amazon.awssdk.core.internal.util.UserAgentUtils;
 import software.amazon.awssdk.regions.util.ResourcesEndpointProvider;
 import software.amazon.awssdk.utils.DateUtils;
 import software.amazon.awssdk.utils.IoUtils;
@@ -130,6 +132,7 @@ public void basicCachingFunctionalityWorks() {
     private void stubForSuccessResponseWithCustomBody(String body) {
         stubFor(
             get(urlPathEqualTo(CREDENTIALS_PATH))
+                .withHeader("User-Agent", equalTo(UserAgentUtils.getUserAgent()))
                 .willReturn(aResponse()
                                 .withStatus(200)
                                 .withHeader("Content-Type", "application/json")
diff --git a/core/regions/src/main/java/software/amazon/awssdk/regions/util/ResourcesEndpointProvider.java b/core/regions/src/main/java/software/amazon/awssdk/regions/util/ResourcesEndpointProvider.java
@@ -20,7 +20,7 @@
 import java.util.HashMap;
 import java.util.Map;
 import software.amazon.awssdk.annotations.SdkProtectedApi;
-import software.amazon.awssdk.core.util.VersionInfo;
+import software.amazon.awssdk.core.internal.util.UserAgentUtils;
 
 /**
  * <p>
@@ -57,7 +57,7 @@ default ResourcesEndpointRetryPolicy retryPolicy() {
      */
     default Map<String, String> headers() {
         Map<String, String> requestHeaders = new HashMap<>();
-        requestHeaders.put("User-Agent", String.format("aws-sdk-java/%s", VersionInfo.SDK_VERSION));
+        requestHeaders.put("User-Agent", UserAgentUtils.getUserAgent());
         requestHeaders.put("Accept", "*/*");
         requestHeaders.put("Connection", "keep-alive");
 
diff --git a/core/regions/src/test/java/software/amazon/awssdk/regions/util/HttpCredentialsUtilsTest.java b/core/regions/src/test/java/software/amazon/awssdk/regions/util/HttpCredentialsUtilsTest.java
@@ -36,6 +36,7 @@
 import org.mockito.runners.MockitoJUnitRunner;
 import software.amazon.awssdk.core.exception.SdkClientException;
 import software.amazon.awssdk.core.exception.SdkServiceException;
+import software.amazon.awssdk.core.internal.util.UserAgentUtils;
 import software.amazon.awssdk.core.util.VersionInfo;
 import software.amazon.awssdk.regions.internal.util.ConnectionUtils;
 import software.amazon.awssdk.regions.internal.util.SocketUtils;
@@ -52,7 +53,7 @@ public class HttpCredentialsUtilsTest {
     private static Map<String, String> headers = new HashMap<String, String>()
     {
         {
-            put("User-Agent", String.format("aws-sdk-java/%s", VersionInfo.SDK_VERSION));
+            put("User-Agent", UserAgentUtils.getUserAgent());
             put("Accept", "*/*");
             put("Connection", "keep-alive");
         }
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/util/UserAgentUtils.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/util/UserAgentUtils.java
@@ -33,7 +33,8 @@
 public final class UserAgentUtils {
 
     private static final String UA_STRING = "aws-sdk-{platform}/{version} {os.name}/{os.version} {java.vm.name}/{java.vm"
-                                            + ".version} Java/{java.version}{language.and.region}{additional.languages}";
+                                            + ".version} Java/{java.version}{language.and.region}{additional.languages} "
+                                            + "vendor/{java.vendor}";
 
     /** Disallowed characters in the user agent token: @see <a href="https://tools.ietf.org/html/rfc7230#section-3.2.6">RFC 7230</a> */
     private static final String UA_BLACKLIST_REGEX = "[() ,/:;<=>?@\\[\\]{}\\\\]";
@@ -84,6 +85,7 @@ static String userAgent() {
                 .replace("{java.vm.name}", sanitizeInput(JavaSystemSetting.JAVA_VM_NAME.getStringValue().orElse(null)))
                 .replace("{java.vm.version}", sanitizeInput(JavaSystemSetting.JAVA_VM_VERSION.getStringValue().orElse(null)))
                 .replace("{java.version}", sanitizeInput(JavaSystemSetting.JAVA_VERSION.getStringValue().orElse(null)))
+                .replace("{java.vendor}", sanitizeInput(JavaSystemSetting.JAVA_VENDOR.getStringValue().orElse(null)))
                 .replace("{additional.languages}", getAdditionalJvmLanguages());
 
         Optional<String> language = JavaSystemSetting.USER_LANGUAGE.getStringValue();
diff --git a/core/sdk-core/src/test/java/software/amazon/awssdk/core/internal/util/UserAgentUtilsTest.java b/core/sdk-core/src/test/java/software/amazon/awssdk/core/internal/util/UserAgentUtilsTest.java
@@ -21,6 +21,7 @@
 import java.util.Arrays;
 import org.junit.Test;
 import software.amazon.awssdk.core.internal.util.UserAgentUtils;
+import software.amazon.awssdk.utils.JavaSystemSetting;
 
 public class UserAgentUtilsTest {
 
@@ -31,6 +32,21 @@ public void userAgent() {
         Arrays.stream(userAgent.split(" ")).forEach(str -> assertThat(isValidInput(str)).isTrue());
     }
 
+    @Test
+    public void userAgent_HasVendor() {
+        System.setProperty(JavaSystemSetting.JAVA_VENDOR.property(), "finks");
+        String userAgent = UserAgentUtils.userAgent();
+        System.clearProperty(JavaSystemSetting.JAVA_VENDOR.property());
+        assertThat(userAgent).contains("vendor/finks");
+    }
+
+    @Test
+    public void userAgent_HasUnknownVendor() {
+        System.clearProperty(JavaSystemSetting.JAVA_VENDOR.property());
+        String userAgent = UserAgentUtils.userAgent();
+        assertThat(userAgent).contains("vendor/unknown");
+    }
+
     private boolean isValidInput(String input) {
         return input.startsWith("(") || input.contains("/") && input.split("/").length == 2;
     }
diff --git a/utils/src/main/java/software/amazon/awssdk/utils/JavaSystemSetting.java b/utils/src/main/java/software/amazon/awssdk/utils/JavaSystemSetting.java
@@ -23,6 +23,7 @@
 @SdkProtectedApi
 public enum JavaSystemSetting implements SystemSetting {
     JAVA_VERSION("java.version"),
+    JAVA_VENDOR("java.vendor"),
     TEMP_DIRECTORY("java.io.tmpdir"),
     JAVA_VM_NAME("java.vm.name"),
     JAVA_VM_VERSION("java.vm.version"),

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@`
`36`	`36`	`import org.mockito.runners.MockitoJUnitRunner;`
`37`	`37`	`import software.amazon.awssdk.core.exception.SdkClientException;`
`38`	`38`	`import software.amazon.awssdk.core.exception.SdkServiceException;`
	`39`	`+import software.amazon.awssdk.core.internal.util.UserAgentUtils;`
`39`	`40`	`import software.amazon.awssdk.core.util.VersionInfo;`
`40`	`41`	`import software.amazon.awssdk.regions.internal.util.ConnectionUtils;`
`41`	`42`	`import software.amazon.awssdk.regions.internal.util.SocketUtils;`
`@@ -52,7 +53,7 @@ public class HttpCredentialsUtilsTest {`
`52`	`53`	`private static Map<String, String> headers = new HashMap<String, String>()`
`53`	`54`	`{`
`54`	`55`	`{`
`55`		`- put("User-Agent", String.format("aws-sdk-java/%s", VersionInfo.SDK_VERSION));`
	`56`	`+ put("User-Agent", UserAgentUtils.getUserAgent());`
`56`	`57`	`put("Accept", "/");`
`57`	`58`	`put("Connection", "keep-alive");`
`58`	`59`	`}`