-
Notifications
You must be signed in to change notification settings - Fork 29.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test_runner: add support for coverage thresholds
Co-Authored-By: Marco Ippolito <[email protected]> PR-URL: #54429 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>
- Loading branch information
Showing
7 changed files
with
207 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
'use strict'; | ||
const common = require('../common'); | ||
const assert = require('node:assert'); | ||
const { spawnSync } = require('node:child_process'); | ||
const { readdirSync } = require('node:fs'); | ||
const { test } = require('node:test'); | ||
const fixtures = require('../common/fixtures'); | ||
const tmpdir = require('../common/tmpdir'); | ||
|
||
common.skipIfInspectorDisabled(); | ||
tmpdir.refresh(); | ||
|
||
function findCoverageFileForPid(pid) { | ||
const pattern = `^coverage\\-${pid}\\-(\\d{13})\\-(\\d+)\\.json$`; | ||
const regex = new RegExp(pattern); | ||
|
||
return readdirSync(tmpdir.path).find((file) => { | ||
return regex.test(file); | ||
}); | ||
} | ||
|
||
function getTapCoverageFixtureReport() { | ||
/* eslint-disable @stylistic/js/max-len */ | ||
const report = [ | ||
'# start of coverage report', | ||
'# -------------------------------------------------------------------------------------------------------------------', | ||
'# file | line % | branch % | funcs % | uncovered lines', | ||
'# -------------------------------------------------------------------------------------------------------------------', | ||
'# test/fixtures/test-runner/coverage.js | 78.65 | 38.46 | 60.00 | 12-13 16-22 27 39 43-44 61-62 66-67 71-72', | ||
'# test/fixtures/test-runner/invalid-tap.js | 100.00 | 100.00 | 100.00 | ', | ||
'# test/fixtures/v8-coverage/throw.js | 71.43 | 50.00 | 100.00 | 5-6', | ||
'# -------------------------------------------------------------------------------------------------------------------', | ||
'# all files | 78.35 | 43.75 | 60.00 |', | ||
'# -------------------------------------------------------------------------------------------------------------------', | ||
'# end of coverage report', | ||
].join('\n'); | ||
/* eslint-enable @stylistic/js/max-len */ | ||
|
||
if (common.isWindows) { | ||
return report.replaceAll('/', '\\'); | ||
} | ||
|
||
return report; | ||
} | ||
|
||
const fixture = fixtures.path('test-runner', 'coverage.js'); | ||
const neededArguments = [ | ||
'--experimental-test-coverage', | ||
'--test-reporter', 'tap', | ||
]; | ||
|
||
const coverages = [ | ||
{ flag: '--test-coverage-lines', name: 'line', actual: 78.35 }, | ||
{ flag: '--test-coverage-functions', name: 'function', actual: 60.00 }, | ||
{ flag: '--test-coverage-branches', name: 'branch', actual: 43.75 }, | ||
]; | ||
|
||
for (const coverage of coverages) { | ||
test(`test passing ${coverage.flag}`, async (t) => { | ||
const result = spawnSync(process.execPath, [ | ||
...neededArguments, | ||
`${coverage.flag}=25`, | ||
fixture, | ||
]); | ||
|
||
const stdout = result.stdout.toString(); | ||
assert(stdout.includes(getTapCoverageFixtureReport())); | ||
assert.doesNotMatch(stdout, RegExp(`Error: [\\d\\.]+% ${coverage.name} coverage`)); | ||
assert.strictEqual(result.status, 0); | ||
assert(!findCoverageFileForPid(result.pid)); | ||
}); | ||
|
||
test(`test failing ${coverage.flag}`, async (t) => { | ||
const result = spawnSync(process.execPath, [ | ||
...neededArguments, | ||
`${coverage.flag}=99`, | ||
fixture, | ||
]); | ||
|
||
const stdout = result.stdout.toString(); | ||
assert(stdout.includes(getTapCoverageFixtureReport())); | ||
assert.match(stdout, RegExp(`Error: ${coverage.actual.toFixed(2)}% ${coverage.name} coverage does not meet threshold of 99%`)); | ||
assert.strictEqual(result.status, 1); | ||
assert(!findCoverageFileForPid(result.pid)); | ||
}); | ||
|
||
test(`test out-of-range ${coverage.flag} (too high)`, async (t) => { | ||
const result = spawnSync(process.execPath, [ | ||
...neededArguments, | ||
`${coverage.flag}=101`, | ||
fixture, | ||
]); | ||
|
||
assert.match(result.stderr.toString(), RegExp(`The value of "${coverage.flag}`)); | ||
assert.strictEqual(result.status, 1); | ||
assert(!findCoverageFileForPid(result.pid)); | ||
}); | ||
|
||
test(`test out-of-range ${coverage.flag} (too low)`, async (t) => { | ||
const result = spawnSync(process.execPath, [ | ||
...neededArguments, | ||
`${coverage.flag}=-1`, | ||
fixture, | ||
]); | ||
|
||
assert.match(result.stderr.toString(), RegExp(`The value of "${coverage.flag}`)); | ||
assert.strictEqual(result.status, 1); | ||
assert(!findCoverageFileForPid(result.pid)); | ||
}); | ||
} |