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

feat: reformat human readable output for test results #377

Closed
wants to merge 10 commits into from
Closed

feat: reformat human readable output for test results #377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9e1d7e0
feat: move summary to bottom of output got human test reporter
k-capehart Jun 10, 2024
fe20941
feat: add verbose parameter to denote when to display passing tests
k-capehart Jun 11, 2024
f4e3095
test: add unit test for verbose paramter
k-capehart Jun 11, 2024
6dbbd10
refactor: implement updates based on feedback
k-capehart Jun 18, 2024
d2f5c08
fix: move summary to bottom of output for humanTransformer
k-capehart Jun 18, 2024
9427dbe
fix: remove log statement
k-capehart Jun 18, 2024
f6bc076
feat: only show coverage table if concise is false, add tests for hum…
k-capehart Jun 19, 2024
2651f05
fix: output needs a default string value, was ouputting 'undefined'
k-capehart Jun 19, 2024
9bcdb34
fix: 'undefined' being printed when tables are empty
k-capehart Jun 19, 2024
f95a88f
Merge branch 'main' into reformat-test-reporter
peternhale Jun 20, 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
161 changes: 93 additions & 68 deletions src/reporters/humanFormatTransform.ts
View file
Open in desktop
peternhale marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@ export class HumanFormatTransform extends Readable {
constructor(
private readonly testResult: TestResult,
private readonly detailedCoverage: boolean,
private readonly concise: boolean = false,
options?: ReadableOptions
) {
super(options);
this.testResult = testResult;
this.detailedCoverage ??= false;
this.concise = concise;
this.logger = Logger.childFromRoot('HumanFormatTransform');
}

Expand All @@ -45,7 +47,6 @@ export class HumanFormatTransform extends Readable {

@elapsedTime()
public format(): void {
this.formatSummary();
if (!this.testResult.codecoverage || !this.detailedCoverage) {
this.formatTestResults();
}
Expand All @@ -54,8 +55,11 @@ export class HumanFormatTransform extends Readable {
if (this.detailedCoverage) {
this.formatDetailedCov();
}
this.formatCodeCov();
if (!this.concise) {
this.formatCodeCov();
}
}
this.formatSummary();
}

@elapsedTime()
Expand Down Expand Up @@ -110,6 +114,7 @@ export class HumanFormatTransform extends Readable {
: [])
];

this.push(`${EOL}${EOL}`);
tb.createTable(
summaryRowArray,
[
Expand All @@ -135,93 +140,113 @@ export class HumanFormatTransform extends Readable {
runTime: number;
stackTrace: string | null;
}) => {
const msg = elem.stackTrace
? `${elem.message}\n${elem.stackTrace}`
: elem.message;
if (
!this.concise ||
elem.outcome === ApexTestResultOutcome.Fail ||
elem.outcome === ApexTestResultOutcome.CompileFail
) {
const msg = elem.stackTrace
? `${elem.message}\n${elem.stackTrace}`
: elem.message;

testRowArray.push({
name: elem.fullName,
outcome: elem.outcome,
msg: elem.message ? msg : '',
runtime:
elem.outcome !== ApexTestResultOutcome.Fail ? `${elem.runTime}` : ''
});
testRowArray.push({
name: elem.fullName,
outcome: elem.outcome,
msg: elem.message ? msg : '',
runtime:
elem.outcome !== ApexTestResultOutcome.Fail
? `${elem.runTime}`
: ''
});
}
}
);

this.push(`${EOL}${EOL}`);
tb.createTable(
testRowArray,
[
{
key: 'name',
label: nls.localize('testNameColHeader')
},
{ key: 'outcome', label: nls.localize('outcomeColHeader') },
{ key: 'msg', label: nls.localize('msgColHeader') },
{ key: 'runtime', label: nls.localize('runtimeColHeader') }
],
nls.localize('testResultsHeader')
);
if (testRowArray.length > 0) {
this.push(`${EOL}${EOL}`);
tb.createTable(
testRowArray,
[
{
key: 'name',
label: nls.localize('testNameColHeader')
},
{ key: 'outcome', label: nls.localize('outcomeColHeader') },
{ key: 'msg', label: nls.localize('msgColHeader') },
{ key: 'runtime', label: nls.localize('runtimeColHeader') }
],
nls.localize('testResultsHeader')
);
}
}

@elapsedTime()
private formatDetailedCov(): void {
const tb = new TableWriteableStream(this);
const testRowArray: Row[] = [];
this.testResult.tests.forEach((elem: ApexTestResultData) => {
const msg = elem.stackTrace
? `${elem.message}\n${elem.stackTrace}`
: elem.message;
if (
!this.concise ||
elem.outcome === ApexTestResultOutcome.Fail ||
elem.outcome === ApexTestResultOutcome.CompileFail
) {
const msg = elem.stackTrace
? `${elem.message}\n${elem.stackTrace}`
: elem.message;

if (elem.perClassCoverage) {
elem.perClassCoverage.forEach((perClassCov) => {
if (elem.perClassCoverage) {
elem.perClassCoverage.forEach((perClassCov) => {
testRowArray.push({
name: elem.fullName,
coveredClassName: perClassCov.apexClassOrTriggerName,
outcome: elem.outcome,
coveredClassPercentage: perClassCov.percentage,
msg: elem.message ? msg : '',
runtime: `${elem.runTime}`
});
});
} else {
testRowArray.push({
name: elem.fullName,
coveredClassName: perClassCov.apexClassOrTriggerName,
coveredClassName: '',
outcome: elem.outcome,
coveredClassPercentage: perClassCov.percentage,
coveredClassPercentage: '',
peternhale marked this conversation as resolved.
Show resolved Hide resolved
msg: elem.message ? msg : '',
runtime: `${elem.runTime}`
});
});
} else {
testRowArray.push({
name: elem.fullName,
coveredClassName: '',
outcome: elem.outcome,
coveredClassPercentage: '',
msg: elem.message ? msg : '',
runtime: `${elem.runTime}`
});
}
}
});

this.push(os.EOL.repeat(2));
tb.createTable(
testRowArray,
[
{
key: 'name',
label: nls.localize('testNameColHeader')
},
{
key: 'coveredClassName',
label: nls.localize('classTestedHeader')
},
{
key: 'outcome',
label: nls.localize('outcomeColHeader')
},
{
key: 'coveredClassPercentage',
label: nls.localize('percentColHeader')
},
{ key: 'msg', label: nls.localize('msgColHeader') },
{ key: 'runtime', label: nls.localize('runtimeColHeader') }
],
nls.localize('detailedCodeCovHeader', [this.testResult.summary.testRunId])
);
if (testRowArray.length > 0) {
this.push(os.EOL.repeat(2));
tb.createTable(
testRowArray,
[
{
key: 'name',
label: nls.localize('testNameColHeader')
},
{
key: 'coveredClassName',
label: nls.localize('classTestedHeader')
},
{
key: 'outcome',
label: nls.localize('outcomeColHeader')
},
{
key: 'coveredClassPercentage',
label: nls.localize('percentColHeader')
},
{ key: 'msg', label: nls.localize('msgColHeader') },
{ key: 'runtime', label: nls.localize('runtimeColHeader') }
],
nls.localize('detailedCodeCovHeader', [
this.testResult.summary.testRunId
])
);
}
}

@elapsedTime('elapsedTime', LoggerLevel.TRACE)
Expand Down
Loading