Always include branches, regardless of whether a merge request exists for those branches or not. (#376)

Author: jonasgroenke

src/main/java/io/jenkins/plugins/gitlabbranchsource/BranchDiscoveryTrait.java

@@ -1,8 +1,10 @@
 package io.jenkins.plugins.gitlabbranchsource;
 
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.Extension;
 import hudson.util.ListBoxModel;
+import java.util.regex.Pattern;
 import jenkins.scm.api.SCMHead;
 import jenkins.scm.api.SCMHeadCategory;
 import jenkins.scm.api.SCMHeadOrigin;
@@ -32,20 +34,33 @@ public class BranchDiscoveryTrait extends SCMSourceTrait {
      */
     private int strategyId;
 
+    /**
+     * Regex of branches that should always be included regardless of whether a merge request exists or not.
+     */
+    private String branchesAlwaysIncludedRegex;
+
+    /**
+     * The compiled {@link Pattern} of the branchesAlwaysIncludedRegex.
+     */
+    @CheckForNull
+    private transient Pattern branchesAlwaysIncludedRegexPattern;
+
     /**
      * Constructor for stapler.
      *
      * @param strategyId the strategy id.
+     * @param branchesAlwaysIncludedRegex the branchesAlwaysIncludedRegex.
      */
     @DataBoundConstructor
-    public BranchDiscoveryTrait(int strategyId) {
+    public BranchDiscoveryTrait(int strategyId, String branchesAlwaysIncludedRegex) {
         this.strategyId = strategyId;
+        this.branchesAlwaysIncludedRegex = branchesAlwaysIncludedRegex;
     }
 
     /**
      * Constructor for legacy code.
      *
-     * @param buildBranch build branches that are not filed as a MR.
+     * @param buildBranch       build branches that are not filed as a MR.
      * @param buildBranchWithMr build branches that are also MRs.
      */
     public BranchDiscoveryTrait(boolean buildBranch, boolean buildBranchWithMr) {
@@ -61,6 +76,28 @@ public int getStrategyId() {
         return strategyId;
     }
 
+    /**
+     * Returns the branchesAlwaysIncludedRegex.
+     *
+     * @return the branchesAlwaysIncludedRegex.
+     */
+    public String getBranchesAlwaysIncludedRegex() {
+        return branchesAlwaysIncludedRegex;
+    }
+
+    /**
+     * Returns the compiled {@link Pattern} of the branchesAlwaysIncludedRegex.
+     *
+     * @return the branchesAlwaysIncludedRegexPattern.
+     */
+    public Pattern getBranchesAlwaysIncludedRegexPattern() {
+        if (branchesAlwaysIncludedRegex != null && branchesAlwaysIncludedRegexPattern == null) {
+            branchesAlwaysIncludedRegexPattern = Pattern.compile(branchesAlwaysIncludedRegex);
+        }
+
+        return branchesAlwaysIncludedRegexPattern;
+    }
+
     /**
      * Returns {@code true} if building branches that are not filed as a MR.
      *
@@ -92,11 +129,11 @@ protected void decorateContext(SCMSourceContext<?, ?> context) {
         switch (strategyId) {
             case 1:
                 ctx.wantOriginMRs(true);
-                ctx.withFilter(new ExcludeOriginMRBranchesSCMHeadFilter());
+                ctx.withFilter(new ExcludeOriginMRBranchesSCMHeadFilter(getBranchesAlwaysIncludedRegexPattern()));
                 break;
             case 2:
                 ctx.wantOriginMRs(true);
-                ctx.withFilter(new OnlyOriginMRBranchesSCMHeadFilter());
+                ctx.withFilter(new OnlyOriginMRBranchesSCMHeadFilter(getBranchesAlwaysIncludedRegexPattern()));
                 break;
             case 3:
             default:
@@ -208,12 +245,33 @@ public String getDisplayName() {
      */
     public static class ExcludeOriginMRBranchesSCMHeadFilter extends SCMHeadFilter {
 
+        /**
+         * The compiled {@link Pattern} of the branchesAlwaysIncludedRegex.
+         */
+        private final Pattern branchesAlwaysIncludedRegexPattern;
+
+        /**
+         * Constructor
+         *
+         * @param branchesAlwaysIncludedRegexPattern the branchesAlwaysIncludedRegexPattern.
+         */
+        public ExcludeOriginMRBranchesSCMHeadFilter(Pattern branchesAlwaysIncludedRegexPattern) {
+            this.branchesAlwaysIncludedRegexPattern = branchesAlwaysIncludedRegexPattern;
+        }
+
         /**
          * {@inheritDoc}
          */
         @Override
         public boolean isExcluded(@NonNull SCMSourceRequest request, @NonNull SCMHead head) {
             if (head instanceof BranchSCMHead && request instanceof GitLabSCMSourceRequest) {
+                if (branchesAlwaysIncludedRegexPattern != null
+                        && branchesAlwaysIncludedRegexPattern
+                                .matcher(head.getName())
+                                .matches()) {
+                    return false;
+                }
+
                 for (MergeRequest m : ((GitLabSCMSourceRequest) request).getMergeRequests()) {
                     // only match if the merge request is an origin merge request
                     if (m.getSourceProjectId().equals(m.getTargetProjectId())
@@ -231,12 +289,33 @@ public boolean isExcluded(@NonNull SCMSourceRequest request, @NonNull SCMHead he
      */
     public static class OnlyOriginMRBranchesSCMHeadFilter extends SCMHeadFilter {
 
+        /**
+         * The compiled {@link Pattern} of the branchesAlwaysIncludedRegex.
+         */
+        private final Pattern branchesAlwaysIncludedRegexPattern;
+
+        /**
+         * Constructor
+         *
+         * @param branchesAlwaysIncludedRegexPattern the branchesAlwaysIncludedRegexPattern.
+         */
+        public OnlyOriginMRBranchesSCMHeadFilter(Pattern branchesAlwaysIncludedRegexPattern) {
+            this.branchesAlwaysIncludedRegexPattern = branchesAlwaysIncludedRegexPattern;
+        }
+
         /**
          * {@inheritDoc}
          */
         @Override
         public boolean isExcluded(@NonNull SCMSourceRequest request, @NonNull SCMHead head) {
             if (head instanceof BranchSCMHead && request instanceof GitLabSCMSourceRequest) {
+                if (branchesAlwaysIncludedRegexPattern != null
+                        && branchesAlwaysIncludedRegexPattern
+                                .matcher(head.getName())
+                                .matches()) {
+                    return false;
+                }
+
                 for (MergeRequest m : ((GitLabSCMSourceRequest) request).getMergeRequests()) {
                     if (m.getSourceProjectId().equals(m.getTargetProjectId())
                             && !m.getSourceBranch().equalsIgnoreCase(head.getName())) {

src/main/resources/io/jenkins/plugins/gitlabbranchsource/BranchDiscoveryTrait/config.jelly

@@ -4,4 +4,7 @@
   <f:entry title="${%Strategy}" field="strategyId">
     <f:select default="1"/>
   </f:entry>
+  <f:entry title="${%Branches to always include}" field="branchesAlwaysIncludedRegex">
+    <f:textbox/>
+  </f:entry>
 </j:jelly>

src/main/resources/io/jenkins/plugins/gitlabbranchsource/BranchDiscoveryTrait/help-branchesAlwaysIncludedRegex.html

@@ -0,0 +1,3 @@
+<div>
+  Regular expression of branches that should always be included regardless of whether a merge request exists or not for those branches.
+</div>