Add Code Coverage, Model Coverage and Test results report for HTML

build-test-publish.pipeline.yml

@@ -1,4 +1,4 @@
-name: 1.13$(Rev:.r)
+name: 1.14$(Rev:.r)
 
 trigger:
   - master

integ-test-promote-template.yml

@@ -209,7 +209,9 @@ jobs:
           displayName: Run MATLAB tests producing artifacts
           inputs:
             testResultsJUnit: test-results/matlab/results.xml
+            testResultsHTML:  test-results/matlab/resultsHTML
             codeCoverageCobertura: code-coverage/coverage.xml
+            codeCoverageHTML: code-coverage/coverageHTML
             sourceFolder: src
         - task: MathWorks.matlab-azure-devops-extension-dev.RunMATLABTests.RunMATLABTests@${{ version }}
           displayName: Run MATLAB tests filter by folder
@@ -225,10 +227,22 @@ jobs:
             set -e
             grep -q FirstTest test-results/matlab/results.xml
           displayName: Verify test results file was created
+        - bash: |
+            set -e
+            test -d test-results/matlab/resultsHTML
+            test -f test-results/matlab/resultsHTML/*.html
+          displayName: Verify HTML test results folder and HTML file was created
+          condition: not(eq(${{ version }}, '0'))
         - bash: |
             set -e
             grep -q add code-coverage/coverage.xml
           displayName: Verify code coverage file was created
+        - bash: |
+            set -e
+            test -d code-coverage/coverageHTML
+            test -f code-coverage/coverageHTML/*.html
+          displayName: Verify HTML code coverage folder and HTML file was created
+          condition: not(eq(${{ version }}, '0'))
         - bash: |
             set -e
             grep -q simpleTest test-results/matlab/selectbyfolder.xml
@@ -273,7 +287,7 @@ jobs:
             sourceFolder: src
         - bash: |
             set -e
-            grep -q "TestRunner.withTextOutput('OutputDetail', 3)" console.log
+            grep -q "('OutputDetail', 3)" console.log
             rm console.log
           displayName: Verify tests ran with detailed display level for event details
         - task: MathWorks.matlab-azure-devops-extension-dev.RunMATLABTests.RunMATLABTests@${{ version }}
@@ -283,7 +297,7 @@ jobs:
             sourceFolder: src
         - bash: |
             set -e
-            grep -q "TestRunner.withTextOutput('LoggingLevel', 3)" console.log
+            grep -q "('LoggingLevel', 3)" console.log
             rm console.log
           displayName: Verify tests ran with detailed verbosity level for logged diagnostics
         - bash: |
@@ -346,6 +360,7 @@ jobs:
           inputs:
             selectByFolder: "simtests"
             modelCoverageCobertura: test-results/matlab/modelcoverage.xml
+            modelCoverageHTML: test-results/matlab/modelcoverageHTML
             testResultsSimulinkTest: test-results/matlab/stmResult.mldatx
             testResultsPDF: test-results/matlab/results.pdf
           condition: eq(variables['Agent.OS'], 'Linux')
@@ -354,6 +369,12 @@ jobs:
             grep -q new_temp_model test-results/matlab/modelcoverage.xml
           displayName: Verify Model coverage was created
           condition: eq(variables['Agent.OS'], 'Linux')
+        - bash: |
+            set -e
+            test -d test-results/matlab/modelcoverageHTML
+            test -f test-results/matlab/modelcoverageHTML/*.html
+          displayName: Verify HTML Model coverage folder and HTML file was created
+          condition: not(eq(${{ version }}, '0'))
         - bash: |
             set -e
             test -f test-results/matlab/stmResult.mldatx
@@ -364,7 +385,6 @@ jobs:
             test -f test-results/matlab/results.pdf
           displayName: Verify PDF report was created
           condition: eq(variables['Agent.OS'], 'Linux')
-
     - job: test_run_build_v${{ version }}
       strategy:
         matrix:

tasks/run-matlab-tests/v1/main.ts

@@ -11,12 +11,15 @@ async function run() {
         const options: scriptgen.IRunTestsOptions = {
             JUnitTestResults: taskLib.getInput("testResultsJUnit"),
             CoberturaCodeCoverage: taskLib.getInput("codeCoverageCobertura"),
+            HTMLCodeCoverage: taskLib.getInput("codeCoverageHTML"),
             SourceFolder: taskLib.getInput("sourceFolder"),
             SelectByFolder: taskLib.getInput("selectByFolder"),
             SelectByTag: taskLib.getInput("selectByTag"),
             CoberturaModelCoverage: taskLib.getInput("modelCoverageCobertura"),
+            HTMLModelCoverage: taskLib.getInput("modelCoverageHTML"),
             SimulinkTestResults: taskLib.getInput("testResultsSimulinkTest"),
             PDFTestReport: taskLib.getInput("testResultsPDF"),
+            HTMLTestReport: taskLib.getInput("testResultsHTML"),
             Strict: taskLib.getBoolInput("strict"),
             UseParallel: taskLib.getBoolInput("useParallel"),
             OutputDetail: taskLib.getInput("outputDetail"),

tasks/run-matlab-tests/v1/scriptgen.ts

@@ -5,10 +5,13 @@ import * as path from "path";
 export interface IRunTestsOptions {
     JUnitTestResults?: string;
     CoberturaCodeCoverage?: string;
+    HTMLCodeCoverage?: string;
     SourceFolder?: string;
     PDFTestReport?: string;
+    HTMLTestReport?: string;
     SimulinkTestResults?: string;
     CoberturaModelCoverage?: string;
+    HTMLModelCoverage?: string;
     SelectByTag?: string;
     SelectByFolder?: string;
     Strict?: boolean;
@@ -22,10 +25,13 @@ export function generateCommand(options: IRunTestsOptions): string {
         `testScript = genscript('Test',` +
             `'JUnitTestResults','${options.JUnitTestResults || ""}',` +
             `'CoberturaCodeCoverage','${options.CoberturaCodeCoverage || ""}',` +
+            `'HTMLCodeCoverage','${options.HTMLCodeCoverage || ""}',` +
             `'SourceFolder','${options.SourceFolder || ""}',` +
             `'PDFTestReport','${options.PDFTestReport || ""}',` +
+            `'HTMLTestReport','${options.HTMLTestReport || ""}',` +
             `'SimulinkTestResults','${options.SimulinkTestResults || ""}',` +
             `'CoberturaModelCoverage','${options.CoberturaModelCoverage || ""}',` +
+            `'HTMLModelCoverage','${options.HTMLModelCoverage || ""}',` +
             `'SelectByTag','${options.SelectByTag || ""}',` +
             `'SelectByFolder','${options.SelectByFolder || ""}',` +
             `'Strict',${options.Strict || false},` +

tasks/run-matlab-tests/v1/task.json

@@ -102,6 +102,15 @@
             "required": false,
             "helpMarkDown": "Path to write the test results in PDF format (requires MATLAB R2020b or later on macOS platforms)."
         },
+        {
+            "name": "testResultsHTML",
+            "type": "string",
+            "label": "HTML test report ",
+            "defaultValue": "",
+            "groupName": "testArtifacts",
+            "required": false,
+            "helpMarkDown": "Path to write the test results in HTML format."
+        },
         {
             "name": "testResultsJUnit",
             "type": "string",
@@ -129,6 +138,15 @@
             "groupName": "coverageArtifacts",
             "helpMarkDown": "Path to write the code coverage results in Cobertura XML format."
         },
+        {
+            "name": "codeCoverageHTML",
+            "type": "string",
+            "label": "HTML code coverage",
+            "defaultValue": "",
+            "required": false,
+            "groupName": "coverageArtifacts",
+            "helpMarkDown": "Path to write the code coverage results in HTML format."
+        },
         {
             "name": "modelCoverageCobertura",
             "type": "string",
@@ -138,6 +156,15 @@
             "required": false,
             "helpMarkDown": "Path to write the model coverage report in Cobertura XML format (requires Simulink Coverage and is supported in MATLAB R2018b or later)."
         },
+        {
+            "name": "modelCoverageHTML",
+            "type": "string",
+            "label": "HTML model coverage",
+            "defaultValue": "",
+            "groupName": "coverageArtifacts",
+            "required": false,
+            "helpMarkDown": "Path to write the model coverage report in HTML format (requires Simulink Coverage and is supported in MATLAB R2018b or later)."
+        },
         {
             "name": "startupOptions",
             "type": "string",

tasks/run-matlab-tests/v1/test/scriptgen.test.ts

@@ -9,10 +9,13 @@ export default function suite() {
             const options: scriptgen.IRunTestsOptions = {
                 JUnitTestResults: "",
                 CoberturaCodeCoverage: "",
+                HTMLCodeCoverage: "",
                 SourceFolder: "",
                 PDFTestReport: "",
+                HTMLTestReport: "",
                 SimulinkTestResults: "",
                 CoberturaModelCoverage: "",
+                HTMLModelCoverage: "",
                 SelectByTag: "",
                 SelectByFolder: "",
                 Strict: false,
@@ -26,20 +29,23 @@ export default function suite() {
             assert(actual.includes("genscript('Test'"));
             assert(actual.includes("'JUnitTestResults',''"));
             assert(actual.includes("'CoberturaCodeCoverage',''"));
+            assert(actual.includes("'HTMLCodeCoverage',''"));
             assert(actual.includes("'SourceFolder',''"));
             assert(actual.includes("'PDFTestReport',''"));
+            assert(actual.includes("'HTMLTestReport',''"));
             assert(actual.includes("'SimulinkTestResults',''"));
             assert(actual.includes("'CoberturaModelCoverage',''"));
+            assert(actual.includes("'HTMLModelCoverage',''"));
             assert(actual.includes("'SelectByTag',''"));
             assert(actual.includes("'SelectByFolder',''"));
             assert(actual.includes("'Strict',false"));
             assert(actual.includes("'UseParallel',false"));
             assert(actual.includes("'OutputDetail',''"));
             assert(actual.includes("'LoggingLevel',''"));
 
-            const expected = `genscript('Test', 'JUnitTestResults','', 'CoberturaCodeCoverage','',
-                'SourceFolder','', 'PDFTestReport','', 'SimulinkTestResults','',
-                'CoberturaModelCoverage','', 'SelectByTag','', 'SelectByFolder','',
+            const expected = `genscript('Test', 'JUnitTestResults','', 'CoberturaCodeCoverage','','HTMLCodeCoverage','',
+                'SourceFolder','', 'PDFTestReport','', 'HTMLTestReport','', 'SimulinkTestResults','',
+                'CoberturaModelCoverage','', 'HTMLModelCoverage','', 'SelectByTag','', 'SelectByFolder','',
                 'Strict',false, 'UseParallel',false, 'OutputDetail','', 'LoggingLevel','')`
                 .replace(/\s+/g, "");
             assert(actual.replace(/\s+/g, "").includes(expected));
@@ -49,10 +55,13 @@ export default function suite() {
             const options: scriptgen.IRunTestsOptions = {
                 JUnitTestResults: "test-results/results.xml",
                 CoberturaCodeCoverage: "code-coverage/coverage.xml",
+                HTMLCodeCoverage: "code-coverage/coverage.html",
                 SourceFolder: "source",
                 PDFTestReport: "test-results/pdf-results.pdf",
+                HTMLTestReport: "test-results/html-results.html",
                 SimulinkTestResults: "test-results/simulinkTest.mldatx",
                 CoberturaModelCoverage: "test-results/modelcoverage.xml",
+                HTMLModelCoverage: "test-results/modelcoverage.html",
                 SelectByTag: "FeatureA",
                 SelectByFolder: "test/tools;test/toolbox",
                 Strict: true,
@@ -66,10 +75,13 @@ export default function suite() {
             assert(actual.includes("genscript('Test'"));
             assert(actual.includes("'JUnitTestResults','test-results/results.xml'"));
             assert(actual.includes("'CoberturaCodeCoverage','code-coverage/coverage.xml'"));
+            assert(actual.includes("'HTMLCodeCoverage','code-coverage/coverage.html'"));
             assert(actual.includes("'SourceFolder','source'"));
             assert(actual.includes("'PDFTestReport','test-results/pdf-results.pdf'"));
+            assert(actual.includes("'HTMLTestReport','test-results/html-results.html'"));
             assert(actual.includes("'SimulinkTestResults','test-results/simulinkTest.mldatx'"));
             assert(actual.includes("'CoberturaModelCoverage','test-results/modelcoverage.xml'"));
+            assert(actual.includes("'HTMLModelCoverage','test-results/modelcoverage.html'"));
             assert(actual.includes("'SelectByTag','FeatureA'"));
             assert(actual.includes("'SelectByFolder','test/tools;test/toolbox'"));
             assert(actual.includes("'Strict',true"));
@@ -78,9 +90,9 @@ export default function suite() {
             assert(actual.includes("'LoggingLevel','Detailed'"));
 
             const expected = `genscript('Test', 'JUnitTestResults','test-results/results.xml',
-                'CoberturaCodeCoverage','code-coverage/coverage.xml', 'SourceFolder','source',
-                'PDFTestReport','test-results/pdf-results.pdf', 'SimulinkTestResults','test-results/simulinkTest.mldatx',
-                'CoberturaModelCoverage','test-results/modelcoverage.xml', 'SelectByTag','FeatureA',
+                'CoberturaCodeCoverage','code-coverage/coverage.xml','HTMLCodeCoverage','code-coverage/coverage.html', 'SourceFolder','source',
+                'PDFTestReport','test-results/pdf-results.pdf', 'HTMLTestReport','test-results/html-results.html', 'SimulinkTestResults','test-results/simulinkTest.mldatx',
+                'CoberturaModelCoverage','test-results/modelcoverage.xml', 'HTMLModelCoverage','test-results/modelcoverage.html', 'SelectByTag','FeatureA',
                 'SelectByFolder','test/tools;test/toolbox', 'Strict',true, 'UseParallel',true, 'OutputDetail','Detailed',
                 'LoggingLevel','Detailed' )`
                 .replace(/\s+/g, "");