jenkins review fix (#65)

Traceableai · Aug 14, 2024 · c189b2e · c189b2e
1 parent e2a2aa1
commit c189b2e
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 40 deletions.
diff --git a/src/main/java/io/jenkins/plugins/traceable/ast/TraceableASTGenerateReportAction.java b/src/main/java/io/jenkins/plugins/traceable/ast/TraceableASTGenerateReportAction.java
@@ -19,6 +19,7 @@ public class TraceableASTGenerateReportAction implements RunAction2 {
     private Secret clientToken;
     private String traceableRootCaFileName;
     private String traceableCliCertFileName;
+    // lgtm[jenkins/plaintext-storage]
     private String traceableCliKeyFileName;
     private final FilePath workspace;
     private final TaskListener listener;

diff --git a/src/main/java/io/jenkins/plugins/traceable/ast/TraceableApiInspectorStepBuilder.java b/src/main/java/io/jenkins/plugins/traceable/ast/TraceableApiInspectorStepBuilder.java
@@ -9,6 +9,7 @@
 import hudson.model.TaskListener;
 import hudson.tasks.BuildStepDescriptor;
 import hudson.tasks.Builder;
+import hudson.util.Secret;
 import io.jenkins.plugins.traceable.ast.scan.utils.ApiInspector;
 import java.io.IOException;
 import jenkins.tasks.SimpleBuildStep;
@@ -23,7 +24,7 @@ public class TraceableApiInspectorStepBuilder extends Builder implements SimpleB
     private String repoPath;
     private String specFilePath;
     private String traceableServer;
-    private String traceableToken;
+    private static Secret traceableToken;
     private StringBuilder report;
 
     public String getRepoPath() {
@@ -38,7 +39,7 @@ public String getTraceableServer() {
         return traceableServer;
     }
 
-    public String getTraceableToken() {
+    public static Secret getTraceableToken() {
         return traceableToken;
     }
 
@@ -58,8 +59,8 @@ public void setTraceableServer(String traceableServer) {
     }
 
     @DataBoundSetter
-    public void setTraceableToken(String traceableToken) {
-        this.traceableToken = traceableToken;
+    public static void setTraceableToken(Secret traceableToken) {
+        TraceableApiInspectorStepBuilder.traceableToken = traceableToken;
     }
 
     @DataBoundConstructor
@@ -79,7 +80,8 @@ public void perform(Run<?, ?> run, FilePath workspace, EnvVars env, Launcher lau
         if (StringUtils.isBlank(specFilePath)) {
             findAndInspect(workspace, listener, repoWorkspacePath, scriptPath);
         } else {
-            String[] args = new String[] {traceableServer, traceableToken, specFilePath};
+            String absoluteSpecFilePath = repoWorkspacePath + "/" + specFilePath;
+            String[] args = new String[] {traceableServer, traceableToken.getPlainText(), absoluteSpecFilePath};
             report.append(runScript(workspace, listener, scriptPath, args, true));
         }
 
@@ -101,7 +103,7 @@ private void findAndInspect(
         }
 
         for (String specFile : specFilePathsList) {
-            String[] args = new String[] {traceableServer, traceableToken, specFile};
+            String[] args = new String[] {traceableServer, traceableToken.getPlainText(), specFile};
             String newOpenApiSpecString =
                     "========================================\nUploading open api spec : " + specFile + "\n";
             listener.getLogger().println(newOpenApiSpecString);

diff --git a/src/main/java/io/jenkins/plugins/traceable/ast/scan/utils/ApiInspector.java b/src/main/java/io/jenkins/plugins/traceable/ast/scan/utils/ApiInspector.java
@@ -2,7 +2,6 @@
 
 import com.google.common.base.Charsets;
 import com.google.common.io.CharStreams;
-import hudson.FilePath.FileCallable;
 import hudson.model.TaskListener;
 import hudson.remoting.VirtualChannel;
 import java.io.BufferedWriter;
@@ -17,9 +16,9 @@
 import java.util.Objects;
 import java.util.Scanner;
 import java.util.UUID;
-import org.jenkinsci.remoting.RoleChecker;
+import jenkins.MasterToSlaveFileCallable;
 
-public class ApiInspector implements FileCallable<String> {
+public class ApiInspector extends MasterToSlaveFileCallable<String> {
 
     private final TaskListener listener;
     private final String scriptPath;
@@ -46,11 +45,6 @@ public String invoke(File f, VirtualChannel channel) throws IOException, Interru
         return returnOutput.toString();
     }
 
-    @Override
-    public void checkRoles(RoleChecker checker) throws SecurityException {
-        return;
-    }
-
     private void copyScript() throws IOException {
 
         String bundledScript = CharStreams.toString(new InputStreamReader(

diff --git a/src/main/java/io/jenkins/plugins/traceable/ast/scan/utils/DownloadTraceableCliBinary.java b/src/main/java/io/jenkins/plugins/traceable/ast/scan/utils/DownloadTraceableCliBinary.java
@@ -1,6 +1,5 @@
 package io.jenkins.plugins.traceable.ast.scan.utils;
 
-import hudson.FilePath.FileCallable;
 import hudson.remoting.VirtualChannel;
 import java.io.BufferedInputStream;
 import java.io.BufferedReader;
@@ -10,9 +9,9 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.net.URL;
-import org.jenkinsci.remoting.RoleChecker;
+import jenkins.MasterToSlaveFileCallable;
 
-public class DownloadTraceableCliBinary implements FileCallable<Void> {
+public class DownloadTraceableCliBinary extends MasterToSlaveFileCallable<Void> {
 
     private String workspacePath;
     private String version;
@@ -50,12 +49,6 @@ public Void invoke(File f, VirtualChannel channel) throws IOException, Interrupt
         return null;
     }
 
-    @Override
-    public void checkRoles(RoleChecker checker) throws SecurityException {
-        // We want this to be able to run on any type of machine (controller or agent)
-        return;
-    }
-
     private String getKernelName() throws IOException, InterruptedException {
         String[] command = {"uname", "-s"};
         ProcessBuilder pb = new ProcessBuilder(command);

diff --git a/src/main/java/io/jenkins/plugins/traceable/ast/scan/utils/GenerateReport.java b/src/main/java/io/jenkins/plugins/traceable/ast/scan/utils/GenerateReport.java
@@ -2,7 +2,6 @@
 
 import com.google.common.base.Charsets;
 import com.google.common.io.CharStreams;
-import hudson.FilePath.FileCallable;
 import hudson.remoting.VirtualChannel;
 import java.io.BufferedWriter;
 import java.io.File;
@@ -17,9 +16,9 @@
 import java.util.UUID;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
-import org.jenkinsci.remoting.RoleChecker;
+import jenkins.MasterToSlaveFileCallable;
 
-public class GenerateReport implements FileCallable<String[]> {
+public class GenerateReport extends MasterToSlaveFileCallable<String[]> {
 
     private final String scriptPath;
     private String[] args;
@@ -47,11 +46,6 @@ public String[] invoke(File f, VirtualChannel channel) throws IOException, Inter
         return ret;
     }
 
-    @Override
-    public void checkRoles(RoleChecker checker) throws SecurityException {
-        return;
-    }
-
     private void copyScript() throws IOException {
 
         String bundledScript = CharStreams.toString(new InputStreamReader(

diff --git a/src/main/java/io/jenkins/plugins/traceable/ast/scan/utils/RunScript.java b/src/main/java/io/jenkins/plugins/traceable/ast/scan/utils/RunScript.java
@@ -2,7 +2,6 @@
 
 import com.google.common.base.Charsets;
 import com.google.common.io.CharStreams;
-import hudson.FilePath.FileCallable;
 import hudson.model.TaskListener;
 import hudson.remoting.VirtualChannel;
 import java.io.BufferedWriter;
@@ -17,10 +16,10 @@
 import java.util.Objects;
 import java.util.Scanner;
 import java.util.UUID;
+import jenkins.MasterToSlaveFileCallable;
 import org.apache.commons.lang.StringUtils;
-import org.jenkinsci.remoting.RoleChecker;
 
-public class RunScript implements FileCallable<String> {
+public class RunScript extends MasterToSlaveFileCallable<String> {
 
     private final TaskListener listener;
     private final String scriptPath;
@@ -46,12 +45,6 @@ public String invoke(File f, VirtualChannel channel) throws IOException, Interru
         return RunScript.scanId;
     }
 
-    @Override
-    public void checkRoles(RoleChecker checker) throws SecurityException {
-        // We want this to be able to run on any type of machine (controller or agent)
-        return;
-    }
-
     private void copyScript() throws IOException {
 
         String bundledScript = CharStreams.toString(new InputStreamReader(