[JENKINS-30398] Implements SimpleBuildStep

jenkinsci · Sep 16, 2015 · 904c2f6 · 904c2f6
1 parent 3c3c1d2
commit 904c2f6
Show file tree

Hide file tree

Showing 7 changed files with 312 additions and 144 deletions.
diff --git a/src/main/java/org/jenkinsci/plugins/ansible/AnsibleAdHocCommandBuilder.java b/src/main/java/org/jenkinsci/plugins/ansible/AnsibleAdHocCommandBuilder.java
@@ -15,34 +15,42 @@
  */
 package org.jenkinsci.plugins.ansible;
 
+import javax.annotation.Nonnull;
 import java.io.IOException;
 
 import com.cloudbees.plugins.credentials.CredentialsProvider;
 import com.cloudbees.plugins.credentials.common.StandardCredentials;
 import com.cloudbees.plugins.credentials.common.StandardUsernameCredentials;
+import hudson.AbortException;
 import hudson.Extension;
+import hudson.FilePath;
 import hudson.Launcher;
 import hudson.Util;
 import hudson.model.AbstractBuild;
 import hudson.model.BuildListener;
+import hudson.model.Computer;
+import hudson.model.Run;
+import hudson.model.TaskListener;
 import hudson.tasks.Builder;
 import hudson.util.FormValidation;
+import jenkins.tasks.SimpleBuildStep;
 import org.apache.commons.lang.StringUtils;
 import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
 import org.kohsuke.stapler.QueryParameter;
 
 /**
  * A builder which wraps an Ansible Ad-Hoc command invocation.
  */
-public class AnsibleAdHocCommandBuilder extends Builder {
+public class AnsibleAdHocCommandBuilder extends Builder implements SimpleBuildStep {
 
-    public final String ansibleName;
+    public String ansibleName;
 
     // SSH settings
     /**
      * The id of the credentials to use.
      */
-    public final String credentialsId;
+    public String credentialsId = null;
 
     public final String hostPattern;
 
@@ -55,22 +63,22 @@ public class AnsibleAdHocCommandBuilder extends Builder {
 
     public final String command;
 
-    public final boolean sudo;
+    public boolean sudo = false;
 
-    public final String sudoUser;
+    public String sudoUser = "root";
 
-    public final int forks;
+    public int forks = 5;
 
-    public final boolean unbufferedOutput;
+    public boolean unbufferedOutput = true;
 
-    public final boolean colorizedOutput;
+    public boolean colorizedOutput = false;
 
-    public final boolean hostKeyChecking;
+    public boolean hostKeyChecking = false;
 
-    public final String additionalParameters;
+    public String additionalParameters = null;
 
 
-    @DataBoundConstructor
+    @Deprecated
     public AnsibleAdHocCommandBuilder(String ansibleName, String hostPattern, Inventory inventory, String module,
                                       String command, String credentialsId, boolean sudo, String sudoUser, int forks,
                                       boolean unbufferedOutput, boolean colorizedOutput, boolean hostKeyChecking,
@@ -91,34 +99,92 @@ public AnsibleAdHocCommandBuilder(String ansibleName, String hostPattern, Invent
         this.additionalParameters = additionalParameters;
     }
 
-    @Override
-    public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException {
+    @Deprecated
+    public AnsibleAdHocCommandBuilder(String hostPattern, Inventory inventory, String module, String command) {
+        this.hostPattern = hostPattern;
+        this.inventory = inventory;
+        this.module = module;
+        this.command = command;
+    }
+
+    @DataBoundSetter
+    public void setAnsibleName(String ansibleName) {
+        this.ansibleName = ansibleName;
+    }
+
+    @DataBoundSetter
+    public void setCredentialsId(String credentialsId) {
+        this.credentialsId = credentialsId;
+    }
+
+    @DataBoundSetter
+    public void setSudo(boolean sudo) {
+        this.sudo = sudo;
+    }
+
+    @DataBoundSetter
+    public void setSudoUser(String sudoUser) {
+        this.sudoUser = sudoUser;
+    }
 
+    @DataBoundSetter
+    public void setForks(int forks) {
+        this.forks = forks;
+    }
+
+    @DataBoundSetter
+    public void setUnbufferedOutput(boolean unbufferedOutput) {
+        this.unbufferedOutput = unbufferedOutput;
+    }
+
+    @DataBoundSetter
+    public void setColorizedOutput(boolean colorizedOutput) {
+        this.colorizedOutput = colorizedOutput;
+    }
+
+    @DataBoundSetter
+    public void setHostKeyChecking(boolean hostKeyChecking) {
+        this.hostKeyChecking = hostKeyChecking;
+    }
+
+    @DataBoundSetter
+    public void setAdditionalParameters(String additionalParameters) {
+        this.additionalParameters = additionalParameters;
+    }
+
+    @Override
+    public void perform(@Nonnull Run<?, ?> run, @Nonnull FilePath ws, @Nonnull Launcher launcher, @Nonnull TaskListener listener) throws InterruptedException, IOException {
         try {
-            CLIRunner runner = new CLIRunner(build, launcher, listener);
-            String exe = AnsibleInstallation.getExecutable(ansibleName, AnsibleCommand.ANSIBLE, build.getBuiltOn(), listener, build.getEnvironment(listener));
-            AnsibleAdHocCommandInvocation invocation = new AnsibleAdHocCommandInvocation(exe , build, listener);
+            CLIRunner runner = new CLIRunner(run, ws, launcher, listener);
+            Computer computer = Computer.currentComputer();
+            if (computer == null) {
+                throw new AbortException("The ansible playbook build step requires to be launched on a node");
+            }
+            String exe = AnsibleInstallation.getExecutable(ansibleName, AnsibleCommand.ANSIBLE, computer.getNode(), listener, run.getEnvironment(listener));
+            AnsibleAdHocCommandInvocation invocation = new AnsibleAdHocCommandInvocation(exe, run, ws, listener);
             invocation.setHostPattern(hostPattern);
             invocation.setInventory(inventory);
             invocation.setModule(module);
             invocation.setModuleCommand(command);
             invocation.setSudo(sudo, sudoUser);
             invocation.setForks(forks);
             invocation.setCredentials(StringUtils.isNotBlank(credentialsId) ?
-                CredentialsProvider.findCredentialById(credentialsId, StandardUsernameCredentials.class, build) :
-                null);
+                    CredentialsProvider.findCredentialById(credentialsId, StandardUsernameCredentials.class, run) :
+                    null);
             invocation.setAdditionalParameters(additionalParameters);
             invocation.setHostKeyCheck(hostKeyChecking);
             invocation.setUnbufferedOutput(unbufferedOutput);
             invocation.setColorizedOutput(colorizedOutput);
-            return invocation.execute(runner);
+            if (!invocation.execute(runner)) {
+                throw new AbortException("Ansible Ad-Hoc command execution failed");
+            }
         } catch (IOException ioe) {
             Util.displayIOException(ioe, listener);
             ioe.printStackTrace(listener.fatalError(hudson.tasks.Messages.CommandInterpreter_CommandFailed()));
-            return false;
+            throw ioe;
         } catch (AnsibleInvocationException aie) {
             listener.fatalError(aie.getMessage());
-            return false;
+            throw new AbortException(aie.getMessage());
         }
     }
 

diff --git a/src/main/java/org/jenkinsci/plugins/ansible/AnsibleAdHocCommandInvocation.java b/src/main/java/org/jenkinsci/plugins/ansible/AnsibleAdHocCommandInvocation.java
@@ -17,9 +17,12 @@
 
 import java.io.IOException;
 
+import hudson.FilePath;
 import hudson.Launcher;
 import hudson.model.AbstractBuild;
 import hudson.model.BuildListener;
+import hudson.model.Run;
+import hudson.model.TaskListener;
 import hudson.util.ArgumentListBuilder;
 import org.apache.commons.lang.StringUtils;
 
@@ -38,6 +41,12 @@ protected AnsibleAdHocCommandInvocation(String exe, AbstractBuild<?, ?> build, B
         super(exe, build, build.getWorkspace(), listener);
     }
 
+    public AnsibleAdHocCommandInvocation(String exe, Run<?, ?> build, FilePath ws, TaskListener listener)
+            throws IOException, InterruptedException, AnsibleInvocationException
+    {
+        super(exe, build, ws, listener);
+    }
+
     public AnsibleAdHocCommandInvocation setHostPattern(String hostPattern) {
         this.hostPattern = hostPattern;
         return this;

diff --git a/src/main/java/org/jenkinsci/plugins/ansible/AnsibleInstallation.java b/src/main/java/org/jenkinsci/plugins/ansible/AnsibleInstallation.java
@@ -58,23 +58,6 @@ public AnsibleInstallation forNode(Node node, TaskListener log) throws IOExcepti
         return new AnsibleInstallation(getName(), translateFor(node, log), getProperties().toList());
     }
 
-//    public String getExecutable(final AnsibleCommand command, Launcher launcher) throws IOException, InterruptedException {
-//        return launcher.getChannel().call(new Callable<String, IOException>() {
-//            public String call() throws IOException {
-//                File exe = new File(getHome(), command.getName());
-//                if (exe.exists()) {
-//                    return exe.getPath();
-//                }
-//                return null;
-//            }
-//
-//            @Override
-//            public void checkRoles(RoleChecker checker) throws SecurityException {
-//                //To change body of implemented methods use File | Settings | File Templates.
-//            }
-//        });
-//    }
-
     public static String getExecutable(String name, AnsibleCommand command, Node node, TaskListener listener, EnvVars env) throws IOException, InterruptedException {
         if (name != null) {
             Jenkins j = Jenkins.getInstance();