Merge pull request #1078 from synopsys-arc-oss/run-shell-command_renaming

Renamed "Run Command" to "Run Shell Command"

core/src/main/java/hudson/tools/AbstractCommandInstaller.java

+/*
+ * The MIT License
+ *
+ * Copyright 2009-2014 Sun Microsystems and contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package hudson.tools;
+
+import hudson.FilePath;
+import hudson.model.Node;
+import hudson.model.TaskListener;
+import hudson.util.FormValidation;
+import java.io.IOException;
+import org.kohsuke.stapler.QueryParameter;
+
+/**
+ * A generic script-based installer.
+ * @since TODO: define a version
+ * @see BatchCommandInstaller
+ * @see CommandInstaller
+ * @author Oleg Nenashev
+ * 
+ */
+public abstract class AbstractCommandInstaller extends ToolInstaller {
+
+    /**
+     * Command to execute, similar to {@link CommandInterpreter#command}.
+     */
+    private final String command;
+    private final String toolHome;
+
+    public AbstractCommandInstaller(String label, String command, String toolHome) {
+        super(label);
+        this.command = fixCrLf(command);
+        this.toolHome = toolHome;
+    }
+
+    public String getCommand() {
+        return command;
+    }
+
+    public String getToolHome() {
+        return toolHome;
+    }
+
+    public abstract String getCommandFileExtension();
+
+    /**
+     * Retrieves a call for remote script caller.
+     */
+    public abstract String[] getCommandCall(FilePath script);
+
+    @Override
+    public FilePath performInstallation(ToolInstallation tool, Node node, TaskListener log) throws IOException, InterruptedException {
+        FilePath dir = preferredLocation(tool, node);
+        // XXX support Windows batch scripts, Unix scripts with interpreter line, etc. (see CommandInterpreter subclasses)
+        FilePath script = dir.createTextTempFile("hudson", getCommandFileExtension(), command);
+        try {
+            String cmd[] = getCommandCall(script);
+            int r = node.createLauncher(log).launch().cmds(cmd).stdout(log).pwd(dir).join();
+            if (r != 0) {
+                throw new IOException("Command returned status " + r);
+            }
+        } finally {
+            script.delete();
+        }
+        return dir.child(getToolHome());
+    }
+
+    /**
+     * Fix CR/LF and always make it Unix style.
+     */
+    //TODO: replace by a Windows style
+    private static String fixCrLf(String s) {
+        // eliminate CR
+        int idx;
+        while ((idx = s.indexOf("\r\n")) != -1) {
+            s = s.substring(0, idx) + s.substring(idx + 1);
+        }
+        return s;
+    }
+
+    public static abstract class Descriptor<TInstallerClass extends AbstractCommandInstaller>
+            extends ToolInstallerDescriptor<TInstallerClass> {
+
+        public FormValidation doCheckCommand(@QueryParameter String value) {
+            if (value.length() > 0) {
+                return FormValidation.ok();
+            } else {
+                return FormValidation.error(Messages.CommandInstaller_no_command());
+            }
+        }
+
+        public FormValidation doCheckToolHome(@QueryParameter String value) {
+            if (value.length() > 0) {
+                return FormValidation.ok();
+            } else {
+                return FormValidation.error(Messages.CommandInstaller_no_command());
+            }
+        }
+    }
+}

core/src/main/java/hudson/tools/BatchCommandInstaller.java

+/*
+ * The MIT License
+ *
+ * Copyright (c) 2013, Oleg Nenashev
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package hudson.tools;
+
+import hudson.Extension;
+import hudson.FilePath;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+/**
+ * Installs tool via script execution of Batch script.
+ * Inspired by "Command installer" from the Jenkins core.
+ * @since 0.1
+ */
+public class BatchCommandInstaller extends AbstractCommandInstaller {
+
+    @DataBoundConstructor
+    public BatchCommandInstaller(String label, String command, String toolHome) {
+        super(label, command, toolHome);
+    }
+
+    @Override
+    public String getCommandFileExtension() {
+        return ".bat";
+    }
+
+    @Override
+    public String[] getCommandCall(FilePath script) {
+        String[] cmd = {"cmd", "/c", "call", script.getRemote()};
+        return cmd;
+    }
+ 
+    @Extension
+    public static class DescriptorImpl extends Descriptor<BatchCommandInstaller> {
+
+        @Override
+        public String getDisplayName() {
+            return Messages.BatchCommandInstaller_DescriptorImpl_displayName();
+        }        
+    }
+}

core/src/main/java/hudson/tools/CommandInstaller.java

@@ -26,95 +26,36 @@ package hudson.tools;
 
 import hudson.Extension;
 import hudson.FilePath;
-import hudson.model.Node;
-import hudson.model.TaskListener;
-import hudson.tasks.CommandInterpreter;
-import hudson.util.FormValidation;
-import java.io.IOException;
 import org.kohsuke.stapler.DataBoundConstructor;
-import org.kohsuke.stapler.QueryParameter;
 
 /**
  * Installs a tool by running an arbitrary shell command.
  * @since 1.305
  */
-public class CommandInstaller extends ToolInstaller {
-
-    /**
-     * Command to execute, similar to {@link CommandInterpreter#command}.
-     */
-    private final String command;
-
-    /**
-     * Resulting tool home directory.
-     */
-    private final String toolHome;
+public class CommandInstaller extends AbstractCommandInstaller {
 
     @DataBoundConstructor
     public CommandInstaller(String label, String command, String toolHome) {
-        super(label);
-        this.command = fixCrLf(command);
-        this.toolHome = toolHome;
-    }
-
-    /**
-     * Fix CR/LF and always make it Unix style.
-     */
-    private static String fixCrLf(String s) {
-        // eliminate CR
-        int idx;
-        while((idx=s.indexOf("\r\n"))!=-1)
-            s = s.substring(0,idx)+s.substring(idx+1);
-        return s;
-    }
-    
-    public String getCommand() {
-        return command;
+        super(label, command, toolHome);
     }
 
-    public String getToolHome() {
-        return toolHome;
+    @Override
+    public String getCommandFileExtension() {
+        return ".sh";
     }
 
-    public FilePath performInstallation(ToolInstallation tool, Node node, TaskListener log) throws IOException, InterruptedException {
-        FilePath dir = preferredLocation(tool, node);
-        // TODO support Windows batch scripts, Unix scripts with interpreter line, etc. (see CommandInterpreter subclasses)
-        FilePath script = dir.createTextTempFile("hudson", ".sh", command);
-        try {
-            String[] cmd = {"sh", "-e", script.getRemote()};
-            int r = node.createLauncher(log).launch().cmds(cmd).stdout(log).pwd(dir).join();
-            if (r != 0) {
-                throw new IOException("Command returned status " + r);
-            }
-        } finally {
-            script.delete();
-        }
-        return dir.child(toolHome);
+    @Override
+    public String[] getCommandCall(FilePath script) {
+        String[] cmd = {"sh", "-e", script.getRemote()};
+        return cmd;
     }
 
     @Extension
-    public static class DescriptorImpl extends ToolInstallerDescriptor<CommandInstaller> {
+    public static class DescriptorImpl extends Descriptor<CommandInstaller> {
 
+        @Override
         public String getDisplayName() {
             return Messages.CommandInstaller_DescriptorImpl_displayName();
         }
-
-        public FormValidation doCheckCommand(@QueryParameter String value) {
-            if (value.length() > 0) {
-                return FormValidation.ok();
-            } else {
-                return FormValidation.error(Messages.CommandInstaller_no_command());
-            }
-        }
-
-        public FormValidation doCheckToolHome(@QueryParameter String value) {
-            if (value.length() > 0) {
-                return FormValidation.ok();
-            } else {
-                return FormValidation.error(Messages.CommandInstaller_no_toolHome());
-            }
-        }
-
     }
-
 }

core/src/main/resources/hudson/tools/Messages.properties

@@ -21,9 +21,10 @@
 # THE SOFTWARE.
 
 ToolLocationNodeProperty.displayName=Tool Locations
-CommandInstaller.DescriptorImpl.displayName=Run Command
+CommandInstaller.DescriptorImpl.displayName=Run Shell Command
 CommandInstaller.no_command=Must provide a command to run.
 CommandInstaller.no_toolHome=Must provide a tool home directory.
+BatchCommandInstaller.DescriptorImpl.displayName=Run Batch Command
 JDKInstaller.FailedToInstallJDK=Failed to install JDK. Exit code={0}
 JDKInstaller.RequireOracleAccount=Installing JDK requires Oracle account. <a href="{0}" target="_new">Please enter your username/password</a>
 JDKInstaller.UnableToInstallUntilLicenseAccepted=Unable to auto-install JDK until the license is accepted.