[FIXED JENKINS-27295] Offering a new global variable params for typed…

… access to ParametersAction.
jenkinsci · Sep 17, 2016 · ac46350 · ac46350
1 parent 86c7ea9
commit ac46350
Show file tree

Hide file tree

Showing 3 changed files with 181 additions and 0 deletions.
diff --git a/src/main/java/org/jenkinsci/plugins/workflow/cps/ParamsVariable.java b/src/main/java/org/jenkinsci/plugins/workflow/cps/ParamsVariable.java
@@ -0,0 +1,86 @@
+/*
+ * The MIT License
+ *
+ * Copyright 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.
+ */
+
+package org.jenkinsci.plugins.workflow.cps;
+
+import hudson.Extension;
+import hudson.model.ParameterValue;
+import hudson.model.ParametersAction;
+import hudson.model.Run;
+import java.io.Serializable;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import org.jenkinsci.plugins.workflow.pickles.PickleFactory;
+
+/**
+ * Allows access to {@link ParametersAction}.
+ */
+@Extension public class ParamsVariable extends GlobalVariable {
+
+    @Override public String getName() {
+        return "params";
+    }
+
+    @SuppressWarnings("unchecked")
+    @Override public Object getValue(CpsScript script) throws Exception {
+        Run<?,?> b = script.$build();
+        if (b == null) {
+            throw new IllegalStateException("cannot find owning build");
+        }
+        ParametersAction action = b.getAction(ParametersAction.class);
+        if (action == null) {
+            return Collections.emptyMap();
+        }
+        List<ParameterValue> parameterValues;
+        try { // TODO 1.651.2+ remove reflection
+            parameterValues = (List<ParameterValue>) ParametersAction.class.getMethod("getAllParameters").invoke(action);
+        } catch (NoSuchMethodException x) {
+            parameterValues = action.getParameters();
+        }
+        // Could extend AbstractMap and make a Serializable lazy wrapper, but getValue impls seem cheap anyway.
+        Map<String,Object> values = new HashMap<>();
+        for (ParameterValue parameterValue : parameterValues) {
+            Object value = parameterValue.getValue();
+            if (!(value instanceof Serializable)) {
+                boolean canPickle = false;
+                for (PickleFactory pf : PickleFactory.all()) {
+                    if (pf.writeReplace(value) != null) {
+                        // For example SecretPickle can handle Secret from PasswordParameterValue.
+                        canPickle = true;
+                        break;
+                    }
+                }
+                if (!canPickle) {
+                    // Just skip anything not serializable, such as a Run from a RunParameterValue.
+                    continue;
+                }
+            }
+            values.put(parameterValue.getName(), value);
+        }
+        return values;
+    }
+
+}
diff --git a/src/main/resources/org/jenkinsci/plugins/workflow/cps/ParamsVariable/help.jelly b/src/main/resources/org/jenkinsci/plugins/workflow/cps/ParamsVariable/help.jelly
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+The MIT License
+
+Copyright 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.
+-->
+
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core">
+    <p>
+        Exposes all parameters defined in the build as a map with variously typed values. Example:
+    </p>
+    <pre><code>if (params.BOOLEAN_PARAM_NAME) {doSomething()}</code></pre>
+</j:jelly>
diff --git a/src/test/java/org/jenkinsci/plugins/workflow/cps/ParamsVariableTest.java b/src/test/java/org/jenkinsci/plugins/workflow/cps/ParamsVariableTest.java
@@ -0,0 +1,63 @@
+/*
+ * The MIT License
+ *
+ * Copyright 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.
+ */
+
+package org.jenkinsci.plugins.workflow.cps;
+
+import hudson.model.BooleanParameterDefinition;
+import hudson.model.BooleanParameterValue;
+import hudson.model.ParametersAction;
+import hudson.model.ParametersDefinitionProperty;
+import hudson.model.PasswordParameterDefinition;
+import hudson.model.PasswordParameterValue;
+import hudson.model.StringParameterDefinition;
+import hudson.model.StringParameterValue;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.junit.Test;
+import org.junit.Rule;
+import org.jvnet.hudson.test.Issue;
+import org.jvnet.hudson.test.JenkinsRule;
+
+public class ParamsVariableTest {
+
+    @Rule public JenkinsRule r = new JenkinsRule();
+
+    @Issue("JENKINS-27295")
+    @Test public void smokes() throws Exception {
+        WorkflowJob p = r.jenkins.createProject(WorkflowJob.class, "p");
+        p.setDefinition(new CpsFlowDefinition("echo(/TEXT=${params.TEXT} FLAG=${params.FLAG ? 'yes' : 'no'} PASS=${params.PASS}/)",true));
+        p.addProperty(new ParametersDefinitionProperty(
+            new StringParameterDefinition("TEXT", ""),
+            new BooleanParameterDefinition("FLAG", false, null),
+            new PasswordParameterDefinition("PASS", "", null)));
+        WorkflowRun b = r.assertBuildStatusSuccess(p.scheduleBuild2(0, new ParametersAction(
+            new StringParameterValue("TEXT", "hello"),
+            new BooleanParameterValue("FLAG", true),
+            new PasswordParameterValue("PASS", "s3cr3t"))));
+        r.assertLogContains("TEXT=hello", b);
+        r.assertLogContains("FLAG=yes", b);
+        r.assertLogContains("PASS=s3cr3t", b);
+    }
+
+}