Merge pull request #77 from matlab-actions/tarun/codeCovView

Code Coverage Summary View in GitHub Actions

Author: taguptamw

.github/workflows/bat.yml

@@ -1,5 +1,5 @@
 name: Build and Test
-on: [push]
+on: [push, pull_request]
 permissions:
   contents: read
 
@@ -46,12 +46,18 @@ jobs:
         with:
           source-folder: sample
           startup-options: -logfile output.log
+          code-coverage-metric-level: mcdc  # new option to configure metric level 
       - name: Verify option application
         run: |
           set -e
           grep "Running TheTruth" output.log
           grep "Done TheTruth" output.log
-          grep "1 Passed" output.log
+          grep "Running QuadraticPolynomialTest" output.log
+          grep "Done QuadraticPolynomialTest" output.log
+          grep "Running tAssumptionFailure" output.log
+          grep "Done tAssumptionFailure" output.log
+          grep "3 Passed" output.log
+          grep "1 Incomplete" output.log
         shell: bash
       - name: Generate Model
         uses: matlab-actions/run-command@v2
@@ -97,4 +103,4 @@ jobs:
       - name: Verify workflow command is added
         run: |
             grep "::group::TheTruth" output.log
-        shell: bash
+        shell: bash

.gitignore

@@ -124,4 +124,4 @@ out
 .yarn/unplugged
 .yarn/build-state.yml
 .yarn/install-state.gz
-.pnp.*
+.pnp.*

action.yml

@@ -1,4 +1,4 @@
-# Copyright 2020-2024 The MathWorks, Inc.
+# Copyright 2020-2026 The MathWorks, Inc.
 
 name: Run MATLAB Tests
 description: >-
@@ -84,6 +84,11 @@ inputs:
       Startup options for MATLAB
     required: false
     default: ""
+  code-coverage-metric-level:
+    description: >-
+      Level of coverage metrics to collect
+    required: false
+    default: mcdc
 runs:
   using: node24
   main: dist/index.js

package-lock.json

@@ -22,7 +22,7 @@
     "dependencies": {
         "@actions/core": "^3.0.0",
         "@actions/exec": "^3.0.0",
-        "common-utils": "github:matlab-actions/common-utils#v2.0.1"
+        "common-utils": "github:matlab-actions/common-utils#v2.1.0"
     },
     "devDependencies": {
         "@types/jest": "^30.0.0",

package.json

@@ -0,0 +1,38 @@
+classdef CodeCoverageSummaryPluginService < matlab.buildtool.internal.services.ciplugins.CITestRunnerPluginService
+    % Copyright 2026 The MathWorks, Inc.
+    
+    methods
+        function plugins = providePlugins(~, ~)
+
+            % Check if MATLAB Test license is available
+            if license('test', 'matlab_test') 
+                
+                % Get metric level from environment variable
+                metricLevel = getenv('INPUT_CODE_COVERAGE_METRIC_LEVEL');
+                
+                % Create a shared CoverageResult format object
+                format = matlab.unittest.plugins.codecoverage.CoverageResult;
+                
+                % Create an array to hold multiple plugins
+                plugins = matlab.unittest.plugins.TestRunnerPlugin.empty(0);
+                
+                % Get source folder from environment variable
+                sourceFolder = getenv('INPUT_SOURCE_FOLDER');
+                if isempty(sourceFolder)
+                    sourceFolder = pwd;
+                end
+                
+                coveragePlugin = matlab.unittest.plugins.CodeCoveragePlugin.forFolder(...
+                    sourceFolder, 'Producing', format, 'MetricLevel', metricLevel);
+
+                plugins(end+1) = coveragePlugin;
+                
+                % Add the summary plugin with the same format object
+                summaryPlugin = testframework.CodeCoverageSummaryPlugin(format, metricLevel);
+                plugins(end+1) = summaryPlugin;
+            else
+                plugins = matlab.unittest.plugins.TestRunnerPlugin.empty(1,0);
+            end
+        end
+    end
+end

plugins/+matlab/+unittest/+internal/+services/+plugins/CodeCoverageSummaryPluginService.m

@@ -0,0 +1,103 @@
+classdef CodeCoverageSummaryPlugin < matlab.unittest.plugins.TestRunnerPlugin
+    % Copyright 2026 The MathWorks, Inc.
+    
+    properties (Access=private)
+        CoverageFormat
+        MetricLevel
+    end
+    
+    methods
+        function plugin = CodeCoverageSummaryPlugin(coverageFormat, metricLevel)
+            plugin.CoverageFormat = coverageFormat;
+            plugin.MetricLevel = metricLevel;
+        end
+    end
+    
+    methods (Access=protected)
+        function runSession(plugin, pluginData)
+            % Checkout MATLAB Test license
+            license('checkout', 'matlab_test');
+            
+            % Run the session first (this ensures coverage data is collected)
+            runSession@matlab.unittest.plugins.TestRunnerPlugin(plugin, pluginData);
+            
+            % Now extract and save coverage data
+            if isempty(plugin.CoverageFormat.Result)
+                warning("testframework:CodeCoverageSummaryPlugin:NoCoverageData", "No coverage data collected.");
+                return;
+            end
+            
+            result = plugin.CoverageFormat.Result;
+            
+            % Create coverage summary structure
+            coverageDetails = struct();
+            coverageDetails.MetricLevel = plugin.MetricLevel;
+            
+            % Always get function and statement coverage (available for all levels)
+            functionCoverage = coverageSummary(result, "function");
+            statementCoverage = coverageSummary(result, "statement");
+            
+            coverageDetails.FunctionCoverage = sumCoverage(functionCoverage);
+            coverageDetails.StatementCoverage = sumCoverage(statementCoverage);
+            
+            % Get decision coverage if metric level is decision, condition, or mcdc
+            if ismember(plugin.MetricLevel, {'decision', 'condition', 'mcdc'})
+                decisionCoverage = coverageSummary(result, "decision");
+                coverageDetails.DecisionCoverage = sumCoverage(decisionCoverage);
+            end
+            
+            % Get condition coverage if metric level is condition or mcdc
+            if ismember(plugin.MetricLevel, {'condition', 'mcdc'})
+                conditionCoverage = coverageSummary(result, "condition");
+                coverageDetails.ConditionCoverage = sumCoverage(conditionCoverage);
+            end
+            
+            % Get MC/DC coverage if metric level is mcdc
+            if strcmp(plugin.MetricLevel, 'mcdc')
+                mcdcCoverage = coverageSummary(result, "mcdc");
+                coverageDetails.MCDCCoverage = sumCoverage(mcdcCoverage);
+            end
+            
+            coverageResults = {coverageDetails};
+            
+            % Determine file path for coverage results
+            coverageArtifactFile = fullfile(getenv("RUNNER_TEMP"), "matlabCoverageResults" + getenv("GITHUB_RUN_ID") + ".json");
+
+            try
+                JsonCoverageResults = jsonencode(coverageResults, "PrettyPrint", true);
+
+                [fID, msg] = fopen(coverageArtifactFile, "w");
+                if fID == -1
+                    warning("testframework:CodeCoverageSummaryPlugin:UnableToOpenFile","Unable to open a file required to show code coverage data. (Cause: %s)", msg);
+                else
+                    closeFile = onCleanup(@()fclose(fID));
+                    fprintf(fID, '%s', JsonCoverageResults);
+                end
+            catch e
+                warning("testframework:CodeCoverageSummaryPlugin:UnableToJsonEncode","Unable to serialize code coverage data into JSON format. (Cause: %s)", e.message);
+            end
+        end
+    end
+end
+
+% Helper function to sum up the coverage data from multiple files
+function coverageStruct = sumCoverage(coverageMatrix)
+    % Split the vector in half: first half is executed, second half is total
+    executed = sum(coverageMatrix(:, 1));
+    total = sum(coverageMatrix(:, 2));
+    
+    coverageStruct = struct(...
+        'Executed', executed, ...
+        'Total', total, ...
+        'Percentage', calculatePercentage([executed, total]) ...
+    );
+end
+
+% function to calculate percentage
+function percentage = calculatePercentage(coverageData)
+    if coverageData(2) == 0
+        percentage = NaN; % Avoid division by zero
+    else
+        percentage = (coverageData(1) / coverageData(2)) * 100;
+    end
+end