Address review to refactor MatlabBuild

Author: abhargav-mw

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

@@ -123,9 +123,4 @@ default String getValidMatlabFileName(String actualName) {
         return MatlabBuilderConstants.MATLAB_TEST_RUNNER_FILE_PREFIX
                 + actualName.replaceAll("-", "_");
     }
-
-    default String getCellArrayFrmList(List<String> listOfStr){
-        listOfStr.replaceAll(val -> "'" + val.replaceAll("'", "''") + "'");
-        return "{" + String.join(",", listOfStr) + "}";
-    }
 }

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

@@ -15,6 +15,8 @@
 import java.util.ArrayList;
 import java.util.Optional;
 import java.util.Arrays;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
 import javax.annotation.Nonnull;
 import hudson.EnvVars;
 import hudson.Extension;
@@ -37,7 +39,6 @@ public class RunMatlabTestsBuilder extends Builder implements SimpleBuildStep, M
 
     private int buildResult;
     private EnvVars env;
-    private static final String SOURCE_FOLDER = "SourceFolder";
 
     // Make all old values transient which protects them writing back on disk.
     private transient boolean tapChkBx;
@@ -282,6 +283,15 @@ public String constructCommandForTest(FilePath scriptPath) {
         return runCommand;
     }
 
+    private String getCellArrayFrmList(List<String> listOfStr){
+        // Ignore empty string values in the list
+        Predicate<String> isEmpty = String::isEmpty;
+        Predicate<String> isNotEmpty = isEmpty.negate();
+        List<String> filteredListOfStr = listOfStr.stream().filter(isNotEmpty).collect(Collectors.toList());
+        filteredListOfStr.replaceAll(val -> "'" + val.replaceAll("'", "''") + "'");
+        return "{" + String.join(",", filteredListOfStr) + "}";
+    }
+
     // Concatenate the input arguments
     private String getInputArguments() {
 
@@ -299,20 +309,16 @@ private String getInputArguments() {
             artifact.addFilePathArgTo(args);
         }
 
+        args.forEach((key, val) -> inputArgsList.add("'" + key + "'" + "," + "'" + val + "'"));
+
         // Add source folder options to argument
         SourceFolder sf = getSourceFolder();
         if(sf != null && !sf.getSourceFolderPaths().isEmpty()){
-            sf.addFilePathArgTo(SOURCE_FOLDER, args);
+            sf.addSourceToInputArgs(inputArgsList, getCellArrayFrmList(sf.getSourceFolderPaths().stream()
+                    .map(SourceFolderPaths::getSrcFolderPath)
+                    .collect(Collectors.toList())));
         }
 
-        args.forEach((key, val) -> {
-            if(key.equals(SOURCE_FOLDER)){
-                inputArgsList.add("'" + key + "'" + "," + val);
-            }else{
-                inputArgsList.add("'" + key + "'" + "," + "'" + val + "'");
-            }
-        });
-
         return String.join(",", inputArgsList);
     }
 

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

@@ -9,6 +9,9 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
+
 import org.jenkinsci.plugins.workflow.steps.Step;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
 import org.jenkinsci.plugins.workflow.steps.StepDescriptor;
@@ -24,7 +27,7 @@
 import hudson.model.TaskListener;
 import hudson.Util;
 
-public class RunMatlabTestsStep extends Step implements MatlabBuild{
+public class RunMatlabTestsStep extends Step {
 
     private String testResultsPDF;
     private String testResultsTAP;
@@ -158,4 +161,13 @@ private Map<String, String> getGenscriptArgs() {
         }
         return args;
     }
+
+    private String getCellArrayFrmList(List<String> listOfStr){
+        // Ignore empty string values in the list
+        Predicate<String> isEmpty = String::isEmpty;
+        Predicate<String> isNotEmpty = isEmpty.negate();
+        List<String> filteredListOfStr = listOfStr.stream().filter(isNotEmpty).collect(Collectors.toList());
+        filteredListOfStr.replaceAll(val -> "'" + val.replaceAll("'", "''") + "'");
+        return "{" + String.join(",", filteredListOfStr) + "}";
+    }
 }

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

@@ -16,9 +16,10 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 
-public class SourceFolder extends AbstractDescribableImpl<SourceFolder> implements MatlabBuild {
+public class SourceFolder extends AbstractDescribableImpl<SourceFolder> {
 
     private List<SourceFolderPaths> sourceFolderPaths;
+    private static final String SOURCE_FOLDER = "SourceFolder";
 
     @DataBoundConstructor
     public SourceFolder(List<SourceFolderPaths> sourceFolderPaths) {
@@ -29,11 +30,9 @@ public List<SourceFolderPaths> getSourceFolderPaths() {
         return this.sourceFolderPaths;
     }
 
-    public  void addFilePathArgTo(String sourceKeyVal, Map<String, String> inputArgs) {
+    public  void addSourceToInputArgs(List<String> inputArgsList, String cellArraySourceVal) {
         // Concatenate all source folders to MATLAB cell array string.
-        inputArgs.put(sourceKeyVal, getCellArrayFrmList(this.sourceFolderPaths.stream()
-                .map(SourceFolderPaths::getSrcFolderPath)
-                .collect(Collectors.toList())));
+        inputArgsList.add("'" + SOURCE_FOLDER + "'" + "," + cellArraySourceVal);
     }
 
     @Extension public static class DescriptorImpl extends Descriptor<SourceFolder> {

src/main/resources/com/mathworks/ci/RunMatlabTestsStep/config.jelly

@@ -1,28 +1,32 @@
 <?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
 
-	  <f:entry field="testResultsPDF">
+	  <f:entry field="testResultsPDF" title="testResultsPDF: ">
 	        <f:textbox/>
 	  </f:entry> 
 
-	  <f:entry field="testResultsTAP">
+	  <f:entry field="testResultsTAP" title="testResultsTAP: ">
 	        <f:textbox/>
 	  </f:entry> 
 
-	  <f:entry field="testResultsJUnit">
+	  <f:entry field="testResultsJUnit" title="testResultsJUnit: ">
 	        <f:textbox/>
 	  </f:entry> 
 
-	  <f:entry field="codeCoverageCobertura">
+	  <f:entry field="codeCoverageCobertura" title="codeCoverageCobertura: ">
 	        <f:textbox/>
 	  </f:entry>
 
-	  <f:entry field="testResultsSimulinkTest">
+	  <f:entry field="testResultsSimulinkTest" title="testResultsSimulinkTest: ">
 	        <f:textbox/>
 	  </f:entry> 
 
-	  <f:entry field="modelCoverageCobertura">
+	  <f:entry field="modelCoverageCobertura" title="modelCoverageCobertura: ">
 	        <f:textbox/>
-	  </f:entry> 
+	  </f:entry>
+
+	<f:entry field="sourceFolder" title="sourceFolder: ">
+		<f:textbox/>
+	</f:entry>
 
-</j:jelly>
+</j:jelly>

src/main/resources/com/mathworks/ci/RunMatlabTestsStep/help-sourceFolder.html

@@ -0,0 +1,5 @@
+<div>
+    <p>Specify the location of folders containing source code, relative to the project root folder. The specified folders and their subfolders are added to the top of the MATLAB search path. To generate a coverage report, MATLAB uses only the source code in the specified folders and their subfolders.</p>
+    <p>Paste the source folder path in the box in a list format.</p>
+    <p>Example: ["src/folderA", "src/folderB"]</p>
+</div>