buildSummary.unit.test.ts

// Copyright 2024 The MathWorks, Inc.

import * as buildSummary from './buildSummary';
import * as core from '@actions/core';


jest.mock('@actions/core', () => ({
    summary: {
        addTable: jest.fn().mockReturnThis(),
        write: jest.fn().mockReturnThis(),
    },
}));

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, 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 (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', '🟢 Succeeded', 'Task 5 description', '00:00:30']
        ]);
    });

    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.writeSummary(mockTableRows);

        expect(core.summary.addTable).toHaveBeenCalledTimes(1);
        expect(core.summary.addTable).toHaveBeenCalledWith(mockTableRows);
    });
});