Added PDF report option

Author: hkhan17

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

@@ -345,6 +345,7 @@ public static class RunTestsAutomaticallyOption extends TestRunTypeList {
         private boolean taCoberturaChkBx;
         private boolean taSTMResultsChkBx;
         private boolean taModelCoverageChkBx;
+        private boolean taPDFReportChkBx;
 
         @DataBoundConstructor
         public RunTestsAutomaticallyOption() {
@@ -376,6 +377,11 @@ public void setTaModelCoverageChkBx(boolean taModelCoverageChkBx) {
             this.taModelCoverageChkBx = taModelCoverageChkBx;
         }
 
+        @DataBoundSetter
+        public void setTaPDFReportChkBx(boolean taPDFReportChkBx) {
+            this.taPDFReportChkBx = taPDFReportChkBx;
+        }
+                
         public boolean getTatapChkBx() {
             return tatapChkBx;
         }
@@ -396,6 +402,10 @@ public boolean getTaModelCoverageChkBx() {
             return taModelCoverageChkBx;
         }
 
+        public boolean getTaPDFReportChkBx() {
+            return taPDFReportChkBx;
+        }
+                
         @Extension
         public static final class DescriptorImpl extends TestRunTypeDescriptor {
             @Override
@@ -417,6 +427,8 @@ public boolean getBooleanByName(String memberName) {
                     return this.getTaSTMResultsChkBx();
                 case "taModelCoverageChkBx":
                     return this.getTaModelCoverageChkBx();
+                case "taPDFReportChkBx":
+                    return this.getTaPDFReportChkBx();
                 default:
                     return false;
             }
@@ -605,13 +617,14 @@ private String getNodeSpecificFileSeperator(Launcher launcher) {
 
     // Concatenate the input arguments
     private String getInputArguments() {
+        String pdfReport = MatlabBuilderConstants.PDF_REPORT + "," + getTestRunTypeList().getBooleanByName("taPDFReportChkBx");
     	String tapResults = MatlabBuilderConstants.TAP_RESULTS + "," + getTestRunTypeList().getBooleanByName("tatapChkBx");
     	String junitResults = MatlabBuilderConstants.JUNIT_RESULTS + "," + getTestRunTypeList().getBooleanByName("taJunitChkBx");
     	String stmResults = MatlabBuilderConstants.STM_RESULTS + "," + getTestRunTypeList().getBooleanByName("taSTMResultsChkBx");
     	String coberturaCodeCoverage = MatlabBuilderConstants.COBERTURA_CODE_COVERAGE + "," + getTestRunTypeList().getBooleanByName("taCoberturaChkBx");
     	String coberturaModelCoverage = MatlabBuilderConstants.COBERTURA_MODEL_COVERAGE + "," + getTestRunTypeList().getBooleanByName("taModelCoverageChkBx");
 
-    	String inputArgsToMatlabFcn = tapResults + "," + junitResults + ","
+    	String inputArgsToMatlabFcn = pdfReport + "," + tapResults + "," + junitResults + ","
     			+ stmResults + "," + coberturaCodeCoverage + "," + coberturaModelCoverage;
 
         return inputArgsToMatlabFcn;

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

@@ -15,6 +15,7 @@ public class MatlabBuilderConstants {
     static final String AUTOMATIC_OPTION = "RunTestsAutomaticallyOption";
 
     // Input parameter names (Passed to runMatlabTests.m as name-value pair arguments)
+    static final String PDF_REPORT = "'PDFReport'";
     static final String TAP_RESULTS = "'TAPResults'";
     static final String JUNIT_RESULTS = "'JUnitResults'";
     static final String STM_RESULTS = "'SimulinkTestResults'";

src/main/resources/com/mathworks/ci/MatlabBuilder/RunTestsAutomaticallyOption/config.jelly

@@ -2,6 +2,10 @@
 <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:section title="Generate Test Artifacts">
+  	 <f:entry field="taPDFReportChkBx">	
+    	<f:checkbox title="PDF test report " name="taPDFReportChkBx" checked="${instance.taPDFReportChkBx}"/>	
+     </f:entry>
+
 	 <f:entry field="tatapChkBx">
     	<f:checkbox title="TAP test results" name="tatapChkBx" checked="${instance.tatapChkBx}"/>
      </f:entry>

src/main/resources/com/mathworks/ci/MatlabBuilder/RunTestsAutomaticallyOption/help-taPDFReportChkBx.html

@@ -1,10 +1,10 @@
 <div>
 <br>
 Generate a test report in PDF format, <b>testreport.pdf</b>, and save it in the <b>matlabTestArtifacts</b> folder of the Jenkins workspace.
-<br>
-<br>
-Note: Due to Jenkins Content Security Policy rules, the generated report might not open properly from within the Jenkins workspace. 
+<br><br>
+Due to Jenkins Content Security Policy rules, the generated report might not open properly from within the Jenkins workspace. 
 Consider copying the report to a location outside the workspace and opening it from there. For more information, 
 see <a href="http://wiki.jenkins.io/display/JENKINS/Configuring+Content+Security+Policy">Configuring Jenkins Content Security Policy</a>.
-<br>    
+<br><br>
+<i><b>*This feature is not supported on Mac OS platform.</b></i>
 </div>

src/main/resources/com/mathworks/ci/MatlabBuilder/runMatlabTests.m

@@ -73,7 +73,7 @@
     BASE_VERSION_COBERTURA_SUPPORT = '9.3';
 
     if verLessThan('matlab',BASE_VERSION_COBERTURA_SUPPORT)
-         warning('MATLAB:testArtifact:coberturaReportNotSupported', 'Producing Cobertura results is not supported in this release.');
+         warning('MATLAB:testArtifact:coberturaReportNotSupported', 'Producing Cobertura code coverage results is not supported in this release.');
     else 
         import('matlab.unittest.plugins.CodeCoveragePlugin');
         mkdirIfNeeded(resultsDir)
@@ -111,9 +111,12 @@
     end
 end
 
-% Produce PDF test report (Not supported below R2016b)
+% Produce PDF test report (Not supported on MAC platform and below R2017a)
 if producePDFReport
-    if ~testReportPluginPresent
+    if ismac
+        warning('MATLAB:testArtifact:unSupportedPlatform', ...
+            'Producing a PDF test report is not supported on Mac OS platform.');
+    elseif ~testReportPluginPresent
         issuePDFReportUnsupportedWarning;
     else
         mkdirIfNeeded(resultsDir);
@@ -129,6 +132,7 @@
 results = runner.run(suite);
 failed = any([results.Failed]);
 
+
 function tapToFile = getTapResultFile(resultsDir)
 import('matlab.unittest.plugins.ToFile');
 mkdirIfNeeded(resultsDir)
@@ -164,7 +168,7 @@ function mkdirIfNeeded(dir)
 filePath = fullfile(resultsDir, 'simulinktestresults.mldatx');
 
 function tf = testReportPluginPresent
-BASE_VERSION_REPORTPLUGIN_SUPPORT = '9.1'; % R2016b
+BASE_VERSION_REPORTPLUGIN_SUPPORT = '9.2'; % R2017a 
 
 tf = ~verLessThan('matlab',BASE_VERSION_REPORTPLUGIN_SUPPORT);
 

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

@@ -300,7 +300,7 @@ public void verifyRunTestAutomaticallyIsDefault() throws Exception {
         this.matlabBuilder.setMatlabRoot(getMatlabroot("R2018b"));
         FreeStyleBuild build = getBuildforRunTestAutomatically();
         jenkins.assertLogContains("-batch", build);
-        jenkins.assertLogContains("\'TAPResults\',true," +
+        jenkins.assertLogContains("\'PDFReport\',true,\'TAPResults\',true," +
                                   "\'JUnitResults\',true,\'SimulinkTestResults\',true," +
                                   "\'CoberturaCodeCoverage\',true,\'CoberturaModelCoverage\',true", build);
     }
@@ -548,6 +548,7 @@ private FreeStyleBuild getBuildforRunTestAutomatically() throws InterruptedExcep
         runOption.setTatapChkBx(true);
         runOption.setTaModelCoverageChkBx(true);
         runOption.setTaSTMResultsChkBx(true);
+        runOption.setTaPDFReportChkBx(true);
         this.matlabBuilder.setTestRunTypeList(runOption);
         project.getBuildersList().add(this.matlabBuilder);
         FreeStyleBuild build = project.scheduleBuild2(0).get();