WIP: Add support for Jenkins pipeline

Pipelines don't use AbstractProject and AbstractBuild. Instead, they use
WorkflowJob and WorkflowRun. The common ancestors are Job and Run.

There are some common interfaces implemented by freestyle projects and
pipelines, which allows us to retain most of the functionality when
operating in a pipeline.

Custom messages for post-build-comments are not implemented yet.

Original patch by Robert Hencke <[email protected]>

Author: proski

src/main/java/stashpullrequestbuilder/stashpullrequestbuilder/StashBuildListener.java

@@ -1,7 +1,7 @@
 package stashpullrequestbuilder.stashpullrequestbuilder;
 
 import hudson.Extension;
-import hudson.model.AbstractBuild;
+import hudson.model.Run;
 import hudson.model.TaskListener;
 import hudson.model.listeners.RunListener;
 import java.lang.invoke.MethodHandles;
@@ -10,26 +10,26 @@
 
 /** Created by Nathan McCarthy */
 @Extension
-public class StashBuildListener extends RunListener<AbstractBuild> {
+public class StashBuildListener extends RunListener<Run<?, ?>> {
   private static final Logger logger =
       Logger.getLogger(MethodHandles.lookup().lookupClass().getName());
 
   @Override
-  public void onStarted(AbstractBuild abstractBuild, TaskListener listener) {
+  public void onStarted(Run<?, ?> run, TaskListener listener) {
     logger.info("BuildListener onStarted called.");
-    StashBuildTrigger trigger = StashBuildTrigger.getTrigger(abstractBuild.getProject());
+    StashBuildTrigger trigger = StashBuildTrigger.getTrigger(run.getParent());
     if (trigger == null) {
       return;
     }
-    trigger.getBuilder().getBuilds().onStarted(abstractBuild);
+    trigger.getBuilder().getBuilds().onStarted(run);
   }
 
   @Override
-  public void onCompleted(AbstractBuild abstractBuild, @Nonnull TaskListener listener) {
-    StashBuildTrigger trigger = StashBuildTrigger.getTrigger(abstractBuild.getProject());
+  public void onCompleted(Run<?, ?> run, @Nonnull TaskListener listener) {
+    StashBuildTrigger trigger = StashBuildTrigger.getTrigger(run.getParent());
     if (trigger == null) {
       return;
     }
-    trigger.getBuilder().getBuilds().onCompleted(abstractBuild, listener);
+    trigger.getBuilder().getBuilds().onCompleted(run, listener);
   }
 }

src/main/java/stashpullrequestbuilder/stashpullrequestbuilder/StashBuildTrigger.java

@@ -10,10 +10,11 @@
 import com.cloudbees.plugins.credentials.domains.URIRequirementBuilder;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import hudson.Extension;
-import hudson.model.AbstractProject;
 import hudson.model.Build;
 import hudson.model.Cause;
+import hudson.model.CauseAction;
 import hudson.model.Item;
+import hudson.model.Job;
 import hudson.model.ParameterDefinition;
 import hudson.model.ParameterValue;
 import hudson.model.ParametersAction;
@@ -37,7 +38,9 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import jenkins.model.Jenkins;
+import jenkins.model.ParameterizedJobMixIn;
 import net.sf.json.JSONObject;
+import org.acegisecurity.Authentication;
 import org.apache.commons.lang.StringUtils;
 import org.kohsuke.stapler.AncestorInPath;
 import org.kohsuke.stapler.DataBoundConstructor;
@@ -47,7 +50,7 @@
 
 /** Created by Nathan McCarthy */
 @SuppressFBWarnings({"WMI_WRONG_MAP_ITERATOR", "NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"})
-public class StashBuildTrigger extends Trigger<AbstractProject<?, ?>> {
+public class StashBuildTrigger extends Trigger<Job<?, ?>> {
   private static final Logger logger =
       Logger.getLogger(MethodHandles.lookup().lookupClass().getName());
   private final String projectPath;
@@ -138,11 +141,16 @@ public String getcredentialsId() {
   }
 
   private StandardUsernamePasswordCredentials getCredentials() {
+    Authentication defaultAuth = null;
+    if (job instanceof Queue.Task) {
+      defaultAuth = Tasks.getDefaultAuthenticationOf((Queue.Task) job);
+    }
+
     return CredentialsMatchers.firstOrNull(
         CredentialsProvider.lookupCredentials(
             StandardUsernamePasswordCredentials.class,
             this.job,
-            Tasks.getDefaultAuthenticationOf(this.job),
+            defaultAuth,
             URIRequirementBuilder.fromUri(stashHost).build()),
         CredentialsMatchers.allOf(CredentialsMatchers.withId(credentialsId)));
   }
@@ -196,19 +204,26 @@ public boolean isCancelOutdatedJobsEnabled() {
   }
 
   @Override
-  public void start(AbstractProject<?, ?> project, boolean newInstance) {
+  public void start(Job<?, ?> job, boolean newInstance) {
     try {
-      Objects.requireNonNull(project, "project is null");
-      this.stashPullRequestsBuilder = new StashPullRequestsBuilder(project, this);
+      Objects.requireNonNull(job, "job is null");
+      this.stashPullRequestsBuilder = new StashPullRequestsBuilder(job, this);
     } catch (NullPointerException e) {
       logger.log(Level.SEVERE, "Can't start trigger", e);
       return;
     }
-    super.start(project, newInstance);
+    super.start(job, newInstance);
   }
 
-  public static StashBuildTrigger getTrigger(AbstractProject project) {
-    Trigger trigger = project.getTrigger(StashBuildTrigger.class);
+  public static StashBuildTrigger getTrigger(Job job) {
+    if (!(job instanceof ParameterizedJobMixIn.ParameterizedJob)) {
+      return null;
+    }
+
+    ParameterizedJobMixIn.ParameterizedJob parameterizedJob =
+        (ParameterizedJobMixIn.ParameterizedJob) job;
+
+    Trigger trigger = parameterizedJob.getTriggers().get(descriptor);
     return (StashBuildTrigger) trigger;
   }
 
@@ -231,7 +246,21 @@ public QueueTaskFuture<?> startJob(StashCause cause) {
       abortRunningJobsThatMatch(cause);
     }
 
-    return job.scheduleBuild2(job.getQuietPeriod(), cause, new ParametersAction(values));
+    ParameterizedJobMixIn jobMixIn =
+        new ParameterizedJobMixIn() {
+          @Override
+          protected Job asJob() {
+            return StashBuildTrigger.this.job;
+          }
+        };
+
+    int quietPeriod = Jenkins.getInstance().getQuietPeriod();
+    if (job instanceof ParameterizedJobMixIn.ParameterizedJob) {
+      quietPeriod = ((ParameterizedJobMixIn.ParameterizedJob) job).getQuietPeriod();
+    }
+
+    return jobMixIn.scheduleBuild2(
+        quietPeriod, new CauseAction(cause), new ParametersAction(values));
   }
 
   private void cancelPreviousJobsInQueueThatMatch(@Nonnull StashCause stashCause) {
@@ -300,9 +329,9 @@ public void run() {
       return;
     }
 
-    AbstractProject project = stashPullRequestsBuilder.getProject();
-    if (project.isDisabled()) {
-      logger.fine(format("Project disabled, skipping build (%s).", project.getName()));
+    Job<?, ?> job = stashPullRequestsBuilder.getJob();
+    if (job.isBuildable()) {
+      logger.fine(format("Project disabled, skipping build (%s).", job.getName()));
       return;
     }
 

src/main/java/stashpullrequestbuilder/stashpullrequestbuilder/StashBuilds.java

@@ -1,8 +1,10 @@
 package stashpullrequestbuilder.stashpullrequestbuilder;
 
 import hudson.Util;
-import hudson.model.AbstractBuild;
+import hudson.model.AbstractProject;
+import hudson.model.Job;
 import hudson.model.Result;
+import hudson.model.Run;
 import hudson.model.TaskListener;
 import java.io.IOException;
 import java.lang.invoke.MethodHandles;
@@ -22,40 +24,43 @@ public StashBuilds(StashBuildTrigger trigger, StashRepository repository) {
     this.repository = repository;
   }
 
-  public void onStarted(AbstractBuild<?, ?> build) {
-    StashCause cause = build.getCause(StashCause.class);
+  public void onStarted(Run<?, ?> run) {
+    StashCause cause = run.getCause(StashCause.class);
     if (cause == null) {
       return;
     }
     try {
-      build.setDescription(cause.getShortDescription());
+      run.setDescription(cause.getShortDescription());
     } catch (IOException e) {
       logger.log(Level.SEVERE, "Can't update build description", e);
     }
   }
 
-  public void onCompleted(AbstractBuild<?, ?> build, TaskListener listener) {
-    StashCause cause = build.getCause(StashCause.class);
+  public void onCompleted(Run<?, ?> run, TaskListener listener) {
+    StashCause cause = run.getCause(StashCause.class);
     if (cause == null) {
       return;
     }
-    Result result = build.getResult();
+    Result result = run.getResult();
     // Note: current code should no longer use "new JenkinsLocationConfiguration()"
     // as only one instance per runtime is really supported by the current core.
     JenkinsLocationConfiguration globalConfig = JenkinsLocationConfiguration.get();
     String rootUrl = globalConfig == null ? null : globalConfig.getUrl();
     String buildUrl = "";
     if (rootUrl == null) {
-      buildUrl = " PLEASE SET JENKINS ROOT URL FROM GLOBAL CONFIGURATION " + build.getUrl();
+      buildUrl = " PLEASE SET JENKINS ROOT URL FROM GLOBAL CONFIGURATION " + run.getUrl();
     } else {
-      buildUrl = rootUrl + build.getUrl();
+      buildUrl = rootUrl + run.getUrl();
     }
     repository.deletePullRequestComment(cause.getPullRequestId(), cause.getBuildStartCommentId());
 
     String additionalComment = "";
+    StashPostBuildComment comments = null;
+    Job<?, ?> job = run.getParent();
 
-    StashPostBuildComment comments =
-        build.getProject().getPublishersList().get(StashPostBuildComment.class);
+    if (job instanceof AbstractProject<?, ?>) {
+      comments = ((AbstractProject<?, ?>) job).getPublishersList().get(StashPostBuildComment.class);
+    }
 
     if (comments != null) {
       String buildComment =
@@ -66,28 +71,27 @@ public void onCompleted(AbstractBuild<?, ?> build, TaskListener listener) {
       if (buildComment != null && !buildComment.isEmpty()) {
         String expandedComment;
         try {
-          expandedComment =
-              Util.fixEmptyAndTrim(build.getEnvironment(listener).expand(buildComment));
+          expandedComment = Util.fixEmptyAndTrim(run.getEnvironment(listener).expand(buildComment));
         } catch (IOException | InterruptedException e) {
           expandedComment = "Exception while expanding '" + buildComment + "': " + e;
         }
 
         additionalComment = "\n\n" + expandedComment;
       }
     }
-    String duration = build.getDurationString();
+    String duration = run.getDurationString();
     repository.postFinishedComment(
         cause.getPullRequestId(),
         cause.getSourceCommitHash(),
         cause.getDestinationCommitHash(),
         result,
         buildUrl,
-        build.getNumber(),
+        run.getNumber(),
         additionalComment,
         duration);
 
     // Merge PR
-    if (trigger.getMergeOnSuccess() && build.getResult() == Result.SUCCESS) {
+    if (trigger.getMergeOnSuccess() && run.getResult() == Result.SUCCESS) {
       boolean mergeStat =
           repository.mergePullRequest(cause.getPullRequestId(), cause.getPullRequestVersion());
       if (mergeStat == true) {

src/main/java/stashpullrequestbuilder/stashpullrequestbuilder/StashPullRequestsBuilder.java

@@ -2,7 +2,7 @@
 
 import static java.lang.String.format;
 
-import hudson.model.AbstractProject;
+import hudson.model.Job;
 import java.lang.invoke.MethodHandles;
 import java.util.Collection;
 import java.util.logging.Logger;
@@ -13,29 +13,28 @@
 public class StashPullRequestsBuilder {
   private static final Logger logger =
       Logger.getLogger(MethodHandles.lookup().lookupClass().getName());
-  private AbstractProject<?, ?> project;
+  private Job<?, ?> job;
   private StashBuildTrigger trigger;
   private StashRepository repository;
   private StashBuilds builds;
 
-  public StashPullRequestsBuilder(
-      @Nonnull AbstractProject project, @Nonnull StashBuildTrigger trigger) {
-    this.project = project;
+  public StashPullRequestsBuilder(@Nonnull Job<?, ?> job, @Nonnull StashBuildTrigger trigger) {
+    this.job = job;
     this.trigger = trigger;
     this.repository = new StashRepository(trigger.getProjectPath(), this);
     this.builds = new StashBuilds(trigger, repository);
   }
 
   public void run() {
-    logger.info(format("Build Start (%s).", project.getName()));
+    logger.info(format("Build Start (%s).", job.getName()));
     this.repository.init();
     Collection<StashPullRequestResponseValue> targetPullRequests =
         this.repository.getTargetPullRequests();
     this.repository.addFutureBuildTasks(targetPullRequests);
   }
 
-  public AbstractProject<?, ?> getProject() {
-    return this.project;
+  public Job<?, ?> getJob() {
+    return this.job;
   }
 
   public StashBuildTrigger getTrigger() {

src/main/java/stashpullrequestbuilder/stashpullrequestbuilder/StashRepository.java

@@ -73,7 +73,7 @@ public void init() {
   }
 
   public Collection<StashPullRequestResponseValue> getTargetPullRequests() {
-    logger.info(format("Fetch PullRequests (%s).", builder.getProject().getName()));
+    logger.info(format("Fetch PullRequests (%s).", builder.getJob().getName()));
     List<StashPullRequestResponseValue> pullRequests = client.getPullRequests();
     List<StashPullRequestResponseValue> targetPullRequests =
         new ArrayList<StashPullRequestResponseValue>();
@@ -90,10 +90,7 @@ public String postBuildStartCommentTo(StashPullRequestResponseValue pullRequest)
     String destinationCommit = pullRequest.getToRef().getLatestCommit();
     String comment =
         format(
-            BUILD_START_MARKER,
-            builder.getProject().getDisplayName(),
-            sourceCommit,
-            destinationCommit);
+            BUILD_START_MARKER, builder.getJob().getDisplayName(), sourceCommit, destinationCommit);
     StashPullRequestComment commentResponse =
         this.client.postPullRequestComment(pullRequest.getId(), comment);
     return commentResponse.getCommentId().toString();
@@ -216,7 +213,7 @@ public void postFinishedComment(
     String comment =
         format(
             BUILD_FINISH_SENTENCE,
-            builder.getProject().getDisplayName(),
+            builder.getJob().getDisplayName(),
             sourceCommit,
             destinationCommit,
             message,
@@ -292,7 +289,7 @@ private void deletePreviousBuildFinishedComments(StashPullRequestResponseValue p
         }
 
         String project_build_finished =
-            format(BUILD_FINISH_REGEX, builder.getProject().getDisplayName());
+            format(BUILD_FINISH_REGEX, builder.getJob().getDisplayName());
         Matcher finishMatcher =
             Pattern.compile(project_build_finished, Pattern.CASE_INSENSITIVE).matcher(content);
 
@@ -354,7 +351,7 @@ private boolean isBuildTarget(StashPullRequestResponseValue pullRequest) {
           }
 
           // These will match any start or finish message -- need to check commits
-          String escapedBuildName = Pattern.quote(builder.getProject().getDisplayName());
+          String escapedBuildName = Pattern.quote(builder.getJob().getDisplayName());
           String project_build_start = String.format(BUILD_START_REGEX, escapedBuildName);
           String project_build_finished = String.format(BUILD_FINISH_REGEX, escapedBuildName);
           Matcher startMatcher =