Merge pull request #203 from mathworks/github_issue_202

Fixed github isuue 202

Author: nbhoski

azure-pipelines.yml

@@ -6,7 +6,7 @@
 strategy:
   matrix:
     linux:
-      imageName: 'ubuntu-16.04'
+      imageName: 'ubuntu-18.04'
     mac:
       imageName: 'macOS-10.15'
     windows:

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

@@ -99,8 +99,9 @@ default void prepareTmpFldr(FilePath tmpFldr, String runnerScript) throws IOExce
         zipFileLocation.unzip(tmpFldr);
     }
 
-    default String getRunnerScript(String script, String params) {
+    default String getRunnerScript(String script, String params, String uniqueTmpFldrName) {
         script = script.replace("${PARAMS}", params);
+        script = script.replaceAll("\\$\\{TMPDIR\\}", uniqueTmpFldrName);
         return script;
     }
 

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

@@ -40,6 +40,11 @@ public class MatlabBuilderConstants {
     // 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" + "";
+            + "disp(strtrim(testScript.Contents));\n"
+            + "runnerFile = testScript.writeToFile(fullfile(tempname,'runnerScript.m'));\n"
+            + "[tmpDir,scriptName,ext] = fileparts(runnerFile);"
+            + "addpath(tmpDir);\n"
+            + "rmdir('.matlab/${TMPDIR}/+scriptgen', 's');\n"
+            + "delete('.matlab/${TMPDIR}/genscript.m');\n"
+            + "fprintf('___________________________________\\n\\n');\n";
 }

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

@@ -60,26 +60,30 @@ public void stop(Throwable cause) throws Exception {
 
     private int execMatlabCommand(FilePath workspace, Launcher launcher,
             TaskListener listener, EnvVars envVars) throws IOException, InterruptedException {
-        final String uniqueTmpFldrName = getUniqueNameForRunnerFile();  
+        final String uniqueMatlabResourceFldr = getUniqueNameForRunnerFile();  
         try {
             FilePath genScriptLocation =
-                    getFilePathForUniqueFolder(launcher, uniqueTmpFldrName, workspace);
+                    getFilePathForUniqueFolder(launcher, uniqueMatlabResourceFldr, workspace);
             final String cmdPrefix =
                     "addpath('" + genScriptLocation.getRemote().replaceAll("'", "''") + "'); ";
             final String matlabScriptName = getValidMatlabFileName(genScriptLocation.getBaseName());
 
-            ProcStarter matlabLauncher = getProcessToRunMatlabCommand(workspace, launcher, listener,
-                    envVars, cmdPrefix + matlabScriptName, uniqueTmpFldrName);
+            ProcStarter matlabLauncher =
+                    getProcessToRunMatlabCommand(workspace, launcher, listener, envVars,
+                            cmdPrefix + matlabScriptName + ",delete('.matlab/"
+                                    + genScriptLocation.getBaseName() + "/" + matlabScriptName
+                                    + ".m'),runnerScript,rmdir(tmpDir,'s')",
+                            uniqueMatlabResourceFldr);
 
             // prepare temp folder by coping genscript package and writing runner script.
             prepareTmpFldr(genScriptLocation,
-                    getRunnerScript(MatlabBuilderConstants.TEST_RUNNER_SCRIPT, envVars.expand(getCommandArgs())));
+                    getRunnerScript(MatlabBuilderConstants.TEST_RUNNER_SCRIPT, envVars.expand(getCommandArgs()),uniqueMatlabResourceFldr));
 
             return matlabLauncher.pwd(workspace).join();
         } finally {
             // Cleanup the runner File from tmp directory
             final FilePath matlabRunnerScript =
-                    getFilePathForUniqueFolder(launcher, uniqueTmpFldrName, workspace);
+                    getFilePathForUniqueFolder(launcher, uniqueMatlabResourceFldr, workspace);
             if (matlabRunnerScript.exists()) {
                 matlabRunnerScript.deleteRecursive();
             }

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

@@ -282,7 +282,7 @@ private int execMatlabCommand(FilePath workspace, Launcher launcher,
 
             // copy genscript package in temp folder and write a runner script.
             prepareTmpFldr(genScriptLocation, getRunnerScript(
-                    MatlabBuilderConstants.TEST_RUNNER_SCRIPT, envVars.expand(getInputArguments())));
+                    MatlabBuilderConstants.TEST_RUNNER_SCRIPT, envVars.expand(getInputArguments()),uniqueTmpFldrName));
 
             return matlabLauncher.pwd(workspace).join();
         } catch (Exception e) {
@@ -301,7 +301,8 @@ private int execMatlabCommand(FilePath workspace, Launcher launcher,
     public String constructCommandForTest(FilePath scriptPath) {
         final String matlabScriptName = getValidMatlabFileName(scriptPath.getBaseName());
         final String runCommand = "addpath('" + scriptPath.getRemote().replaceAll("'", "''")
-                + "'); " + matlabScriptName;
+                + "'); " + matlabScriptName + ",delete('.matlab/" + scriptPath.getBaseName() + "/"
+                + matlabScriptName + ".m'),runnerScript,rmdir(tmpDir,'s')";
         return runCommand;
     }
 

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

@@ -484,7 +484,7 @@ public void verifyMATLABscratchFileGenerated() throws Exception {
         project.getBuildWrappersList().add(this.buildWrapper);
         project.getBuildersList().add(testBuilder);
         FreeStyleBuild build = project.scheduleBuild2(0).get();
-        File matlabRunner = new File(build.getWorkspace() + File.separator + "runMatlabTests.m");
+        File matlabRunner = new File(build.getWorkspace() + File.separator + "runnerScript.m");
         Assert.assertFalse(matlabRunner.exists());
     }
 
@@ -500,4 +500,28 @@ public void verifyMATLABfolderGenerated() throws Exception {
         File matlabRunner = new File(build.getWorkspace() + File.separator + ".matlab");
         Assert.assertTrue(matlabRunner.exists());
     }
+    
+    /*
+     * Test to verify if runner script is deleted from .matlab folder during MATLAB call 
+     */
+    @Test
+    public void verifyRunnerScriptDeleted() throws Exception {
+        this.buildWrapper.setMatlabBuildWrapperContent(new MatlabBuildWrapperContent(Message.getValue("matlab.custom.location"), getMatlabroot("R2018b")));
+        project.getBuildWrappersList().add(this.buildWrapper);
+        project.getBuildersList().add(testBuilder);
+        FreeStyleBuild build = project.scheduleBuild2(0).get();
+        jenkins.assertLogContains("delete('.matlab/", build);
+    }
+    
+    /*
+     * Test to verify if runner script is deleted from system temp directory during MATLAB call 
+     */
+    @Test
+    public void verifySystemTempDirDeleted() throws Exception {
+        this.buildWrapper.setMatlabBuildWrapperContent(new MatlabBuildWrapperContent(Message.getValue("matlab.custom.location"), getMatlabroot("R2018b")));
+        project.getBuildWrappersList().add(this.buildWrapper);
+        project.getBuildersList().add(testBuilder);
+        FreeStyleBuild build = project.scheduleBuild2(0).get();
+        jenkins.assertLogContains("rmdir(tmpDir,'s')", build);
+    }
 }

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

@@ -163,6 +163,30 @@ public void verifyTestSelectByFolder () throws Exception {
         j.assertBuildStatusSuccess(build);
     }
 
+    /*
+     * Verify runner script deleted from .matlab folder during MATLAB call
+     */
+
+    @Test
+    public void verifyRunnerScriptDeletedFromWorkSpace() throws Exception {
+        project.setDefinition(new CpsFlowDefinition(
+                "node {runMATLABTests(testResultsPDF:'myresult/result.pdf')}", true));
+        WorkflowRun build = project.scheduleBuild2(0).get();
+        j.assertLogContains("delete('.matlab/", build);
+    }
+    
+    /*
+     * Verify runner script deleted from system Tmp directory during MATLAB call
+     */
+
+    @Test
+    public void verifySystemTmpDirDeleted() throws Exception {
+        project.setDefinition(new CpsFlowDefinition(
+                "node {runMATLABTests(testResultsPDF:'myresult/result.pdf')}", true));
+        WorkflowRun build = project.scheduleBuild2(0).get();
+        j.assertLogContains("rmdir(tmpDir,'s')", build);
+    }
+    
     /*@Integ Test
      * Verify default command options for test Filter using selectByTag option 
      */