Added support for Jenkins environment variables.

Author: nbhoski

src/main/java/com/mathworks/ci/MatlabBuilder.java

@@ -392,13 +392,13 @@ private int execMatlabCommand(Run<?, ?> build, FilePath workspace, Launcher laun
                 workspace, getClass().getClassLoader());
         ProcStarter matlabLauncher;
         try {
-            MatlabReleaseInfo rel = new MatlabReleaseInfo(getLocalMatlab());
+            MatlabReleaseInfo rel = new MatlabReleaseInfo(env.expand(getLocalMatlab()));
             matlabLauncher = launcher.launch().pwd(workspace).envs(env);
             if (rel.verLessThan(BASE_MATLAB_VERSION_BATCH_SUPPORT)) {
                 ListenerLogDecorator outStream = new ListenerLogDecorator(listener);
-                matlabLauncher = matlabLauncher.cmds(constructDefaultMatlabCommand(isLinuxLauncher)).stderr(outStream);
+                matlabLauncher = matlabLauncher.cmds(constructDefaultMatlabCommand(isLinuxLauncher,env)).stderr(outStream);
             } else {
-                matlabLauncher = matlabLauncher.cmds(constructMatlabCommandWithBatch()).stdout(listener);
+                matlabLauncher = matlabLauncher.cmds(constructMatlabCommandWithBatch(env)).stdout(listener);
             }
         } catch (MatlabVersionNotFoundException e) {
             listener.getLogger().println(e.getMessage());
@@ -407,7 +407,7 @@ private int execMatlabCommand(Run<?, ?> build, FilePath workspace, Launcher laun
         return matlabLauncher.join();
     }
 
-    public List<String> constructMatlabCommandWithBatch() {
+    public List<String> constructMatlabCommandWithBatch(EnvVars env) {
         final String testRunMode = this.getTestRunTypeList().getDescriptor().getDisplayName();
         final String runCommand;
         final List<String> matlabDefaultArgs;
@@ -421,23 +421,23 @@ public List<String> constructMatlabCommandWithBatch() {
                     + getTestRunTypeList().getBooleanByName("taCoberturaChkBx") + "))";
         } else {
 
-            runCommand = this.getTestRunTypeList().getStringByName("customMatlabCommand");
+            runCommand = env.expand(this.getTestRunTypeList().getStringByName("customMatlabCommand"));
         }
 
         matlabDefaultArgs =
-                Arrays.asList(this.localMatlab + File.separator + "bin" + File.separator + "matlab",
+                Arrays.asList(env.expand(this.localMatlab) + File.separator + "bin" + File.separator + "matlab",
                         "-batch", runCommand);
 
         return matlabDefaultArgs;
     }
 
-    public List<String> constructDefaultMatlabCommand(boolean isLinuxLauncher) {
+    public List<String> constructDefaultMatlabCommand(boolean isLinuxLauncher, EnvVars env) {
         final List<String> matlabDefaultArgs = new ArrayList<String>();
-        Collections.addAll(matlabDefaultArgs, getPreRunnerSwitches());
+        Collections.addAll(matlabDefaultArgs, getPreRunnerSwitches(env));
         if (!isLinuxLauncher) {
             matlabDefaultArgs.add("-noDisplayDesktop");
         }
-        Collections.addAll(matlabDefaultArgs, getRunnerSwitch());
+        Collections.addAll(matlabDefaultArgs, getRunnerSwitch(env));
         if (!isLinuxLauncher) {
             matlabDefaultArgs.add("-wait");
         }
@@ -446,9 +446,9 @@ public List<String> constructDefaultMatlabCommand(boolean isLinuxLauncher) {
     }
 
 
-    private String[] getPreRunnerSwitches() {
+    private String[] getPreRunnerSwitches(EnvVars env) {
         String[] preRunnerSwitches =
-                {this.localMatlab + File.separator + "bin" + File.separator + "matlab", "-nosplash",
+                {env.expand(this.localMatlab) + File.separator + "bin" + File.separator + "matlab", "-nosplash",
                         "-nodesktop", "-noAppIcon"};
         return preRunnerSwitches;
     }
@@ -458,7 +458,7 @@ private String[] getPostRunnerSwitches() {
         return postRunnerSwitch;
     }
 
-    private String[] getRunnerSwitch() {
+    private String[] getRunnerSwitch(EnvVars env) {
         final String runCommand;
         final String testRunMode = this.getTestRunTypeList().getDescriptor().getDisplayName();
         if (!testRunMode.equalsIgnoreCase(
@@ -471,7 +471,7 @@ private String[] getRunnerSwitch() {
                     + getTestRunTypeList().getBooleanByName("taCoberturaChkBx")
                     + ")),catch e,disp(getReport(e,'extended')),exit(1),end";
         } else {
-            runCommand = "try,eval(\"" + this.getTestRunTypeList().getStringByName("customMatlabCommand").replaceAll("\"","\"\"")
+            runCommand = "try,eval(\"" + env.expand(this.getTestRunTypeList().getStringByName("customMatlabCommand").replaceAll("\"","\"\""))
                     + "\"),catch e,disp(getReport(e,'extended')),exit(1),end,exit";
         }
 

src/test/java/com/mathworks/ci/MatlabBuilderTest.java

@@ -3,8 +3,10 @@
 
 
 import static org.junit.Assert.assertFalse;
+import hudson.EnvVars;
 import hudson.model.FreeStyleBuild;
 import hudson.model.Result;
+import hudson.slaves.EnvironmentVariablesNodeProperty;
 import hudson.model.FreeStyleProject;
 import hudson.tasks.Builder;
 import java.io.File;
@@ -129,7 +131,7 @@ public void verifyMATLABlaunchedWithDefaultArgumentsBatch() throws Exception {
         FreeStyleBuild build = project.scheduleBuild2(0).get();
         jenkins.assertLogContains("-batch", build);
         jenkins.assertLogContains("exit(runMatlabTests", build);
-        Assert.assertEquals(3, matlabBuilder.constructMatlabCommandWithBatch().size());
+        Assert.assertEquals(3, matlabBuilder.constructMatlabCommandWithBatch(new EnvVars()).size());
     }
 
     /*
@@ -145,7 +147,7 @@ public void verifyMATLABlaunchedWithDefaultArgumentsRWindows() throws Exception
         FreeStyleBuild build = project.scheduleBuild2(0).get();
         jenkins.assertLogContains("-r", build);
         jenkins.assertLogContains("try,exit(runMatlabTests", build);
-        Assert.assertEquals(9, matlabBuilder.constructDefaultMatlabCommand(false).size());
+        Assert.assertEquals(9, matlabBuilder.constructDefaultMatlabCommand(false,new EnvVars()).size());
     }
 
     /*
@@ -161,7 +163,7 @@ public void verifyMATLABlaunchedWithDefaultArgumentsRLinux() throws Exception {
         FreeStyleBuild build = project.scheduleBuild2(0).get();
         jenkins.assertLogContains("-r", build);
         jenkins.assertLogContains("try,exit(runMatlabTests", build);
-        Assert.assertEquals(7, matlabBuilder.constructDefaultMatlabCommand(true).size());
+        Assert.assertEquals(7, matlabBuilder.constructDefaultMatlabCommand(true,new EnvVars()).size());
     }
 
     /*
@@ -405,6 +407,48 @@ public void verifyCoberturaError() throws Exception {
         Assert.assertTrue(filteredPageText.contains(TestMessage.getValue("Builder.invalid.matlab.root.error")));
     }
 
+    /*
+     * Test to verify if MatlabRoot field supports Jenkins environment variables.
+     * 
+     */
+    
+    @Test
+    public void verifyEnvVarSupportForMatlabRoot() throws Exception {
+        EnvironmentVariablesNodeProperty prop = new EnvironmentVariablesNodeProperty();
+        EnvVars var = prop.getEnvVars();
+        var.put("MATLAB", "R2017a");
+        jenkins.jenkins.getGlobalNodeProperties().add(prop);
+        String mroot = getMatlabroot("R2017a");
+        this.matlabBuilder.setLocalMatlab(mroot.replace("R2017a", "$MATLAB"));
+        this.matlabBuilder.setTestRunTypeList(new RunTestsAutomaticallyOption());
+        project.getBuildersList().add(this.matlabBuilder);
+        FreeStyleBuild build = project.scheduleBuild2(0).get();
+        jenkins.assertLogContains(mroot, build);
+        
+    }
+    
+    /*
+     * Test to verify if Custom command field supports Jenkins environment variables.
+     * 
+     */
+    
+    @Test
+    public void verifyEnvVarSupportForCustomCommandField() throws Exception {
+        EnvironmentVariablesNodeProperty prop = new EnvironmentVariablesNodeProperty();
+        EnvVars var = prop.getEnvVars();
+        var.put("TAG", "R2017a");
+        jenkins.jenkins.getGlobalNodeProperties().add(prop);
+        String mroot = getMatlabroot("R2017a");
+        this.matlabBuilder.setLocalMatlab(mroot);
+        RunTestsWithCustomCommandOption runOption = new RunTestsWithCustomCommandOption();
+        this.matlabBuilder.setTestRunTypeList(runOption);
+        runOption.setCustomMatlabCommand("disp($TAG)");
+        project.getBuildersList().add(this.matlabBuilder);
+        FreeStyleBuild build = project.scheduleBuild2(0).get();
+        jenkins.assertLogContains("R2017a", build);
+        
+    }
+    
     /*
      * Private helper methods for tests
      */

src/test/java/com/mathworks/ci/MatlabBuilderTester.java

@@ -10,6 +10,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import hudson.EnvVars;
 import hudson.Extension;
 import hudson.Launcher;
 import hudson.model.AbstractProject;
@@ -29,12 +30,12 @@ public MatlabBuilderTester(String localMatlab, String matlabExecutorPath,
     }
 
     @Override
-    public List<String> constructMatlabCommandWithBatch() {
+    public List<String> constructMatlabCommandWithBatch(EnvVars env) {
         return testMatlabCommand();
     }
 
     @Override
-    public List<String> constructDefaultMatlabCommand(boolean isLinuxLauncher) {
+    public List<String> constructDefaultMatlabCommand(boolean isLinuxLauncher,EnvVars env) {
         return testMatlabCommand();
     }