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.

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

test_runner: report coverage thresholds in test:coverage #54813

Merged
merged 3 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
5 changes: 5 additions & 0 deletions doc/api/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -2814,6 +2814,11 @@ are defined, while others are emitted in the order that the tests execute.
numbers and the number of times they were covered.
* `line` {number} The line number.
* `count` {number} The number of times the line was covered.
* `thresholds` {Object} An object containing whether or not the coverage for
RedYetiDev marked this conversation as resolved.
Show resolved Hide resolved
each coverage type.
* `function` {number} The user-specified `function` threshold value.
* `branch` {number} The user-specified `branch` threshold value.
* `line` {number} The user-specified `line` threshold value.
RedYetiDev marked this conversation as resolved.
Show resolved Hide resolved
* `totals` {Object} An object containing a summary of coverage for all
files.
* `totalLineCount` {number} The total number of lines.
Expand Down
6 changes: 4 additions & 2 deletions lib/internal/test_runner/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -1010,8 +1010,6 @@ class Test extends AsyncResource {
reporter.diagnostic(nesting, loc, `duration_ms ${this.duration()}`);

if (coverage) {
reporter.coverage(nesting, loc, coverage);

const coverages = [
{ __proto__: null, actual: coverage.totals.coveredLinePercent,
threshold: this.config.lineCoverage, name: 'line' },
Expand All @@ -1023,13 +1021,17 @@ class Test extends AsyncResource {
threshold: this.config.functionCoverage, name: 'function' },
];

coverage.thresholds = { __proto__: null };
RedYetiDev marked this conversation as resolved.
Show resolved Hide resolved
for (let i = 0; i < coverages.length; i++) {
const { threshold, actual, name } = coverages[i];
coverage.thresholds[name] = threshold;
if (actual < threshold) {
process.exitCode = kGenericUserError;
reporter.diagnostic(nesting, loc, `Error: ${NumberPrototypeToFixed(actual, 2)}% ${name} coverage does not meet threshold of ${threshold}%.`);
}
}

reporter.coverage(nesting, loc, coverage);
}

if (harness.watching) {
Expand Down
57 changes: 45 additions & 12 deletions test/parallel/test-runner-coverage-thresholds.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,7 @@ function getTapCoverageFixtureReport() {
}

const fixture = fixtures.path('test-runner', 'coverage.js');
const neededArguments = [
'--experimental-test-coverage',
'--test-reporter', 'tap',
];
const reporter = fixtures.fileURL('test-runner/custom_reporters/coverage.mjs');

const coverages = [
{ flag: '--test-coverage-lines', name: 'line', actual: 78.35 },
Expand All @@ -56,10 +53,12 @@ const coverages = [
];

for (const coverage of coverages) {
test(`test passing ${coverage.flag}`, async (t) => {
test(`test passing ${coverage.flag}`, () => {
const result = spawnSync(process.execPath, [
...neededArguments,
'--test',
'--experimental-test-coverage',
`${coverage.flag}=25`,
'--test-reporter', 'tap',
fixture,
]);

Expand All @@ -70,10 +69,27 @@ for (const coverage of coverages) {
assert(!findCoverageFileForPid(result.pid));
});

test(`test failing ${coverage.flag}`, async (t) => {
test(`test passing ${coverage.flag} with custom reporter`, () => {
const result = spawnSync(process.execPath, [
'--test',
'--experimental-test-coverage',
`${coverage.flag}=25`,
'--test-reporter', reporter,
fixture,
]);

const stdout = JSON.parse(result.stdout.toString());
assert.strictEqual(stdout.summary.thresholds[coverage.name], 25);
assert.strictEqual(result.status, 0);
assert(!findCoverageFileForPid(result.pid));
});

test(`test failing ${coverage.flag}`, () => {
const result = spawnSync(process.execPath, [
...neededArguments,
'--test',
'--experimental-test-coverage',
`${coverage.flag}=99`,
'--test-reporter', 'tap',
fixture,
]);

Expand All @@ -84,9 +100,25 @@ for (const coverage of coverages) {
assert(!findCoverageFileForPid(result.pid));
});

test(`test out-of-range ${coverage.flag} (too high)`, async (t) => {
test(`test failing ${coverage.flag} with custom reporter`, () => {
const result = spawnSync(process.execPath, [
'--test',
'--experimental-test-coverage',
`${coverage.flag}=99`,
'--test-reporter', reporter,
fixture,
]);

const stdout = JSON.parse(result.stdout.toString());
assert.strictEqual(stdout.summary.thresholds[coverage.name], 99);
assert.strictEqual(result.status, 1);
assert(!findCoverageFileForPid(result.pid));
});

test(`test out-of-range ${coverage.flag} (too high)`, () => {
const result = spawnSync(process.execPath, [
...neededArguments,
'--test',
'--experimental-test-coverage',
`${coverage.flag}=101`,
fixture,
]);
Expand All @@ -96,9 +128,10 @@ for (const coverage of coverages) {
assert(!findCoverageFileForPid(result.pid));
});

test(`test out-of-range ${coverage.flag} (too low)`, async (t) => {
test(`test out-of-range ${coverage.flag} (too low)`, () => {
const result = spawnSync(process.execPath, [
...neededArguments,
'--test',
'--experimental-test-coverage',
`${coverage.flag}=-1`,
fixture,
]);
Expand Down
Loading