- allow whitelisted branches to be configured via dsl (#125)

Author: jgangemi

github-pullrequest-plugin/src/main/java/com/github/kostyasha/github/integration/branch/dsl/GitHubBranchJobDslExtenstion.java

@@ -3,11 +3,15 @@
 import antlr.ANTLRException;
 import com.github.kostyasha.github.integration.branch.GitHubBranchTrigger;
 import com.github.kostyasha.github.integration.branch.dsl.context.GitHubBranchTriggerDslContext;
+
+import org.jenkinsci.plugins.github.pullrequest.restrictions.GitHubPRBranchRestriction;
+
 import hudson.Extension;
 import javaposse.jobdsl.dsl.helpers.triggers.TriggerContext;
 import javaposse.jobdsl.plugin.ContextExtensionPoint;
 import javaposse.jobdsl.plugin.DslExtensionMethod;
 
+
 /**
  * @author Kanstantsin Shautsou
  */
@@ -23,6 +27,8 @@ public Object onBranch(Runnable closure) throws ANTLRException {
         trigger.setPreStatus(context.isSetPreStatus());
         trigger.setCancelQueued(context.isCancelQueued());
         trigger.setAbortRunning(context.isAbortRunning());
+        trigger.setBranchRestriction(new GitHubPRBranchRestriction(context.whitelistedBranches()));
+
         return trigger;
     }
 }

github-pullrequest-plugin/src/main/java/com/github/kostyasha/github/integration/branch/dsl/context/GitHubBranchTriggerDslContext.java

@@ -8,6 +8,7 @@
 import org.jenkinsci.plugins.github.pullrequest.dsl.context.GitHubPRTriggerModeDslContext;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 
 /**
@@ -19,6 +20,8 @@ public class GitHubBranchTriggerDslContext implements Context {
     private boolean setPreStatus;
     private boolean cancelQueued;
     private boolean abortRunning;
+
+    private List<String> whitelistedBranches = new ArrayList<>();
     private List<GitHubBranchEvent> events = new ArrayList<>();
 
 
@@ -53,6 +56,10 @@ public void events(Runnable closure) {
         events.addAll(eventsContext.events());
     }
 
+    public void whitelistedBranches(String... branches) {
+        whitelistedBranches.addAll(Arrays.asList(branches));
+    }
+
     public String cron() {
         return cron;
     }
@@ -77,4 +84,7 @@ public List<GitHubBranchEvent> events() {
         return events;
     }
 
+    public List<String> whitelistedBranches() {
+        return whitelistedBranches;
+    }
 }

github-pullrequest-plugin/src/main/java/org/jenkinsci/plugins/github/pullrequest/restrictions/GitHubPRBranchRestriction.java

@@ -1,36 +1,41 @@
 package org.jenkinsci.plugins.github.pullrequest.restrictions;
 
-import hudson.Extension;
-import hudson.model.Describable;
-import hudson.model.Descriptor;
-import jenkins.model.Jenkins;
-import org.kohsuke.github.GHPullRequest;
-import org.kohsuke.stapler.DataBoundConstructor;
-
 import java.util.Arrays;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
+import java.util.regex.Pattern;
+
+import com.google.common.base.Joiner;
+
+import org.kohsuke.github.GHPullRequest;
+import org.kohsuke.stapler.DataBoundConstructor;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.util.regex.Pattern;
+import hudson.Extension;
+import hudson.model.Describable;
+import hudson.model.Descriptor;
+import jenkins.model.Jenkins;
 
 /**
  * Restriction by target branch (one or many).
  *
  * @author Kanstantsin Shautsou
  */
 public class GitHubPRBranchRestriction implements Describable<GitHubPRBranchRestriction> {
+    private static final String LINE_SEPARATOR = System.lineSeparator();
     private static final Logger LOGGER = LoggerFactory.getLogger(GitHubPRBranchRestriction.class);
 
-    private final String targetBranch;
     private final Set<String> targetBranchList;
 
     @DataBoundConstructor
     public GitHubPRBranchRestriction(String targetBranch) {
-        this.targetBranch = targetBranch.trim();
-        //TODO check if System.lineSeparator() is correct separator
-        this.targetBranchList = new HashSet<String>(Arrays.asList(targetBranch.split(System.lineSeparator())));
+        this(split(targetBranch));
+    }
+
+    public GitHubPRBranchRestriction(List<String> targetBranches) {
+        this.targetBranchList = new HashSet<>(targetBranches);
         targetBranchList.remove("");
     }
 
@@ -57,13 +62,18 @@ public Set<String> getTargetBranchList() {
     }
 
     public String getTargetBranch() {
-        return targetBranch;
+        // TODO check if System.lineSeparator() is correct separator
+        return Joiner.on("\n").skipNulls().join(targetBranchList);
     }
 
     public Descriptor<GitHubPRBranchRestriction> getDescriptor() {
         return (DescriptorImpl) Jenkins.getInstance().getDescriptor(GitHubPRBranchRestriction.class);
     }
 
+    private static List<String> split(String targetBranch) {
+        return Arrays.asList(targetBranch.trim().split(LINE_SEPARATOR));
+    }
+
     @Extension
     public static class DescriptorImpl extends Descriptor<GitHubPRBranchRestriction> {
         @Override

github-pullrequest-plugin/src/test/java/org/jenkinsci/plugins/github/pullrequest/dsl/GitHubPRJobDslExtensionTest.java

@@ -26,6 +26,7 @@
 import static org.hamcrest.Matchers.hasSize;
 import static org.hamcrest.Matchers.instanceOf;
 import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.notNullValue;
 import static org.jenkinsci.plugins.github.pullrequest.GitHubPRTriggerMode.HEAVY_HOOKS_CRON;
 import static org.junit.Assert.*;
 
@@ -73,6 +74,8 @@ public void shouldCreateJobWithExtendedDsl() throws Exception {
         assertThat("Should have cancel queued", trigger.isCancelQueued(), equalTo(true));
         assertThat("Should add events", trigger.getEvents(), hasSize(3));
         assertThat("Should set mode", trigger.getTriggerMode(), equalTo(HEAVY_HOOKS_CRON));
+        assertThat("Branch restriction set", trigger.getBranchRestriction(), is(notNullValue()));
+        assertThat("Restricted is master", trigger.getBranchRestriction().getTargetBranch(), equalTo("master"));
     }
 
 }

github-pullrequest-plugin/src/test/resources/dsl/branch-jobdsl.groovy

@@ -15,6 +15,8 @@ freeStyleJob('gh-branch') {
                 hashChanged()
                 deleted()
             }
+
+            whitelistedBranches('master')
         }
 
     }