Split GroovyScript for agent and controller

mtughan · mtughan · commit 5d0d63f4a51e · 2024-11-22T11:41:03.000-05:00
Make GroovyScript simpler by separating the parts meant only for the
controller into a new class that extends GroovyScript. This also makes
the intention of each class and the differences between them clearer
from the names themselves.
diff --git a/src/main/java/org/jenkinsci/plugins/scriptler/builder/ScriptlerBuilder.java b/src/main/java/org/jenkinsci/plugins/scriptler/builder/ScriptlerBuilder.java
@@ -45,6 +45,7 @@
 import org.jenkinsci.plugins.scriptler.config.Parameter;
 import org.jenkinsci.plugins.scriptler.config.Script;
 import org.jenkinsci.plugins.scriptler.config.ScriptlerConfiguration;
+import org.jenkinsci.plugins.scriptler.util.ControllerGroovyScript;
 import org.jenkinsci.plugins.scriptler.util.GroovyScript;
 import org.jenkinsci.plugins.scriptler.util.ScriptHelper;
 import org.jenkinsci.plugins.scriptler.util.UIHelper;
@@ -256,8 +257,8 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
             final Object output;
             if (script.onlyController) {
                 // When run on controller, make build, launcher, listener available to script
-                output = FilePath.localChannel.call(
-                        new GroovyScript(script.getScriptText(), expandedParams, true, listener, launcher, build));
+                output = FilePath.localChannel.call(new ControllerGroovyScript(
+                        script.getScriptText(), expandedParams, true, listener, launcher, build));
             } else {
                 VirtualChannel channel = launcher.getChannel();
                 if (channel == null) {
diff --git a/src/main/java/org/jenkinsci/plugins/scriptler/tokenmacro/ScriptlerTokenMacro.java b/src/main/java/org/jenkinsci/plugins/scriptler/tokenmacro/ScriptlerTokenMacro.java
@@ -8,9 +8,11 @@
 import hudson.remoting.ChannelClosedException;
 import hudson.remoting.VirtualChannel;
 import java.io.IOException;
-import java.util.Collections;
+import java.util.List;
+import jenkins.model.Jenkins;
 import org.jenkinsci.plugins.scriptler.Messages;
 import org.jenkinsci.plugins.scriptler.config.Script;
+import org.jenkinsci.plugins.scriptler.util.ControllerGroovyScript;
 import org.jenkinsci.plugins.scriptler.util.GroovyScript;
 import org.jenkinsci.plugins.scriptler.util.ScriptHelper;
 import org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro;
@@ -39,21 +41,23 @@ public String evaluate(AbstractBuild<?, ?> context, TaskListener listener, Strin
             throw new MacroEvaluationException(Messages.tokenmacro_AdminScriptOnly(scriptId));
         }
 
+        String scriptText = script.getScriptText();
         VirtualChannel channel;
-        if (script.onlyController) {
+        GroovyScript groovyScript;
+        if (script.onlyController || Jenkins.get().equals(context.getBuiltOn())) {
             channel = FilePath.localChannel;
+            groovyScript = new ControllerGroovyScript(scriptText, List.of(), true, listener, null, context);
         } else {
             FilePath remoteFilePath = context.getWorkspace();
             if (remoteFilePath == null) {
                 // the remote node has apparently disconnected, so we can't run our script
                 throw new ChannelClosedException((Channel) null, null);
             }
             channel = remoteFilePath.getChannel();
+            groovyScript = new GroovyScript(scriptText, List.of(), true, listener);
         }
 
-        Object output = channel.call(
-                new GroovyScript(script.getScriptText(), Collections.emptyList(), true, listener, null, context));
-
+        Object output = channel.call(groovyScript);
         return output != null ? output.toString() : "";
     }
 
diff --git a/src/main/java/org/jenkinsci/plugins/scriptler/util/ControllerGroovyScript.java b/src/main/java/org/jenkinsci/plugins/scriptler/util/ControllerGroovyScript.java
@@ -0,0 +1,56 @@
+package org.jenkinsci.plugins.scriptler.util;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+import groovy.lang.GroovyShell;
+import hudson.Launcher;
+import hudson.model.AbstractBuild;
+import hudson.model.TaskListener;
+import java.io.Serial;
+import java.util.Collection;
+import jenkins.model.Jenkins;
+import org.jenkinsci.plugins.scriptler.config.Parameter;
+
+public class ControllerGroovyScript extends GroovyScript {
+    @Serial
+    private static final long serialVersionUID = 1L;
+
+    private final transient AbstractBuild<?, ?> build;
+    private final transient Launcher launcher;
+
+    /**
+     * This constructor can only be used when the script is executed on the controller, because launcher and build can not be transferred to an agent and therefore the execution will fail
+     * @param script the script to be executed
+     * @param parameters the parameters to be passed to the script
+     * @param failWithException should the job fail with an exception
+     * @param listener access to logging via listener
+     * @param launcher the launcher
+     * @param build the current build
+     */
+    public ControllerGroovyScript(
+            String script,
+            @NonNull Collection<Parameter> parameters,
+            boolean failWithException,
+            TaskListener listener,
+            Launcher launcher,
+            AbstractBuild<?, ?> build) {
+        super(script, parameters, failWithException, listener);
+        this.build = build;
+        this.launcher = launcher;
+    }
+
+    @Override
+    public ClassLoader getClassLoader() {
+        return Jenkins.get().getPluginManager().uberClassLoader;
+    }
+
+    @Override
+    protected void setShellVariables(@NonNull GroovyShell shell) {
+        super.setShellVariables(shell);
+        if (build != null) {
+            shell.setVariable("build", build);
+        }
+        if (launcher != null) {
+            shell.setVariable("launcher", launcher);
+        }
+    }
+}
diff --git a/src/main/java/org/jenkinsci/plugins/scriptler/util/GroovyScript.java b/src/main/java/org/jenkinsci/plugins/scriptler/util/GroovyScript.java
@@ -3,21 +3,15 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 import groovy.lang.GroovyShell;
 import groovy.lang.Script;
-import hudson.Launcher;
-import hudson.model.AbstractBuild;
 import hudson.model.TaskListener;
 import java.io.PrintStream;
 import java.io.Serial;
 import java.util.*;
 import java.util.concurrent.ConcurrentLinkedQueue;
-import jenkins.model.Jenkins;
 import jenkins.security.MasterToSlaveCallable;
-import jenkins.security.Roles;
 import org.apache.commons.collections.map.LRUMap;
 import org.jenkinsci.plugins.scriptler.Messages;
 import org.jenkinsci.plugins.scriptler.config.Parameter;
-import org.jenkinsci.remoting.Role;
-import org.jenkinsci.remoting.RoleChecker;
 
 /**
  * Inspired by hudson.util.RemotingDiagnostics.Script, but adding parameters.
@@ -33,9 +27,6 @@ public class GroovyScript extends MasterToSlaveCallable<Object, RuntimeException
 
     private final boolean failWithException;
     private final TaskListener listener;
-    private final transient AbstractBuild<?, ?> build;
-    private final transient Launcher launcher;
-    private transient ClassLoader cl;
 
     @SuppressWarnings("unchecked")
     private static final Map<String, ConcurrentLinkedQueue<Script>> cache = Collections.synchronizedMap(new LRUMap(10));
@@ -50,56 +41,30 @@ public class GroovyScript extends MasterToSlaveCallable<Object, RuntimeException
     }
 
     /**
-     * This constructor can only be used when the script is executed on the controller, because launcher and build can not be transferred to an agent and the execution will fail
+     * Constructor
      * @param script the script to be executed
      * @param parameters the parameters to be passed to the script
      * @param failWithException should the job fail with an exception
      * @param listener access to logging via listener
-     * @param launcher the launcher
-     * @param build the current build
      */
     public GroovyScript(
             String script,
             @NonNull Collection<Parameter> parameters,
             boolean failWithException,
-            TaskListener listener,
-            Launcher launcher,
-            AbstractBuild<?, ?> build) {
+            TaskListener listener) {
         this.script = script;
         this.parameters = new ArrayList<>(parameters);
         this.failWithException = failWithException;
         this.listener = listener;
-        this.cl = getClassLoader();
-        this.build = build;
-        this.launcher = launcher;
-    }
-
-    /**
-     * Constructor
-     * @param script the script to be executed
-     * @param parameters the parameters to be passed to the script
-     * @param failWithException should the job fail with an exception
-     * @param listener access to logging via listener
-     */
-    public GroovyScript(
-            String script,
-            @NonNull Collection<Parameter> parameters,
-            boolean failWithException,
-            TaskListener listener) {
-        this(script, parameters, failWithException, listener, null, null);
     }
 
     public ClassLoader getClassLoader() {
-        return Jenkins.get().getPluginManager().uberClassLoader;
+        return Thread.currentThread().getContextClassLoader();
     }
 
     public Object call() {
-        // if we run locally, cl!=null. Otherwise the delegating classloader will be available as context classloader.
-        if (cl == null) {
-            cl = Thread.currentThread().getContextClassLoader();
-        }
         PrintStream logger = listener.getLogger();
-        GroovyShell shell = new GroovyShell(cl);
+        GroovyShell shell = new GroovyShell(getClassLoader());
 
         for (Parameter param : parameters) {
             final String paramName = param.getName();
@@ -112,9 +77,7 @@ public Object call() {
 
         // set default variables
         shell.setVariable("out", logger);
-        shell.setVariable("listener", listener);
-        if (build != null) shell.setVariable("build", build);
-        if (launcher != null) shell.setVariable("launcher", launcher);
+        setShellVariables(shell);
 
         ConcurrentLinkedQueue<Script> scriptPool = cache.get(script);
         if (scriptPool == null) {
@@ -152,13 +115,8 @@ public Object call() {
         }
     }
 
-    @Override
-    public void checkRoles(RoleChecker roleChecker) throws SecurityException {
-        if (launcher != null && build != null) {
-            roleChecker.check(this, Roles.MASTER);
-        } else {
-            roleChecker.check(this, Role.UNKNOWN);
-        }
+    protected void setShellVariables(@NonNull GroovyShell shell) {
+        shell.setVariable("listener", listener);
     }
 
     private static final class ScriptlerExecutionException extends RuntimeException {
