[FIXED JENKINS-48448] Add parameter instance to script envVars

jenkinsci · Dec 8, 2017 · ef6f97c · ef6f97c
1 parent 03eda6f
commit ef6f97c
Show file tree

Hide file tree

Showing 3 changed files with 117 additions and 0 deletions.
diff --git a/src/main/java/org/biouno/unochoice/AbstractScriptableParameter.java b/src/main/java/org/biouno/unochoice/AbstractScriptableParameter.java
@@ -74,6 +74,10 @@ public abstract class AbstractScriptableParameter extends AbstractUnoChoiceParam
      * Constant used to add the build in the environment variables map.
      */
     protected static final String JENKINS_BUILD_VARIABLE_NAME = "jenkinsBuild";
+    /**
+     * Constant used to add the parameter name in the enviroment variables map.
+     */
+    protected static final String JENKINS_PARAMETER_VARIABLE_NAME = "jenkinsParameter";
     /**
      * Number of visible items on the screen.
      */
@@ -178,6 +182,9 @@ private Map<Object, Object> getHelperParameters() {
             }
         }
 
+        // Here we set the parameter name
+        helperParameters.put(JENKINS_PARAMETER_VARIABLE_NAME, this);
+
         // Here we inject the global node properties
         final Map<String, Object> globalNodeProperties = Utils.getGlobalNodeProperties();
         helperParameters.putAll(globalNodeProperties);

diff --git a/src/test/java/org/biouno/unochoice/issue48448/TestParameterObjectIsPresent.java b/src/test/java/org/biouno/unochoice/issue48448/TestParameterObjectIsPresent.java
@@ -0,0 +1,80 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2016 Ioannis Moutsatsos, Bruno P. Kinoshita
+ *
+ * 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.biouno.unochoice.issue48448;
+
+import static org.junit.Assert.assertTrue;
+
+import java.io.IOException;
+import java.util.Map;
+
+import org.biouno.unochoice.CascadeChoiceParameter;
+import org.biouno.unochoice.ChoiceParameter;
+import org.biouno.unochoice.model.GroovyScript;
+import org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript;
+import org.jenkinsci.plugins.scriptsecurity.scripts.ScriptApproval;
+import org.jenkinsci.plugins.scriptsecurity.scripts.languages.GroovyLanguage;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.Issue;
+import org.jvnet.hudson.test.JenkinsRule;
+
+/**
+ * Test that scripts can access the parameter object.
+ *
+ * @since 1.5.x
+ */
+@Issue("JENKINS-48448")
+public class TestParameterObjectIsPresent {
+
+    @Rule
+    public JenkinsRule j = new JenkinsRule();
+
+    // LIST script
+    private final String SCRIPT_LIST = "return ['A', 'B', jenkinsParameter.getName(), 'C']";
+    private final String FALLBACK_SCRIPT_LIST = "return ['EMPTY!']";
+
+    private final String PARAMETER_NAME = "my-parameter-name";
+
+    @Before
+    public void setUp() throws Exception {
+        ScriptApproval.get()
+                .preapprove(SCRIPT_LIST, GroovyLanguage.get());
+        ScriptApproval.get()
+                .preapprove(FALLBACK_SCRIPT_LIST, GroovyLanguage.get());
+    }
+
+    @Test
+    public void testParameterObjectIsPresent() throws IOException {
+        GroovyScript listScript = new GroovyScript(new SecureGroovyScript(SCRIPT_LIST, Boolean.FALSE, null),
+                new SecureGroovyScript(FALLBACK_SCRIPT_LIST, Boolean.FALSE, null));
+        ChoiceParameter listParam = new ChoiceParameter(PARAMETER_NAME, "description...", "random-name1", listScript,
+                CascadeChoiceParameter.PARAMETER_TYPE_MULTI_SELECT, true, 1);
+        Map<Object, Object> listSelectionValue = listParam.getChoices();
+
+        // keys and values have the same content when the parameter returns an array...
+        assertTrue("Missing parameter name!", listSelectionValue.containsKey(PARAMETER_NAME));
+    }
+
+}
diff --git a/src/test/java/org/biouno/unochoice/issue48448/package-info.java b/src/test/java/org/biouno/unochoice/issue48448/package-info.java
@@ -0,0 +1,30 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2016 Ioannis Moutsatsos, Bruno P. Kinoshita
+ *
+ * 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.
+ */
+
+/**
+ * Tests for parameters with the equals separator. See JENKINS-48448.
+ *
+ * @since 2.1
+ */
+package org.biouno.unochoice.issue48448;