[FIXED JENKINS-42168] Add validateDeclarativePipeline(path) step

Given a path to a file containing a Declarative Pipeline to validate, this will read that file from the workspace, validate its contents, echo out relevant errors to the build log, and return true if the contents validated, or false other wise.
jenkinsci · Feb 21, 2017 · bc6c177 · bc6c177
1 parent 3295465
commit bc6c177
Show file tree

Hide file tree

Showing 4 changed files with 221 additions and 4 deletions.
diff --git a/...org/jenkinsci/plugins/pipeline/modeldefinition/steps/ValidateDeclarativePipelineStep.java b/...org/jenkinsci/plugins/pipeline/modeldefinition/steps/ValidateDeclarativePipelineStep.java
@@ -0,0 +1,124 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2017, CloudBees, 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 org.jenkinsci.plugins.pipeline.modeldefinition.steps;
+
+import com.google.inject.Inject;
+import hudson.Extension;
+import hudson.FilePath;
+import hudson.model.TaskListener;
+import org.apache.commons.lang.StringUtils;
+import org.jenkinsci.plugins.pipeline.modeldefinition.ast.ModelASTPipelineDef;
+import org.jenkinsci.plugins.pipeline.modeldefinition.parser.Converter;
+import org.jenkinsci.plugins.workflow.steps.AbstractStepDescriptorImpl;
+import org.jenkinsci.plugins.workflow.steps.AbstractStepImpl;
+import org.jenkinsci.plugins.workflow.steps.AbstractSynchronousNonBlockingStepExecution;
+import org.jenkinsci.plugins.workflow.steps.StepContextParameter;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+import java.io.Serializable;
+
+/**
+ * Step that will validate a string containing a Declarative Pipeline.
+ *
+ * @author Andrew Bayer
+ */
+public final class ValidateDeclarativePipelineStep extends AbstractStepImpl implements Serializable {
+
+    private static final long serialVersionUID = 1L;
+
+    private final String path;
+
+    @DataBoundConstructor
+    public ValidateDeclarativePipelineStep(String path) {
+        this.path = path;
+    }
+
+    public String getPath() {
+        return path;
+    }
+
+    @Extension
+    public static final class DescriptorImpl extends AbstractStepDescriptorImpl {
+
+        public DescriptorImpl() {
+            super(ValidateDeclarativePipelineStepExecution.class);
+        }
+
+        @Override public String getFunctionName() {
+            return "validateDeclarativePipeline";
+        }
+
+        @Override public String getDisplayName() {
+            return "Validate a string containing a Declarative Pipeline";
+        }
+    }
+
+    public static final class ValidateDeclarativePipelineStepExecution extends AbstractSynchronousNonBlockingStepExecution<Boolean> {
+
+        @Inject(optional=true)
+        private transient ValidateDeclarativePipelineStep step;
+
+        @StepContextParameter
+        private transient FilePath cwd;
+
+        @StepContextParameter
+        private transient TaskListener listener;
+
+        @Override
+        public Boolean run() throws Exception {
+            if (StringUtils.isEmpty(step.getPath())) {
+                listener.getLogger().println("No Declarative Pipeline file specified.");
+                return false;
+            } else {
+                FilePath f = cwd.child(step.getPath());
+                if (!f.exists() || f.isDirectory()) {
+                    listener.getLogger().println("Declarative Pipeline file '" + step.getPath() + "' does not exist.");
+                    return false;
+                } else {
+                    String text = f.readToString();
+                    if (StringUtils.isEmpty(text)) {
+                        listener.getLogger().println("Declarative Pipeline file '" + step.getPath() + "' is empty.");
+                        return false;
+                    } else {
+                        try {
+                            ModelASTPipelineDef pipelineDef = Converter.scriptToPipelineDef(text);
+                            if (pipelineDef != null) {
+                                listener.getLogger().println("Declarative Pipeline file '" + step.getPath() + "' is valid.");
+                                return true;
+                            } else {
+                                listener.getLogger().println("Declarative Pipeline file '" + step.getPath() + "' does not contain the 'pipeline' step.");
+                                return false;
+                            }
+                        } catch (Exception e) {
+                            listener.getLogger().println("Error(s) validating Declarative Pipeline file '" + step.getPath() + "' - " + e.toString());
+                            return false;
+                        }
+                    }
+                }
+            }
+        }
+
+        private static final long serialVersionUID = 1L;
+    }
+}
diff --git a/...on/src/test/java/org/jenkinsci/plugins/pipeline/modeldefinition/AbstractModelDefTest.java b/...on/src/test/java/org/jenkinsci/plugins/pipeline/modeldefinition/AbstractModelDefTest.java
@@ -288,16 +288,24 @@ protected void prepRepoWithJenkinsfile(String subDir, String pipelineName) throw
     }
 
     protected void prepRepoWithJenkinsfileAndOtherFiles(String pipelineName, String... otherFiles) throws Exception {
+        Map<String,String> otherMap = new HashMap<>();
+        for (String otherFile : otherFiles) {
+            otherMap.put(otherFile, otherFile);
+        }
+        prepRepoWithJenkinsfileAndOtherFiles(pipelineName, otherMap);
+    }
+
+    protected void prepRepoWithJenkinsfileAndOtherFiles(String pipelineName, Map<String,String> otherFiles) throws Exception {
         sampleRepo.init();
         sampleRepo.write("Jenkinsfile",
                 pipelineSourceFromResources(pipelineName));
         sampleRepo.git("add", "Jenkinsfile");
 
 
-        for (String otherFile : otherFiles) {
+        for (Map.Entry<String,String> otherFile : otherFiles.entrySet()) {
             if (otherFile != null) {
-                sampleRepo.write(otherFile, fileContentsFromResources(otherFile));
-                sampleRepo.git("add", otherFile);
+                sampleRepo.write(otherFile.getValue(), fileContentsFromResources(otherFile.getKey()));
+                sampleRepo.git("add", otherFile.getValue());
             }
         }
 
@@ -429,6 +437,7 @@ public class ExpectationsBuilder {
         private Result result = Result.SUCCESS;
         private final String resourceParent;
         private String resource;
+        private Map<String,String> otherResources;
         private List<String> logContains;
         private List<String> logNotContains;
         private WorkflowRun run;
@@ -447,6 +456,12 @@ private ExpectationsBuilder(Result result, String resourceParent, String resourc
             this.resourceParent = resourceParent;
             this.resource = resource;
             buildMatchers = new ArrayList<>();
+            otherResources = new HashMap<>();
+        }
+
+        public ExpectationsBuilder otherResource(String resource, String filename) {
+            this.otherResources.put(resource, filename);
+            return this;
         }
 
         public ExpectationsBuilder inLogInOrder(String... msgsInOrder) {
@@ -516,7 +531,11 @@ public WorkflowRun go() throws Exception {
 
             if (run == null) {
                 if (runFromRepo) {
-                    prepRepoWithJenkinsfile(resourceFullName);
+                    if (otherResources.isEmpty()) {
+                        prepRepoWithJenkinsfile(resourceFullName);
+                    } else {
+                        prepRepoWithJenkinsfileAndOtherFiles(resourceFullName, otherResources);
+                    }
                     run = getAndStartBuild(folder);
                 } else {
                     run = getAndStartNonRepoBuild(folder, resourceFullName);

diff --git a/...jenkinsci/plugins/pipeline/modeldefinition/steps/ValidateDeclarativePipelineStepTest.java b/...jenkinsci/plugins/pipeline/modeldefinition/steps/ValidateDeclarativePipelineStepTest.java
@@ -0,0 +1,44 @@
+package org.jenkinsci.plugins.pipeline.modeldefinition.steps;
+
+import org.jenkinsci.plugins.pipeline.modeldefinition.AbstractModelDefTest;
+import org.junit.Test;
+
+public class ValidateDeclarativePipelineStepTest extends AbstractModelDefTest {
+
+    @Test
+    public void passes() throws Exception {
+        expect("validateDeclarativePipelineStep")
+                .otherResource("simplePipeline.groovy", "testFile.groovy")
+                .logContains("Declarative Pipeline file 'testFile.groovy' is valid.",
+                        "validation result - true")
+                .go();
+    }
+
+    @Test
+    public void noFile() throws Exception {
+        expect("validateDeclarativePipelineStep")
+                .logContains("Declarative Pipeline file 'testFile.groovy' does not exist.",
+                        "validation result - false")
+                .go();
+    }
+
+    @Test
+    public void noPipelineStep() throws Exception {
+        expect("validateDeclarativePipelineStep")
+                .otherResource("validateDeclarativePipelineStep.groovy", "testFile.groovy")
+                .logContains("Declarative Pipeline file 'testFile.groovy' does not contain the 'pipeline' step.",
+                        "validation result - false")
+                .go();
+    }
+
+    @Test
+    public void validationErrors() throws Exception {
+        expect("validateDeclarativePipelineStep")
+                .otherResource("errors/emptyEnvironment.groovy", "testFile.groovy")
+                .logContains("Error(s) validating Declarative Pipeline file 'testFile.groovy' - org.codehaus.groovy.control.MultipleCompilationErrorsException",
+                        "WorkflowScript: 26: No variables specified for environment @ line 26, column 5.",
+                        "validation result - false")
+                .go();
+    }
+
+}
diff --git a/pipeline-model-definition/src/test/resources/validateDeclarativePipelineStep.groovy b/pipeline-model-definition/src/test/resources/validateDeclarativePipelineStep.groovy
@@ -0,0 +1,30 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2016, CloudBees, 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.
+ */
+
+node {
+    checkout scm
+
+    def valid = validateDeclarativePipeline("testFile.groovy")
+    echo "validation result - ${valid}"
+}