Ignorable pusher

pom.xml

@@ -47,7 +47,7 @@
     <dependency>
       <groupId>org.jmock</groupId>
       <artifactId>jmock-junit4</artifactId>
-      <version>2.5.1</version>
+      <version>2.8.1</version>
       <scope>test</scope>
     </dependency>
     <dependency>

src/main/java/com/cloudbees/jenkins/GitHubPushTrigger.java

@@ -53,8 +53,26 @@
  * @author Kohsuke Kawaguchi
  */
 public class GitHubPushTrigger extends Trigger<AbstractProject<?, ?>> implements GitHubTrigger {
+    String pushBy;
+    private final String ignorablePusher;
+
     @DataBoundConstructor
+    public GitHubPushTrigger(final String ignorablePusher) {
+        this.ignorablePusher = ignorablePusher;
+    }
+
     public GitHubPushTrigger() {
+        this("");
+    }
+
+    @Override
+    public String pushBy() {
+        return pushBy;
+    }
+
+    @Override
+    public String getIgnorablePusher() {
+        return ignorablePusher;
     }
 
     /**
@@ -69,7 +87,7 @@ public void onPost() {
      * Called when a POST is made.
      */
     public void onPost(String triggeredByUser) {
-        final String pushBy = triggeredByUser;
+        pushBy = triggeredByUser;
         getDescriptor().queue.execute(new Runnable() {
             private boolean runPolling() {
                 try {

src/main/java/com/cloudbees/jenkins/GitHubTrigger.java

@@ -50,4 +50,15 @@ public void parseAssociatedNames(AbstractProject<?, ?> job, Collection<GitHubRep
             }
         }
     }
+
+    String pushBy();
+
+    /**
+     * Gets the regular expression to which the name or email of an ignorable pusher is to be
+     * matched.
+     *
+     * @return the regular expression to which the name or email of an ignorable pusher is to be
+     *         matched.
+     */
+    String getIgnorablePusher();
 }

src/main/java/com/cloudbees/jenkins/GitHubWebHook.java

@@ -10,8 +10,10 @@
 import hudson.triggers.Trigger;
 import hudson.util.AdaptedIterator;
 import hudson.util.Iterators.FilterIterator;
+
 import jenkins.model.Jenkins;
 import net.sf.json.JSONObject;
+
 import org.acegisecurity.Authentication;
 import org.acegisecurity.context.SecurityContextHolder;
 import org.apache.commons.codec.binary.Base64;
@@ -32,7 +34,6 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-
 /**
  * Receives github hook.
  *
@@ -186,7 +187,9 @@ public void doIndex(StaplerRequest req, StaplerResponse rsp) {
     public void processGitHubPayload(String payload, Class<? extends Trigger<?>> triggerClass) {
         JSONObject o = JSONObject.fromObject(payload);
         String repoUrl = o.getJSONObject("repository").getString("url"); // something like 'https://github.com/kohsuke/foo'
-        String pusherName = o.getJSONObject("pusher").getString("name");
+        final JSONObject pusher = o.getJSONObject("pusher");
+        final String pusherName = pusher.getString("name");
+        final String pusherEmail = pusher.getString("email");
 
         LOGGER.info("Received POST for {}", repoUrl);
         LOGGER.debug("Full details of the POST was {}", o.toString());
@@ -207,6 +210,22 @@ public void processGitHubPayload(String payload, Class<? extends Trigger<?>> tri
                 for (AbstractProject<?, ?> job : Jenkins.getInstance().getAllItems(AbstractProject.class)) {
                     GitHubTrigger trigger = (GitHubTrigger) job.getTrigger(triggerClass);
                     if (trigger != null) {
+                        final String regex = trigger.getIgnorablePusher();
+
+                        if (pusherName != null && !pusherName.isEmpty()
+                                && pusherName.matches(regex)) {
+
+                            LOGGER.info("Ignoring pusher [{}] ...", pusherName);
+                            continue;
+                        }
+
+                        if (pusherEmail != null && !pusherEmail.isEmpty()
+                                && pusherEmail.matches(regex)) {
+
+                            LOGGER.info("Ignoring pusher [{}] ...", pusherEmail);
+                            continue;
+                        }
+
                         LOGGER.debug("Considering to poke {}", job.getFullDisplayName());
                         if (GitHubRepositoryNameContributor.parseAssociatedNames(job).contains(changedRepository)) {
                             LOGGER.info("Poked {}", job.getFullDisplayName());

src/main/resources/com/cloudbees/jenkins/GitHubPushTrigger/config.jelly

@@ -0,0 +1,5 @@
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
+  <f:entry title="${%github.ignorablePusher}" help="/descriptor/com.cloudbees.jenkins.GitHubPushTrigger/help/ignorablePusher">
+    <f:textbox name="github.ignorablePusher" value="${instance.ignorablePusher}" />
+  </f:entry>
+</j:jelly>

src/main/resources/com/cloudbees/jenkins/GitHubPushTrigger/config.properties

@@ -0,0 +1 @@
+github.ignorablePusher=Ignorable pusher

src/main/resources/com/cloudbees/jenkins/GitHubPushTrigger/config_de.properties

@@ -0,0 +1 @@
+github.ignorablePusher=Ignorierbarer Pusher

src/main/resources/com/cloudbees/jenkins/GitHubPushTrigger/help-ignorablePusher.html

@@ -0,0 +1,3 @@
+<div>
+  This defines a regular expression to which the name or email of an ignorable pusher is to be matched. Such a push wil be ignored. Normally a preceding push of Jenkins him self could be prevented that way.
+</div>

src/main/resources/com/cloudbees/jenkins/GitHubPushTrigger/help-ignorablePusher_de.html

@@ -0,0 +1,3 @@
+<div>
+  Hier wird ein regulärer Ausdruck definiert, der zu dem Namen oder der E-Mail eines ignorierbaren Pushers paßt. Solch ein Push wird ignoriert. Üblicherweise kann kann auf diese Weise damit ein vorhergehender Push von Jenkins selber verhindert werden.
+</div>

src/test/java/com/cloudbees/jenkins/GitHubPushTriggerTestCase.java

@@ -0,0 +1,84 @@
+package com.cloudbees.jenkins;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import hudson.model.FreeStyleProject;
+import hudson.plugins.git.GitSCM;
+import hudson.scm.SCM;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.nio.charset.StandardCharsets;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+
+import com.cloudbees.jenkins.GitHubPushTrigger.DescriptorImpl;
+
+/**
+ * @author <a href = "mailto:achim.derigs@graudata.com">Achim Derigs</a>
+ */
+public final class GitHubPushTriggerTestCase {
+
+    @Rule
+    public final JenkinsRule j = new JenkinsRule();
+
+    private static void triggerWebHook(final String repositoryUrl, final String pusherName)
+            throws IOException {
+
+        final DescriptorImpl descriptor = DescriptorImpl.get();
+        final URL url = descriptor.getHookUrl();
+        final HttpURLConnection connection = (HttpURLConnection) url.openConnection();
+        connection.setRequestMethod("POST");
+        connection.setDoOutput(true);
+        connection.connect();
+
+        final String payload = "payload={\"repository\":{\"url\":\"" + repositoryUrl
+                + "\"},\"pusher\":{\"name\":\"" + pusherName + "\",\"email\":\"\"}}";
+
+        final OutputStream stream = connection.getOutputStream();
+
+        try {
+            stream.write(payload.getBytes(StandardCharsets.UTF_8));
+        } finally {
+            stream.close();
+        }
+
+        assertEquals(HttpURLConnection.HTTP_OK, connection.getResponseCode());
+    }
+
+    @Test
+    public void trigger() throws IOException {
+        final String repositoryUrl = "https://github.com/OpenDataSpace/parent";
+        final SCM scm = new GitSCM(repositoryUrl);
+        final FreeStyleProject project = j.createFreeStyleProject();
+        project.setScm(scm);
+
+        final String expected = System.getProperty("user.name");
+        final GitHubPushTrigger trigger = new GitHubPushTrigger();
+        project.addTrigger(trigger);
+        triggerWebHook(repositoryUrl, expected);
+
+        final String actual = trigger.pushBy();
+        assertEquals(expected, actual);
+    }
+
+    @Test
+    public void ignore() throws IOException {
+        final String repositoryUrl = "https://github.com/OpenDataSpace/parent";
+        final SCM scm = new GitSCM(repositoryUrl);
+        final FreeStyleProject project = j.createFreeStyleProject();
+        project.setScm(scm);
+
+        final String pusherName = System.getProperty("user.name");
+        final GitHubPushTrigger trigger = new GitHubPushTrigger(pusherName);
+        project.addTrigger(trigger);
+        triggerWebHook(repositoryUrl, pusherName);
+
+        final Object object = trigger.pushBy();
+        assertNull(object);
+    }
+}