Merge pull request #12 from jenkinsci/feature/SIGN-6572

SIGN-6572 - log plug-in, JDK, and Jenkins versions to User-Agent header
jenkinsci · Jan 8, 2024 · 4e8a1e6 · 4e8a1e6
2 parents cbc1518 + 5e5ceec
commit 4e8a1e6
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/pom.xml b/pom.xml
@@ -45,7 +45,7 @@
         <dependency>
             <groupId>io.signpath.javaclient</groupId>
             <artifactId>api-client</artifactId>
-            <version>1.0.7</version>
+            <version>1.0.8</version>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>

diff --git a/.../java/io/jenkins/plugins/signpath/ApiIntegration/SignPathClient/SignPathClientFacade.java b/.../java/io/jenkins/plugins/signpath/ApiIntegration/SignPathClient/SignPathClientFacade.java
@@ -1,5 +1,6 @@
 package io.jenkins.plugins.signpath.ApiIntegration.SignPathClient;
 //</editor-fold>
+import hudson.util.VersionNumber;
 import io.jenkins.plugins.signpath.ApiIntegration.ApiConfiguration;
 import io.jenkins.plugins.signpath.ApiIntegration.Model.SigningRequestModel;
 import io.jenkins.plugins.signpath.ApiIntegration.Model.SigningRequestOriginModel;
@@ -20,6 +21,7 @@
 import java.util.UUID;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import jenkins.model.Jenkins;
 
 public class SignPathClientFacade implements SignPathFacade {
 
@@ -41,7 +43,8 @@ public SignPathClientFacade(SignPathCredentials credentials, ApiConfiguration ap
                 apiConfiguration.getServiceUnavailableTimeoutInSeconds(),
                 apiConfiguration.getUploadAndDownloadRequestTimeoutInSeconds(),
                 apiConfiguration.getWaitForCompletionTimeoutInSeconds(),
-                apiConfiguration.getWaitBetweenReadinessChecksInSeconds()
+                apiConfiguration.getWaitBetweenReadinessChecksInSeconds(),
+                buildUserAgent()
             ));
     }
 
@@ -129,5 +132,14 @@ private Map<String, String> buildOriginData(SigningRequestModel submitModel){
         originParameters.put("RepositoryData.SourceControlManagementType", origin.getRepositoryMetadata().getSourceControlManagementType());
 
         return originParameters;
-    } 
+    }
+
+    private String buildUserAgent(){
+
+        return String.format("SignPath.Plugins.Jenkins/%1$s (OpenJDK %2$s; Jenkins %3$s)",
+                SignPathClientFacade.class.getPackage().getImplementationVersion(),
+                System.getProperty("java.version"),
+                Jenkins.getVersion()
+                );
+    }
 }