Accomodated command as script changes to DSL pipeline.

Author: Nikhil Bhoski

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

@@ -0,0 +1,106 @@
+package com.mathworks.ci;
+
+import java.io.IOException;
+import org.jenkinsci.plugins.workflow.steps.StepContext;
+import org.jenkinsci.plugins.workflow.steps.StepExecution;
+import hudson.EnvVars;
+import hudson.FilePath;
+import hudson.Launcher;
+import hudson.Launcher.ProcStarter;
+import hudson.model.Result;
+import hudson.model.TaskListener;
+
+public class MatlabCommandStepExecution extends StepExecution implements MatlabBuild {
+    
+    private static final long serialVersionUID = 1957239693658914450L;
+    
+    private String command;
+    private EnvVars env;
+
+
+    public MatlabCommandStepExecution(StepContext context, String command) {
+        super(context);
+        this.command = command;
+    }
+
+    private String getCommand() {
+        return this.env == null ? this.command : this.env.expand(this.command );
+    }
+    
+    private void setEnv(EnvVars env) {
+        this.env = env;
+    }
+
+    @Override
+    public boolean start() throws Exception {
+        final Launcher launcher = getContext().get(Launcher.class);
+        final FilePath workspace = getContext().get(FilePath.class);
+        final TaskListener listener = getContext().get(TaskListener.class);
+        final EnvVars env = getContext().get(EnvVars.class);
+        setEnv(env);
+        
+        //Make sure the Workspace exists before run
+        
+        workspace.mkdirs();
+        
+        int res = execMatlabCommand(workspace, launcher, listener, env);
+
+        getContext().setResult((res == 0) ? Result.SUCCESS : Result.FAILURE);
+        
+        getContext().onSuccess(true);
+        
+        //return false represents the asynchronous run. 
+        return false;
+    }
+
+    @Override
+    public void stop(Throwable cause) throws Exception {
+        getContext().onFailure(cause);
+    }
+    
+    private synchronized int execMatlabCommand(FilePath workspace, Launcher launcher,
+            TaskListener listener, EnvVars envVars) throws IOException, InterruptedException {
+        final String uniqueTmpFldrName = getUniqueNameForRunnerFile();
+        final String uniqueCommandFile =
+                "command_" + getUniqueNameForRunnerFile().replaceAll("-", "_");
+        final FilePath uniqeTmpFolderPath =
+                getFilePathForUniqueFolder(launcher, uniqueTmpFldrName, workspace);
+
+        // Create MATLAB script
+        createMatlabScriptByName(uniqeTmpFolderPath, uniqueCommandFile, workspace, listener);
+        ProcStarter matlabLauncher;
+
+        try {
+            matlabLauncher = getProcessToRunMatlabCommand(workspace, launcher, listener, envVars,
+                    uniqueCommandFile, uniqueTmpFldrName);
+            launcher.launch().pwd(uniqeTmpFolderPath).envs(envVars);
+            listener.getLogger()
+                    .println("#################### Starting command output ####################");
+            return matlabLauncher.pwd(uniqeTmpFolderPath).join();
+
+        } catch (Exception e) {
+            listener.getLogger().println(e.getMessage());
+            return 1;
+        } finally {
+            // Cleanup the tmp directory
+            if (uniqeTmpFolderPath.exists()) {
+                uniqeTmpFolderPath.deleteRecursive();
+            }
+        }
+    }
+    
+    private void createMatlabScriptByName(FilePath uniqeTmpFolderPath, String uniqueScriptName, FilePath workspace, TaskListener listener) throws IOException, InterruptedException {
+        
+        // Create a new command runner script in the temp folder.
+        final FilePath matlabCommandFile =
+                new FilePath(uniqeTmpFolderPath, uniqueScriptName + ".m");
+        final String matlabCommandFileContent =
+                "cd '" + workspace.getRemote().replaceAll("'", "''") + "';\n" + getCommand();
+
+        // Display the commands on console output for users reference
+        listener.getLogger()
+                .println("Generating MATLAB script with content:\n" + getCommand() + "\n");
+
+        matlabCommandFile.write(matlabCommandFileContent, "UTF-8");
+    }
+}

src/main/java/com/mathworks/ci/MatlabStepExecution.java renamed to src/main/java/com/mathworks/ci/MatlabRunTestsStepExecution.java

@@ -15,14 +15,14 @@
 import hudson.model.Result;
 import hudson.model.TaskListener;
 
-public class MatlabStepExecution extends StepExecution implements MatlabBuild {
+public class MatlabRunTestsStepExecution extends StepExecution implements MatlabBuild {
 
     private static final long serialVersionUID = 6704588180717665100L;
 
     private String command;
 
 
-    public MatlabStepExecution(StepContext context, String command) {
+    public MatlabRunTestsStepExecution(StepContext context, String command) {
         super(context);
         this.command = command;
     }
@@ -65,7 +65,7 @@ private synchronized int execMatlabCommand(FilePath workspace, Launcher launcher
                     envVars.expand(getCommand()), uniqueTmpFldrName);
 
 
-            return matlabLauncher.join();
+            return matlabLauncher.pwd(workspace).join();
         } catch (Exception e) {
             listener.getLogger().println(e.getMessage());
             return 1;

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

@@ -36,7 +36,7 @@ public String getCommand() {
 
     @Override
     public StepExecution start(StepContext context) throws Exception {
-        return new MatlabStepExecution(context, getCommand());
+        return new MatlabCommandStepExecution(context, getCommand());
     }
 
     @Extension
@@ -52,6 +52,11 @@ public Set<? extends Class<?>> getRequiredContext() {
         public String getFunctionName() {
             return Message.getValue("matlab.command.build.step.name");
         }
+        
+        @Override
+        public String getDisplayName() {
+            return Message.getValue("matlab.command.step.display.name");
+        }
     }
 }
 

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

@@ -111,7 +111,7 @@ public StepExecution start(StepContext context) throws Exception {
         FilePath targetWorkspace = new FilePath(launcher.getChannel(), workspace.getRemote());
         copyScratchFileInWorkspace(MatlabBuilderConstants.MATLAB_TESTS_RUNNER_RESOURCE,
                 MatlabBuilderConstants.MATLAB_TESTS_RUNNER_TARGET_FILE, targetWorkspace);
-        return new MatlabStepExecution(context,constructCommandForTest(getInputArgs()));
+        return new MatlabRunTestsStepExecution(context,constructCommandForTest(getInputArgs()));
     }
 
     @Extension
@@ -127,6 +127,11 @@ public Set<? extends Class<?>> getRequiredContext() {
         public String getFunctionName() {
             return Message.getValue("matlab.tests.build.step.name");
         }
+        
+        @Override
+        public String getDisplayName() {
+            return Message.getValue("matlab.tests.step.display.name");
+        }
     }
 
     public String constructCommandForTest(String inputArguments) {

src/main/resources/config.properties

@@ -18,4 +18,6 @@ Builder.matlab.runner.script.target.file.linux.name = run_matlab_command.sh
 Builder.matlab.runner.script.target.file.windows.name = run_matlab_command.bat
 build.workspace.computer.not.found = Unable to access the computer for this build.
 matlab.command.build.step.name = runMATLABCommand
-matlab.tests.build.step.name = runMATLABTests
+matlab.tests.build.step.name = runMATLABTests
+matlab.command.step.display.name = Runs MATLAB command and scripts
+matlab.tests.step.display.name = Runs MATLAB tests and produce test artifacts

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

@@ -12,7 +12,7 @@
 import hudson.Launcher.ProcStarter;
 import hudson.model.TaskListener;
 
-public class TestStepExecution extends MatlabStepExecution {
+public class TestStepExecution extends MatlabRunTestsStepExecution {
 
     public TestStepExecution(StepContext context, String command) {
         super(context, command);