Rearrange pipeline step parameter creation order to avoid serialization issues

Author: sameagen-MW

src/main/java/com/mathworks/ci/parameters/MatlabActionParameters.java

@@ -14,12 +14,12 @@
  *
  */
 
-public class MatlabActionParameters implements Serializable {
-    private transient Run build;
+public class MatlabActionParameters {
+    private Run build;
     private FilePath workspace;
     private EnvVars env;
-    private transient Launcher launcher;
-    private transient TaskListener listener;
+    private Launcher launcher;
+    private TaskListener listener;
 
     private String startupOptions;
 

src/main/java/com/mathworks/ci/pipeline/MatlabBuildStepExecution.java

@@ -19,25 +19,28 @@ public class MatlabBuildStepExecution extends SynchronousNonBlockingStepExecutio
 
     private static final long serialVersionUID = 4771831219402275744L;
 
-    private BuildActionParameters params;
     private MatlabActionFactory factory;
-    public MatlabBuildStepExecution(MatlabActionFactory factory, StepContext context, String tasks, String startupOptions, String buildOptions) throws IOException, InterruptedException {
-        super(context);
+    private RunMatlabBuildStep step;
+
+    public MatlabBuildStepExecution(MatlabActionFactory factory, StepContext ctx, RunMatlabBuildStep step) throws IOException, InterruptedException {
+        super(ctx);
 
-        this.params = new BuildActionParameters(context, startupOptions, tasks, buildOptions);
         this.factory = factory;
+        this.step = step;
     }
 
-    public MatlabBuildStepExecution(StepContext context, String tasks, String startupOptions, String buildOptions) throws IOException, InterruptedException {
-        this(new MatlabActionFactory(), context, tasks, startupOptions, buildOptions);
-    }
-
-    public BuildActionParameters getParameters() {
-        return this.params;
+    public MatlabBuildStepExecution(StepContext ctx, RunMatlabBuildStep step) throws IOException, InterruptedException {
+        this(new MatlabActionFactory(), ctx, step);
     }
 
     @Override
     public Void run() throws Exception {
+        BuildActionParameters params = new BuildActionParameters(
+                getContext(),
+                step.getStartupOptions(),
+                step.getTasks(),
+                step.getBuildOptions());
+
         RunMatlabBuildAction action = factory.createAction(params);
         try {
             action.run();

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

@@ -18,30 +18,26 @@ public class MatlabCommandStepExecution extends SynchronousNonBlockingStepExecut
 
     private static final long serialVersionUID = 1957239693658914450L;
 
-    private String command;
-    private String startupOptions;
-
-    private RunActionParameters params;
-
     private MatlabActionFactory factory;
+    private RunMatlabCommandStep step;
 
-    public MatlabCommandStepExecution(MatlabActionFactory factory, StepContext context, String command, String startupOptions) throws IOException, InterruptedException {
+    public MatlabCommandStepExecution(MatlabActionFactory factory, StepContext context, RunMatlabCommandStep step) throws IOException, InterruptedException {
         super(context);
 
-        this.params = new RunActionParameters(context, startupOptions, command);
         this.factory = factory;
+        this.step = step;
     }
 
-    public MatlabCommandStepExecution(StepContext context, String command, String startupOptions) throws IOException, InterruptedException {
-        this(new MatlabActionFactory(), context, command, startupOptions);
-    }
-
-    public RunActionParameters getParameters() {
-        return this.params;
+    public MatlabCommandStepExecution(StepContext context, RunMatlabCommandStep step) throws IOException, InterruptedException {
+        this(new MatlabActionFactory(), context, step);
     }
 
     @Override
     public Void run() throws Exception {
+        RunActionParameters params = new RunActionParameters(
+                getContext(),
+                step.getStartupOptions(),
+                step.getCommand());
         RunMatlabCommandAction action = factory.createAction(params);        
 
         try {

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

@@ -20,26 +20,39 @@ public class MatlabRunTestsStepExecution extends SynchronousNonBlockingStepExecu
 
     private static final long serialVersionUID = 6704588180717665100L;
 
-    private TestActionParameters params;
     private MatlabActionFactory factory;
+    private RunMatlabTestsStep step;
 
-    public MatlabRunTestsStepExecution(MatlabActionFactory factory, StepContext context, TestActionParameters params) throws IOException, InterruptedException {
+    public MatlabRunTestsStepExecution(MatlabActionFactory factory, StepContext context, RunMatlabTestsStep step) throws IOException, InterruptedException {
         super(context);
 
-        this.params = params;
         this.factory = factory;
+        this.step = step;
     }
 
-    public MatlabRunTestsStepExecution(StepContext context, TestActionParameters params) throws IOException, InterruptedException {
-        this(new MatlabActionFactory(), context, params);
+    public MatlabRunTestsStepExecution(StepContext context, RunMatlabTestsStep step) throws IOException, InterruptedException {
+        this(new MatlabActionFactory(), context, step);
     }
 
-    public TestActionParameters getParameters() {
-        return this.params;
-    }
 
     @Override
     public Void run() throws Exception {
+        TestActionParameters params = new TestActionParameters(
+                getContext(),
+                step.getStartupOptions(),
+                step.getTestResultsPDF(),
+                step.getTestResultsTAP(),
+                step.getTestResultsJUnit(),
+                step.getCodeCoverageCobertura(),
+                step.getTestResultsSimulinkTest(),
+                step.getModelCoverageCobertura(),
+                step.getSelectByTag(),
+                step.getLoggingLevel(),
+                step.getOutputDetail(),
+                step.getUseParallel(),
+                step.getStrict(),
+                step.getSourceFolder(),
+                step.getSelectByFolder());
         RunMatlabTestsAction action = factory.createAction(params);
         try {
             action.run();

src/main/java/com/mathworks/ci/pipeline/RunMatlabBuildStep.java

@@ -5,6 +5,7 @@
  *  
  */
 
+import java.io.Serializable;
 import java.util.Set;
 import org.jenkinsci.plugins.workflow.steps.Step;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
@@ -23,7 +24,9 @@
 
 import com.mathworks.ci.Message;
 
-public class RunMatlabBuildStep extends Step {
+public class RunMatlabBuildStep extends Step implements Serializable {
+
+    private static final long serialVersionUID = 1L;
 
     private String tasks;
     private String startupOptions;
@@ -63,7 +66,7 @@ public void setBuildOptions (String buildOptions) {
 
     @Override
     public StepExecution start(StepContext context) throws Exception {
-        return new MatlabBuildStepExecution(context, getTasks(), getStartupOptions(), getBuildOptions());
+        return new MatlabBuildStepExecution(context, this);
     }
 
     @Extension

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

@@ -1,10 +1,11 @@
 package com.mathworks.ci.pipeline;
 
 /**
- * Copyright 2020-2023 The MathWorks, Inc.
+ * Copyright 2020-2024 The MathWorks, Inc.
  *  
  */
 
+import java.io.Serializable;
 import java.util.Set;
 import org.jenkinsci.plugins.workflow.steps.Step;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
@@ -23,8 +24,10 @@
 
 import com.mathworks.ci.Message;
 
-public class RunMatlabCommandStep extends Step {
+public class RunMatlabCommandStep extends Step implements Serializable {
 
+    private static final long serialVersionUID = 1L;
+
     private String command;
     private String startupOptions = "";
 
@@ -33,7 +36,6 @@ public RunMatlabCommandStep(String command) {
         this.command = command;
     }
 
-
     public String getCommand() {
         return this.command;
     }
@@ -49,7 +51,7 @@ public String getStartupOptions() {
 
     @Override
     public StepExecution start(StepContext context) throws Exception {
-        return new MatlabCommandStepExecution(context, getCommand(), getStartupOptions());
+        return new MatlabCommandStepExecution(context, this);
     }
 
     @Extension

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

@@ -4,6 +4,7 @@
  *  
  */
 
+import java.io.Serializable;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -27,7 +28,9 @@
 import com.mathworks.ci.Message;
 import com.mathworks.ci.parameters.TestActionParameters;
 
-public class RunMatlabTestsStep extends Step {
+public class RunMatlabTestsStep extends Step implements Serializable {
+
+    private static final long serialVersionUID = 1L;
 
     private String testResultsPDF;
     private String testResultsTAP;
@@ -179,23 +182,7 @@ public void setStartupOptions(String startupOptions) {
 
     @Override
     public StepExecution start(StepContext context) throws Exception {
-        TestActionParameters params = new TestActionParameters(
-                context,
-                this.getStartupOptions(),
-                this.getTestResultsPDF(),
-                this.getTestResultsTAP(),
-                this.getTestResultsJUnit(),
-                this.getCodeCoverageCobertura(),
-                this.getTestResultsSimulinkTest(),
-                this.getModelCoverageCobertura(),
-                this.getSelectByTag(),
-                this.getLoggingLevel(),
-                this.getOutputDetail(),
-                this.getUseParallel(),
-                this.getStrict(),
-                this.getSourceFolder(),
-                this.getSelectByFolder());
-        return new MatlabRunTestsStepExecution(context, params);
+        return new MatlabRunTestsStepExecution(context, this);
     }
 
     @Extension

src/main/java/com/mathworks/ci/utilities/MatlabCommandRunner.java

@@ -48,7 +48,9 @@ public MatlabCommandRunner(MatlabActionParameters params) throws IOException, In
                 new Thread(() -> {
                     try {
                         tempFolder.deleteRecursive();
-                    } catch(Exception e) {}
+                    } catch(Exception e) {
+                        System.err.println(e.toString());
+                    }
                 }));
     }
 

src/test/java/unit/com/mathworks/ci/pipeline/MatlabBuildStepExecutionUnitTest.java

@@ -37,7 +37,7 @@ public void setup() throws IOException, InterruptedException {
 
     @Test
     public void shouldHandleNullCases() throws Exception, IOException, InterruptedException, MatlabExecutionException {
-        MatlabBuildStepExecution ex = new MatlabBuildStepExecution(factory, context, null, null, null);
+        MatlabBuildStepExecution ex = new MatlabBuildStepExecution(factory, context, new RunMatlabBuildStep());
 
         ArgumentCaptor<BuildActionParameters> captor = ArgumentCaptor.forClass(BuildActionParameters.class);
 
@@ -46,16 +46,21 @@ public void shouldHandleNullCases() throws Exception, IOException, InterruptedEx
         verify(factory).createAction(captor.capture());
 
         BuildActionParameters params = captor.getValue();
-        assertEquals(null, params.getStartupOptions());
-        assertEquals(null, params.getTasks());
-        assertEquals(null, params.getBuildOptions());
+        assertEquals("", params.getStartupOptions());
+        assertEquals("", params.getTasks());
+        assertEquals("", params.getBuildOptions());
 
         verify(action).run();
     }
 
     @Test
     public void shouldHandleMaximalCases() throws Exception, IOException, InterruptedException, MatlabExecutionException {
-        MatlabBuildStepExecution ex = new MatlabBuildStepExecution(factory, context, "mytask", "-nojvm -nodisplay", "-continueOnFailure");
+        RunMatlabBuildStep step = new RunMatlabBuildStep();
+        step.setStartupOptions("-nojvm -logfile file");
+        step.setTasks("vacuum bills");
+        step.setBuildOptions("-continueOnFailure");
+
+        MatlabBuildStepExecution ex = new MatlabBuildStepExecution(factory, context, step);
 
         ex.run();
 
@@ -64,16 +69,16 @@ public void shouldHandleMaximalCases() throws Exception, IOException, Interrupte
         verify(factory).createAction(captor.capture());
 
         BuildActionParameters params = captor.getValue();
-        assertEquals("-nojvm -nodisplay", params.getStartupOptions());
-        assertEquals("mytask", params.getTasks());
+        assertEquals("-nojvm -logfile file", params.getStartupOptions());
+        assertEquals("vacuum bills", params.getTasks());
         assertEquals("-continueOnFailure", params.getBuildOptions());
 
         verify(action).run();
     }
 
     @Test
     public void shouldHandleActionThrowing() throws Exception, IOException, InterruptedException, MatlabExecutionException {
-        MatlabBuildStepExecution ex = new MatlabBuildStepExecution(factory, context, null, null, null);
+        MatlabBuildStepExecution ex = new MatlabBuildStepExecution(factory, context, new RunMatlabBuildStep());
 
         doThrow(new MatlabExecutionException(12)).when(action).run();
 

src/test/java/unit/com/mathworks/ci/pipeline/MatlabCommandStepExecutionUnitTest.java

@@ -37,41 +37,48 @@ public void setup() throws IOException, InterruptedException {
 
     @Test
     public void shouldHandleNullCases() throws Exception, IOException, InterruptedException, MatlabExecutionException {
-        MatlabCommandStepExecution ex = new MatlabCommandStepExecution(factory, context, null, null);
-
-        ArgumentCaptor<RunActionParameters> captor = ArgumentCaptor.forClass(RunActionParameters.class);
+        MatlabCommandStepExecution ex = new MatlabCommandStepExecution(
+                factory, 
+                context, 
+                new RunMatlabCommandStep(null));
 
         ex.run();
 
+        ArgumentCaptor<RunActionParameters> captor = ArgumentCaptor.forClass(RunActionParameters.class);
         verify(factory).createAction(captor.capture());
 
         RunActionParameters params = captor.getValue();
-        assertEquals(null, params.getStartupOptions());
+        assertEquals("", params.getStartupOptions());
         assertEquals(null, params.getCommand());
 
         verify(action).run();
     }
 
     @Test
     public void shouldHandleMaximalCases() throws Exception, IOException, InterruptedException, MatlabExecutionException {
-        MatlabCommandStepExecution ex = new MatlabCommandStepExecution(factory, context, "mycommand", "-nojvm -nodisplay");
+        RunMatlabCommandStep step = new RunMatlabCommandStep("mycommand");
+        step.setStartupOptions("-nojvm -logfile file");
+
+        MatlabCommandStepExecution ex = new MatlabCommandStepExecution(factory, context, step);
 
         ex.run();
 
         ArgumentCaptor<RunActionParameters> captor = ArgumentCaptor.forClass(RunActionParameters.class);
-
         verify(factory).createAction(captor.capture());
 
         RunActionParameters params = captor.getValue();
-        assertEquals("-nojvm -nodisplay", params.getStartupOptions());
+        assertEquals("-nojvm -logfile file", params.getStartupOptions());
         assertEquals("mycommand", params.getCommand());
 
         verify(action).run();
     }
 
     @Test
     public void shouldHandleActionThrowing() throws Exception, IOException, InterruptedException, MatlabExecutionException {
-        MatlabCommandStepExecution ex = new MatlabCommandStepExecution(factory, context, null, null);
+        MatlabCommandStepExecution ex = new MatlabCommandStepExecution(
+                factory, 
+                context, 
+                new RunMatlabCommandStep(null));
 
         doThrow(new MatlabExecutionException(12)).when(action).run();