Refactored the common code using default methods.

Author: nbhoski

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

@@ -0,0 +1,68 @@
+package com.mathworks.ci;
+/**
+ * Copyright 2019-2020 The MathWorks, Inc.
+ * 
+ * Build Interface has two default methods. MATLAB builders can override the 
+ * default behavior.
+ * 
+ */
+
+import java.io.IOException;
+import java.io.InputStream;
+import hudson.EnvVars;
+import hudson.FilePath;
+import hudson.Launcher;
+import hudson.Launcher.ProcStarter;
+import hudson.model.TaskListener;
+
+public interface MatlabBuild {
+    
+    /**
+     * This Method decorates the launcher with MATLAB command provided and returns the Process 
+     * object to launch MATLAB with appropriate startup options like -r or -batch
+     * @param workspace
+     * @param launcher
+     * @param listener
+     * @param envVars
+     * @param matlabCommand
+     * @return
+     * @throws IOException
+     * @throws InterruptedException
+     */
+    default ProcStarter getProcessToRunMatlabCommand(FilePath workspace, Launcher launcher,TaskListener listener, EnvVars envVars, String matlabCommand) throws IOException, InterruptedException {
+        ProcStarter matlabLauncher;
+        matlabLauncher = launcher.launch().pwd(workspace).envs(envVars);
+        FilePath targetWorkspace = new FilePath(launcher.getChannel(), workspace.getRemote());
+        if(launcher.isUnix()) {
+            matlabLauncher = launcher.launch().pwd(workspace).envs(envVars).cmds("./run_matlab_command.sh",matlabCommand).stdout(listener);
+            //Copy runner .sh for linux platform in workspace.
+            copyFileInWorkspace(MatlabBuilderConstants.SHELL_RUNNER_SCRIPT, "Builder.matlab.runner.script.target.file.linux.name", targetWorkspace);
+        }else {
+            launcher = launcher.decorateByPrefix("cmd.exe","/C");
+            matlabLauncher = launcher.launch().pwd(workspace).envs(envVars).cmds("run_matlab_command.bat","\""+matlabCommand+"\"").stdout(listener);
+            //Copy runner.bat for Windows platform in workspace.
+            copyFileInWorkspace(MatlabBuilderConstants.BAT_RUNNER_SCRIPT, "Builder.matlab.runner.script.target.file.windows.name", targetWorkspace);
+        }
+        return matlabLauncher;
+    }
+
+    /**
+     * Method to copy given file from source to target node specific workspace.
+     * @param sourceFile
+     * @param targetFile
+     * @param targetWorkspace
+     * @throws IOException
+     * @throws InterruptedException
+     */
+    default void copyFileInWorkspace(String sourceFile, String targetFile,
+            FilePath targetWorkspace) throws IOException, InterruptedException {
+        final ClassLoader classLoader = getClass().getClassLoader();
+        FilePath targetFilePath = new FilePath(targetWorkspace, Message.getValue(targetFile));
+        InputStream in = classLoader.getResourceAsStream(sourceFile);
+        targetFilePath.copyFrom(in);
+        // set executable permission
+        targetFilePath.chmod(0755);
+        
+    }
+
+}

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

@@ -11,9 +11,6 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.nio.file.StandardCopyOption;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;

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

@@ -7,7 +7,6 @@
  */
 
 import java.io.IOException;
-import java.io.InputStream;
 import javax.annotation.Nonnull;
 import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
@@ -27,7 +26,7 @@
 import jenkins.tasks.SimpleBuildStep;
 import net.sf.json.JSONObject;
 
-public class RunMatlabCommandBuilder extends Builder implements SimpleBuildStep {
+public class RunMatlabCommandBuilder extends Builder implements SimpleBuildStep, MatlabBuild {
     private int buildResult;
     private EnvVars env;
     private String matlabCommand;
@@ -114,33 +113,11 @@ private synchronized int execMatlabCommand(FilePath workspace, Launcher launcher
             TaskListener listener, EnvVars envVars) throws IOException, InterruptedException {
         ProcStarter matlabLauncher;
         try {
-            matlabLauncher = launcher.launch().pwd(workspace).envs(envVars);
-            FilePath targetWorkspace = new FilePath(launcher.getChannel(), workspace.getRemote());
-            if(launcher.isUnix()) {
-                matlabLauncher = launcher.launch().pwd(workspace).envs(envVars).cmds("./run_matlab_command.sh",getCommand()).stdout(listener);
-                //Copy runner .sh for linux platform in workspace.
-                copyFileInWorkspace(MatlabBuilderConstants.SHELL_RUNNER_SCRIPT, "Builder.matlab.runner.script.target.file.linux.name", targetWorkspace);
-            }else {
-                launcher = launcher.decorateByPrefix("cmd.exe","/C");
-                matlabLauncher = launcher.launch().pwd(workspace).envs(envVars).cmds("run_matlab_command.bat","\""+getCommand()+"\"").stdout(listener);
-                //Copy runner.bat for Windows platform in workspace.
-                copyFileInWorkspace(MatlabBuilderConstants.BAT_RUNNER_SCRIPT, "Builder.matlab.runner.script.target.file.windows.name", targetWorkspace);
-            }
+            matlabLauncher = getProcessToRunMatlabCommand(workspace, launcher, listener, envVars,getCommand());
         } catch (Exception e) {
             listener.getLogger().println(e.getMessage());
             return 1;
         }
         return matlabLauncher.join();
-    }
-    
-    public void copyFileInWorkspace(String matlabRunnerResourcePath, String matlabRunnerTarget,
-            FilePath targetWorkspace) throws IOException, InterruptedException {
-        final ClassLoader classLoader = getClass().getClassLoader();
-        FilePath targetFile = new FilePath(targetWorkspace, Message.getValue(matlabRunnerTarget));
-        InputStream in = classLoader.getResourceAsStream(matlabRunnerResourcePath);
-        targetFile.copyFrom(in);
-        // set executable permission
-        targetFile.chmod(0755);
-    }
-
+    } 
 }

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

@@ -10,7 +10,6 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.io.InputStream;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.function.Function;
@@ -39,7 +38,7 @@
 import jenkins.tasks.SimpleBuildStep;
 import net.sf.json.JSONObject;
 
-public class RunMatlabTestsBuilder extends Builder implements SimpleBuildStep {
+public class RunMatlabTestsBuilder extends Builder implements SimpleBuildStep,MatlabBuild {
 
     private int buildResult;
     private EnvVars env;
@@ -284,21 +283,13 @@ private synchronized int execMatlabCommand(FilePath workspace, Launcher launcher
             TaskListener listener, EnvVars envVars) throws IOException, InterruptedException {
         ProcStarter matlabLauncher;
         try {
-            matlabLauncher = launcher.launch().pwd(workspace).envs(envVars);
-            FilePath targetWorkspace = new FilePath(launcher.getChannel(), workspace.getRemote());
-            if (launcher.isUnix()) {
-                matlabLauncher = launcher.launch().pwd(workspace).envs(envVars).cmds("./run_matlab_command.sh",constructCommandForTest(getInputArguments())).stdout(listener);
-                // Copy runner .sh for linux platform in workspace.
-                cpoyFileInWorkspace(MatlabBuilderConstants.SHELL_RUNNER_SCRIPT,"Builder.matlab.runner.script.target.file.linux.name", targetWorkspace);
-            } else {
-                launcher = launcher.decorateByPrefix("cmd.exe", "/C");
-                matlabLauncher = launcher.launch().pwd(workspace).envs(envVars).cmds("run_matlab_command.bat","\"" + constructCommandForTest(getInputArguments()) + "\"").stdout(listener);
-                // Copy runner.bat for Windows platform in workspace.
-                cpoyFileInWorkspace(MatlabBuilderConstants.BAT_RUNNER_SCRIPT,"Builder.matlab.runner.script.target.file.windows.name", targetWorkspace);
-            }
+            matlabLauncher = getProcessToRunMatlabCommand(workspace, launcher, listener, envVars,
+                    constructCommandForTest(getInputArguments()));
 
             // Copy MATLAB scratch file into the workspace.
-            cpoyFileInWorkspace(MatlabBuilderConstants.MATLAB_RUNNER_RESOURCE,MatlabBuilderConstants.MATLAB_RUNNER_TARGET_FILE, targetWorkspace);
+            FilePath targetWorkspace = new FilePath(launcher.getChannel(), workspace.getRemote());
+            copyFileInWorkspace(MatlabBuilderConstants.MATLAB_RUNNER_RESOURCE,
+                    MatlabBuilderConstants.MATLAB_RUNNER_TARGET_FILE, targetWorkspace);
         } catch (Exception e) {
             listener.getLogger().println(e.getMessage());
             return 1;
@@ -314,16 +305,6 @@ public String constructCommandForTest(String inputArguments) {
         return runCommand;
     }   
 
-    private void cpoyFileInWorkspace(String matlabRunnerResourcePath, String matlabRunnerTarget,
-            FilePath targetWorkspace) throws IOException, InterruptedException {
-        final ClassLoader classLoader = getClass().getClassLoader();
-        FilePath targetFile = new FilePath(targetWorkspace, Message.getValue(matlabRunnerTarget));
-        InputStream in = classLoader.getResourceAsStream(matlabRunnerResourcePath);
-        targetFile.copyFrom(in);
-        // set executable permission to the file.
-        targetFile.chmod(0755);
-    }
-    
     // Concatenate the input arguments
     private String getInputArguments() {
         String pdfReport = MatlabBuilderConstants.PDF_REPORT + "," + this.getPdfReportChkBx();

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

@@ -3,18 +3,10 @@
 
 
 import static org.junit.Assert.assertFalse;
-import hudson.EnvVars;
-import hudson.FilePath;
-import hudson.model.FreeStyleBuild;
-import hudson.model.Result;
-import hudson.slaves.EnvironmentVariablesNodeProperty;
-import hudson.model.FreeStyleProject;
-import hudson.tasks.Builder;
 import java.io.File;
 import java.io.IOException;
 import java.net.URISyntaxException;
 import java.net.URL;
-import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.ExecutionException;
 import org.junit.After;
@@ -29,6 +21,12 @@
 import com.gargoylesoftware.htmlunit.html.HtmlPage;
 import com.mathworks.ci.MatlabBuilder.RunTestsAutomaticallyOption;
 import com.mathworks.ci.MatlabBuilder.RunTestsWithCustomCommandOption;
+import hudson.EnvVars;
+import hudson.FilePath;
+import hudson.model.FreeStyleBuild;
+import hudson.model.FreeStyleProject;
+import hudson.model.Result;
+import hudson.slaves.EnvironmentVariablesNodeProperty;
 
 
 /*

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

@@ -10,9 +10,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
-import hudson.EnvVars;
 import hudson.Extension;
-import hudson.Launcher;
 import hudson.model.AbstractProject;
 import hudson.tasks.BuildStepDescriptor;
 import hudson.tasks.Builder;

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

@@ -10,7 +10,6 @@
 import java.util.ArrayList;
 import java.util.List;
 import javax.annotation.Nonnull;
-import org.kohsuke.stapler.DataBoundSetter;
 import org.kohsuke.stapler.StaplerRequest;
 import hudson.EnvVars;
 import hudson.Extension;
@@ -29,7 +28,6 @@ public class RunMatlabCommandBuilderTester extends RunMatlabCommandBuilder {
     private int buildResult;
     private EnvVars env;
     private MatlabReleaseInfo matlabRel;
-    private String matlabCommand;
     private String commandParameter;
     private String matlabExecutorPath;
 
@@ -42,10 +40,6 @@ public RunMatlabCommandBuilderTester(String matlabExecutorPath, String customTes
 
     // Getter and Setters to access local members
 
-    public void setMatlabCommand(String matlabCommand) {
-        this.matlabCommand = matlabCommand;
-    }
-
     private void setEnv(EnvVars env) {
         this.env = env;
     }

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

@@ -23,12 +23,10 @@
 import com.gargoylesoftware.htmlunit.WebAssert;
 import com.gargoylesoftware.htmlunit.html.HtmlCheckBoxInput;
 import com.gargoylesoftware.htmlunit.html.HtmlPage;
-import hudson.EnvVars;
 import hudson.FilePath;
 import hudson.model.FreeStyleBuild;
 import hudson.model.FreeStyleProject;
 import hudson.model.Result;
-import hudson.slaves.EnvironmentVariablesNodeProperty;
 import hudson.tasks.Builder;
 
 public class RunMatlabTestsBuilderTest {