Add support for limiting job concurrency based on one or more build parameters (replaces pull request #9)

README

@@ -1,3 +1,16 @@
 Work in progress on a plugin to dynamically allocate labels in order
 to allow for throttling the number of concurrent builds of a project
 allowed to run on a given node at one time.
+
+Contributing
+------------
+
+### Run / Debug cycle:
+
+Execute `mvn hpi:run`. This will compile the plugin and launch a Jenkins instance on http://localhost:8080
+
+### Create Package (.hpi):
+
+Execute `mvn hpi:hpi`. This will create `throttle-concurrent.hpi` in the `target/` directory
+
+For other mvn targets, see: https://jenkins-ci.org/maven-hpi-plugin/

pom.xml

@@ -26,7 +26,7 @@ THE SOFTWARE.
   <parent>
     <groupId>org.jenkins-ci.plugins</groupId>
     <artifactId>plugin</artifactId>
-    <version>1.424</version>
+    <version>1.509.4</version>
   </parent>
 
   <artifactId>throttle-concurrents</artifactId>

src/main/java/hudson/plugins/throttleconcurrents/ThrottleJobProperty.java

@@ -16,6 +16,7 @@
 import hudson.matrix.MatrixBuild;
 import hudson.matrix.MatrixProject;
 
+import java.util.Arrays;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -36,27 +37,33 @@
 public class ThrottleJobProperty extends JobProperty<Job<?,?>> {
     // Moving category to categories, to support, well, multiple categories per job.
     @Deprecated transient String category;
-    
+
     private Integer maxConcurrentPerNode;
     private Integer maxConcurrentTotal;
     private List<String> categories;
     private boolean throttleEnabled;
     private String throttleOption;
+    private boolean limitOneJobWithMatchingParams;
     private transient boolean throttleConfiguration;
     private @CheckForNull ThrottleMatrixProjectOptions matrixOptions;
 
+    private String paramsToUseForLimit;
+    private transient List<String> paramsToCompare;
+
     /**
      * Store a config version so we're able to migrate config on various
      * functionality upgrades.
      */
     private Long configVersion;
-    
+
     @DataBoundConstructor
     public ThrottleJobProperty(Integer maxConcurrentPerNode,
                                Integer maxConcurrentTotal,
                                List<String> categories,
                                boolean throttleEnabled,
                                String throttleOption,
+                               boolean limitOneJobWithMatchingParams,
+                               String paramsToUseForLimit,
                                @CheckForNull ThrottleMatrixProjectOptions matrixOptions
                                ) {
         this.maxConcurrentPerNode = maxConcurrentPerNode == null ? 0 : maxConcurrentPerNode;
@@ -66,9 +73,22 @@ public ThrottleJobProperty(Integer maxConcurrentPerNode,
                 new CopyOnWriteArrayList<String>(categories);
         this.throttleEnabled = throttleEnabled;
         this.throttleOption = throttleOption;
+        this.limitOneJobWithMatchingParams = limitOneJobWithMatchingParams;
         this.matrixOptions = matrixOptions;
-    }
+        this.paramsToUseForLimit = paramsToUseForLimit;
+        if ((this.paramsToUseForLimit != null)) {
+            if ((this.paramsToUseForLimit.length() > 0)) {
+                this.paramsToCompare = Arrays.asList(this.paramsToUseForLimit.split(","));
+            }
+            else {
+                this.paramsToCompare = new ArrayList<String>();
+            }
+        }
+        else {
+            this.paramsToCompare = new ArrayList<String>();
+        }
 
+    }
 
     /**
      * Migrates deprecated/obsolete data
@@ -95,6 +115,7 @@ public Object readResolve() {
                 maxConcurrentTotal = 0;
             }
         }
+
         configVersion = 1L;
 
         // Handle the throttleConfiguration in custom builds (not released)
@@ -126,28 +147,36 @@ public boolean getThrottleEnabled() {
         return throttleEnabled;
     }
 
+    public boolean isLimitOneJobWithMatchingParams() {
+        return limitOneJobWithMatchingParams;
+    }
+
     public String getThrottleOption() {
         return throttleOption;
     }
-    
+
     public List<String> getCategories() {
         return categories;
     }
-    
+
     public Integer getMaxConcurrentPerNode() {
         if (maxConcurrentPerNode == null)
             maxConcurrentPerNode = 0;
-        
+
         return maxConcurrentPerNode;
     }
 
     public Integer getMaxConcurrentTotal() {
         if (maxConcurrentTotal == null)
             maxConcurrentTotal = 0;
-        
+
         return maxConcurrentTotal;
     }
 
+    public String getParamsToUseForLimit() {
+        return paramsToUseForLimit;
+    }
+
     @CheckForNull
     public ThrottleMatrixProjectOptions getMatrixOptions() {
         return matrixOptions;
@@ -171,6 +200,23 @@ public boolean isThrottleMatrixConfigurations() {
                 : ThrottleMatrixProjectOptions.DEFAULT.isThrottleMatrixConfigurations();
     }
 
+    public List<String> getParamsToCompare() {
+        if (paramsToCompare == null) {
+            if ((paramsToUseForLimit != null)) {
+                if ((paramsToUseForLimit.length() > 0)) {
+                    paramsToCompare = Arrays.asList(paramsToUseForLimit.split(","));
+                }
+                else {
+                    paramsToCompare = new ArrayList<String>();
+                }
+            }
+            else {
+                paramsToCompare = new ArrayList<String>();
+            }
+        }
+        return paramsToCompare;
+    }
+
     static List<Queue.Task> getCategoryTasks(String category) {
         assert category != null && !category.equals("");
         List<Queue.Task> categoryTasks = new ArrayList<Queue.Task>();
@@ -198,18 +244,19 @@ static List<Queue.Task> getCategoryTasks(String category) {
         }
         return categoryTasks;
     }
+
     private static Item getItem(ItemGroup group, String name) {
         if (group instanceof Jenkins) {
             return ((Jenkins) group).getItemMap().get(name);
         } else {
             return group.getItem(name);
         }
     }
-    
+
     @Extension
     public static final class DescriptorImpl extends JobPropertyDescriptor {
         private List<ThrottleCategory> categories;
-        
+
         /** Map from category names, to properties including that category. */
         private transient Map<String,Map<ThrottleJobProperty,Void>> propertiesByCategory 
                  = new HashMap<String,Map<ThrottleJobProperty,Void>>();
@@ -235,7 +282,7 @@ public DescriptorImpl() {
         public String getDisplayName() {
             return "Throttle Concurrent Builds";
         }
-        
+
         @Override
         @SuppressWarnings("rawtypes")
         public boolean isApplicable(Class<? extends Job> jobType) {
@@ -279,10 +326,9 @@ public FormValidation doCheckMaxConcurrentTotal(@QueryParameter String value) {
             return checkNullOrInt(value);
         }
 
-
         public ThrottleCategory getCategoryByName(String categoryName) {
             ThrottleCategory category = null;
-            
+
             for (ThrottleCategory tc : categories) {
                 if (tc.getCategoryName().equals(categoryName)) {
                     category = tc;
@@ -295,7 +341,7 @@ public ThrottleCategory getCategoryByName(String categoryName) {
         public void setCategories(List<ThrottleCategory> categories) {
             this.categories = new CopyOnWriteArrayList<ThrottleCategory>(categories);
         }
-        
+
         public List<ThrottleCategory> getCategories() {
             if (categories == null) {
                 categories = new CopyOnWriteArrayList<ThrottleCategory>();
@@ -308,14 +354,14 @@ public ListBoxModel doFillCategoryItems() {
             ListBoxModel m = new ListBoxModel();
 
             m.add("(none)", "");
-            
+
             for (ThrottleCategory tc : getCategories()) {
                 m.add(tc.getCategoryName());
             }
 
             return m;
         }
-        
+
     }
 
     public static final class ThrottleCategory extends AbstractDescribableImpl<ThrottleCategory> {
@@ -335,18 +381,18 @@ public ThrottleCategory(String categoryName,
             this.nodeLabeledPairs =
                  nodeLabeledPairs == null ? new ArrayList<NodeLabeledPair>() : nodeLabeledPairs;
         }
-        
+
         public Integer getMaxConcurrentPerNode() {
             if (maxConcurrentPerNode == null)
                 maxConcurrentPerNode = 0;
-            
+
             return maxConcurrentPerNode;
         }
-        
+
         public Integer getMaxConcurrentTotal() {
             if (maxConcurrentTotal == null)
                 maxConcurrentTotal = 0;
-            
+
             return maxConcurrentTotal;
         }
 
@@ -360,7 +406,7 @@ public List<NodeLabeledPair> getNodeLabeledPairs() {
 
             return nodeLabeledPairs;
         }
-        
+
         @Extension
         public static class DescriptorImpl extends Descriptor<ThrottleCategory> {
             @Override