Add Code Coverage, Model Coverage and Test results report for HTML (#149)

mw-kapilg · taguptamw · web-flow · commit 1aead4dbbc63 · 2025-10-23T00:36:51.000+05:30
* build

* remove comment

* html code coverage

* html model coverage and html test report

* update task.json

* test code coverage html in template.yml

* test commit

* add folder for code cov html

* fix cod cov html

* fix code coverage html

* update code coverage html

* comment added

* remove comment

* test results html

* skip version 0

* fix test results html

* remove TestRunner.withTextOutput

* model coverage HTML

* add condition in model coverage HTML

* upload artifacts

* verify html file creation and remove upload artifact

* remove file verification in model coverage and upload artifacts

* fix upload results

* fix artifacts

* artifacts

* model coverage html verification

* final fix model coverage

* remove model coverage file verification

* ls the files

* add model cov verif

* remove ls

* refactoring

* change report to results

* fix namings

* remove tab space

* Fix path namings

* add File path

* Add table entries for HTML test and coverage artifacts

* Remove extra trademark symbol

---------

Co-authored-by: tagupta &lt;tagupta@mathworks.com&gt;
diff --git a/build-test-publish.pipeline.yml b/build-test-publish.pipeline.yml
@@ -1,4 +1,4 @@
-name: 1.13$(Rev:.r)
+name: 1.14$(Rev:.r)
 
 trigger:
   - master
diff --git a/integ-test-promote-template.yml b/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
diff --git a/overview.md b/overview.md
@@ -233,11 +233,14 @@ Input                     | Description
 `useParallel`              | <p>(Optional) Option to run tests in parallel, specified as `false` or `true`. By default, the value is `false` and tests run in serial. If the test runner configuration is suited for parallelization, you can specify a value of `true` to run tests in parallel. This input requires a Parallel Computing Toolbox license.</p><p>**Example:** `useParallel: true`</p>
 `outputDetail`            | <p>(Optional) Amount of event detail displayed for the test run, specified as `none`, `terse`, `concise`, `detailed`, or `verbose`. By default, the task displays failing and logged events at the `detailed` level and test run progress at the `concise` level.<p></p>**Example:** `outputDetail: verbose`</p>
 `loggingLevel`            | <p>(Optional) Maximum verbosity level for logged diagnostics included for the test run, specified as `none`, `terse`, `concise`, `detailed`, or `verbose`. By default, the task includes diagnostics logged at the `terse` level.<p></p>**Example:** `loggingLevel: detailed`</p> 
-`testResultsPDF`          | <p>(Optional) Location to write the test results in PDF format, specified as a path relative to the project root folder. On macOS platforms, this input is supported in MATLAB R2020b and later.</p><p>**Example:** `testResultsPDF: test-results/results.pdf`</p>
-`testResultsJUnit`        | <p>(Optional) Location to write the test results in JUnit-style XML format, specified as a path relative to the project root folder.</p><p>**Example:** `testResultsJUnit: test-results/results.xml`</p>
-`testResultsSimulinkTest` | <p>(Optional) Location to export Simulink Test Manager results in MLDATX format, specified as a path relative to the project root folder. This input requires a Simulink Test license and is supported in MATLAB R2019a and later.</p><p>**Example:** `testResultsSimulinkTest: test-results/results.mldatx`</p>
-`codeCoverageCobertura`   | <p>(Optional) Location to write the code coverage results in Cobertura XML format, specified as a path relative to the project root folder.</p><p>**Example:** `codeCoverageCobertura: code-coverage/coverage.xml`</p>
-`modelCoverageCobertura`  | <p>(Optional) Location to write the model coverage results in Cobertura XML format, specified as a path relative to the project root folder. This input requires a Simulink Coverage&trade; license and is supported in MATLAB R2018b and later.</p><p>**Example:** `modelCoverageCobertura: model-coverage/coverage.xml`</p>
+`testResultsHTML`        | <p>(Optional) Location to write the test results in HTML format, specified as a folder path relative to the project root folder.</p><p>**Example:** `testResultsHTML: test-results`</p>
+`testResultsPDF`          | <p>(Optional) Location to write the test results in PDF format, specified as a file path relative to the project root folder. On macOS platforms, this input is supported in MATLAB R2020b and later.</p><p>**Example:** `testResultsPDF: test-results/results.pdf`</p>
+`testResultsJUnit`        | <p>(Optional) Location to write the test results in JUnit-style XML format, specified as a file path relative to the project root folder.</p><p>**Example:** `testResultsJUnit: test-results/results.xml`</p>
+`testResultsSimulinkTest` | <p>(Optional) Location to export Simulink Test Manager results in MLDATX format, specified as a file path relative to the project root folder. This input requires a Simulink Test license and is supported in MATLAB R2019a and later.</p><p>**Example:** `testResultsSimulinkTest: test-results/results.mldatx`</p>
+`codeCoverageHTML`         | <p>(Optional) Location to write the code coverage results in HTML format, specified as a folder path relative to the project root folder.</p><p>**Example:** `codeCoverageHTML: code-coverage`</p>
+`codeCoverageCobertura`   | <p>(Optional) Location to write the code coverage results in Cobertura XML format, specified as a file path relative to the project root folder.</p><p>**Example:** `codeCoverageCobertura: code-coverage/coverage.xml`</p>
+`modelCoverageHTML`        | <p>(Optional) Location to write the model coverage results in HTML format, specified as a folder path relative to the project root folder. This input requires a Simulink Coverage&trade; license and is supported in MATLAB R2018b and later.</p><p>**Example:** `modelCoverageHTML: model-coverage`</p>
+`modelCoverageCobertura`  | <p>(Optional) Location to write the model coverage results in Cobertura XML format, specified as a file path relative to the project root folder. This input requires a Simulink Coverage license and is supported in MATLAB R2018b and later.</p><p>**Example:** `modelCoverageCobertura: model-coverage/coverage.xml`</p>
 `startupOptions`         | <p>(Optional) MATLAB startup options, specified as a list of options separated by spaces. For more information about startup options, see [Commonly Used Startup Options](https://www.mathworks.com/help/matlab/matlab_env/commonly-used-startup-options.html).</p><p>Using this input to specify the `-batch` or `-r` option is not supported.</p><p>**Example:** `startupOptions: -nojvm`<br/>**Example:** `startupOptions: -nojvm -logfile output.log`</p>
 
 >**Note:** To customize the pretest state of the system, you can specify startup code that automatically executes before your tests run. For information on how to specify startup or shutdown files in a MATLAB project, see [Automate Startup and Shutdown Tasks](https://www.mathworks.com/help/matlab/matlab_prog/automate-startup-and-shutdown-tasks.html). If your pipeline does not use a MATLAB project, specify the commands you want executed at startup in a `startup.m` file instead, and save the file to the root of your repository. See [`startup`](https://www.mathworks.com/help/matlab/ref/startup.html) for more information.
diff --git a/tasks/run-matlab-tests/v1/main.ts b/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"),
diff --git a/tasks/run-matlab-tests/v1/scriptgen.ts b/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},` +
diff --git a/tasks/run-matlab-tests/v1/task.json b/tasks/run-matlab-tests/v1/task.json
@@ -100,7 +100,16 @@
             "defaultValue": "",
             "groupName": "testArtifacts",
             "required": false,
-            "helpMarkDown": "Path to write the test results in PDF format (requires MATLAB R2020b or later on macOS platforms)."
+            "helpMarkDown": "File 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": "Folder path to write the test results in HTML format."
         },
         {
             "name": "testResultsJUnit",
@@ -109,7 +118,7 @@
             "defaultValue": "",
             "groupName": "testArtifacts",
             "required": false,
-            "helpMarkDown": "Path to write the test results in JUnit-style XML format."
+            "helpMarkDown": "File path to write the test results in JUnit-style XML format."
         },
         {
             "name": "testResultsSimulinkTest",
@@ -118,7 +127,7 @@
             "defaultValue": "",
             "groupName": "testArtifacts",
             "required": false,
-            "helpMarkDown": "Path to export Simulink Test Manager results in MLDATX format (requires Simulink Test and is supported in MATLAB R2019a or later)."
+            "helpMarkDown": "File path to export Simulink Test Manager results in MLDATX format (requires Simulink Test and is supported in MATLAB R2019a or later)."
         },
         {
             "name": "codeCoverageCobertura",
@@ -127,7 +136,16 @@
             "defaultValue": "",
             "required": false,
             "groupName": "coverageArtifacts",
-            "helpMarkDown": "Path to write the code coverage results in Cobertura XML format."
+            "helpMarkDown": "File 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": "Folder path to write the code coverage results in HTML format."
         },
         {
             "name": "modelCoverageCobertura",
@@ -136,7 +154,16 @@
             "defaultValue": "",
             "groupName": "coverageArtifacts",
             "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)."
+            "helpMarkDown": "File 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": "Folder path to write the model coverage results in HTML format (requires Simulink Coverage and is supported in MATLAB R2018b or later)."
         },
         {
             "name": "startupOptions",
diff --git a/tasks/run-matlab-tests/v1/test/scriptgen.test.ts b/tasks/run-matlab-tests/v1/test/scriptgen.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: 1.13$(Rev:.r)`
	`1`	`+name: 1.14$(Rev:.r)`
`2`	`2`
`3`	`3`	`trigger:`
`4`	`4`	`- master`