Merge pull request #34 from mathworks/gecko-280753_copy_for_custom_option

Scratch file copy operation restricted to Automatic mode only.

Author: nbhoski

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

@@ -59,6 +59,7 @@ public class MatlabBuilder extends Builder implements SimpleBuildStep {
             "Builder.matlab.runner.target.file.name";
     private static final String MATLAB_RUNNER_RESOURCE =
             "com/mathworks/ci/MatlabBuilder/runMatlabTests.m";
+    private static final String AUTOMATIC_OPTION = "RunTestsAutomaticallyOption";
 
 
     @DataBoundConstructor
@@ -408,9 +409,13 @@ private synchronized int execMatlabCommand(Run<?, ?> build, FilePath workspace,
             TaskListener listener, boolean isLinuxLauncher)
             throws IOException, InterruptedException {
         setEnv(build.getEnvironment(listener));
-        //Copy MATLAB scratch file into the workspace
-        copyMatlabScratchFileInWorkspace(MATLAB_RUNNER_RESOURCE, MATLAB_RUNNER_TARGET_FILE,
-                workspace, getClass().getClassLoader());
+        final String testRunMode = this.getTestRunTypeList().getDescriptor().getId();
+        
+        // Copy MATLAB scratch file into the workspace only if Automatic option is selected.
+        if (testRunMode.contains(AUTOMATIC_OPTION)) {
+            copyMatlabScratchFileInWorkspace(MATLAB_RUNNER_RESOURCE, MATLAB_RUNNER_TARGET_FILE,
+                    workspace, getClass().getClassLoader());
+        }
         ProcStarter matlabLauncher;
         try {
             MatlabReleaseInfo rel = new MatlabReleaseInfo(getLocalMatlab());
@@ -429,11 +434,10 @@ private synchronized int execMatlabCommand(Run<?, ?> build, FilePath workspace,
     }
 
     public List<String> constructMatlabCommandWithBatch() {
-        final String testRunMode = this.getTestRunTypeList().getDescriptor().getDisplayName();
+        final String testRunMode = this.getTestRunTypeList().getDescriptor().getId();
         final String runCommand;
         final List<String> matlabDefaultArgs;
-        if (!testRunMode.equalsIgnoreCase(
-                Message.getValue("builder.matlab.customcommandoption.display.name"))) {
+        if (testRunMode.contains(AUTOMATIC_OPTION)) {
             String matlabFunctionName =
                     FilenameUtils.removeExtension(Message.getValue(MATLAB_RUNNER_TARGET_FILE));
             runCommand = "exit(" + matlabFunctionName + "("
@@ -481,9 +485,8 @@ private String[] getPostRunnerSwitches() {
 
     private String[] getRunnerSwitch() {
         final String runCommand;
-        final String testRunMode = this.getTestRunTypeList().getDescriptor().getDisplayName();
-        if (!testRunMode.equalsIgnoreCase(
-                Message.getValue("builder.matlab.customcommandoption.display.name"))) {
+        final String testRunMode = this.getTestRunTypeList().getDescriptor().getId();
+        if (testRunMode.contains(AUTOMATIC_OPTION)) {
             String matlabFunctionName =
                     FilenameUtils.removeExtension(Message.getValue(MATLAB_RUNNER_TARGET_FILE));
             runCommand = "try,exit(" + matlabFunctionName + "("

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

@@ -187,9 +187,8 @@ public void verifyBuilderFailsForInvalidMATLABPath() throws Exception {
     public void verifyBuildFailureWhenMatlabException() throws Exception {
         MatlabBuilderTester tester = new MatlabBuilderTester(getMatlabroot("R2018b"),
                 matlabExecutorAbsolutePath, "-positiveFail");
-        // tester.setFailBuildIfTestFailureCheckBox(false);
+        tester.setTestRunTypeList(new RunTestsAutomaticallyOption());
         project.getBuildersList().add(tester);
-
         FreeStyleBuild build = project.scheduleBuild2(0).get();
         jenkins.assertBuildStatus(Result.FAILURE, build);
     }
@@ -202,6 +201,7 @@ public void verifyBuildFailureWhenMatlabException() throws Exception {
     public void verifyMatlabInvokedWithValidExecutable() throws Exception {
         MatlabBuilderTester tester = new MatlabBuilderTester(getMatlabroot("R2018b"),
                 matlabExecutorAbsolutePath, "-positive");
+        tester.setTestRunTypeList(new RunTestsAutomaticallyOption());
         project.getBuildersList().add(tester);
         FreeStyleBuild build = project.scheduleBuild2(0).get();
         jenkins.assertBuildStatus(Result.SUCCESS, build);
@@ -218,7 +218,7 @@ public void verifyMatlabPointsToValidExecutable() throws Exception {
         MatlabBuilderTester tester = new MatlabBuilderTester(getMatlabroot("R2018b"),
                 matlabExecutorAbsolutePath, "-positive");
         project.getBuildersList().add(tester);
-
+        tester.setTestRunTypeList(new RunTestsAutomaticallyOption());
         FreeStyleBuild build = project.scheduleBuild2(0).get();
         jenkins.assertBuildStatus(Result.SUCCESS, build);
         jenkins.assertLogContains(matlabExecutorAbsolutePath, build);
@@ -301,6 +301,32 @@ public void verifyRunTestAutomaticallyIsDefault() throws Exception {
         jenkins.assertLogContains("true,true,true", build);
     }
 
+    /*
+     * Test to verify if MATALB scratch file is generated in workspace for Automatic option.
+     */
+    @Test
+    public void verifyMATLABscratchFileGeneratedForAutomaticOption() throws Exception {
+        this.matlabBuilder.setMatlabRoot(getMatlabroot("R2018b"));
+        this.matlabBuilder.setTestRunTypeList(new RunTestsAutomaticallyOption());
+        project.getBuildersList().add(this.matlabBuilder);
+        FreeStyleBuild build = project.scheduleBuild2(0).get();
+        File matlabRunner = new File(build.getWorkspace() + File.separator + "runMatlabTests.m");
+        Assert.assertTrue(matlabRunner.exists());
+    }
+    
+    /*
+     * Test to verify if MATALB scratch file is not generated in workspace for Custom option.
+     */
+    @Test
+    public void verifyMATLABscratchFileGeneratedForCustomOption() throws Exception {
+        this.matlabBuilder.setMatlabRoot(getMatlabroot("R2018b"));
+        this.matlabBuilder.setTestRunTypeList(new RunTestsWithCustomCommandOption());
+        project.getBuildersList().add(this.matlabBuilder);
+        FreeStyleBuild build = project.scheduleBuild2(0).get();
+        File matlabRunner = new File(build.getWorkspace() + File.separator + "runMatlabTests.m");
+        Assert.assertFalse(matlabRunner.exists());
+    }
+    
     /*
      * Test to verify default value of getStringByName() when Automatic test mode. 
      */