Skip to content

Commit

Permalink
Fix skipped and todo tests in Github Actions Reporter
Browse files Browse the repository at this point in the history
  • Loading branch information
@MatteoH2O1999
MatteoH2O1999 committed Jul 7, 2023
1 parent 1f019af commit c3afed2
Show file tree
Hide file tree
Showing 4 changed files with 214 additions and 24 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

### Fixes

- `[jest-reporters]` Add "skipped" and "todo" symbols to Github Actions Reporter ([#14309](https://github.com/jestjs/jest/pull/14309))

### Chore & Maintenance

### Performance
Expand Down
35 changes: 22 additions & 13 deletions packages/jest-reporters/src/GitHubActionsReporter.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import stripAnsi = require('strip-ansi');
import type {
AggregatedResult,
AssertionResult,
Status,
Test,
TestContext,
TestResult,
Expand All @@ -21,6 +22,7 @@ import {
getTopFrame,
separateMessageFromStack,
} from 'jest-message-util';
import {specialChars} from 'jest-util';
import BaseReporter from './BaseReporter';

type AnnotationOptions = {
Expand All @@ -32,6 +34,7 @@ type AnnotationOptions = {
};

const titleSeparator = ' \u203A ';
const ICONS = specialChars.ICONS;

type PerformanceInfo = {
end: number;
Expand All @@ -42,7 +45,7 @@ type PerformanceInfo = {

type ResultTreeLeaf = {
name: string;
passed: boolean;
passed: Status;
duration: number;
children: Array<never>;
};
Expand Down Expand Up @@ -215,17 +218,15 @@ export default class GitHubActionsReporter extends BaseReporter {
const branches: Array<Array<string>> = [];
suiteResult.forEach(element => {
if (element.ancestorTitles.length === 0) {
let passed = true;
if (element.status !== 'passed') {
if (element.status === 'failed') {
root.passed = false;
passed = false;
}
const duration = element.duration || 1;
root.children.push({
children: [],
duration,
name: element.title,
passed,
passed: element.status,
});
} else {
let alreadyInserted = false;
Expand Down Expand Up @@ -263,21 +264,19 @@ export default class GitHubActionsReporter extends BaseReporter {
};
const branches: Array<Array<string>> = [];
suiteResult.forEach(element => {
let passed = true;
let duration = element.duration;
if (!duration || isNaN(duration)) {
duration = 1;
}
if (this.arrayEqual(element.ancestorTitles, ancestors)) {
if (element.status !== 'passed') {
if (element.status === 'failed') {
node.passed = false;
passed = false;
}
node.children.push({
children: [],
duration,
name: element.title,
passed,
passed: element.status,
});
} else if (
this.arrayChild(
Expand Down Expand Up @@ -354,10 +353,20 @@ export default class GitHubActionsReporter extends BaseReporter {
}
const spaces = ' '.repeat(numberSpaces);
let resultSymbol;
if (resultTree.passed) {
resultSymbol = chalk.green('\u2713');
} else {
resultSymbol = chalk.red('\u00D7');
switch (resultTree.passed) {
case 'passed':
resultSymbol = chalk.green(ICONS.success);
break;
case 'failed':
resultSymbol = chalk.red(ICONS.failed);
break;
case 'todo':
resultSymbol = chalk.magenta(ICONS.todo);
break;
case 'pending':
case 'skipped':
resultSymbol = chalk.yellow(ICONS.pending);
break;
}
this.log(
`${spaces + resultSymbol} ${resultTree.name} (${
Expand Down
155 changes: 146 additions & 9 deletions packages/jest-reporters/src/__tests__/GitHubActionsReporter.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,25 @@
import type {
AggregatedResult,
AssertionResult,
Status,
Test,
TestCaseResult,
TestResult,
} from '@jest/test-result';
import type {Config} from '@jest/types';
import GitHubActionsReporter from '../GitHubActionsReporter';
import {normalizeIcons} from '../../../../e2e/Utils';
import BaseGitHubActionsReporter from '../GitHubActionsReporter';

afterEach(() => {
jest.clearAllMocks();
});

class GitHubActionsReporter extends BaseGitHubActionsReporter {
override log(message: string): void {
super.log(normalizeIcons(message));
}
}

const mockedStderrWrite = jest
.spyOn(process.stderr, 'write')
.mockImplementation(() => true);
Expand Down Expand Up @@ -174,7 +182,7 @@ describe('logs', () => {
children: [],
duration: 10,
name: 'test',
passed: false,
passed: 'failed',
},
],
name: '/',
Expand Down Expand Up @@ -217,7 +225,7 @@ describe('logs', () => {
children: [],
duration: 10,
name: 'test',
passed: true,
passed: 'passed',
},
],
name: '/',
Expand Down Expand Up @@ -262,7 +270,7 @@ describe('logs', () => {
children: [],
duration: 10,
name: 'test',
passed: false,
passed: 'failed',
},
],
name: 'Test describe',
Expand Down Expand Up @@ -311,7 +319,68 @@ describe('logs', () => {
children: [],
duration: 10,
name: 'test',
passed: true,
passed: 'passed',
},
],
name: 'Test describe',
passed: true,
},
],
name: '/',
passed: true,
performanceInfo: {
end: 30,
runtime: 20,
slow: false,
start: 10,
},
};
const gha = new GitHubActionsReporter({} as Config.GlobalConfig, {
silent: false,
});

const generated = gha['getResultTree'](testResults, '/', suitePerf);

expect(mockedStderrWrite).not.toHaveBeenCalled();
expect(generated).toEqual(expectedResults);
});

test('skipped single test and todo single test inside describe', () => {
const testResults = [
{
ancestorTitles: ['Test describe'],
duration: 10,
status: 'skipped',
title: 'test',
},
{
ancestorTitles: ['Test describe'],
duration: 14,
status: 'todo',
title: 'test2',
},
] as unknown as Array<AssertionResult>;
const suitePerf = {
end: 30,
runtime: 20,
slow: false,
start: 10,
};
const expectedResults = {
children: [
{
children: [
{
children: [],
duration: 10,
name: 'test',
passed: 'skipped',
},
{
children: [],
duration: 14,
name: 'test2',
passed: 'todo',
},
],
name: 'Test describe',
Expand Down Expand Up @@ -346,7 +415,7 @@ describe('logs', () => {
children: [],
duration: 10,
name: 'test',
passed: false,
passed: 'failed' as Status,
},
],
name: '/',
Expand Down Expand Up @@ -374,7 +443,7 @@ describe('logs', () => {
children: [],
duration: 10,
name: 'test',
passed: true,
passed: 'passed' as Status,
},
],
name: '/',
Expand Down Expand Up @@ -404,7 +473,7 @@ describe('logs', () => {
children: [],
duration: 10,
name: 'test',
passed: false,
passed: 'failed' as Status,
},
],
name: 'Test describe',
Expand Down Expand Up @@ -438,7 +507,75 @@ describe('logs', () => {
children: [],
duration: 10,
name: 'test',
passed: true,
passed: 'passed' as Status,
},
],
name: 'Test describe',
passed: true,
},
],
name: '/',
passed: true,
performanceInfo: {
end: 30,
runtime: 20,
slow: false,
start: 10,
},
};
const gha = new GitHubActionsReporter({} as Config.GlobalConfig, {
silent: false,
});

gha['printResultTree'](generatedTree);

expect(mockedStderrWrite.mock.calls).toMatchSnapshot();
});

test('todo single test inside describe', () => {
const generatedTree = {
children: [
{
children: [
{
children: [],
duration: 10,
name: 'test',
passed: 'todo' as Status,
},
],
name: 'Test describe',
passed: true,
},
],
name: '/',
passed: true,
performanceInfo: {
end: 30,
runtime: 20,
slow: false,
start: 10,
},
};
const gha = new GitHubActionsReporter({} as Config.GlobalConfig, {
silent: false,
});

gha['printResultTree'](generatedTree);

expect(mockedStderrWrite.mock.calls).toMatchSnapshot();
});

test('skipped single test inside describe', () => {
const generatedTree = {
children: [
{
children: [
{
children: [],
duration: 10,
name: 'test',
passed: 'skipped' as Status,
},
],
name: 'Test describe',
Expand Down
Loading

0 comments on commit c3afed2

Please sign in to comment.