Merge pull request jenkinsci#90 from paschdan/review-trigger-with-integration

aaronjwhiteside · web-flow · commit f8c080f9e876 · 2020-10-09T21:23:05.000+11:00
Review trigger with integration
diff --git a/README.md b/README.md
@@ -49,6 +49,9 @@ If you plan to use this plugin to add/modify/remove comments, labels, commit sta
 
 This plugin adds the following pipeline triggers
 
+* issueCommentTrigger
+* pullRequestReview
+
 ## issueCommentTrigger
 
 ### Requirements
@@ -120,6 +123,60 @@ The GitHub comment and author that triggered the build are exposed as environmen
 * `GITHUB_COMMENT`
 * `GITHUB_COMMENT_AUTHOR`
 
+## pullRequestReview
+
+### Parameters
+
+- `reviewStates` (__Optional__) - A Java array of the PR review states you wish to trigger the build with. If not specified it will trigger for any review state. Possible states are `pending, approved, changes_requested, commented, dismissed`
+
+### Usage
+
+#### Scripted Pipeline:
+```groovy
+properties([
+    pipelineTriggers([
+      pullRequestReview(reviewStates: ['approved'])
+    ])
+])
+```
+
+#### Declarative Pipeline:
+```groovy
+pipeline {
+    triggers {
+      pullRequestReview(reviewStates: ['approved'])
+    }
+}
+```
+
+#### Detecting whether a build was started by the trigger in a script:
+
+Note that the following uses `currentBuild.rawBuild` and should therefore only
+be done in a `@NonCPS` context. See [the workflow-cps-plugin Technical Design
+](https://github.com/jenkinsci/workflow-cps-plugin/blob/master/README.md#technical-design)
+for more information.
+
+```groovy
+def triggerCause = currentBuild.rawBuild.getCause(org.jenkinsci.plugins.pipeline.github.trigger.PullRequestReviewCause)
+
+if (triggerCause) {
+    echo("Build was started by ${triggerCause.userLogin}, who reviewed the PR: " +
+         "\"${triggerCause.state}\", which matches one of " +
+         "\"${triggerCause.reviewStates}\" trigger pattern.")
+} else {
+    echo('Build was not started by a trigger')
+}
+```
+
+#### Environment variables
+
+The GitHub review comment and author that triggered the build are exposed as environment variables (from version > 2.8).
+
+* `GITHUB_REVIEW_COMMENT`
+* `GITHUB_REVIEW_AUTHOR`
+* `GITHUB_REVIEW_STATE`
+
+
 # Global Variables
 
 ## `repository`
diff --git a/pom.xml b/pom.xml
@@ -39,7 +39,7 @@
         <connection>scm:git:https://github.com/jenkinsci/${project.artifactId}-plugin.git</connection>
         <developerConnection>scm:git:ssh://git@github.com/jenkinsci/${project.artifactId}-plugin.git</developerConnection>
         <url>http://github.com/jenkinsci/${project.artifactId}-plugin</url>
-        <tag>pipeline-github-2.6</tag>
+        <tag>${scmTag}</tag>
     </scm>
 
     <repositories>
diff --git a/src/main/java/org/jenkinsci/plugins/pipeline/github/trigger/GitHubEventSubscriber.java b/src/main/java/org/jenkinsci/plugins/pipeline/github/trigger/GitHubEventSubscriber.java
@@ -16,6 +16,7 @@
 import org.kohsuke.github.GHEvent;
 import org.kohsuke.github.GHEventPayload;
 import org.kohsuke.github.GHIssueComment;
+import org.kohsuke.github.GHPullRequestReview;
 import org.kohsuke.github.GitHub;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -73,6 +74,9 @@ protected void onEvent(final GHSubscriberEvent event) {
             case ISSUE_COMMENT:
                 handleIssueComment(event);
                 break;
+            case PULL_REQUEST_REVIEW:
+                handlePullRequestReview(event);
+                break;
             default:
                 // no-op
         }
@@ -189,12 +193,115 @@ private boolean triggerMatches(final IssueCommentTrigger trigger,
         return false;
     }
 
+    private void handlePullRequestReview(final GHSubscriberEvent event) {
+        // we only care about created or updated events
+        switch (event.getType()) {
+            case CREATED:
+            case UPDATED:
+            // case: SUBMITTED:
+                break;
+            default:
+                return;
+        }
+        // decode payload
+        final GHEventPayload.PullRequestReview pullRequestReview;
+        try {
+            pullRequestReview = GitHub.offline()
+                    .parseEventPayload(new StringReader(event.getPayload()), GHEventPayload.PullRequestReview.class);
+        } catch (final IOException e) {
+            LOG.error("Unable to parse the payload of GHSubscriberEvent: {}", event, e);
+            return;
+        }
+
+        switch (pullRequestReview.getAction()) {
+            case "submitted":
+                break;
+            default:
+                LOG.debug("Ignoring pullRequestReview: {} with Action: {}",
+                pullRequestReview.getReview(), pullRequestReview.getAction());
+                return;
+        }
+
+        final String key = String.format("%s/%s/%d",
+                pullRequestReview.getRepository().getOwnerName(),
+                pullRequestReview.getRepository().getName(),
+                pullRequestReview.getPullRequest().getNumber());
+
+        // lookup trigger
+        final PullRequestReviewTrigger.DescriptorImpl triggerDescriptor = (PullRequestReviewTrigger.DescriptorImpl) Jenkins.get()
+                .getDescriptor(PullRequestReviewTrigger.class);
+
+        if (triggerDescriptor == null) {
+            LOG.error("Unable to find the PullRequestReview Trigger, this shouldn't happen.");
+            return;
+        }
+        String reviewer = pullRequestReview.getSender().getLogin();
+
+        // create values for the action if a new job is triggered afterward
+        ArrayList<ParameterValue> reviewEnvVars = new ArrayList<ParameterValue>();
+        reviewEnvVars.add(new StringParameterValue("GITHUB_REVIEW_COMMENT", String.valueOf(pullRequestReview.getReview().getBody())));
+        reviewEnvVars.add(new StringParameterValue("GITHUB_REVIEW_AUTHOR", reviewer));
+        reviewEnvVars.add(new StringParameterValue("GITHUB_REVIEW_STATE", pullRequestReview.getReview().getState().name()));
+
+
+        for (final WorkflowJob job : triggerDescriptor.getJobs(key)) {
+            // find triggers
+            final List<PullRequestReviewTrigger> matchingTriggers = job.getTriggersJobProperty()
+                    .getTriggers()
+                    .stream()
+                    .filter(PullRequestReviewTrigger.class::isInstance)
+                    .map(PullRequestReviewTrigger.class::cast)
+                    .filter(t -> triggerMatches(t, pullRequestReview.getReview(), job))
+                    .collect(Collectors.toList());
+
+            // check if they have authorization
+            for (final PullRequestReviewTrigger matchingTrigger : matchingTriggers) {
+                boolean authorized = isAuthorized(job, reviewer);
+
+                if (authorized) {
+                    job.scheduleBuild2(
+                            Jenkins.get().getQuietPeriod(),
+                            new CauseAction(new PullRequestReviewCause(
+                                        reviewer,
+                                        pullRequestReview.getReview().getState().name().toLowerCase(),
+                                        pullRequestReview.getReview().getBody(),
+                                        matchingTrigger.getReviewStates())),
+                            new GitHubEnvironmentVariablesAction(reviewEnvVars));
+
+                    LOG.info("Job: {} triggered by PullRequestReview: {}",
+                            job.getFullName(), pullRequestReview.getReview());
+                } else {
+                    LOG.warn("Job: {}, PullRequestReview: {}, Reviewer: {} is not a collaborator, " +
+                                    "and is therefore not authorized to trigger a build.",
+                            job.getFullName(),
+                            pullRequestReview.getReview(),
+                            reviewer);
+                }
+            }
+        }
+    }
+
+    private boolean triggerMatches(final PullRequestReviewTrigger trigger,
+                                   final GHPullRequestReview review,
+                                   final WorkflowJob job) {
+        if (trigger.matches(review.getState().name().toLowerCase())) {
+            LOG.debug("Job: {}, PullRequestReview: {} matched one of the states: {}",
+                    job.getFullName(), review, trigger.getReviewStates());
+            return true;
+        } else {
+            LOG.debug("Job: {}, PullRequestReview: {}, state did not match the states: {}",
+                    job.getFullName(), review, trigger.getReviewStates());
+        }
+        return false;
+    }
+
     @Override
     protected Set<GHEvent> events() {
         final Set<GHEvent> events = new HashSet<>();
 //        events.add(GHEvent.PULL_REQUEST_REVIEW_COMMENT);
 //        events.add(GHEvent.COMMIT_COMMENT);
         events.add(GHEvent.ISSUE_COMMENT);
+        events.add(GHEvent.PULL_REQUEST_REVIEW);
         return Collections.unmodifiableSet(events);
     }
 }
diff --git a/src/main/java/org/jenkinsci/plugins/pipeline/github/trigger/PullRequestReviewCause.java b/src/main/java/org/jenkinsci/plugins/pipeline/github/trigger/PullRequestReviewCause.java
@@ -0,0 +1,49 @@
+package org.jenkinsci.plugins.pipeline.github.trigger;
+
+import hudson.model.Cause;
+import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.Whitelisted;
+
+/**
+ * Represents the user who reviewed the PR that triggered the build.
+ *
+ * @author Aaron Walker
+ */
+public class PullRequestReviewCause extends Cause {
+
+  private final String userLogin;
+  private final String comment;
+  private final String state;
+  private final String[] reviewStates;
+
+  public PullRequestReviewCause(final String userLogin, final String state, final String comment, final String[] reviewStates) {
+    this.userLogin = userLogin;
+    this.state = state;
+    this.comment = comment;
+    this.reviewStates = reviewStates;
+  }
+
+  @Whitelisted
+  public String getUserLogin() {
+      return userLogin;
+  }
+
+  @Whitelisted
+  public String getComment() {
+      return comment;
+  }
+  
+  @Whitelisted
+  public String getState() {
+      return state;
+  }
+
+  @Whitelisted
+  public String[] getReviewStates() {
+      return reviewStates;
+  }
+
+  @Override
+  public String getShortDescription() {
+      return String.format("%s reviewed: %s", userLogin, state);
+  }
+}
diff --git a/src/main/java/org/jenkinsci/plugins/pipeline/github/trigger/PullRequestReviewTrigger.java b/src/main/java/org/jenkinsci/plugins/pipeline/github/trigger/PullRequestReviewTrigger.java
@@ -0,0 +1,107 @@
+package org.jenkinsci.plugins.pipeline.github.trigger;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import hudson.Extension;
+import hudson.model.Item;
+import hudson.triggers.Trigger;
+import hudson.triggers.TriggerDescriptor;
+import jenkins.scm.api.SCMHead;
+import jenkins.scm.api.SCMSource;
+import org.jenkinsci.Symbol;
+import org.jenkinsci.plugins.github_branch_source.GitHubSCMSource;
+import org.jenkinsci.plugins.github_branch_source.PullRequestSCMHead;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.annotation.Nonnull;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.regex.Pattern;
+/**
+ * An PullRequestApprovalTrigger, to be used from pipeline scripts only.
+ *
+ * This trigger will not show up on a jobs configuration page.
+ *
+ * @author Aaron Walker
+ * @see org.jenkinsci.plugins.workflow.job.properties.PipelineTriggersJobProperty
+ */
+public class PullRequestReviewTrigger  extends Trigger<WorkflowJob> {
+  private static final Logger LOG = LoggerFactory.getLogger(PullRequestReviewTrigger.class);
+
+  private String[] reviewStates = null;
+
+  @DataBoundConstructor
+  public PullRequestReviewTrigger() {}
+
+  public String[] getReviewStates() {
+      return reviewStates;
+  }
+
+  @DataBoundSetter
+  public void setReviewStates(@Nonnull final String [] reviewStates) {
+      this.reviewStates = reviewStates;
+  }
+
+  @Override
+  public void start(final WorkflowJob project, final boolean newInstance) {
+      super.start(project, newInstance);
+      // we only care about pull requests
+      if (SCMHead.HeadByItem.findHead(project) instanceof PullRequestSCMHead) {
+          DescriptorImpl.jobs
+                  .computeIfAbsent(getKey(project), key -> new HashSet<>())
+                  .add(project);
+      }
+  }
+
+  @Override
+  public void stop() {
+      if (SCMHead.HeadByItem.findHead(job) instanceof PullRequestSCMHead) {
+          DescriptorImpl.jobs.getOrDefault(getKey(job), Collections.emptySet())
+                  .remove(job);
+      }
+  }
+
+  @SuppressFBWarnings("NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE")
+  private String getKey(final WorkflowJob project) {
+      final GitHubSCMSource scmSource = (GitHubSCMSource) SCMSource.SourceByItem.findSource(project);
+      final PullRequestSCMHead scmHead = (PullRequestSCMHead) SCMHead.HeadByItem.findHead(project);
+
+      return String.format("%s/%s/%d",
+              scmSource.getRepoOwner(),
+              scmSource.getRepository(),
+              scmHead.getNumber());
+  }
+
+  boolean matches(final String reviewState) {
+    if(reviewStates == null) {
+        return true; //defaults to trigger on any review state
+    } else {
+        List<String> list = Arrays.asList(reviewStates);
+        return list.contains(reviewState);
+    }
+  }
+
+  @Symbol("pullRequestReview")
+  @Extension
+  public static class DescriptorImpl extends TriggerDescriptor {
+      private transient static final Map<String, Set<WorkflowJob>> jobs = new ConcurrentHashMap<>();
+
+      @Override
+      public boolean isApplicable(final Item item) {
+          return false; // this is not configurable from the ui.
+      }
+
+      public Set<WorkflowJob> getJobs(final String key) {
+          return jobs.getOrDefault(key, Collections.emptySet());
+      }
+  }
+}
