Refactor code and add support for test results summary and logs grouping via common-utils (#70)

mw-kapilg · web-flow · commit 4fdda8f612a8 · 2025-12-03T03:09:09.000+05:30
* Add test results data viz

* update imports

* print total tests count

* update yml

* check workspace

* fix join

* update pluginPath

* move resources

* add copy dir command

* remove test file

* rename resource

* update namespace

* update counts to stats

* fix error

* move failed tests section above all tests

* introduce test failure

* update failed tests view

* add title and preserve MATLAB formatting

* add more tests and update view

* try nested table

* unify sections

* format diagnostics

* format table

* format function calls

* update testcase

* more formattinhg

* update join separator

* update all join separators

* add sub-heading

* introduce test failure

* remove diagnostics formatting

* add formatting for double \n

* add whitespace

* debug

* debug

* debug

* debug

* double \n formatting

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* update diagnostics condition

* update file path

* update display path

* add action name

* update workspace

* refactor

* verify multiple test runs in same action

* add grouping

* add test class grouping

* update test class grouping

* update test class grouping

* remove test case grouping

* remove old grouping

* add tests

* add multi-platform testting

* debug

* update test setup

* remove extra files and add more MATLAB tests

* update os check

* add continue-on-error

* update assumption failure

* format code and add more tests

* update os info

* update package

* move fatalAssertion failure to a new file so it runs at the end

* fix codescan issue and add help icon

* fix test

* fix typo

* remove fatal assertion as it cause other test scripts to not run

* update genscript url temporarily for dev

* move test summary and log grouping to common-utils

* check if node_modules is present

* reorder steps in npm ci command

* update common-utils repo

* update bat.yml

* use matlab module from common-utils

* update view generation preferences

* update bat.yml

* add tests log grouping

* commit untracked plugin files

* update as per common-utils update

* revert plugins path logic

* update plugins path and add execOptions

* fix test failure

* use common-utils v1.0.0

* fix package-lock.json
diff --git a/.github/workflows/bat.yml b/.github/workflows/bat.yml
@@ -36,10 +36,12 @@ jobs:
         uses: matlab-actions/setup-matlab@v2
         with:
           products: |
+            MATLAB_Test
             Simulink
             Simulink_Test
             Simulink_Coverage
       - name: Run MATLAB Tests
+        continue-on-error: true
         uses: ./
         with:
           source-folder: sample
@@ -58,6 +60,7 @@ jobs:
       - name: Set up diary for logging
         run: echo 'diary console.log' >> startup.m
       - name: Run run-test command
+        continue-on-error: true
         uses: ./
         with:
             test-results-simulink-test: test-results/simulinktest.mldatx
@@ -90,4 +93,8 @@ jobs:
             grep -q "runInParallel" console.log
             grep -q "'OutputDetail', 3" console.log
             grep -q "'LoggingLevel', 3" console.log
-        shell: bash
+        shell: bash
+      - name: Verify workflow command is added
+        run: |
+            grep "::group::TheTruth" output.log
+        shell: bash
diff --git a/.npmrc b/.npmrc
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -13,22 +13,24 @@
         "package": "ncc build --minify",
         "test": "jest",
         "all": "npm test && npm run build && npm run package",
-        "ci": "npm run clean && npm run deps && npm ci && npm run all"
+        "ci": "npm run clean && npm ci && npm run deps && npm run all"
     },
     "files": [
         "lib/"
     ],
     "dependencies": {
         "@actions/core": "^1.11.1",
         "@actions/exec": "^1.1.1",
-        "run-matlab-command-action": "github:matlab-actions/run-command#v2.3.0"
+        "common-utils": "github:matlab-actions/common-utils#v1.0.0"
     },
     "devDependencies": {
         "@types/jest": "^30.0.0",
+        "@types/jsdom": "^21.1.7",
         "@types/node": "^24.3.0",
         "@vercel/ncc": "^0.38.3",
         "jest": "^30.0.5",
         "jest-circus": "^30.0.5",
+        "jsdom": "^26.1.0",
         "prettier": "3.6.2",
         "ts-jest": "^29.4.1",
         "typescript": "^5.9.2"
diff --git a/plugins/+matlab/+unittest/+internal/+services/+plugins/GitHubLogTestPluginService.m b/plugins/+matlab/+unittest/+internal/+services/+plugins/GitHubLogTestPluginService.m
@@ -0,0 +1,9 @@
+classdef GitHubLogTestPluginService < matlab.buildtool.internal.services.ciplugins.CITestRunnerPluginService
+    % Copyright 2025 The MathWorks, Inc.
+
+    methods
+        function plugins = providePlugins(~, ~)
+            plugins = testframework.GitHubLogTestPlugin();
+        end
+    end
+end
diff --git a/plugins/+testframework/GitHubLogTestPlugin.m b/plugins/+testframework/GitHubLogTestPlugin.m
@@ -0,0 +1,16 @@
+classdef GitHubLogTestPlugin < matlab.unittest.plugins.TestRunnerPlugin
+    % Copyright 2025 The MathWorks, Inc.
+    
+    methods (Access=protected)
+        function runTestClass(plugin, pluginData)
+            % Add GitHub workflow command for starting a test class output group
+            disp("::group::" + pluginData.Name);
+
+            % Invoke the superclass method
+            runTestClass@matlab.unittest.plugins.TestRunnerPlugin(plugin, pluginData);
+
+            % End the test class output group
+           disp("::endgroup::");
+        end
+    end
+end
diff --git a/sample/tAssumptionFailure.m b/sample/tAssumptionFailure.m
@@ -0,0 +1,7 @@
+classdef tAssumptionFailure < matlab.unittest.TestCase
+    methods (Test)
+        function testAssumptionFailure(testCase)
+            testCase.assumeEqual(1+1, 11);
+        end
+    end
+end
diff --git a/scripts/setupdeps.sh b/scripts/setupdeps.sh
@@ -1,30 +1,8 @@
 #!/bin/bash
 
-SCRIPTGEN_URL='https://ssd.mathworks.com/supportfiles/ci/matlab-script-generator/v0/matlab-script-generator.zip'
-RMC_BASE_URL='https://ssd.mathworks.com/supportfiles/ci/run-matlab-command/v2'
-SUPPORTED_OS=('win64' 'maci64' 'maca64' 'glnxa64')
-
-# Create dist directory if it doesn't already exist
-DISTDIR="$(pwd)/dist"
-mkdir -p $DISTDIR/bin
-
-# Download and extract in a temporary directory
-WORKINGDIR=$(mktemp -d -t rmc_build.XXXXXX)
-cd $WORKINGDIR
+source ./node_modules/common-utils/scripts/setupdeps.sh
 
-wget -O  "$WORKINGDIR/license.txt" "$RMC_BASE_URL/license.txt"
-wget -O  "$WORKINGDIR/thirdpartylicenses.txt" "$RMC_BASE_URL/thirdpartylicenses.txt"
-
-for os in ${SUPPORTED_OS[@]}
-do
-    if [[ $os == 'win64' ]] ; then
-        bin_ext='.exe'
-    else
-        bin_ext=''
-    fi
-    mkdir -p "$WORKINGDIR/$os"
-    wget -O  "$WORKINGDIR/$os/run-matlab-command$bin_ext" "$RMC_BASE_URL/$os/run-matlab-command$bin_ext"
-done
+SCRIPTGEN_URL='https://ssd.mathworks.com/supportfiles/ci/matlab-script-generator/v0/matlab-script-generator.zip'
 
 wget -O scriptgen.zip $SCRIPTGEN_URL
 unzip -qod scriptgen scriptgen.zip
@@ -33,4 +11,3 @@ rm scriptgen.zip
 
 mv -f ./* "$DISTDIR/bin"
 rm -rf $WORKINGDIR
-
diff --git a/src/index.ts b/src/index.ts
@@ -1,9 +1,9 @@
-// Copyright 2020-2023 The MathWorks, Inc.
+// Copyright 2020-2025 The MathWorks, Inc.
 
 import * as core from "@actions/core";
 import * as exec from "@actions/exec";
-import { matlab } from "run-matlab-command-action";
 import * as scriptgen from "./scriptgen";
+import { matlab, testResultsSummary } from "common-utils";
 
 /**
  * Gather action inputs and then run action
@@ -34,14 +34,28 @@ async function run() {
     const command = scriptgen.generateCommand(options);
     const startupOptions = core.getInput("startup-options").split(" ");
 
-    const helperScript = await core.group("Generate script", async () => {
-        const helperScript = await matlab.generateScript(workspaceDir, command);
-        core.info("Successfully generated script");
-        return helperScript;
-    });
+    const helperScript = await matlab.generateScript(workspaceDir, command);
+    const execOptions = {
+        env: {
+            ...process.env,
+            MW_BATCH_LICENSING_ONLINE:'true', // Remove when online batch licensing is the default
+        }
+    };
+    core.info("Successfully generated test script!");
+
+    await matlab.runCommand(
+        helperScript,
+        platform,
+        architecture,
+        (cmd, args) => exec.exec(cmd, args, execOptions),
+        startupOptions
+    ).finally(() => {
+        const runnerTemp = process.env.RUNNER_TEMP || '';
+        const runId = process.env.GITHUB_RUN_ID || '';
+        const actionName = process.env.GITHUB_ACTION || '';
 
-    await core.group("Run command", async () => {
-        await matlab.runCommand(helperScript, platform, architecture, exec.exec, startupOptions);
+        testResultsSummary.processAndAddTestSummary(runnerTemp, runId, actionName, workspaceDir);
+        core.summary.write();
     });
 }
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,6 +1,6 @@
 {
     "compilerOptions": {
-        "target": "ES6",
+        "target": "ES2022",
         "module": "CommonJS",
         "declaration": true,
         "sourceMap": true,

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"compilerOptions": {`
`3`		`- "target": "ES6",`
	`3`	`+ "target": "ES2022",`
`4`	`4`	`"module": "CommonJS",`
`5`	`5`	`"declaration": true,`
`6`	`6`	`"sourceMap": true,`