bermudalamb
332c1e7cd0
SonarQube reported 0% coverage for 78 unit, 134 integration and 83 end-to-end tests, so the coverage-on-new-code gate — the most useful thing SonarQube offers a project this size — has been failing permanently while looking configured. It now reports 69.6%, verified by a real scan. Backend coverage comes from both suites, written to separate directories because jest writes coverage/lcov.info by default and the second run would silently overwrite the first. Both are needed rather than just the fast one: the unit suite alone reports 11%, because everything in src/routes is exercised by the integration suite. That suite is manual-only after hanging for 3h12m post-run, so it runs here with --forceExit and the job carries a hard timeout; jest confirmed during testing that it would otherwise have hung. The frontend had no unit tests at all, so its coverage comes from Playwright driving an istanbul-instrumented dev server, collected per test by an auto-fixture and merged with nyc. The 17 specs now import from a local fixtures module that re-exports @playwright/test, which is what lets the fixture attach without touching each test body. Instrumentation is gated behind COVERAGE=true and loaded by dynamic import, since vite-plugin-istanbul is ESM-only while vite.config.ts evaluates as CommonJS. Both directions were checked rather than assumed: a normal build contains no instrumentation, and the dev server instruments nested modules as well as top-level ones — the first attempt used an include glob of src/* which would have silently missed everything under src/admin and src/cart. coverage:report fails when nothing was collected instead of writing an empty report, and that guard was fired deliberately to confirm it works. This project has been bitten twice by tools succeeding while measuring nothing — SonarQube skipping the whole frontend and still exiting EXECUTION SUCCESS in #67, and an ESLint matcher silently matching no files during #60 — and coverage has exactly that shape: an uninstrumented dev server lets every test pass while gathering nothing, and the 0% that follows reads as lost coverage rather than broken collection. Worth knowing when reading the numbers: end-to-end coverage flatters. Istanbul marks a line covered when the browser ran it, so a component rendered during a test counts as covered with nothing asserting anything about it. Recorded in the design doc and the project context rather than left to be discovered. Also declares sonar.tests so test files are analysed under the test rule set rather than as production code. Closes #61
64 lines
2.7 KiB
JavaScript
64 lines
2.7 KiB
JavaScript
#!/usr/bin/env node
|
|
// Turns the per-test istanbul samples in .nyc_output into coverage/lcov.info for
|
|
// SonarQube to import.
|
|
//
|
|
// The check below is the point of this script existing rather than the pipeline
|
|
// just calling `nyc report`. The failure mode that matters here is not an error,
|
|
// it is silence: if the dev server was started without COVERAGE, every test still
|
|
// passes and every page reports no instrumentation, so .nyc_output stays empty
|
|
// and nyc cheerfully writes a valid, empty report. SonarQube then shows frontend
|
|
// coverage at 0%, which reads as "the tests stopped covering things" rather than
|
|
// "collection was never switched on".
|
|
//
|
|
// This project has been bitten twice by tools succeeding while measuring nothing
|
|
// — SonarQube skipping the entire frontend and still exiting EXECUTION SUCCESS
|
|
// (#67), and an ESLint matcher silently matching no files (#60). Coverage has the
|
|
// same shape, so it fails loudly instead.
|
|
const { existsSync, readdirSync } = require('fs');
|
|
const { execFileSync } = require('child_process');
|
|
const path = require('path');
|
|
|
|
const root = path.resolve(__dirname, '..');
|
|
const nycOutput = path.join(root, '.nyc_output');
|
|
|
|
const samples = existsSync(nycOutput)
|
|
? readdirSync(nycOutput).filter((f) => f.endsWith('.json'))
|
|
: [];
|
|
|
|
if (samples.length === 0) {
|
|
console.error('No coverage was collected — .nyc_output holds no samples.');
|
|
console.error('');
|
|
console.error('The tests may well have passed; that is the problem. Coverage is only');
|
|
console.error('gathered when the dev server is instrumented, which happens when COVERAGE=true');
|
|
console.error('reaches it. Run the suite with `npm run test:e2e:cov` rather than `npm run test:e2e`.');
|
|
console.error('');
|
|
console.error('If it was run that way, check that Playwright started its own dev server rather');
|
|
console.error('than reusing one you already had open — an uninstrumented server collects nothing.');
|
|
process.exit(1);
|
|
}
|
|
|
|
console.log(`Merging ${samples.length} coverage sample(s) from ${samples.length} test(s).`);
|
|
|
|
// Invoked through nyc's own entry point rather than npx: on Windows, spawning
|
|
// the npx.cmd shim fails with EINVAL under current Node unless a shell is used,
|
|
// and running the JS directly avoids needing one at all.
|
|
execFileSync(
|
|
process.execPath,
|
|
[
|
|
path.join(root, 'node_modules', 'nyc', 'bin', 'nyc.js'),
|
|
'report',
|
|
'--reporter=lcov',
|
|
'--reporter=text-summary',
|
|
'--report-dir',
|
|
'coverage'
|
|
],
|
|
{ cwd: root, stdio: 'inherit' }
|
|
);
|
|
|
|
const lcov = path.join(root, 'coverage', 'lcov.info');
|
|
if (!existsSync(lcov)) {
|
|
console.error(`nyc reported success but ${lcov} was not written.`);
|
|
process.exit(1);
|
|
}
|
|
console.log(`Wrote ${path.relative(root, lcov)}`);
|