Merge pull request #188 from mathworks/pipeline_stage_failure

Add support for stage failures in pipelines

Author: abhargav-mw

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

@@ -43,10 +43,15 @@ public Void run() throws Exception {
 
         workspace.mkdirs();
 
-        int res = execMatlabCommand(workspace, launcher, listener, env);
+        int exitCode = execMatlabCommand(workspace, launcher, listener, env);
 
-        getContext().setResult((res == 0) ? Result.SUCCESS : Result.FAILURE);
-        
+        if(exitCode == 0){
+            getContext().setResult(Result.SUCCESS);
+            return null;
+        }
+
+        // throw an exception if return code is non-zero
+        stop(new MatlabExecutionException(exitCode));
         return null;
     }
 
@@ -74,9 +79,6 @@ private synchronized int execMatlabCommand(FilePath workspace, Launcher launcher
                     .println("#################### Starting command output ####################");
             return matlabLauncher.pwd(workspace).join();
 
-        } catch (Exception e) {
-            listener.getLogger().println(e.getMessage());
-            return 1;
         } finally {
             // Cleanup the tmp directory
             if (uniqueTmpFolderPath.exists()) {
@@ -99,4 +101,4 @@ private void createMatlabScriptByName(FilePath uniqeTmpFolderPath, String unique
 
         matlabCommandFile.write(matlabCommandFileContent, "UTF-8");
     }
-}
+}

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

@@ -0,0 +1,21 @@
+package com.mathworks.ci;
+
+import java.lang.Exception;
+
+public class MatlabExecutionException extends Exception {
+
+    private final int exitCode;
+
+    MatlabExecutionException(int exitCode) {
+        super(String.format(Message.getValue("matlab.execution.exception.prefix"), exitCode));
+        this.exitCode = exitCode;
+    }
+
+    /*
+     * Function to retrieve MATLAB process's exit code.
+     * This may require Jenkins In-process script approval.
+     */
+    public int getExitCode() {
+        return exitCode;
+    }
+}

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

@@ -42,10 +42,15 @@ public Void run() throws Exception {
 
         workspace.mkdirs();
 
-        int res = execMatlabCommand(workspace, launcher, listener, env);
+        int exitCode = execMatlabCommand(workspace, launcher, listener, env);
 
-        getContext().setResult((res == 0) ? Result.SUCCESS : Result.FAILURE);
-        
+        if(exitCode == 0){
+            getContext().setResult(Result.SUCCESS);
+            return null;
+        }
+
+        // throw an exception if returned exit code is non-zero
+        stop(new MatlabExecutionException(exitCode));
         return null;
     }
 
@@ -72,9 +77,6 @@ private synchronized int execMatlabCommand(FilePath workspace, Launcher launcher
                     getRunnerScript(MatlabBuilderConstants.TEST_RUNNER_SCRIPT, envVars.expand(getCommandArgs())));
 
             return matlabLauncher.pwd(workspace).join();
-        } catch (Exception e) {
-            listener.getLogger().println(e.getMessage());
-            return 1;
         } finally {
             // Cleanup the runner File from tmp directory
             final FilePath matlabRunnerScript =

src/main/resources/config.properties

@@ -14,6 +14,7 @@ builder.matlab.customcommandoption.display.name = Custom
 Releaseinfo.matlab.version.not.found.error = Error finding MATLAB release for given MATLAB root. Verify MATLAB root path.
 matlab.not.found.error = Unable to launch MATLAB from the specified location. Verify the path to MATLAB root folder.
 matlab.not.found.error.for.node = Unable to launch MATLAB '%s' on the node '%s'. Verify global tool configuration for the specified node.
+matlab.execution.exception.prefix = Received a nonzero exit code %d while trying to run MATLAB.
 Builder.matlab.modelcoverage.support.warning = To generate a Cobertura model coverage report, use MATLAB R2018b or a newer release.
 Builder.matlab.exportstmresults.support.warning = To export Simulink Test Manager results, use MATLAB R2019a or a newer release.
 Builder.matlab.runner.script.target.file.linux.name = run_matlab_command.sh

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

@@ -5,6 +5,8 @@
  */
 
 import java.io.IOException;
+
+import hudson.model.Result;
 import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
@@ -120,4 +122,33 @@ public void verifyMatrixBuild() throws Exception {
         j.assertLogContains("pwd", build);
         j.assertLogContains("ver", build);
     }
+
+    /*
+    * Test for verifying Run Matlab Command raises exception for non-zero exit code.
+    * */
+    @Test
+    public void verifyExceptionForNonZeroExitCode() throws Exception {
+        // exitMatlab is a mock command for run_matlab_command script to exit with 1.
+        project.setDefinition(
+                new CpsFlowDefinition("node { try {runMATLABCommand(command: 'exitMatlab')}catch(exc){echo exc.getMessage()}}", true));
+
+        WorkflowRun build = project.scheduleBuild2(0).get();
+        j.assertLogContains(String.format(Message.getValue("matlab.execution.exception.prefix"), 1), build);
+        j.assertBuildStatusSuccess(build);
+    }
+
+    /*
+     * Test for verifying Run Matlab Command raises exception for non-zero exit code.
+     * */
+    @Test
+    public void verifyExceptionStackTraceForNonZeroExitCode() throws Exception {
+        // exitMatlab is a mock command for run_matlab_command script to exit with 1.
+        project.setDefinition(
+                new CpsFlowDefinition("node { runMATLABCommand(command: 'exitMatlab')}", true));
+
+        WorkflowRun build = project.scheduleBuild2(0).get();
+        j.assertBuildStatus(Result.FAILURE, build);
+        j.assertLogContains("com.mathworks.ci.MatlabExecutionException", build);
+        j.assertLogContains(String.format(Message.getValue("matlab.execution.exception.prefix"), 1), build);
+    }
 }

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

@@ -6,6 +6,8 @@
  */
 
 import java.io.IOException;
+
+import hudson.model.Result;
 import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
 import org.jenkinsci.plugins.workflow.job.WorkflowJob;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
@@ -125,6 +127,15 @@ public void verifyEmptyParameter() throws Exception {
         j.assertLogNotContains("SimulinkTestResultsPath", build);
         j.assertLogNotContains("CoberturaModelCoveragePath", build);
     }
+
+    @Test
+    public void verifyExceptionForNonZeroExitCode() throws Exception {
+        project.setDefinition(new CpsFlowDefinition(
+                "node {runMATLABTests()}", true));
+        WorkflowRun build = project.scheduleBuild2(0).get();
+        j.assertBuildStatus(Result.FAILURE, build);
+        j.assertLogContains(String.format(Message.getValue("matlab.execution.exception.prefix"), 1), build);
+    }
 
     /*@Integ Test
      * Verify default command options for test Filter using selectByFolder option 

src/test/resources/run_matlab_command_test.bat

@@ -5,3 +5,5 @@ echo "tester_started"
 set "arg1=%~1"
 
 echo "%arg1%"
+
+if "%arg1%" == "exitMatlab" (exit /b 1)

src/test/resources/run_matlab_command_test.sh

@@ -3,4 +3,7 @@
 #Copyright 2020 The MathWorks, Inc.
 
 echo "tester_started"
-echo $1 
+echo $1
+if [[ $1 == "exitMatlab" ]]; then
+  exit 1
+fi