Merge pull request #116 from snyk/feat/include-artifactory-version-in-user-agent

feat: include artifactory version in user agent

Author: jacek-rzrz

core/src/main/java/io/snyk/plugins/artifactory/SnykPlugin.java

@@ -1,6 +1,7 @@
 package io.snyk.plugins.artifactory;
 
 import io.snyk.plugins.artifactory.audit.AuditModule;
+import io.snyk.plugins.artifactory.configuration.UserAgent;
 import io.snyk.plugins.artifactory.configuration.properties.ArtifactProperty;
 import io.snyk.plugins.artifactory.configuration.ConfigurationModule;
 import io.snyk.plugins.artifactory.exception.CannotScanException;
@@ -33,7 +34,6 @@
 public class SnykPlugin {
 
   private static final Logger LOG = LoggerFactory.getLogger(SnykPlugin.class);
-  private static final String API_USER_AGENT = "snyk-artifactory-plugin/";
 
   private ConfigurationModule configurationModule;
   private AuditModule auditModule;
@@ -155,7 +155,7 @@ private SnykClient createSnykClient(@Nonnull ConfigurationModule configurationMo
     var config = SnykConfig.newBuilder()
       .setBaseUrl(baseUrl)
       .setToken(token)
-      .setUserAgent(API_USER_AGENT + pluginVersion)
+      .setUserAgent(UserAgent.getUserAgent(pluginVersion))
       .setTrustAllCertificates(trustAllCertificates)
       .setSslCertificatePath(sslCertificatePath)
       .setHttpProxyHost(httpProxyHost)

core/src/main/java/io/snyk/plugins/artifactory/configuration/UserAgent.java

@@ -0,0 +1,23 @@
+package io.snyk.plugins.artifactory.configuration;
+
+import java.util.Optional;
+import java.util.function.Function;
+
+public class UserAgent {
+  private static final String PREFIX = "snyk-artifactory-plugin/";
+  public static String ARTIFACTORY_VERSION_ENV = "ARTIFACTORY_VERSION";
+
+  public static String getUserAgent(String pluginVersion) {
+    return getUserAgent(pluginVersion, System::getenv);
+  }
+
+  public static String getUserAgent(String pluginVersion, Function<String, String> getEnv) {
+    String pluginPart = PREFIX + pluginVersion;
+
+    String artifactoryPart = Optional.ofNullable(getEnv.apply(ARTIFACTORY_VERSION_ENV))
+      .map(v -> " artifactory/" + v)
+      .orElse("");
+
+    return pluginPart + artifactoryPart;
+  }
+}

core/src/test/java/io/snyk/plugins/artifactory/configuration/UserAgentTest.java

@@ -0,0 +1,29 @@
+package io.snyk.plugins.artifactory.configuration;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static io.snyk.plugins.artifactory.configuration.UserAgent.ARTIFACTORY_VERSION_ENV;
+import static org.junit.jupiter.api.Assertions.*;
+
+class UserAgentTest {
+
+  @Test
+  void whenArtifactoryVersionEnvAvailable() {
+    Map<String, String> env = new HashMap<>();
+    env.put(ARTIFACTORY_VERSION_ENV, "1.2.3");
+
+    String userAgent = UserAgent.getUserAgent("3.4.5", env::get);
+
+    assertEquals("snyk-artifactory-plugin/3.4.5 artifactory/1.2.3", userAgent);
+  }
+
+  @Test
+  void whenArtifactoryVersionEnvNotAvailable() {
+    String userAgent = UserAgent.getUserAgent("3.4.5", env -> null);
+
+    assertEquals("snyk-artifactory-plugin/3.4.5", userAgent);
+  }
+}