Skip to content

Commit

Permalink
Hide internals and add silent option
Browse files Browse the repository at this point in the history
  • Loading branch information
@MatteoH2O1999
MatteoH2O1999 committed Jan 10, 2023
1 parent e4a8508 commit c964cb6
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 47 deletions.
6 changes: 3 additions & 3 deletions docs/Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1278,12 +1278,12 @@ export default config;

#### GitHub Actions Reporter

If included in the list, the built-in GitHub Actions Reporter will annotate changed files with test failure messages and print logs with github group features for easy navigation. Note that `'default'` should not be used in this case as `'github-actions'` will handle that already, so remember to also include `'summary'`:
If included in the list, the built-in GitHub Actions Reporter will annotate changed files with test failure messages and print logs with github group features for easy navigation. Note that `'default'` should not be used in this case as `'github-actions'` will handle that already, so remember to also include `'summary'`. If you wish to use it only for annotations simply pass `'silent: true'` as option (default is `false`):

```js tab
/** @type {import('jest').Config} */
const config = {
reporters: ['github-actions', 'summary'],
reporters: [['github-actions', {silent: false}], 'summary'],
};

module.exports = config;
Expand All @@ -1293,7 +1293,7 @@ module.exports = config;
import type {Config} from 'jest';

const config: Config = {
reporters: ['github-actions', 'summary'],
reporters: [['github-actions', {silent: false}], 'summary'],
};

export default config;
Expand Down
96 changes: 60 additions & 36 deletions packages/jest-reporters/src/GitHubActionsReporter.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,40 @@ type resultTree = {

export default class GitHubActionsReporter extends BaseReporter {
static readonly filename = __filename;
private readonly silent: boolean;

constructor(
_globalConfig: Config.GlobalConfig,
reporterOptions: Config.ReporterConfig,
) {
super();
if (reporterOptions === null || reporterOptions === undefined) {
reporterOptions = ['github-actions', {silent: false}];
}
let options = reporterOptions[1];
if (options === null || options === undefined) {
options = {silent: false};
}
const silentOption = options.silent;
if (silentOption !== null && silentOption !== undefined) {
this.silent = silentOption as boolean;
} else {
this.silent = false;
}
}

override onTestResult(
test: Test,
testResult: TestResult,
aggregatedResults: AggregatedResult,
): void {
this.__printFullResult(test.context, testResult);
if (this.__isLastTestSuite(aggregatedResults)) {
if (this.silent) {
return;
}
this.printFullResult(test.context, testResult);
if (this.isLastTestSuite(aggregatedResults)) {
this.log('');
if (this.__printFailedTestLogs(test, aggregatedResults)) {
if (this.printFailedTestLogs(test, aggregatedResults)) {
this.log('');
}
}
Expand Down Expand Up @@ -130,7 +154,7 @@ export default class GitHubActionsReporter extends BaseReporter {
);
}

__isLastTestSuite(results: AggregatedResult): boolean {
private isLastTestSuite(results: AggregatedResult): boolean {
const passedTestSuites = results.numPassedTestSuites;
const failedTestSuites = results.numFailedTestSuites;
const totalTestSuites = results.numTotalTestSuites;
Expand All @@ -146,19 +170,19 @@ export default class GitHubActionsReporter extends BaseReporter {
}
}

__printFullResult(context: TestContext, results: TestResult): void {
private printFullResult(context: TestContext, results: TestResult): void {
const rootDir = context.config.rootDir;
let testDir = results.testFilePath.replace(rootDir, '');
testDir = testDir.slice(1, testDir.length);
const resultTree = this.__getResultTree(
const resultTree = this.getResultTree(
results.testResults,
testDir,
results.perfStats,
);
this.__printResultTree(resultTree);
this.printResultTree(resultTree);
}

__arrayEqual(a1: Array<any>, a2: Array<any>): boolean {
private arrayEqual(a1: Array<any>, a2: Array<any>): boolean {
if (a1.length !== a2.length) {
return false;
}
Expand All @@ -171,7 +195,7 @@ export default class GitHubActionsReporter extends BaseReporter {
return true;
}

__arrayChild(a1: Array<any>, a2: Array<any>): boolean {
private arrayChild(a1: Array<any>, a2: Array<any>): boolean {
if (a1.length - a2.length !== 1) {
return false;
}
Expand All @@ -184,7 +208,7 @@ export default class GitHubActionsReporter extends BaseReporter {
return true;
}

__getResultTree(
private getResultTree(
suiteResult: Array<AssertionResult>,
testPath: string,
suitePerf: performaceInfo,
Expand Down Expand Up @@ -216,10 +240,7 @@ export default class GitHubActionsReporter extends BaseReporter {
let alreadyInserted = false;
for (let index = 0; index < branches.length; index++) {
if (
this.__arrayEqual(
branches[index],
element.ancestorTitles.slice(0, 1),
)
this.arrayEqual(branches[index], element.ancestorTitles.slice(0, 1))
) {
alreadyInserted = true;
break;
Expand All @@ -231,7 +252,7 @@ export default class GitHubActionsReporter extends BaseReporter {
}
});
branches.forEach(element => {
const newChild = this.__getResultChildren(suiteResult, element);
const newChild = this.getResultChildren(suiteResult, element);
if (!newChild.passed) {
root.passed = false;
}
Expand All @@ -240,7 +261,7 @@ export default class GitHubActionsReporter extends BaseReporter {
return root;
}

__getResultChildren(
private getResultChildren(
suiteResult: Array<AssertionResult>,
ancestors: Array<string>,
): resultTreeNode {
Expand All @@ -256,7 +277,7 @@ export default class GitHubActionsReporter extends BaseReporter {
if (!duration || isNaN(duration)) {
duration = 1;
}
if (this.__arrayEqual(element.ancestorTitles, ancestors)) {
if (this.arrayEqual(element.ancestorTitles, ancestors)) {
if (element.status !== 'passed') {
node.passed = false;
passed = false;
Expand All @@ -268,15 +289,15 @@ export default class GitHubActionsReporter extends BaseReporter {
passed,
});
} else if (
this.__arrayChild(
this.arrayChild(
element.ancestorTitles.slice(0, ancestors.length + 1),
ancestors,
)
) {
let alreadyInserted = false;
for (let index = 0; index < branches.length; index++) {
if (
this.__arrayEqual(
this.arrayEqual(
branches[index],
element.ancestorTitles.slice(0, ancestors.length + 1),
)
Expand All @@ -291,7 +312,7 @@ export default class GitHubActionsReporter extends BaseReporter {
}
});
branches.forEach(element => {
const newChild = this.__getResultChildren(suiteResult, element);
const newChild = this.getResultChildren(suiteResult, element);
if (!newChild.passed) {
node.passed = false;
}
Expand All @@ -300,7 +321,7 @@ export default class GitHubActionsReporter extends BaseReporter {
return node;
}

__printResultTree(resultTree: resultTree): void {
private printResultTree(resultTree: resultTree): void {
let perfMs;
if (resultTree.performanceInfo.slow) {
perfMs = ` (${chalk.red.inverse(
Expand All @@ -310,24 +331,24 @@ export default class GitHubActionsReporter extends BaseReporter {
perfMs = ` (${resultTree.performanceInfo.runtime} ms)`;
}
if (resultTree.passed) {
this.__startGroup(
this.startGroup(
`${chalk.bold.green.inverse('PASS')} ${resultTree.name}${perfMs}`,
);
resultTree.children.forEach(child => {
this.__recursivePrintResultTree(child, true, 1);
this.recursivePrintResultTree(child, true, 1);
});
this.__endGroup();
this.endGroup();
} else {
this.log(
` ${chalk.bold.red.inverse('FAIL')} ${resultTree.name}${perfMs}`,
);
resultTree.children.forEach(child => {
this.__recursivePrintResultTree(child, false, 1);
this.recursivePrintResultTree(child, false, 1);
});
}
}

__recursivePrintResultTree(
private recursivePrintResultTree(
resultTree: resultTreeNode | resultTreeLeaf,
alreadyGrouped: boolean,
depth: number,
Expand Down Expand Up @@ -357,25 +378,28 @@ export default class GitHubActionsReporter extends BaseReporter {
if (alreadyGrouped) {
this.log(' '.repeat(depth) + resultTree.name);
resultTree.children.forEach(child => {
this.__recursivePrintResultTree(child, true, depth + 1);
this.recursivePrintResultTree(child, true, depth + 1);
});
} else {
this.__startGroup(' '.repeat(depth) + resultTree.name);
this.startGroup(' '.repeat(depth) + resultTree.name);
resultTree.children.forEach(child => {
this.__recursivePrintResultTree(child, true, depth + 1);
this.recursivePrintResultTree(child, true, depth + 1);
});
this.__endGroup();
this.endGroup();
}
} else {
this.log(' '.repeat(depth + 1) + resultTree.name);
resultTree.children.forEach(child => {
this.__recursivePrintResultTree(child, false, depth + 1);
this.recursivePrintResultTree(child, false, depth + 1);
});
}
}
}

__printFailedTestLogs(context: Test, testResults: AggregatedResult): boolean {
private printFailedTestLogs(
context: Test,
testResults: AggregatedResult,
): boolean {
const rootDir = context.context.config.rootDir;
const results = testResults.testResults;
let written = false;
Expand All @@ -385,19 +409,19 @@ export default class GitHubActionsReporter extends BaseReporter {
testDir = testDir.slice(1, testDir.length);
if (result.failureMessage) {
written = true;
this.__startGroup(`Errors thrown in ${testDir}`);
this.startGroup(`Errors thrown in ${testDir}`);
this.log(result.failureMessage);
this.__endGroup();
this.endGroup();
}
});
return written;
}

__startGroup(title: string): void {
private startGroup(title: string): void {
this.log(`::group::${title}`);
}

__endGroup(): void {
private endGroup(): void {
this.log('::endgroup::');
}
}
16 changes: 8 additions & 8 deletions packages/jest-reporters/src/__tests__/GithubActionsLogsReporter.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ describe('Result tree generation', () => {
};
const gha = new GhaReporter();

const generated = gha.__getResultTree(testResults, '/', suitePerf);
const generated = gha.getResultTree(testResults, '/', suitePerf);

expect(consoleLog).toBe('');
expect(generated).toEqual(expectedResults);
Expand Down Expand Up @@ -104,7 +104,7 @@ describe('Result tree generation', () => {
};
const gha = new GhaReporter();

const generated = gha.__getResultTree(testResults, '/', suitePerf);
const generated = gha.getResultTree(testResults, '/', suitePerf);

expect(consoleLog).toBe('');
expect(generated).toEqual(expectedResults);
Expand Down Expand Up @@ -148,7 +148,7 @@ describe('Result tree generation', () => {
};
const gha = new GhaReporter();

const generated = gha.__getResultTree(testResults, '/', suitePerf);
const generated = gha.getResultTree(testResults, '/', suitePerf);

expect(consoleLog).toBe('');
expect(generated).toEqual(expectedResults);
Expand Down Expand Up @@ -192,7 +192,7 @@ describe('Result tree generation', () => {
};
const gha = new GhaReporter();

const generated = gha.__getResultTree(testResults, '/', suitePerf);
const generated = gha.getResultTree(testResults, '/', suitePerf);

expect(consoleLog).toBe('');
expect(generated).toEqual(expectedResults);
Expand Down Expand Up @@ -223,7 +223,7 @@ describe('Result tree output', () => {
)} / (20 ms) ${chalk.red(xSymbol)} test (10 ms)`;
const gha = new GhaReporter();

gha.__printResultTree(generatedTree);
gha.printResultTree(generatedTree);

expect(consoleLog).toEqual(expectedOutput);
});
Expand Down Expand Up @@ -251,7 +251,7 @@ describe('Result tree output', () => {
)} / (20 ms) ${chalk.green(ySymbol)} test (10 ms)::endgroup::`;
const gha = new GhaReporter();

gha.__printResultTree(generatedTree);
gha.printResultTree(generatedTree);

expect(consoleLog).toEqual(expectedOutput);
});
Expand Down Expand Up @@ -286,7 +286,7 @@ describe('Result tree output', () => {
` ${chalk.red(xSymbol)} test (10 ms)`;
const gha = new GhaReporter();

gha.__printResultTree(generatedTree);
gha.printResultTree(generatedTree);

expect(consoleLog).toEqual(expectedOutput);
});
Expand Down Expand Up @@ -322,7 +322,7 @@ describe('Result tree output', () => {
'::endgroup::';
const gha = new GhaReporter();

gha.__printResultTree(generatedTree);
gha.printResultTree(generatedTree);

expect(consoleLog).toEqual(expectedOutput);
});
Expand Down

0 comments on commit c964cb6

Please sign in to comment.