Merge pull request #150 from mathworks/2.1.4-Qualification

matlab-2.1.4-Qualification

Author: abhargav-mw

CONFIGDOC.md

@@ -60,7 +60,7 @@ The **Run MATLAB Tests** build step enables you to generate different types of t
 
 If you do not select any of the test artifact check boxes, the tests still run, and test failures fail the build.
 
-The **Run MATLAB Tests** build step produces a MATLAB script file named `runMatlabTests.m` in the project workspace. The plugin uses this file to run the tests and generate the test artifacts. You can review the contents of the script to understand the testing workflow.
+The **Run MATLAB Tests** build step produces a MATLAB script file and uses it to run the tests and generate the test artifacts. The plugin writes the contents of this file to the build log. You can review the build log in **Console Output** to understand the testing workflow.
 
 **Note:**
 * The plugin does not create the `matlabTestArtifacts` folder if the name of the folder does not appear in any of the displayed **File path** boxes.

azure-pipelines.yml

@@ -10,7 +10,7 @@ strategy:
     mac:
       imageName: 'macOS-10.15'
     windows:
-      imageName: 'vs2017-win2016'
+      imageName: 'windows-latest'
 
 pool:
   vmImage: $(imageName)

pom.xml

@@ -124,6 +124,22 @@
 							<url>https://ssd.mathworks.com/supportfiles/ci/run-matlab-command/v0/run-matlab-command.zip</url>
 							<unpack>true</unpack>
 							<outputDirectory>${basedir}/src/main/resources</outputDirectory>
+							<skipCache>true</skipCache>
+                            <overwrite>true</overwrite>
+						</configuration>
+					</execution>
+					<execution>
+						<id>get-matlab-gen-script</id>
+						<phase>validate</phase>
+						<goals>
+							<goal>wget</goal>
+						</goals>
+						<configuration>
+							<url>https://ssd.mathworks.com/supportfiles/ci/matlab-script-generator/v0/matlab-script-generator.zip</url>
+							<unpack>false</unpack>
+							<outputDirectory>${basedir}/src/main/resources</outputDirectory>
+							<skipCache>true</skipCache>
+                            <overwrite>true</overwrite>
 						</configuration>
 					</execution>
 				</executions>
@@ -186,6 +202,7 @@
 											<include>**/*.bat</include>
 											<include>**/*.sh</include>
 											<include>**/*.txt</include>
+											<include>**/*.zip</include>
 										</includes>
 										<followSymlinks>false</followSymlinks>
 									</fileset>

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

@@ -96,4 +96,30 @@ default String getNodeSpecificTmpFolderPath(FilePath workspace) throws IOExcepti
     default String getUniqueNameForRunnerFile() {
         return UUID.randomUUID().toString();
     }
+    
+    // This method prepares the temp folder by coping all helper files in it.
+    default void prepareTmpFldr(FilePath tmpFldr, String runnerScript) throws IOException, InterruptedException {
+        // Write MATLAB scratch file in temp folder.
+        FilePath scriptFile =
+                new FilePath(tmpFldr, getValidMatlabFileName(tmpFldr.getBaseName()) + ".m");
+        scriptFile.write(runnerScript, "UTF-8");
+        // copy genscript package
+        copyFileInWorkspace(MatlabBuilderConstants.MATLAB_SCRIPT_GENERATOR,
+                MatlabBuilderConstants.MATLAB_SCRIPT_GENERATOR, tmpFldr);
+        FilePath zipFileLocation =
+                new FilePath(tmpFldr, MatlabBuilderConstants.MATLAB_SCRIPT_GENERATOR);
+
+        // Unzip the file in temp folder.
+        zipFileLocation.unzip(tmpFldr);
+    }
+    
+    default String getRunnerScript(String script, String params) {
+        script = script.replace("${PARAMS}", params);
+        return script;
+    }
+    
+    default String getValidMatlabFileName(String actualName) {
+        return MatlabBuilderConstants.MATLAB_TEST_RUNNER_FILE_PREFIX
+                + actualName.replaceAll("-", "_");
+    }
 }

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

@@ -13,7 +13,6 @@ public class MatlabBuilderConstants {
 
     static final String MATLAB_RUNNER_TARGET_FILE = "Builder.matlab.runner.target.file.name";
     static final String MATLAB_TESTS_RUNNER_TARGET_FILE = "runMatlabTests.m";
-    static final String MATLAB_TESTS_RUNNER_RESOURCE = "com/mathworks/ci/RunMatlabTestsBuilder/runMatlabTests.m";
     static final String MATLAB_RUNNER_RESOURCE = "com/mathworks/ci/MatlabBuilder/runMatlabTests.m";
     static final String AUTOMATIC_OPTION = "RunTestsAutomaticallyOption";
 
@@ -28,4 +27,16 @@ public class MatlabBuilderConstants {
     // Matlab Runner files 
     static final String BAT_RUNNER_SCRIPT = "run_matlab_command.bat";
     static final String SHELL_RUNNER_SCRIPT = "run_matlab_command.sh";
+    
+    //Matlab Script generator package 
+    static final String MATLAB_SCRIPT_GENERATOR = "matlab-script-generator.zip";
+    
+    //Test runner file prefix 
+    static final String MATLAB_TEST_RUNNER_FILE_PREFIX = "test_runner_";
+    
+    // MATLAB runner script
+    static final String TEST_RUNNER_SCRIPT = "testScript = genscript(${PARAMS});\n" + "\n"
+            + "disp('Running MATLAB script with content:');\n"
+            + "disp(strtrim(testScript.writeToText()));\n"
+            + "fprintf('___________________________________\\n\\n');\n" + "run(testScript);\n" + "";
 }

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

@@ -0,0 +1,18 @@
+package com.mathworks.ci;
+
+/**
+ * Copyright 2020 The MathWorks, Inc.
+ * 
+ */
+
+import java.io.FileNotFoundException;
+
+public class MatlabNotFoundError extends Error {
+
+    private static final long serialVersionUID = 7918595075502022644L;
+
+    MatlabNotFoundError(String errorMessage){
+        super(errorMessage);
+    }
+
+}

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

@@ -19,16 +19,16 @@ public class MatlabRunTestsStepExecution extends SynchronousNonBlockingStepExecu
 
     private static final long serialVersionUID = 6704588180717665100L;
 
-    private String command;
+    private String commandArgs;
 
 
-    public MatlabRunTestsStepExecution(StepContext context, String command) {
+    public MatlabRunTestsStepExecution(StepContext context, String commandArgs) {
         super(context);
-        this.command = command;
+        this.commandArgs = commandArgs;
     }
 
-    private String getCommand() {
-        return this.command;
+    private String getCommandArgs() {
+        return this.commandArgs;
     }
 
     @Override
@@ -58,10 +58,19 @@ private synchronized int execMatlabCommand(FilePath workspace, Launcher launcher
             TaskListener listener, EnvVars envVars) throws IOException, InterruptedException {
         final String uniqueTmpFldrName = getUniqueNameForRunnerFile();  
         try {
-            ProcStarter matlabLauncher = getProcessToRunMatlabCommand(workspace, launcher, listener, envVars,
-                    envVars.expand(getCommand()), uniqueTmpFldrName);
+            FilePath genScriptLocation =
+                    getFilePathForUniqueFolder(launcher, uniqueTmpFldrName, workspace);
+            final String cmdPrefix =
+                    "addpath('" + genScriptLocation.getRemote().replaceAll("'", "''") + "'); ";
+            final String matlabScriptName = getValidMatlabFileName(genScriptLocation.getBaseName());
+
+            ProcStarter matlabLauncher = getProcessToRunMatlabCommand(workspace, launcher, listener,
+                    envVars, cmdPrefix + matlabScriptName, uniqueTmpFldrName);
 
-                     
+            // prepare temp folder by coping genscript package and writing runner script.
+            prepareTmpFldr(genScriptLocation,
+                    getRunnerScript(MatlabBuilderConstants.TEST_RUNNER_SCRIPT, envVars.expand(getCommandArgs())));
+                               
             return matlabLauncher.pwd(workspace).join();
         } catch (Exception e) {
             listener.getLogger().println(e.getMessage());

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

@@ -11,9 +11,6 @@
 import java.io.IOException;
 import java.util.*;
 import javax.annotation.Nonnull;
-import org.apache.commons.collections.map.HashedMap;
-import org.apache.commons.io.FilenameUtils;
-import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.DataBoundSetter;
 import org.kohsuke.stapler.StaplerRequest;
@@ -239,13 +236,15 @@ private synchronized int execMatlabCommand(FilePath workspace, Launcher launcher
         final String uniqueTmpFldrName = getUniqueNameForRunnerFile();
         ProcStarter matlabLauncher;
         try {
+            FilePath genScriptLocation =
+                    getFilePathForUniqueFolder(launcher, uniqueTmpFldrName, workspace);
+
             matlabLauncher = getProcessToRunMatlabCommand(workspace, launcher, listener, envVars,
-                    constructCommandForTest(getInputArguments()), uniqueTmpFldrName);
+                    constructCommandForTest(genScriptLocation), uniqueTmpFldrName);
 
-            // Copy MATLAB scratch file into the workspace.
-            FilePath targetWorkspace = new FilePath(launcher.getChannel(), workspace.getRemote());
-            copyFileInWorkspace(MatlabBuilderConstants.MATLAB_TESTS_RUNNER_RESOURCE,
-                    MatlabBuilderConstants.MATLAB_TESTS_RUNNER_TARGET_FILE, targetWorkspace);
+            // copy genscript package in temp folder and write a runner script.
+            prepareTmpFldr(genScriptLocation, getRunnerScript(
+                    MatlabBuilderConstants.TEST_RUNNER_SCRIPT, envVars.expand(getInputArguments())));
 
             return matlabLauncher.pwd(workspace).join();
         } catch (Exception e) {
@@ -260,11 +259,11 @@ private synchronized int execMatlabCommand(FilePath workspace, Launcher launcher
             }
         }
     }
-
-    public String constructCommandForTest(String inputArguments) {
-        final String matlabFunctionName =
-                FilenameUtils.removeExtension(MatlabBuilderConstants.MATLAB_TESTS_RUNNER_TARGET_FILE);
-        final String runCommand = "exit(" + matlabFunctionName + "(" + inputArguments + "))";
+    
+    public String constructCommandForTest(FilePath scriptPath) {
+        final String matlabScriptName = getValidMatlabFileName(scriptPath.getBaseName());
+        final String runCommand = "addpath('" + scriptPath.getRemote().replaceAll("'", "''")
+                + "'); " + matlabScriptName;
         return runCommand;
     }
 
@@ -278,12 +277,14 @@ private String getInputArguments() {
                 new ArrayList<Artifact>(Arrays.asList(getPdfReportArtifact(), getTapArtifact(),
                         getJunitArtifact(), getStmResultsArtifact(), getCoberturaArtifact(),
                         getModelCoverageArtifact()));
+        
+        inputArgsList.add("'Test'");
 
         for (Artifact artifact : artifactList) {
             artifact.addFilePathArgTo(args);
         }
 
-        args.forEach((key, val) -> inputArgsList.add("'" + key + "'" + "," + "'" + val + "'"));
+        args.forEach((key, val) -> inputArgsList.add("'" + key + "'" + "," + "'" + val.replaceAll("'", "''") + "'"));
 
         return String.join(",", inputArgsList);
     }
@@ -301,7 +302,7 @@ private String getInputArguments() {
      */
     public static class PdfArtifact extends AbstractArtifactImpl {
 
-        private static final String PDF_REPORT_PATH = "PDFReportPath";
+        private static final String PDF_TEST_REPORT = "PDFTestReport";
 
         @DataBoundConstructor
         public PdfArtifact(String pdfReportFilePath) {
@@ -310,13 +311,13 @@ public PdfArtifact(String pdfReportFilePath) {
 
         @Override
         public void addFilePathArgTo(Map<String, String> inputArgs) {
-            inputArgs.put(PDF_REPORT_PATH, getFilePath());
+            inputArgs.put(PDF_TEST_REPORT, getFilePath());
         }
     }
 
     public static class TapArtifact extends AbstractArtifactImpl {
 
-        private static final String TAP_RESULTS_PATH = "TAPResultsPath";
+        private static final String TAP_TEST_RESULTS = "TAPTestResults";
 
         @DataBoundConstructor
         public TapArtifact(String tapReportFilePath) {
@@ -325,13 +326,13 @@ public TapArtifact(String tapReportFilePath) {
 
         @Override
         public void addFilePathArgTo(Map<String, String> inputArgs) {
-            inputArgs.put(TAP_RESULTS_PATH, getFilePath());
+            inputArgs.put(TAP_TEST_RESULTS, getFilePath());
         }
     }
 
     public static class JunitArtifact extends AbstractArtifactImpl {
 
-        private static final String JUNIT_RESULTS_PATH = "JUnitResultsPath";
+        private static final String JUNIT_TEST_RESULTS = "JUnitTestResults";
 
         @DataBoundConstructor
         public JunitArtifact(String junitReportFilePath) {
@@ -340,13 +341,13 @@ public JunitArtifact(String junitReportFilePath) {
 
         @Override
         public void addFilePathArgTo(Map<String, String> inputArgs) {
-            inputArgs.put(JUNIT_RESULTS_PATH, getFilePath());
+            inputArgs.put(JUNIT_TEST_RESULTS, getFilePath());
         }
     }
 
     public static class CoberturaArtifact extends AbstractArtifactImpl {
 
-        private static final String COBERTURA_CODE_COVERAGE_PATH = "CoberturaCodeCoveragePath";
+        private static final String COBERTURA_CODE_COVERAGE = "CoberturaCodeCoverage";
 
         @DataBoundConstructor
         public CoberturaArtifact(String coberturaReportFilePath) {
@@ -355,13 +356,13 @@ public CoberturaArtifact(String coberturaReportFilePath) {
 
         @Override
         public void addFilePathArgTo(Map<String, String> inputArgs) {
-            inputArgs.put(COBERTURA_CODE_COVERAGE_PATH, getFilePath());
+            inputArgs.put(COBERTURA_CODE_COVERAGE, getFilePath());
         }
     }
 
     public static class StmResultsArtifact extends AbstractArtifactImpl {
 
-        private static final String STM_RESULTS_PATH = "SimulinkTestResultsPath";
+        private static final String STM_RESULTS = "SimulinkTestResults";
 
         @DataBoundConstructor
         public StmResultsArtifact(String stmResultsFilePath) {
@@ -370,13 +371,13 @@ public StmResultsArtifact(String stmResultsFilePath) {
 
         @Override
         public void addFilePathArgTo(Map<String, String> inputArgs) {
-            inputArgs.put(STM_RESULTS_PATH, getFilePath());
+            inputArgs.put(STM_RESULTS, getFilePath());
         }
     }
 
     public static class ModelCovArtifact extends AbstractArtifactImpl {
 
-        private static final String COBERTURA_MODEL_COVERAGE_PATH = "CoberturaModelCoveragePath";
+        private static final String COBERTURA_MODEL_COVERAGE = "CoberturaModelCoverage";
 
         @DataBoundConstructor
         public ModelCovArtifact(String modelCoverageFilePath) {
@@ -385,7 +386,7 @@ public ModelCovArtifact(String modelCoverageFilePath) {
 
         @Override
         public void addFilePathArgTo(Map<String, String> inputArgs) {
-            inputArgs.put(COBERTURA_MODEL_COVERAGE_PATH, getFilePath());
+            inputArgs.put(COBERTURA_MODEL_COVERAGE, getFilePath());
         }
     }