Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add skip reason for skipped tasks in build summary table #49

Merged
merged 11 commits into from
Aug 30, 2024
Merged

Add skip reason for skipped tasks in build summary table #49

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
33aeed2
add skip reason
mw-kapilg Aug 19, 2024
2c7cf94
update test
mw-kapilg Aug 19, 2024
816f586
fix build summary plugin
mw-kapilg Aug 19, 2024
65e8022
Add 25a enum name compatibility
mw-kapilg Aug 20, 2024
2c9e673
update as per review comments
mw-kapilg Aug 21, 2024
5ee1137
fix test failure
mw-kapilg Aug 21, 2024
8e77637
Use user requested for both UserSpecified and UserRequested
mw-kapilg Aug 22, 2024
8a3ce75
add a couple more unit tests
mw-kapilg Aug 22, 2024
32f8b5f
Update properties access level
mw-kapilg Aug 23, 2024
1bed2fb
update build summary table
mw-kapilg Aug 29, 2024
c07899a
update status to succeeded
mw-kapilg Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 30 additions & 11 deletions plugins/+ciplugins/+github/BuildSummaryPlugin.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,46 @@

% Copyright 2024 The MathWorks, Inc.

methods (Access=protected)
properties (Access=private)
TaskDetails = {};
mw-kapilg marked this conversation as resolved.
Show resolved Hide resolved
end

methods (Access=protected)
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");

[fID, msg] = fopen(fullfile(getenv("RUNNER_TEMP") ,"buildSummary" + getenv("GITHUB_RUN_ID") + ".json"), "w");
if fID == -1
warning("ciplugins:github:BuildSummaryPlugin:UnableToOpenFile","Unable to open a file required to create the MATLAB build summary table: %s", msg);
else
closeFile = onCleanup(@()fclose(fID));
taskDetails = struct();
for idx = 1:numel(pluginData.TaskResults)
taskDetails(idx).name = pluginData.TaskResults(idx).Name;
taskDetails(idx).description = pluginData.TaskGraph.Tasks(idx).Description;
taskDetails(idx).failed = pluginData.TaskResults(idx).Failed;
taskDetails(idx).skipped = pluginData.TaskResults(idx).Skipped;
taskDetails(idx).duration = string(pluginData.TaskResults(idx).Duration);
end
s = jsonencode(taskDetails);
s = jsonencode(plugin.TaskDetails);
fprintf(fID, "%s",s);
end
end

function runTask(plugin, pluginData)
runTask@matlab.buildtool.plugins.BuildRunnerPlugin(plugin, pluginData);

taskDetail = getCommonTaskDetail(pluginData);
plugin.TaskDetails = [plugin.TaskDetails, taskDetail];
end

function skipTask(plugin, pluginData)
skipTask@matlab.buildtool.plugins.BuildRunnerPlugin(plugin, pluginData);

taskDetail = getCommonTaskDetail(pluginData);
taskDetail.skipReason = pluginData.SkipReason;
plugin.TaskDetails = [plugin.TaskDetails, taskDetail];
end
end
end

function taskDetail = getCommonTaskDetail(pluginData)
taskDetail = struct();
taskDetail.name = pluginData.TaskResults.Name;
taskDetail.description = pluginData.TaskGraph.Tasks.Description;
taskDetail.failed = pluginData.TaskResults.Failed;
taskDetail.skipped = pluginData.TaskResults.Skipped;
taskDetail.duration = string(pluginData.TaskResults.Duration);
end
30 changes: 18 additions & 12 deletions src/buildSummary.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,6 @@ import * as core from "@actions/core";
import { join } from 'path';
import { readFileSync, unlinkSync, existsSync } from 'fs';

export interface Task {
name: string;
description: string;
failed: boolean;
skipped: boolean;
duration: string;
}

export function writeSummary(taskSummaryTableRows: string[][]) {
try {
core.summary
Expand All @@ -24,20 +16,34 @@ export function writeSummary(taskSummaryTableRows: string[][]) {
export function getSummaryRows(buildSummary: string): any[] {
const rows = JSON.parse(buildSummary).map((t: any) => {
if (t.failed) {
return [t.name, '🔴 Failed', t.description, t.duration.toString()];
return [t.name, '🔴 Failed', t.description, t.duration];
} else if (t.skipped) {
return [t.name, '🔵 Skipped', t.description, t.duration.toString()];
return [t.name, '🔵 Skipped' + ' (' + interpretSkipReason(t.skipReason) + ')', t.description, t.duration];
} else {
return [t.name, '🟢 Success', t.description, t.duration.toString()];
return [t.name, '🟢 Successful', t.description, t.duration];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return [t.name, '🟢 Successful', t.description, t.duration];
return [t.name, '🟢 Succeeded', t.description, t.duration];

The group preferred "Succeeded" over "Successful" to better match "Failed" and "Skipped".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Mark for checking with the group! I preferred "Successful" more but I guess it's fair enough to use "Succeeded" as we have "Failed" and "Skipped"

}
});
return rows;
}

export function interpretSkipReason(skipReason: string){
switch(skipReason) {
case "UpToDate":
return "up-to-date";
case "UserSpecified":
case "UserRequested":
return "user requested";
case "DependencyFailed":
return "dependency failed";
default:
return skipReason;
}
}

export function processAndDisplayBuildSummary() {
const runId = process.env.GITHUB_RUN_ID || '';
const runnerTemp = process.env.RUNNER_TEMP || '';
const header = [{ data: 'MATLAB Build Task', header: true }, { data: 'Status', header: true }, { data: 'Description', header: true }, { data: 'Duration (hh:mm:ss)', header: true }];
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;
Expand Down
14 changes: 9 additions & 5 deletions src/buildSummary.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,26 @@ describe('summaryGeneration', () => {
it('should process and return summary rows for valid JSON with different task statuses', () => {
const mockBuildSummary = JSON.stringify([
{ name: 'Task 1', failed: true, skipped: false, description: 'Task 1 description', duration: '00:00:10' },
{ name: 'Task 2', failed: false, skipped: true, description: 'Task 2 description', duration: '00:00:20' },
{ name: 'Task 3', failed: false, skipped: false, description: 'Task 3 description', duration: '00:00:30' }
{ name: 'Task 2', failed: false, skipped: true, skipReason: 'UserSpecified', description: 'Task 2 description', duration: '00:00:20' },
{ name: 'Task 3', failed: false, skipped: true, skipReason: 'DependencyFailed', description: 'Task 3 description', duration: '00:00:20' },
{ name: 'Task 4', failed: false, skipped: true, skipReason: 'UpToDate', description: 'Task 4 description', duration: '00:00:20' },
{ name: 'Task 5', failed: false, skipped: false, description: 'Task 5 description', duration: '00:00:30' }
]);

const result = buildSummary.getSummaryRows(mockBuildSummary);

expect(result).toEqual([
['Task 1', '🔴 Failed', 'Task 1 description', '00:00:10'],
['Task 2', '🔵 Skipped', 'Task 2 description', '00:00:20'],
['Task 3', '🟢 Success', 'Task 3 description', '00:00:30']
['Task 2', '🔵 Skipped (user requested)', 'Task 2 description', '00:00:20'],
['Task 3', '🔵 Skipped (dependency failed)', 'Task 3 description', '00:00:20'],
['Task 4', '🔵 Skipped (up-to-date)', 'Task 4 description', '00:00:20'],
['Task 5', '🟢 Successful', 'Task 5 description', '00:00:30']
]);
});

it('writes the summary correctly', () => {
const mockTableRows = [
['MATLAB Build Task', 'Status', 'Description', 'Duration (hh:mm:ss)'],
['MATLAB Task', 'Status', 'Description', 'Duration (HH:mm:ss)'],
['Test Task', '🔴 Failed', 'A test task', '00:00:10'],
];

Expand Down
Loading