remove dependency to maskpasswords (#48)

* remove dependency to MaskPasswords

instead we use a high ordinal which ensures we get initialized first

* add a test for maskpasswords

* fix import

* use ConsoleLogFilter instead of a BuildWrapper

in combination with a high ordinal we ensure that
we get filtered output.

* verify that passwords are always masked

wrong order of build wrapper
mask passwords only configured globally

* use ConsoleLogFilter also for pipeline

* improve javadoc of BuildWrapper

clearly state that is only a marker for the ConsoleLogFilter

Author: mwinter69

pom.xml

@@ -109,12 +109,6 @@
       <scope>compile</scope>
     </dependency>
 
-    <dependency>
-      <groupId>org.jenkins-ci.plugins</groupId>
-      <artifactId>mask-passwords</artifactId>
-      <version>2.8</version>
-      <optional>true</optional>
-    </dependency>
 
     <dependency>
       <groupId>org.jenkins-ci.plugins</groupId>
@@ -139,11 +133,23 @@
     	<version>2.0.0-beta.5</version>
     	<scope>test</scope>
     </dependency>
+    <dependency>
+    	<groupId>org.jenkins-ci.plugins</groupId>
+    	<artifactId>mask-passwords</artifactId>
+    	<version>2.10.1</version>
+    	<scope>test</scope>
+    </dependency>
+    <dependency>
+    	<groupId>org.jenkins-ci.plugins</groupId>
+    	<artifactId>envinject</artifactId>
+    	<version>2.1.5</version>
+    	<scope>test</scope>
+    </dependency>
     <dependency>
     	<groupId>org.jenkins-ci.plugins.workflow</groupId>
     	<artifactId>workflow-step-api</artifactId>
     	<version>1.15</version>
-		<optional>true</optional>
+  		<optional>true</optional>
     </dependency>
   </dependencies>
 

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

@@ -24,100 +24,65 @@
 
 package jenkins.plugins.logstash;
 
+import java.io.IOException;
+
+import org.kohsuke.stapler.DataBoundConstructor;
+
 import hudson.Extension;
 import hudson.Launcher;
-import hudson.model.BuildListener;
 import hudson.model.AbstractBuild;
 import hudson.model.AbstractProject;
-import hudson.model.BuildableItemWithBuildWrappers;
+import hudson.model.BuildListener;
 import hudson.tasks.BuildWrapper;
 import hudson.tasks.BuildWrapperDescriptor;
 
-import java.io.IOException;
-import java.io.OutputStream;
-import java.util.ArrayList;
-import java.util.List;
-
-import org.kohsuke.stapler.DataBoundConstructor;
-
-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;
-
 /**
- * Build wrapper that decorates the build's logger to insert a
+ *
+ * This BuildWrapper is only a marker and has no other functionality.
+ * The {@link LogstashConsoleLogFilter} uses this BuildWrapper to decide if it should send the log to an indexer.
+ * We have to keep this for backward compatibility as in the past this BuildWrapper was used instead.
+ * Using a ConsoleLogFilter allows to remove the dependency to the maskpasswords plugin.
  *
  * @author K Jonathan Harker
  */
-public class LogstashBuildWrapper extends BuildWrapper {
+public class LogstashBuildWrapper extends BuildWrapper
+{
 
   /**
    * 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() {};
-  }
+  public LogstashBuildWrapper()
+  {}
 
   /**
    * {@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);
-        }
-      }
-    }
-
-    return los;
+  public Environment setUp(AbstractBuild build, Launcher launcher, BuildListener listener)
+      throws IOException, InterruptedException
+  {
+    return new Environment()
+    {
+    };
   }
 
   @Override
-  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, null, build.getCharset());
+  public DescriptorImpl getDescriptor()
+  {
+    return (DescriptorImpl)super.getDescriptor();
   }
 
   /**
    * Registers {@link LogstashBuildWrapper} as a {@link BuildWrapper}.
    */
-  @Extension
-  public static class DescriptorImpl extends BuildWrapperDescriptor {
+  // We need a high ordinal so that we are in the list of BuildWrappers before the MaskPasswords
+  @Extension(ordinal = 10000)
+  public static class DescriptorImpl extends BuildWrapperDescriptor
+  {
 
-    public DescriptorImpl() {
+    public DescriptorImpl()
+    {
       super(LogstashBuildWrapper.class);
       load();
     }
@@ -126,15 +91,17 @@ public DescriptorImpl() {
      * {@inheritDoc}
      */
     @Override
-    public String getDisplayName() {
+    public String getDisplayName()
+    {
       return Messages.DisplayName();
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
-    public boolean isApplicable(AbstractProject<?, ?> item) {
+    public boolean isApplicable(AbstractProject<?, ?> item)
+    {
       return true;
     }
   }

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

@@ -0,0 +1,74 @@
+package jenkins.plugins.logstash;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.Serializable;
+
+import hudson.Extension;
+import hudson.console.ConsoleLogFilter;
+import hudson.model.AbstractBuild;
+import hudson.model.BuildableItemWithBuildWrappers;
+import hudson.model.Run;
+import hudson.tasks.BuildWrapper;
+
+@Extension(ordinal = 1000)
+public class LogstashConsoleLogFilter extends ConsoleLogFilter implements Serializable
+{
+
+  private transient Run<?, ?> run;
+  public LogstashConsoleLogFilter() {};
+
+  public LogstashConsoleLogFilter(Run<?, ?> run)
+  {
+    this.run = run;
+  }
+  private static final long serialVersionUID = 1L;
+
+  @Override
+  public OutputStream decorateLogger(Run build, OutputStream logger) throws IOException, InterruptedException
+  {
+    if (build != null && build instanceof AbstractBuild<?, ?>)
+    {
+      if (isLogstashEnabled(build))
+      {
+        LogstashWriter logstash = getLogStashWriter(build, logger);
+        return new LogstashOutputStream(logger, logstash);
+      }
+      else
+      {
+        return logger;
+      }
+    }
+    if (run != null)
+    {
+      LogstashWriter logstash = getLogStashWriter(run, logger);
+      return new LogstashOutputStream(logger, logstash);
+    }
+    else
+    {
+      return logger;
+    }
+  }
+
+  LogstashWriter getLogStashWriter(Run<?, ?> build, OutputStream errorStream)
+  {
+    return new LogstashWriter(build, errorStream, null, build.getCharset());
+  }
+
+  private boolean isLogstashEnabled(Run<?, ?> build)
+  {
+    if (build.getParent() instanceof BuildableItemWithBuildWrappers)
+    {
+      BuildableItemWithBuildWrappers project = (BuildableItemWithBuildWrappers)build.getParent();
+      for (BuildWrapper wrapper : project.getBuildWrappersList())
+      {
+        if (wrapper instanceof LogstashBuildWrapper)
+        {
+          return true;
+        }
+      }
+    }
+    return false;
+  }
+
+}

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

@@ -29,11 +29,6 @@
 
 import java.io.IOException;
 import java.io.OutputStream;
-import java.util.ArrayList;
-import java.util.List;
-
-import com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsBuildWrapper.VarPasswordPair;
-import com.michelin.cio.hudson.plugins.maskpasswords.MaskPasswordsOutputStream;
 
 /**
  * Output stream that writes each line to the provided delegate output stream
@@ -58,14 +53,6 @@ LogstashWriter getLogstashWriter()
     return logstash;
   }
 
-  public MaskPasswordsOutputStream maskPasswords(List<VarPasswordPair> passwords) {
-    List<String> passwordStrings = new ArrayList<String>();
-    for (VarPasswordPair password: passwords) {
-      passwordStrings.add(password.getPassword());
-    }
-    return new MaskPasswordsOutputStream(this, passwordStrings);
-  }
-
   @Override
   protected void eol(byte[] b, int len) throws IOException {
     delegate.write(b, 0, len);

src/main/java/jenkins/plugins/logstash/pipeline/LogstashStep.java

@@ -1,8 +1,6 @@
 package jenkins.plugins.logstash.pipeline;
 
 import java.io.IOException;
-import java.io.OutputStream;
-import java.io.Serializable;
 
 import javax.annotation.Nonnull;
 
@@ -16,11 +14,9 @@
 
 import hudson.Extension;
 import hudson.console.ConsoleLogFilter;
-import hudson.model.AbstractBuild;
 import hudson.model.Run;
 import jenkins.YesNoMaybe;
-import jenkins.plugins.logstash.LogstashOutputStream;
-import jenkins.plugins.logstash.LogstashWriter;
+import jenkins.plugins.logstash.LogstashConsoleLogFilter;
 
 /**
  * Pipeline plug-in step for logstash.
@@ -90,29 +86,4 @@ public boolean takesImplicitBlockArgument() {
       return true;
     }
   }
-
-  private static class LogstashConsoleLogFilter extends ConsoleLogFilter
-      implements Serializable {
-
-    private static final long serialVersionUID = 1;
-    private transient Run<?, ?> run;
-
-    /**
-     * Create a new {@link LogstashConsoleLogFilter} for the given build.
-     *
-     * @param build
-     */
-    LogstashConsoleLogFilter(Run<?, ?> run) {
-        this.run = run;
-    }
-
-    /** {@inheritDoc} */
-    @SuppressWarnings("rawtypes")
-    @Override
-    public OutputStream decorateLogger(AbstractBuild _ignore, OutputStream logger)
-        throws IOException, InterruptedException {
-        LogstashWriter writer = new LogstashWriter(run, logger, null, run.getCharset());
-      return new LogstashOutputStream(logger, writer);
-    }
-  }
 }