[FIX JENKINS-25449] Form validation for label expression

jenkinsci · Nov 5, 2014 · b120b1d · b120b1d
1 parent 1a1ae80
commit b120b1d
Show file tree

Hide file tree

Showing 2 changed files with 108 additions and 1 deletion.
diff --git a/src/main/java/hudson/matrix/LabelExpAxis.java b/src/main/java/hudson/matrix/LabelExpAxis.java
@@ -25,12 +25,22 @@
 
 import hudson.Extension;
 import hudson.Util;
+import hudson.model.AutoCompletionCandidates;
+import hudson.model.TopLevelItemDescriptor;
+import hudson.model.AbstractProject;
+import hudson.util.FormValidation;
 import jenkins.model.Jenkins;
 
+import java.util.ArrayList;
 import java.util.LinkedList;
 import java.util.List;
 
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.DoNotUse;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
+import org.kohsuke.stapler.AncestorInPath;
 import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.QueryParameter;
 
 /**
  * {@link Axis} that selects label expressions.
@@ -82,8 +92,45 @@ public boolean isInstantiable() {
             Jenkins h = Jenkins.getInstance();
             return !h.getNodes().isEmpty() || !h.clouds.isEmpty();
         }
+
+        @Restricted(NoExternalUse.class)
+        public FormValidation doCheckLabelExpr(@AncestorInPath AbstractProject<?,?> project, @QueryParameter String value) {
+            AbstractProject.AbstractProjectDescriptor desc = projectDescriptor();
+
+            if (Util.fixEmptyAndTrim(value) == null) return FormValidation.error("No expressions provided");
+
+            List<FormValidation> validations = new ArrayList<FormValidation>();
+            for (String expr: getExprValues(value)) {
+                validations.add(
+                        desc.doCheckAssignedLabelString(project, expr)
+                );
+            }
+
+            return aggregateValidations(validations);
+        }
+
+        private final AbstractProject.AbstractProjectDescriptor projectDescriptor() {
+            return Jenkins.getInstance().getDescriptorByType(MatrixProject.DescriptorImpl.class);
+        }
     }
-
+
+    // TODO move to hudson.util.FormValidation
+    private static FormValidation aggregateValidations(List<FormValidation> validations) {
+
+        if (validations.size() == 1) return validations.get(0);
+
+        StringBuilder sb = new StringBuilder();
+        sb.append("<ul style='list-style-type: none'>");
+        for (FormValidation validation: validations) {
+            sb.append("<li>").append(validation.renderHtml()).append("</li>");
+        }
+        sb.append("</ul>");
+
+        // Wrap into ok instead of worst of all results as class ok result
+        // wrapped in warning or error overall result would inherit its color.
+        return FormValidation.okWithMarkup(sb.toString());
+    }
+
     public static List<String> getExprValues(String valuesString){
 		List<String> expressions = new LinkedList<String>();
 		String[] exprs = valuesString.split("\n");

diff --git a/src/test/java/hudson/matrix/LabelExpAxisTest.java b/src/test/java/hudson/matrix/LabelExpAxisTest.java
@@ -0,0 +1,60 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2014 Red Hat, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package hudson.matrix;
+
+import static org.junit.Assert.*;
+import hudson.matrix.LabelExpAxis.DescriptorImpl;
+import hudson.util.FormValidation;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+
+public class LabelExpAxisTest {
+
+    @Rule public JenkinsRule j = new JenkinsRule();
+
+    @Test
+    public void test() throws Exception {
+        j.jenkins.setLabelString("aaaa bbbb");
+
+        MatrixProject project = j.createMatrixProject("project");
+        DescriptorImpl descriptor = new LabelExpAxis.DescriptorImpl();
+
+        assertEquals(FormValidation.Kind.ERROR, descriptor.doCheckLabelExpr(project, "").kind);
+
+        assertEquals(FormValidation.Kind.OK, descriptor.doCheckLabelExpr(project, "aaaa").kind);
+        assertEquals(FormValidation.Kind.OK, descriptor.doCheckLabelExpr(project, "aaaa\nbbbb&&aaaa\n").kind);
+
+        assertEquals(FormValidation.Kind.WARNING, descriptor.doCheckLabelExpr(project, "no_such_slave").kind);
+
+        assertEquals(FormValidation.Kind.ERROR, descriptor.doCheckLabelExpr(project, "&&!||").kind);
+
+        // Use worse result - Not yet implemented
+        //assertEquals(FormValidation.Kind.WARNING, descriptor.doCheckLabelExpr(project, "aaaa\nno_such_slave").kind);
+        //assertEquals(FormValidation.Kind.ERROR, descriptor.doCheckLabelExpr(project, "aaaa\n&&").kind);
+        //assertEquals(FormValidation.Kind.ERROR, descriptor.doCheckLabelExpr(project, "no_such_slave\n&&").kind);
+        //assertEquals(FormValidation.Kind.ERROR, descriptor.doCheckLabelExpr(project, "no_such_slave\n&&\naaaa").kind);
+    }
+}