Skip to content

Add new default reporter for github actions #13626

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

Merged
SimenB merged 20 commits into from
Jan 26, 2023
Merged

Add new default reporter for github actions #13626

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
d300a4d
Port implementation for Github Actions logs folding
MatteoH2O1999 Nov 22, 2022
10bada4
Update thrown error
MatteoH2O1999 Nov 24, 2022
c8f6113
Override log to ensure \n after each call
MatteoH2O1999 Nov 24, 2022
b135cbe
Ensure parent methods do nothing
MatteoH2O1999 Nov 24, 2022
927e062
Update header and copied from
MatteoH2O1999 Nov 24, 2022
1480f63
Update CHANGELOG.md
MatteoH2O1999 Nov 24, 2022
d9ed774
Add unit tests
MatteoH2O1999 Nov 24, 2022
9004e0f
Add unit tests for new default reporter
MatteoH2O1999 Nov 24, 2022
560e072
Remove log override from class and relative test correction
MatteoH2O1999 Dec 12, 2022
2f14b3f
Fix import from src folder
MatteoH2O1999 Dec 12, 2022
3d7f86f
Update CHANGELOG.md
MatteoH2O1999 Jan 10, 2023
08609a3
Update with new spec
MatteoH2O1999 Jan 10, 2023
146a9e0
Update documentation
MatteoH2O1999 Jan 10, 2023
82fb3b5
Hide internals and add silent option
MatteoH2O1999 Jan 10, 2023
1f2c3e6
Update type CamelCase and fix silent option
MatteoH2O1999 Jan 10, 2023
266974b
Update silent option
MatteoH2O1999 Jan 10, 2023
6d57199
Merge test files and update snapshots
MatteoH2O1999 Jan 10, 2023
f7ea251
Flip silent default value and fix worker shutdown
MatteoH2O1999 Jan 17, 2023
7cb3b3f
Merge branch 'main' into gha_logs
SimenB Jan 26, 2023
1c12eb3
move changelog entry and copy doc change
SimenB Jan 26, 2023
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
Prev Previous commit
Next Next commit
Update silent option
  • Loading branch information
@MatteoH2O1999
MatteoH2O1999 committed Jan 17, 2023
commit 266974bb02a9bc82ea710b967e0da30524b59def
31 changes: 14 additions & 17 deletions packages/jest-reporters/src/GitHubActionsReporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,19 +62,14 @@ type ResultTree = {

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

constructor(
_globalConfig: Config.GlobalConfig,
reporterOptions: Record<string, unknown> = {silent: false},
reporterOptions: {silent?: boolean} = {silent: false},
) {
super();
const silentOption = reporterOptions.silent;
if (silentOption !== null && silentOption !== undefined) {
this.silent = silentOption as boolean;
} else {
this.silent = false;
}
this.options = {silent: reporterOptions.silent || false};
}

override onTestResult(
Expand All @@ -83,19 +78,18 @@ export default class GitHubActionsReporter extends BaseReporter {
aggregatedResults: AggregatedResult,
): void {
this.generateAnnotations(test, testResult);
if (this.silent) {
return;
if (!this.options.silent) {
this.printFullResult(test.context, testResult);
}
this.printFullResult(test.context, testResult);
if (this.isLastTestSuite(aggregatedResults)) {
this.log('');
if (this.printFailedTestLogs(test, aggregatedResults)) {
this.log('');
}
this.printFailedTestLogs(test, aggregatedResults);
}
}

generateAnnotations({context}: Test, {testResults}: TestResult): void {
private generateAnnotations(
{context}: Test,
{testResults}: TestResult,
): void {
testResults.forEach(result => {
const title = [...result.ancestorTitles, result.title].join(
titleSeparator,
Expand Down Expand Up @@ -402,7 +396,10 @@ export default class GitHubActionsReporter extends BaseReporter {
testDir = testDir.replace(rootDir, '');
testDir = testDir.slice(1, testDir.length);
if (result.failureMessage) {
written = true;
if (!written) {
this.log('');
written = true;
}
this.startGroup(`Errors thrown in ${testDir}`);
this.log(result.failureMessage);
this.endGroup();
Expand Down