[JENKINS-38381] Pipeline remote build logging

pom.xml

@@ -5,8 +5,12 @@
   <parent>
     <groupId>org.jenkins-ci.plugins</groupId>
     <artifactId>plugin</artifactId>
-    <version>1.599</version>
+    <version>2.17</version>
   </parent>
+
+  <properties>
+    <jenkins.version>2.26-SNAPSHOT</jenkins.version>
+  </properties>
 
   <repositories>
     <repository>
@@ -108,6 +112,38 @@
       <artifactId>junit</artifactId>
       <version>1.10</version>
     </dependency>
+
+    <!-- For indexing of jobs in Elasticsearch -->
+    <dependency>
+      <groupId>org.jenkins-ci.plugins</groupId>
+      <artifactId>unique-id</artifactId>
+      <version>2.1.1</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-job</artifactId>
+      <version>2.8-SNAPSHOT</version>
+    </dependency>
+    <!-- For testing of Log wrapping in Pipeline -->
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-durable-task-step</artifactId>
+      <version>2.6-SNAPSHOT</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-cps</artifactId>
+      <version>2.19</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-basic-steps</artifactId>
+      <version>2.2</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>
@@ -127,15 +163,6 @@
         </dependencies>
       </plugin>
 
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-compiler-plugin</artifactId>
-        <configuration>
-          <source>1.7</source>
-          <target>1.7</target>
-        </configuration>
-      </plugin>
-
       <!-- http://jira.codehaus.org/browse/MRELEASE-812 -->
       <plugin>
         <artifactId>maven-release-plugin</artifactId>
@@ -152,17 +179,6 @@
           </dependency>
         </dependencies>
       </plugin>
-
-      <!-- https://issues.jenkins-ci.org/browse/JENKINS-21977 -->
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-surefire-plugin</artifactId>
-        <configuration>
-          <excludes>
-            <exclude>InjectedTest.java</exclude>
-          </excludes>
-        </configuration>
-      </plugin>
     </plugins>
   </build>
 

src/main/java/jenkins/plugins/logstash/LogstashBuildWrapper.java

@@ -24,6 +24,8 @@
 
 package jenkins.plugins.logstash;
 
+import jenkins.plugins.logstash.remoteLogging.RemoteLogstashWriter;
+import jenkins.plugins.logstash.remoteLogging.RemoteLogstashOutputStream;
 import hudson.Extension;
 import hudson.Launcher;
 import hudson.model.BuildListener;
@@ -43,74 +45,51 @@
 import com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsBuildWrapper;
 import com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsBuildWrapper.VarPasswordPair;
 import com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsConfig;
+import hudson.CloseProofOutputStream;
+import hudson.EnvVars;
+import hudson.FilePath;
+import hudson.Proc;
+import hudson.console.ConsoleLogFilter;
+import hudson.model.Job;
+import hudson.model.Run;
+import hudson.model.TaskListener;
+import hudson.remoting.Channel;
+import hudson.remoting.RemoteInputStream;
+import java.io.InputStream;
+import java.io.InterruptedIOException;
+import java.io.Serializable;
+import jenkins.model.Jenkins;
+import jenkins.security.MasterToSlaveCallable;
+import jenkins.tasks.SimpleBuildWrapper;
+import org.apache.commons.io.input.NullInputStream;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
 
 /**
  * Build wrapper that decorates the build's logger to insert a
- * {@link LogstashNote} on each output line.
+ * {@code LogstashNote} on each output line.
  *
  * @author K Jonathan Harker
  */
-public class LogstashBuildWrapper extends BuildWrapper {
+public class LogstashBuildWrapper extends SimpleBuildWrapper {
 
   /**
    * Create a new {@link LogstashBuildWrapper}.
    */
   @DataBoundConstructor
   public LogstashBuildWrapper() {}
 
-  /**
-   * {@inheritDoc}
-   */
-  @Override
-  public Environment setUp(AbstractBuild build, Launcher launcher, BuildListener listener) throws IOException, InterruptedException {
-
-    return new Environment() {};
-  }
-
-  /**
-   * {@inheritDoc}
-   */
-  @Override
-  public OutputStream decorateLogger(AbstractBuild build, OutputStream logger) {
-    LogstashWriter logstash = getLogStashWriter(build, logger);
-
-    LogstashOutputStream los = new LogstashOutputStream(logger, logstash);
-
-    if (build.getProject() instanceof BuildableItemWithBuildWrappers) {
-      BuildableItemWithBuildWrappers project = (BuildableItemWithBuildWrappers) build.getProject();
-      for (BuildWrapper wrapper: project.getBuildWrappersList()) {
-        if (wrapper instanceof MaskPasswordsBuildWrapper) {
-          List<VarPasswordPair> allPasswordPairs = new ArrayList<VarPasswordPair>();
-
-          MaskPasswordsBuildWrapper maskPasswordsWrapper = (MaskPasswordsBuildWrapper) wrapper;
-          List<VarPasswordPair> jobPasswordPairs = maskPasswordsWrapper.getVarPasswordPairs();
-          if (jobPasswordPairs != null) {
-            allPasswordPairs.addAll(jobPasswordPairs);
-          }
-
-          MaskPasswordsConfig config = MaskPasswordsConfig.getInstance();
-          List<VarPasswordPair> globalPasswordPairs = config.getGlobalVarPasswordPairs();
-          if (globalPasswordPairs != null) {
-            allPasswordPairs.addAll(globalPasswordPairs);
-          }
-
-          return los.maskPasswords(allPasswordPairs);
-        }
-      }
+    @Override
+    public void setUp(Context context, Run<?, ?> build, FilePath workspace, 
+            Launcher launcher, TaskListener listener, EnvVars initialEnvironment) 
+            throws IOException, InterruptedException {
+        // Do nothing
     }
-
-    return los;
-  }
-
+
   public DescriptorImpl getDescriptor() {
     return (DescriptorImpl) super.getDescriptor();
   }
 
-  // Method to encapsulate calls for unit-testing
-  LogstashWriter getLogStashWriter(AbstractBuild<?, ?> build, OutputStream errorStream) {
-    return new LogstashWriter(build, errorStream);
-  }
-
   /**
    * Registers {@link LogstashBuildWrapper} as a {@link BuildWrapper}.
    */
@@ -129,7 +108,7 @@ public DescriptorImpl() {
     public String getDisplayName() {
       return Messages.DisplayName();
     }
-
+    
     /**
      * {@inheritDoc}
      */

src/main/java/jenkins/plugins/logstash/LogstashInstallation.java

@@ -47,6 +47,7 @@
  * @author Rusty Gerard
  * @since 1.0.0
  */
+// TODO this should be GlobalConfiguration, not ToolInstallation!
 public class LogstashInstallation extends ToolInstallation {
   private static final long serialVersionUID = -5730780734005293851L;
 

src/main/java/jenkins/plugins/logstash/LogstashWriter.java

@@ -24,8 +24,7 @@
 
 package jenkins.plugins.logstash;
 
-
-import hudson.model.AbstractBuild;
+import hudson.model.Run;
 import jenkins.model.Jenkins;
 import jenkins.plugins.logstash.persistence.BuildData;
 import jenkins.plugins.logstash.persistence.IndexerDaoFactory;
@@ -52,15 +51,15 @@
 public class LogstashWriter {
 
   final OutputStream errorStream;
-  final AbstractBuild<?, ?> build;
+  final Run<?, ?> build;
   final BuildData buildData;
   final String jenkinsUrl;
   final LogstashIndexerDao dao;
   private boolean connectionBroken;
 
-  public LogstashWriter(AbstractBuild<?, ?> build, OutputStream error) {
+  public LogstashWriter(Run<?, ?> run, OutputStream error) {
     this.errorStream = error != null ? error : System.err;
-    this.build = build;
+    this.build = run;
     this.dao = this.getDaoOrNull();
     if (this.dao == null) {
       this.jenkinsUrl = "";

src/main/java/jenkins/plugins/logstash/kibana/AbstractConsoleAction.java

@@ -0,0 +1,43 @@
+/*
+ * To change this license header, choose License Headers in Project Properties.
+ * To change this template file, choose Tools | Templates
+ * and open the template in the editor.
+ */
+package jenkins.plugins.logstash.kibana;
+
+import hudson.model.Action;
+import hudson.model.Run;
+import jenkins.plugins.logstash.util.UniqueIdHelper;
+
+/**
+ * Wrapper base, which is required to nest {@code buildCaption.jelly}.
+ * @author Oleg Nenashev
+ */
+public abstract class AbstractConsoleAction implements Action {
+    private final String jobId;
+    private final Run run;
+
+    public AbstractConsoleAction(Run run) {
+        this.run = run;
+        this.jobId =  UniqueIdHelper.getOrCreateId(run);
+    }
+
+    @Override
+    public String getDisplayName() {
+        return "External log (" + getDataSourceDisplayName() + ")";
+    }
+
+    public Run getRun() {
+        return run;
+    }
+
+    public String getJobId() {
+        return jobId;
+    }
+
+    public boolean isLogUpdated() {
+        return run.isLogUpdated();
+    }
+
+    public abstract String getDataSourceDisplayName();
+}