fix: set user agent (#402)

* fix: set user agent

Signed-off-by: Tomasz Janiszewski <tomek@redhat.com>

* replace whitespace with _

Signed-off-by: Tomasz Janiszewski <tomek@redhat.com>

* fix

Signed-off-by: Tomasz Janiszewski <tomek@redhat.com>

* fix

Signed-off-by: Tomasz Janiszewski <tomek@redhat.com>

---------

Signed-off-by: Tomasz Janiszewski <tomek@redhat.com>

Author: janisz

stackrox-container-image-scanner/src/main/java/com/stackrox/jenkins/plugins/services/ApiClientFactory.java

@@ -24,11 +24,17 @@
 import com.google.common.cache.CacheBuilder;
 import com.google.common.cache.CacheLoader;
 import com.google.common.cache.LoadingCache;
+import hudson.PluginWrapper;
+import jenkins.model.Jenkins;
 import lombok.Data;
+import okhttp3.Interceptor;
 import okhttp3.OkHttpClient;
 
 import com.stackrox.invoker.ApiClient;
 
+import okhttp3.Response;
+import org.jetbrains.annotations.NotNull;
+
 public class ApiClientFactory {
 
     public enum StackRoxTlsValidationMode {
@@ -96,6 +102,7 @@ private static OkHttpClient newHttpClient(@Nullable String caCert, StackRoxTlsVa
         builder.connectTimeout(TIMEOUT);
         builder.readTimeout(TIMEOUT);
         builder.writeTimeout(TIMEOUT);
+        builder.addNetworkInterceptor(new UserAgentInterceptor());
         return builder.build();
     }
 
@@ -156,4 +163,39 @@ private static SSLContext getSslContext(TrustManager[] trustManagers) throws NoS
         sslContext.init(null, trustManagers, null);
         return sslContext;
     }
+
+    public static class UserAgentInterceptor implements Interceptor {
+        private static final String STACKROX_CONTAINER_IMAGE_SCANNER = "stackrox-container-image-scanner";
+        private static final String VALUE = String.format("%s%s (%s; %s) %s",
+                STACKROX_CONTAINER_IMAGE_SCANNER,
+                getVersion(),
+                System.getProperty("os.name"),
+                System.getProperty("os.arch"),
+                "CI"
+        );
+
+        @NotNull
+        @Override
+        public Response intercept(@NotNull Chain chain) throws IOException {
+            return chain.proceed(
+                    chain.request()
+                            .newBuilder()
+                            .header("User-Agent", VALUE)
+                            .build()
+            );
+        }
+
+        static String getVersion() {
+            Jenkins jenkins = Jenkins.getInstanceOrNull();
+            if (jenkins == null) {
+                return "";
+            }
+
+            PluginWrapper plugin = jenkins.pluginManager.getPlugin(STACKROX_CONTAINER_IMAGE_SCANNER);
+            if (plugin == null) {
+                return "";
+            }
+            return String.format("/%s:%s", plugin.getVersion(), Jenkins.getVersion()).replaceAll("\\s+", "_");
+        }
+    }
 }

stackrox-container-image-scanner/src/test/java/com/stackrox/jenkins/plugins/services/ApiClientFactoryTest.java

@@ -2,6 +2,7 @@
 
 import static com.github.tomakehurst.wiremock.client.WireMock.anyUrl;
 import static com.github.tomakehurst.wiremock.client.WireMock.get;
+import static com.github.tomakehurst.wiremock.client.WireMock.matching;
 import static com.github.tomakehurst.wiremock.client.WireMock.ok;
 import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
 import static com.stackrox.jenkins.plugins.services.ApiClientFactory.StackRoxTlsValidationMode.VALIDATE;
@@ -36,12 +37,13 @@ class ApiClientFactoryTest {
 
     @BeforeAll
     static void beforeAll() {
-        SERVER.stubFor(get(anyUrl()).willReturn(ok().withBody("{}")));
+        SERVER.stubFor(get(anyUrl()).withHeader("User-Agent", matching("stackrox-container-image-scanner .* CI")).willReturn(ok().withBody("{}")));
         SERVER.start();
     }
 
     @AfterAll
     static void cleanup() {
+
         SERVER.stop();
     }