[JENKINS-48050] Declarative Pipeline support for dockerNode

.mvn/extensions.xml

@@ -2,6 +2,6 @@
   <extension>
     <groupId>io.jenkins.tools.incrementals</groupId>
     <artifactId>git-changelist-maven-extension</artifactId>
-    <version>1.0-beta-3</version>
+    <version>1.0-beta-5</version>
   </extension>
 </extensions>

pom.xml

@@ -5,12 +5,13 @@
     <parent>
         <groupId>org.jenkins-ci.plugins</groupId>
         <artifactId>plugin</artifactId>
-        <version>3.12</version>
+        <version>3.19</version>
+        <relativePath/>
     </parent>
 
     <groupId>io.jenkins.docker</groupId>
     <artifactId>docker-plugin</artifactId>
-    <version>1.1.6-SNAPSHOT</version>
+    <version>${revision}${changelist}</version>
     <packaging>hpi</packaging>
 
     <name>Docker plugin</name>
@@ -25,12 +26,12 @@
     </developers>
 
     <properties>
-        <revision>1.1.5</revision>
+        <revision>1.1.6</revision>
         <changelist>-SNAPSHOT</changelist>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <java.level>8</java.level>
         <groovy.version>2.4.7</groovy.version>
-        <jenkins.version>2.60.3</jenkins.version>
+        <jenkins.version>2.73.3</jenkins.version>
     </properties>
 
     <dependencies>
@@ -83,7 +84,7 @@
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-api</artifactId>
-            <version>2.23.1</version>
+            <version>2.25</version>
             <optional>true</optional>
         </dependency>
         <dependency>
@@ -95,34 +96,40 @@
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-support</artifactId>
-            <version>2.16</version>
+            <version>2.17</version>
             <optional>true</optional>
         </dependency>
 
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-durable-task-step</artifactId>
             <version>2.17</version>
-            <optional>true</optional>
+            <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-job</artifactId>
-            <version>2.12.2</version>
-            <optional>true</optional>
+            <version>2.15</version>
+            <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-cps</artifactId>
-            <version>2.41</version>
-            <optional>true</optional>
+            <version>2.46</version>
+            <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>org.jenkins-ci.plugins</groupId>
-            <artifactId>script-security</artifactId>
-            <version>1.36</version>
+            <groupId>org.jenkinsci.plugins</groupId>
+            <artifactId>pipeline-model-extensions</artifactId>
+            <version>1.3.1</version>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>org.jenkinsci.plugins</groupId>
+            <artifactId>pipeline-model-definition</artifactId>
+            <version>1.3.1</version>
+            <scope>test</scope>
+        </dependency>
 
         <dependency>
             <groupId>com.kohlschutter.junixsocket</groupId>
@@ -185,10 +192,40 @@
 
     <dependencyManagement>
         <dependencies>
+            <dependency>
+                <groupId>org.jenkins-ci.plugins</groupId>
+                <artifactId>script-security</artifactId>
+                <version>1.42</version>
+            </dependency>
             <dependency>
                 <groupId>org.jenkins-ci.plugins</groupId>
                 <artifactId>structs</artifactId>
-                <version>1.9</version>
+                <version>1.14</version>
+            </dependency>
+            <dependency>
+                <groupId>org.jenkins-ci.plugins</groupId>
+                <artifactId>credentials</artifactId>
+                <version>2.1.16</version>
+            </dependency>
+            <dependency>
+                <groupId>org.jenkins-ci.plugins</groupId>
+                <artifactId>ssh-credentials</artifactId>
+                <version>1.13</version>
+            </dependency>
+            <dependency>
+                <groupId>org.jenkins-ci.plugins</groupId>
+                <artifactId>credentials-binding</artifactId>
+                <version>1.13</version>
+            </dependency>
+            <dependency>
+                <groupId>org.jenkins-ci.plugins</groupId>
+                <artifactId>scm-api</artifactId>
+                <version>2.2.6</version>
+            </dependency>
+            <dependency>
+                <groupId>org.jenkins-ci.plugins.workflow</groupId>
+                <artifactId>workflow-scm-step</artifactId>
+                <version>2.6</version>
             </dependency>
         </dependencies>
     </dependencyManagement>

src/main/java/io/jenkins/docker/pipeline/DockerAgent.java

@@ -0,0 +1,32 @@
+package io.jenkins.docker.pipeline;
+
+import hudson.Extension;
+import org.jenkinsci.Symbol;
+import org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent;
+import org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgentDescriptor;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+@SuppressWarnings("unchecked") // TODO DeclarativeAgent.getDescriptor problem
+public class DockerAgent extends DeclarativeAgent<DockerAgent> {
+
+    public final String image;
+
+    @DataBoundConstructor
+    public DockerAgent(String image) {
+        this.image = image;
+    }
+
+    // TODO other properties accepted by DockerNodeStep
+
+    @Symbol("dockerContainer")
+    @Extension
+    public static class DescriptorImpl extends DeclarativeAgentDescriptor<DockerAgent> {
+
+        @Override
+        public String getDisplayName() {
+            return "Start a Docker container with a new agent";
+        }
+
+    }
+
+}

src/main/java/io/jenkins/docker/pipeline/DockerNodeStep.java

@@ -4,6 +4,7 @@
 import hudson.Extension;
 import hudson.FilePath;
 import hudson.Launcher;
+import hudson.Util;
 import hudson.model.Computer;
 import hudson.model.Item;
 import hudson.model.Node;
@@ -36,27 +37,31 @@ public class DockerNodeStep extends Step {
 
     private String image;
 
-    private String remoteFs;
+    private String remoteFs = "/tmp";
 
     private DockerComputerConnector connector;
 
     @DataBoundConstructor
-    public DockerNodeStep(String dockerHost, String image) {
-        this.dockerHost = dockerHost;
+    public DockerNodeStep(String image) {
         this.image = image;
     }
 
     public String getDockerHost() {
         return dockerHost;
     }
 
+    @DataBoundSetter
+    public void setDockerHost(String dockerHost) {
+        this.dockerHost = Util.fixEmpty(dockerHost);
+    }
+
     public String getCredentialsId() {
         return credentialsId;
     }
 
     @DataBoundSetter
     public void setCredentialsId(String credentialsId) {
-        this.credentialsId = credentialsId;
+        this.credentialsId = Util.fixEmpty(credentialsId);
     }
 
     public String getImage() {

src/main/java/io/jenkins/docker/pipeline/DockerNodeStepExecution.java

@@ -1,20 +1,20 @@
 package io.jenkins.docker.pipeline;
 
+import com.nirima.jenkins.plugins.docker.DockerCloud;
 import com.nirima.jenkins.plugins.docker.DockerTemplate;
 import com.nirima.jenkins.plugins.docker.DockerTemplateBase;
 import hudson.EnvVars;
 import hudson.FilePath;
 import hudson.Util;
-import hudson.console.PlainTextConsoleOutputStream;
 import hudson.model.Computer;
 import hudson.model.Node;
 import hudson.model.TaskListener;
+import hudson.slaves.Cloud;
 import io.jenkins.docker.DockerTransientNode;
 import io.jenkins.docker.client.DockerAPI;
 import io.jenkins.docker.connector.DockerComputerAttachConnector;
 import io.jenkins.docker.connector.DockerComputerConnector;
 import jenkins.model.Jenkins;
-import jenkins.model.NodeListener;
 import org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint;
 import org.jenkinsci.plugins.workflow.graph.FlowNode;
 import org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback;
@@ -23,11 +23,9 @@
 import org.jenkinsci.plugins.workflow.support.actions.WorkspaceActionImpl;
 
 import javax.annotation.Nonnull;
-import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.Future;
 
 /**
  * @author <a href="mailto:nicolas.deloof@gmail.com">Nicolas De Loof</a>
@@ -77,13 +75,18 @@ private DockerTransientNode createNode(TaskListener listener) {
         final String uuid = UUID.randomUUID().toString();
 
         final DockerTemplate t = new DockerTemplate(
-                new DockerTemplateBase(image),
+                new DockerTemplateBase(image), // TODO call .setPullCredentialsId and also add option to .setRegistryUrl or similar
                 connector,
                 uuid, remoteFs, "1");
 
         t.setMode(Node.Mode.EXCLUSIVE);
 
-        final DockerAPI api = new DockerAPI(new DockerServerEndpoint(dockerHost, credentialsId));
+        final DockerAPI api;
+        if (dockerHost == null && credentialsId == null) {
+            api = defaultApi();
+        } else {
+            api = new DockerAPI(new DockerServerEndpoint(dockerHost, credentialsId));
+        }
 
         DockerTransientNode node;
         Computer computer = null;
@@ -114,6 +117,15 @@ private DockerTransientNode createNode(TaskListener listener) {
         return node;
     }
 
+    private static DockerAPI defaultApi() {
+        for (Cloud cloud : Jenkins.getInstance().clouds) {
+            if (cloud instanceof DockerCloud) {
+                return ((DockerCloud) cloud).getDockerApi();
+            }
+        }
+        throw new IllegalStateException("Must either specify dockerHost/credentialsId, or define at least one Docker cloud");
+    }
+
 
     private void invokeBody(DockerTransientNode node, TaskListener listener) {
 

src/main/resources/io/jenkins/docker/pipeline/DockerAgent/config.jelly

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form">
+    <f:entry field="image" title="Image">
+        <f:textbox/>
+    </f:entry>
+</j:jelly>

src/main/resources/io/jenkins/docker/pipeline/DockerAgentScript.groovy

@@ -0,0 +1,28 @@
+package io.jenkins.docker.pipeline
+
+import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
+import org.jenkinsci.plugins.pipeline.modeldefinition.agent.CheckoutScript
+import org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgentScript
+import org.jenkinsci.plugins.workflow.cps.CpsScript
+
+class DockerAgentScript extends DeclarativeAgentScript<DockerAgent> {
+
+    DockerAgentScript(CpsScript s, DockerAgent a) {
+        super(s, a)
+    }
+
+    @Override
+    Closure run(Closure body) {
+        return {
+            try {
+                script.dockerNode(describable?.image) {
+                    CheckoutScript.doCheckout(script, describable, null, body).call()
+                }
+            } catch (Exception e) {
+                script.getProperty("currentBuild").result = Utils.getResultFromException(e)
+                throw e
+            }
+        }
+    }
+
+}

src/main/resources/io/jenkins/docker/pipeline/DockerNodeStep/config.jelly

@@ -1,20 +1,24 @@
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form" xmlns:c="/lib/credentials">
 
-  <f:entry title="Docker Host" field="dockerHost">
-    <f:textbox/>
-  </f:entry>
-
-  <f:entry field="credentialsId" title="Docker API credentials">
-    <c:select/>
-  </f:entry>
-
   <f:entry title="Docker image" field="image">
     <f:textbox/>
   </f:entry>
 
   <f:entry title="Agent root directory" field="remoteFs">
-    <f:textbox/>
+    <f:textbox default="/tmp"/>
   </f:entry>
 
+  <f:advanced>
+
+      <f:entry title="Docker Host" field="dockerHost">
+        <f:textbox/>
+      </f:entry>
+
+      <f:entry field="credentialsId" title="Docker API credentials">
+        <c:select/>
+      </f:entry>
+
+  </f:advanced>
+
 </j:jelly>

src/main/resources/io/jenkins/docker/pipeline/DockerNodeStep/help.html

@@ -2,10 +2,9 @@
     <p>
         Allocates a new Jenkins agent using a specified Docker image and runs tasks on it. Example:
     </p>
-    <pre>docker-node(image: 'cloudbees/jnlp-slave-with-java-build-tools') {
+    <pre>dockerNode('cloudbees/jnlp-slave-with-java-build-tools') {
     git 'https://github.com/jglick/simple-maven-project-with-tests'
-    withMaven {
-        sh 'mvn install'
-    }
+    sh 'mvn -B -Dmaven.test.failure.ignore install'
+    junit '**/target/surefire-reports/TEST-*.xml'
 }</pre>
 </div>