Merge pull request #61 from jenkinsci/branch-filter

Branch filter

Author: sanderv32

Jenkinsfile

@@ -1 +1 @@
-buildPlugin()
+buildPlugin(platforms: ['linux'])

README.md

@@ -6,7 +6,7 @@ Gogs-Webhook Plugin
 This plugin integrates [Gogs](https://gogs.io/) to Jenkins.<br>
 
 In Gogs configure your webhook like this:<br>
-http(s)://<< jenkins-server >>/gogs-webhook/?job=<< jobname >>
+http(s)://<< jenkins-server >>/gogs-webhook/?job=<< jobname >>[&branch=<< branch name>>]
 
 Example how your the webhook in Gogs should look like:
 ![Example webhook](https://github.com/jenkinsci/gogs-webhook-plugin/raw/master/bin/gogs-webhook-screenshot.png)

src/main/java/org/jenkinsci/plugins/gogs/GogsWebHook.java

@@ -33,6 +33,7 @@ associated documentation files (the "Software"), to deal in the Software without
 import org.acegisecurity.context.SecurityContextHolder;
 import org.apache.commons.codec.binary.Hex;
 import org.apache.commons.io.IOUtils;
+import org.apache.commons.lang.StringUtils;
 import org.kohsuke.stapler.StaplerRequest;
 import org.kohsuke.stapler.StaplerResponse;
 
@@ -146,6 +147,8 @@ public void doIndex(StaplerRequest req, StaplerResponse rsp) throws IOException
             jobName = jobObject.toString();
         }
 
+        final Object branchName = queryStringMap.get("branch");
+
         // Get the POST stream
         String body = IOUtils.toString(req.getInputStream(), DEFAULT_CHARSET);
         if (!body.isEmpty() && req.getRequestURI().contains("/" + URLNAME + "/")) {
@@ -160,6 +163,17 @@ public void doIndex(StaplerRequest req, StaplerResponse rsp) throws IOException
                 return;
             }
 
+            String ref = jsonObject.getString("ref");
+            LOGGER.fine("found ref " + ref);
+            LOGGER.fine("found branch " + branchName);
+            if (null != branchName && !StringUtils.containsIgnoreCase(ref, (String) branchName)) {
+                // ignore all commit if they is not in context
+                LOGGER.fine("build was rejected");
+                result.setStatus(200, String.format("Commit is not relevant. Relevant context is %s", branchName));
+                exitWebHook(result, rsp);
+                return;
+            }
+
             String contentType = req.getContentType();
             if (contentType != null && contentType.startsWith("application/x-www-form-urlencoded")) {
                 body = URLDecoder.decode(body, DEFAULT_CHARSET);
@@ -174,7 +188,7 @@ public void doIndex(StaplerRequest req, StaplerResponse rsp) throws IOException
             // filter branch, if ref not match branch filter, skip trigger job.
             boolean isRefMatched = true;
 
-            String ref = (String) jsonObject.getString("ref");
+
             payloadProcessor.setPayload("ref", ref);
             payloadProcessor.setPayload("before", jsonObject.getString("before"));
 

src/test/java/org/jenkinsci/plugins/gogs/GogsConfigHandler.java

@@ -193,6 +193,20 @@ void createEmptyRepo(String projectName) throws IOException {
         }
     }
 
+    void removeRepo(String projectName) throws IOException {
+        Executor executor = getExecutor();
+        String gogsHookConfigUrl = getGogsServer_apiUrl() + "repos/" + this.gogsServer_user + "/" + projectName;
+        Request request = Request.Delete(gogsHookConfigUrl);
+
+        if (this.gogsAccessToken != null) {
+            request.addHeader("Authorization", "token " + this.gogsAccessToken);
+        }
+
+        int result = executor.execute(request).returnResponse().getStatusLine().getStatusCode();
+        if (result != 204) {
+            throw new IOException("Repository deletion call did not return the expected value (returned " +  result + ")");
+        }
+    }
 
     /**
      * Gets a Executor object. The Executor object allows to cache the authentication data.