[JEP-210] Integration tests with DurableTaskStep

pom.xml

@@ -65,7 +65,7 @@
         <jenkins.version>2.73.3</jenkins.version>
         <java.level>8</java.level>
         <workflow-step-api-plugin.version>2.13</workflow-step-api-plugin.version>
-        <workflow-support-plugin.version>2.19-20180209.204154-1</workflow-support-plugin.version> <!-- TODO https://github.com/jenkinsci/workflow-support-plugin/pull/56 -->
+        <workflow-support-plugin.version>2.19-20180213.183111-2</workflow-support-plugin.version> <!-- TODO https://github.com/jenkinsci/workflow-support-plugin/pull/15 -->
     </properties>
     <dependencies>
         <dependency>
@@ -81,7 +81,7 @@
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-api</artifactId>
-            <version>2.25</version>
+            <version>2.26-SNAPSHOT</version> <!-- TODO pending https://github.com/jenkinsci/workflow-api-plugin/pull/17 -->
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
@@ -97,13 +97,13 @@
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-job</artifactId>
-            <version>2.18-20180209.215341-1</version> <!-- TODO https://github.com/jenkinsci/workflow-job-plugin/pull/89 -->
+            <version>2.18-20180213.183217-2</version> <!-- TODO pending https://github.com/jenkinsci/workflow-job-plugin/pull/27 -->
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-basic-steps</artifactId>
-            <version>1.15</version>
+            <version>2.2</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -126,6 +126,12 @@
             <classifier>tests</classifier>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>credentials-binding</artifactId>
+            <version>1.9</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-scm-step</artifactId>

src/test/java/org/jenkinsci/plugins/workflow/steps/durable_task/ShellStepTest.java

@@ -1,22 +1,40 @@
 package org.jenkinsci.plugins.workflow.steps.durable_task;
 
+import com.cloudbees.plugins.credentials.CredentialsProvider;
+import com.cloudbees.plugins.credentials.CredentialsScope;
+import com.cloudbees.plugins.credentials.domains.Domain;
+import com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl;
 import com.google.common.base.Predicate;
-import hudson.EnvVars;
 import hudson.FilePath;
+import hudson.EnvVars;
 import hudson.Functions;
 import hudson.Launcher;
 import hudson.LauncherDecorator;
+import hudson.console.LineTransformationOutputStream;
 import hudson.model.BallColor;
+import hudson.model.BuildListener;
 import hudson.model.FreeStyleProject;
 import hudson.model.Node;
 import hudson.model.Result;
+import hudson.remoting.Channel;
 import hudson.model.Slave;
 import hudson.slaves.DumbSlave;
 import hudson.slaves.EnvironmentVariablesNodeProperty;
 import hudson.tasks.BatchFile;
 import hudson.tasks.Shell;
 import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.PrintStream;
 import java.io.Serializable;
+import java.nio.channels.Channels;
+import java.nio.channels.FileChannel;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.StandardOpenOption;
+import java.util.concurrent.atomic.AtomicInteger;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.logging.Level;
@@ -27,12 +45,14 @@
 import org.jenkinsci.plugins.workflow.cps.nodes.StepAtomNode;
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.jenkinsci.plugins.workflow.job.console.PipelineLogFile;
 import org.jenkinsci.plugins.workflow.steps.AbstractStepDescriptorImpl;
 import org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl;
 import org.jenkinsci.plugins.workflow.steps.AbstractStepImpl;
 import org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback;
 import org.jenkinsci.plugins.workflow.steps.BodyInvoker;
 import org.jenkinsci.plugins.workflow.steps.StepConfigTester;
+import org.jenkinsci.plugins.workflow.support.actions.LessAbstractTaskListener;
 import org.jenkinsci.plugins.workflow.support.visualization.table.FlowGraphTable;
 import org.jenkinsci.plugins.workflow.support.visualization.table.FlowGraphTable.Row;
 import static org.junit.Assert.*;
@@ -237,6 +257,87 @@ public DescriptorImpl() {
         j.assertLogContains("truth is 0 but falsity is 1", j.assertBuildStatusSuccess(p.scheduleBuild2(0)));
     }
 
+    @Issue("JENKINS-38381")
+    @Test public void remoteLogger() throws Exception {
+        final String credentialsId = "creds";
+        final String username = "bob";
+        final String password = "s3cr3t";
+        UsernamePasswordCredentialsImpl c = new UsernamePasswordCredentialsImpl(CredentialsScope.GLOBAL, credentialsId, "sample", username, password);
+        CredentialsProvider.lookupStores(j.jenkins).iterator().next().addCredentials(Domain.global(), c);
+        j.createSlave("remote", null, null);
+        WorkflowJob p = j.jenkins.createProject(WorkflowJob.class, "p");
+        p.setDefinition(new CpsFlowDefinition(
+            "node('master') {\n" +
+            "  sh 'pwd'\n" +
+            "}\n" +
+            "node('remote') {\n" +
+            "  sh 'pwd'\n" +
+            "  sh 'echo on agent'\n" +
+            "  withCredentials([[$class: 'UsernamePasswordBinding', variable: 'USERPASS', credentialsId: '" + credentialsId + "']]) {\n" +
+            "    sh 'set +x; echo curl -u $USERPASS http://server/'\n" +
+            "  }\n" +
+            "}", true));
+        WorkflowRun b = j.assertBuildStatusSuccess(p.scheduleBuild2(0));
+        j.assertLogContains("+ pwd [master #1]", b);
+        j.assertLogContains("+ pwd [master #1 → remote #", b);
+        j.assertLogContains("on agent [master #1 → remote #", b);
+        j.assertLogNotContains(password, b);
+        j.assertLogContains("curl -u **** http://server/ [master #1 → remote #", b);
+    }
+    @TestExtension("remoteLogger") public static class LogFile extends PipelineLogFile {
+        @Override protected BuildListener listenerFor(WorkflowRun b) throws IOException, InterruptedException {
+            return new RemotableBuildListener(logFile(b));
+        }
+        @Override protected InputStream logFor(WorkflowRun b, long start) throws IOException {
+            return Channels.newInputStream(FileChannel.open(logFile(b).toPath(), StandardOpenOption.READ).position(start));
+        }
+        File logFile(WorkflowRun b) {
+            return new File(b.getRootDir(), "special.log");
+        }
+    }
+    private static class RemotableBuildListener extends LessAbstractTaskListener implements BuildListener {
+        private static final long serialVersionUID = 1;
+        /** counts which instance this is per JVM */
+        private static final AtomicInteger instantiationCounter = new AtomicInteger();
+        /** location of log file streamed to by multiple sources */
+        private final File logFile;
+        /** records allocation & deserialization history; e.g., {@code master #1 → agent #1} */
+        private final String id;
+        private transient PrintStream logger;
+        RemotableBuildListener(File logFile) {
+            this(logFile, "master #" + instantiationCounter.incrementAndGet());
+        }
+        private RemotableBuildListener(File logFile, String id) {
+            this.logFile = logFile;
+            this.id = id;
+        }
+        @Override public PrintStream getLogger() {
+            if (logger == null) {
+                final OutputStream fos;
+                try {
+                    fos = new FileOutputStream(logFile, true);
+                } catch (FileNotFoundException x) {
+                    throw new AssertionError(x);
+                }
+                logger = new PrintStream(new LineTransformationOutputStream() {
+                    @Override protected void eol(byte[] b, int len) throws IOException {
+                        fos.write(b, 0, len - 1); // all but NL
+                        fos.write((" [" + id + "]").getBytes(StandardCharsets.UTF_8));
+                        fos.write(b[len - 1]); // NL
+                    }
+                });
+            }
+            return logger;
+        }
+        private Object writeReplace() {
+            /* To see serialization happening from BourneShellScript.launchWithCookie & FileMonitoringController.watch:
+            Thread.dumpStack();
+            */
+            String name = Channel.current().getName();
+            return new RemotableBuildListener(logFile, id + " → " + name + " #" + instantiationCounter.incrementAndGet());
+        }
+    }
+
     @Issue("JENKINS-31096")
     @Test public void encoding() throws Exception {
         // Like JenkinsRule.createSlave but passing a system encoding: