[JENKINS-28764] Write tests and fix possible bug before shipping code

jenkinsci · Jun 28, 2015 · 2ee4d34 · 2ee4d34 · wykapedia · Jan 28, 2016
1 parent d57ac66
commit 2ee4d34
Show file tree

Hide file tree

Showing 4 changed files with 87 additions and 2 deletions.
diff --git a/src/main/java/org/biouno/unochoice/model/ScriptlerScript.java b/src/main/java/org/biouno/unochoice/model/ScriptlerScript.java
@@ -31,6 +31,7 @@
 import java.util.List;
 import java.util.Map;
 
+import org.biouno.unochoice.util.Utils;
 import org.jenkinsci.plugins.scriptler.config.Script;
 import org.jenkinsci.plugins.scriptler.util.ScriptHelper;
 import org.kohsuke.stapler.DataBoundConstructor;
@@ -87,7 +88,7 @@ public Object eval() {
      * @see org.biouno.unochoice.model.Script#eval(java.util.Map)
      */
     public Object eval(Map<String, String> parameters) {
-        final Map<String, String> envVars = System.getenv();
+        final Map<String, String> envVars = Utils.getSystemEnv();
         Map<String, String> evaledParameters = new HashMap<String, String>(envVars);
         // if we have any parameter that came from UI, let's eval and use them
         if (parameters != null && parameters.size() > 0) {
@@ -100,7 +101,7 @@ public Object eval(Map<String, String> parameters) {
                 evaledParameters.put(key, value);
             }
         } else {
-            evaledParameters = this.getParameters();
+            evaledParameters.putAll(this.getParameters());
         }
         return this.toGroovyScript().eval(evaledParameters);
     }

diff --git a/src/main/java/org/biouno/unochoice/util/Utils.java b/src/main/java/org/biouno/unochoice/util/Utils.java
@@ -24,6 +24,7 @@
 
 package org.biouno.unochoice.util;
 
+import java.util.Map;
 import java.util.Set;
 
 import org.apache.commons.lang.StringUtils;
@@ -98,4 +99,14 @@ public static String createRandomParameterName(String prefix, String suffix) {
         return paramName;
     }
 
+    /**
+     * Helped method to return the system environment variables. The main advantage
+     * over calling the System.getenv method directly, is that we can mock this call
+     * (System is final).
+     *
+     * @return System environment variables as map
+     */
+    public static Map<String, String> getSystemEnv() {
+        return System.getenv();
+    }
 }
diff --git a/src/test/java/org/biouno/unochoice/issue28764/TestIssue28764.java b/src/test/java/org/biouno/unochoice/issue28764/TestIssue28764.java
@@ -0,0 +1,68 @@
+package org.biouno.unochoice.issue28764;
+
+import static org.junit.Assert.assertEquals;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.biouno.unochoice.model.ScriptlerScript;
+import org.biouno.unochoice.model.ScriptlerScriptParameter;
+import org.biouno.unochoice.util.Utils;
+import org.jenkinsci.plugins.scriptler.config.Parameter;
+import org.jenkinsci.plugins.scriptler.config.Script;
+import org.jenkinsci.plugins.scriptler.util.ScriptHelper;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mockito;
+import org.powermock.api.mockito.PowerMockito;
+import org.powermock.core.classloader.annotations.PrepareForTest;
+import org.powermock.modules.junit4.PowerMockRunner;
+
+@RunWith(PowerMockRunner.class)
+@PrepareForTest({ ScriptHelper.class, Utils.class })
+public class TestIssue28764 {
+
+    private List<ScriptlerScriptParameter> params = null;
+
+    private Script script = null;
+
+    private ScriptlerScript scriptlerScript = null;
+
+    private Map<String, String> myEnv = null;
+
+    @Before
+    public void setUp() {
+        params = new ArrayList<ScriptlerScriptParameter>();
+
+        script = new Script("id", "name", "comment", true, "originCatalog",
+                "originScript", "originDate", true,
+                (Parameter[]) params.toArray(new Parameter[0]), false);
+        script.setScript("if(binding.variables.get('flag') == null) {return [1, 2, 3]} else {return [1000, 100, 1]}");
+
+        myEnv = new HashMap<String, String>();
+        myEnv.put("flag", "myflag");
+
+        scriptlerScript = new ScriptlerScript("id", params);
+
+        // Mock
+        PowerMockito.mockStatic(Utils.class);
+        PowerMockito.when(Utils.getSystemEnv()).thenReturn(this.myEnv);
+
+        PowerMockito.mockStatic(ScriptHelper.class);
+        PowerMockito.when(
+                ScriptHelper.getScript(Mockito.anyString(),
+                        Mockito.anyBoolean())).thenReturn(this.script);
+    }
+
+    @SuppressWarnings("unchecked")
+    @Test
+    public void testEnvVarsExpanding() {
+        List<Integer> returnValue = (List<Integer>) scriptlerScript.eval();
+        assertEquals(Arrays.asList(new Integer[] { 1000, 100, 1 }), returnValue);
+    }
+
+}
diff --git a/src/test/java/org/biouno/unochoice/issue28764/package-info.java b/src/test/java/org/biouno/unochoice/issue28764/package-info.java
@@ -0,0 +1,5 @@
+/**
+ * Tests for JENKINS-28764: Environment variables are not expanded and thus cannot be used as parameter values to
+ * Scriptler scripts
+ */
+package org.biouno.unochoice.issue28764;