add check and update artifact name for build summary

mw-kapilg · mw-kapilg · commit 46035938d4cb · 2026-05-09T00:21:36.000+05:30
diff --git a/package-lock.json b/package-lock.json
diff --git a/plugins/+buildframework/BuildSummaryPlugin.m b/plugins/+buildframework/BuildSummaryPlugin.m
@@ -10,13 +10,15 @@
         function runTaskGraph(plugin, pluginData)
             runTaskGraph@matlab.buildtool.plugins.BuildRunnerPlugin(plugin, pluginData);
 
-            [fID, msg] = fopen(fullfile(getenv("RUNNER_TEMP") ,"buildSummary" + getenv("GITHUB_RUN_ID") + ".json"), "w");
-            if fID == -1
-                warning("buildframework:BuildSummaryPlugin:UnableToOpenFile","Unable to open a file required to create the MATLAB build summary table: %s", msg);
-            else
-                closeFile = onCleanup(@()fclose(fID));
-                s = jsonencode(plugin.TaskDetails);
-                fprintf(fID, "%s",s);
+            if strcmpi(getenv("MW_GENERATE_JOB_SUMMARY"), "true")
+                [fID, msg] = fopen(fullfile(getenv("RUNNER_TEMP"), "buildSummary" + getenv("GITHUB_ACTION") + "_" + string(datetime('now', 'Format', 'yyyyMMdd_HHmmss_SSS')) + ".json"), "w");
+                if fID == -1
+                    warning("buildframework:BuildSummaryPlugin:UnableToOpenFile","Unable to open a file required to create the MATLAB build summary table: %s", msg);
+                else
+                    closeFile = onCleanup(@()fclose(fID));
+                    s = jsonencode(plugin.TaskDetails);
+                    fprintf(fID, "%s",s);
+                end
             end
         end
 
diff --git a/plugins/+buildframework/ParallelizableBuildSummaryPlugin.m b/plugins/+buildframework/ParallelizableBuildSummaryPlugin.m
@@ -34,14 +34,16 @@ function runBuild(plugin, pluginData)
             end
 
             % Write to file
-            folder = fileparts(plugin.TempFolder);
-            [fID, msg] = fopen(fullfile(folder, "buildSummary" + getenv("GITHUB_RUN_ID") + ".json"), "w");
-            if fID == -1
-                warning("buildframework:BuildSummaryPlugin:UnableToOpenFile","Unable to open a file required to create the MATLAB build summary table: %s", msg);
-            else
-                closeFile = onCleanup(@()fclose(fID));
-                s = jsonencode(taskDetails);
-                fprintf(fID, "%s", s);
+            if strcmpi(getenv("MW_GENERATE_JOB_SUMMARY"), "true")
+                folder = fileparts(plugin.TempFolder);
+                [fID, msg] = fopen(fullfile(folder, "buildSummary" + getenv("GITHUB_ACTION") + "_" + string(datetime('now', 'Format', 'yyyyMMdd_HHmmss_SSS')) + ".json"), "w");
+                if fID == -1
+                    warning("buildframework:BuildSummaryPlugin:UnableToOpenFile","Unable to open a file required to create the MATLAB build summary table: %s", msg);
+                else
+                    closeFile = onCleanup(@()fclose(fID));
+                    s = jsonencode(taskDetails);
+                    fprintf(fID, "%s", s);
+                end
             end
         end
 
diff --git a/src/buildSummary.ts b/src/buildSummary.ts
@@ -1,7 +1,7 @@
-// Copyright 2024-25 The MathWorks, Inc.
+// Copyright 2024-26 The MathWorks, Inc.
 import * as core from "@actions/core";
 import { join } from "path";
-import { readFileSync, unlinkSync, existsSync } from "fs";
+import { readFileSync, unlinkSync, readdirSync } from "fs";
 
 export function addSummary(taskSummaryTableRows: string[][]) {
     try {
@@ -43,24 +43,43 @@ export function interpretSkipReason(skipReason: string) {
     }
 }
 
-export function processAndAddBuildSummary(runnerTemp: string, runId: string) {
+export function processAndAddBuildSummary(runnerTemp: string, actionName: string) {
+    const filePrefix = `buildSummary${actionName}_`;
+    const fileSuffix = `.json`;
+
+    let buildSummaryFiles: string[] = [];
+    try {
+        buildSummaryFiles = readdirSync(runnerTemp)
+            .filter((file) => file.startsWith(filePrefix) && file.endsWith(fileSuffix))
+            .sort();
+    } catch (e) {
+        console.error(
+            `An error occurred while finding build summary file(s) in directory ${runnerTemp}:`,
+            e,
+        );
+        return;
+    }
+
+    if (buildSummaryFiles.length === 0) {
+        return;
+    }
+
     const header = [
         { data: "MATLAB Task", header: true },
         { data: "Status", header: true },
         { data: "Description", header: true },
         { data: "Duration (HH:mm:ss)", header: true },
     ];
 
-    const filePath: string = join(runnerTemp, `buildSummary${runId}.json`);
-    let taskSummaryTable;
-    if (existsSync(filePath)) {
+    for (const fileName of buildSummaryFiles) {
+        const filePath = join(runnerTemp, fileName);
         try {
             const buildSummary = readFileSync(filePath, { encoding: "utf8" });
             const rows = getSummaryRows(buildSummary);
-            taskSummaryTable = [header, ...rows];
+            const taskSummaryTable = [header, ...rows];
+            addSummary(taskSummaryTable);
         } catch (e) {
             console.error("An error occurred while reading the build summary file:", e);
-            return;
         } finally {
             try {
                 unlinkSync(filePath);
@@ -71,6 +90,5 @@ export function processAndAddBuildSummary(runnerTemp: string, runId: string) {
                 );
             }
         }
-        addSummary(taskSummaryTable);
     }
 }
diff --git a/src/buildSummary.unit.test.ts b/src/buildSummary.unit.test.ts
@@ -1,6 +1,8 @@
 // Copyright 2024-26 The MathWorks, Inc.
 
 import { jest, describe, it, expect, beforeEach } from "@jest/globals";
+import * as path from "path";
+import * as nodeFs from "fs";
 
 jest.unstable_mockModule("@actions/core", () => ({
     summary: {
@@ -10,17 +12,56 @@ jest.unstable_mockModule("@actions/core", () => ({
     },
 }));
 
+// Mock fs, passing through real implementations except unlinkSync
+const mockUnlinkSync = jest.fn();
+jest.unstable_mockModule("fs", () => ({
+    readFileSync: nodeFs.readFileSync,
+    existsSync: nodeFs.existsSync,
+    writeFileSync: nodeFs.writeFileSync,
+    readdirSync: nodeFs.readdirSync,
+    unlinkSync: mockUnlinkSync,
+}));
+
 const core = await import("@actions/core");
+const fs = await import("fs");
 const buildSummary = await import("./buildSummary.js");
 
+const runnerTemp = path.join(import.meta.dirname, "..");
+
+function safeDelete(filePath: string) {
+    try {
+        nodeFs.unlinkSync(filePath);
+    } catch (e) {
+        /* ignore */
+    }
+}
+
+const validBuildData = JSON.stringify([
+    {
+        name: "compile",
+        failed: false,
+        skipped: false,
+        description: "Compile source",
+        duration: "00:00:10",
+    },
+    {
+        name: "test",
+        failed: true,
+        skipped: false,
+        description: "Run tests",
+        duration: "00:00:25",
+    },
+]);
+
 beforeEach(() => {
-    (core.summary.addTable as jest.Mock).mockReturnThis();
-    (core.summary.addHeading as jest.Mock).mockReturnThis();
-    (core.summary.write as jest.Mock).mockReturnThis();
+    (core.summary.addTable as jest.Mock).mockClear();
+    (core.summary.addHeading as jest.Mock).mockClear();
+    (core.summary.write as jest.Mock).mockClear();
+    mockUnlinkSync.mockReset();
 });
 
-describe("summaryGeneration", () => {
-    it("should process and return summary rows for valid JSON with different task statuses", () => {
+describe("getSummaryRows", () => {
+    it("should return correct rows for different task statuses", () => {
         const mockBuildSummary = JSON.stringify([
             {
                 name: "Task 1",
@@ -73,19 +114,151 @@ describe("summaryGeneration", () => {
         ]);
     });
 
-    it("writes the summary correctly", () => {
-        const mockTableRows = [
-            ["MATLAB Task", "Status", "Description", "Duration (HH:mm:ss)"],
-            ["Test Task", "🔴 Failed", "A test task", "00:00:10"],
-        ];
-        buildSummary.addSummary(mockTableRows);
-
-        expect(core.summary.addHeading).toHaveBeenCalledTimes(1);
-        expect(core.summary.addHeading).toHaveBeenNthCalledWith(
-            1,
-            expect.stringContaining("MATLAB Build Results"),
+    it("should return empty array for empty JSON array", () => {
+        const result = buildSummary.getSummaryRows("[]");
+        expect(result).toEqual([]);
+    });
+});
+
+describe("processAndAddBuildSummary", () => {
+    it("should discover and process files matching the actionName", () => {
+        const filePath = path.join(runnerTemp, "buildSummarymy-action_20260509_100000_001.json");
+        fs.writeFileSync(filePath, validBuildData);
+
+        try {
+            buildSummary.processAndAddBuildSummary(runnerTemp, "my-action");
+
+            expect(core.summary.addHeading).toHaveBeenCalledWith("MATLAB Build Results");
+            expect(core.summary.addTable).toHaveBeenCalledTimes(1);
+
+            const tableArg = (core.summary.addTable as jest.Mock).mock.calls[0][0] as any[][];
+            expect(tableArg[1]).toEqual(["compile", "🟢 Successful", "Compile source", "00:00:10"]);
+            expect(tableArg[2]).toEqual(["test", "🔴 Failed", "Run tests", "00:00:25"]);
+        } finally {
+            safeDelete(filePath);
+        }
+    });
+
+    it("should ignore files for a different actionName", () => {
+        const matchingFile = path.join(
+            runnerTemp,
+            "buildSummarymy-action_20260509_100000_001.json",
+        );
+        const nonMatchingFile = path.join(
+            runnerTemp,
+            "buildSummaryother-action_20260509_100000_001.json",
         );
-        expect(core.summary.addTable).toHaveBeenCalledTimes(1);
-        expect(core.summary.addTable).toHaveBeenCalledWith(mockTableRows);
+        fs.writeFileSync(matchingFile, validBuildData);
+        fs.writeFileSync(nonMatchingFile, validBuildData);
+
+        try {
+            buildSummary.processAndAddBuildSummary(runnerTemp, "my-action");
+
+            expect(core.summary.addTable).toHaveBeenCalledTimes(1);
+            expect(mockUnlinkSync).toHaveBeenCalledWith(matchingFile);
+            expect(mockUnlinkSync).not.toHaveBeenCalledWith(nonMatchingFile);
+        } finally {
+            safeDelete(matchingFile);
+            safeDelete(nonMatchingFile);
+        }
+    });
+
+    it("should not add summary when no matching files exist", () => {
+        buildSummary.processAndAddBuildSummary(runnerTemp, "nonexistent-action");
+
+        expect(core.summary.addHeading).not.toHaveBeenCalled();
+        expect(core.summary.addTable).not.toHaveBeenCalled();
+    });
+
+    it("should handle non-existent directory gracefully", () => {
+        const consoleSpy = jest.spyOn(console, "error").mockImplementation(() => {});
+
+        buildSummary.processAndAddBuildSummary("/nonexistent/directory/path", "my-action");
+
+        expect(core.summary.addTable).not.toHaveBeenCalled();
+        expect(consoleSpy).toHaveBeenCalledWith(
+            expect.stringContaining(
+                "An error occurred while finding build summary file(s) in directory",
+            ),
+            expect.any(Error),
+        );
+        consoleSpy.mockRestore();
+    });
+
+    it("should handle invalid JSON gracefully", () => {
+        const consoleSpy = jest.spyOn(console, "error").mockImplementation(() => {});
+        const filePath = path.join(runnerTemp, "buildSummarymy-action_20260509_100000_002.json");
+        fs.writeFileSync(filePath, "{ invalid json");
+
+        try {
+            buildSummary.processAndAddBuildSummary(runnerTemp, "my-action");
+
+            expect(core.summary.addTable).not.toHaveBeenCalled();
+            expect(consoleSpy).toHaveBeenCalledWith(
+                "An error occurred while reading the build summary file:",
+                expect.any(Error),
+            );
+        } finally {
+            safeDelete(filePath);
+            consoleSpy.mockRestore();
+        }
+    });
+
+    it("should delete files after processing", () => {
+        const filePath = path.join(runnerTemp, "buildSummarymy-action_20260509_100000_003.json");
+        fs.writeFileSync(filePath, validBuildData);
+
+        try {
+            buildSummary.processAndAddBuildSummary(runnerTemp, "my-action");
+
+            expect(mockUnlinkSync).toHaveBeenCalledWith(filePath);
+        } finally {
+            safeDelete(filePath);
+        }
+    });
+
+    it("should handle file deletion errors gracefully", () => {
+        const consoleSpy = jest.spyOn(console, "error").mockImplementation(() => {});
+        mockUnlinkSync.mockImplementationOnce(() => {
+            throw new Error("Permission denied");
+        });
+
+        const filePath = path.join(runnerTemp, "buildSummarymy-action_20260509_100000_004.json");
+        fs.writeFileSync(filePath, validBuildData);
+
+        try {
+            buildSummary.processAndAddBuildSummary(runnerTemp, "my-action");
+
+            expect(core.summary.addTable).toHaveBeenCalledTimes(1);
+            expect(consoleSpy).toHaveBeenCalledWith(
+                expect.stringContaining(
+                    "An error occurred while trying to delete the build summary file",
+                ),
+                expect.any(Error),
+            );
+        } finally {
+            mockUnlinkSync.mockReset();
+            safeDelete(filePath);
+            consoleSpy.mockRestore();
+        }
+    });
+
+    it("should process multiple build summary files", () => {
+        const file1 = path.join(runnerTemp, "buildSummarymy-action_20260509_100000_005.json");
+        const file2 = path.join(runnerTemp, "buildSummarymy-action_20260509_100000_006.json");
+        fs.writeFileSync(file1, validBuildData);
+        fs.writeFileSync(file2, validBuildData);
+
+        try {
+            buildSummary.processAndAddBuildSummary(runnerTemp, "my-action");
+
+            expect(core.summary.addHeading).toHaveBeenCalledTimes(2);
+            expect(core.summary.addTable).toHaveBeenCalledTimes(2);
+            expect(mockUnlinkSync).toHaveBeenCalledWith(file1);
+            expect(mockUnlinkSync).toHaveBeenCalledWith(file2);
+        } finally {
+            safeDelete(file1);
+            safeDelete(file2);
+        }
     });
 });
