Skip to content

fix(plugin-coverage): prevent invalid coverage when lcov has hit > found #1017

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
matejchalk merged 1 commit into from
Jun 16, 2025
Merged

fix(plugin-coverage): prevent invalid coverage when lcov has hit > found #1017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 7 additions & 9 deletions packages/plugin-coverage/src/lib/runner/lcov/lcov-runner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ export async function parseLcovFiles(
typeof result === 'string' || result.pathToProject == null
? record.file
: path.join(result.pathToProject, record.file),
functions: filterOutInvalidLines(record, 'functions'),
branches: filterOutInvalidLines(record, 'branches'),
lines: filterOutInvalidLines(record, 'lines'),
functions: patchInvalidStats(record, 'functions'),
branches: patchInvalidStats(record, 'branches'),
lines: patchInvalidStats(record, 'lines'),
}),
);
}),
Expand All @@ -101,21 +101,19 @@ export async function parseLcovFiles(
}

/**
* Filters out invalid line numbers.
*
* Some tools like pytest-cov emit line number 0. https://github.com/nedbat/coveragepy/issues/1846
*
* Filters out invalid `line` numbers, and ensures `hit <= found`.
* @param record LCOV record
* @param type Coverage type
* @returns Coverage output from record without invalid line numbers
* @returns Patched stats for type in record
*/
function filterOutInvalidLines<T extends 'branches' | 'functions' | 'lines'>(
function patchInvalidStats<T extends 'branches' | 'functions' | 'lines'>(
record: LCOVRecord,
type: T,
): LCOVRecord[T] {
const stats = record[type];
return {
...stats,
hit: Math.min(stats.hit, stats.found),
details: stats.details.filter(detail => detail.line > 0),
};
}
Expand Down
8 changes: 5 additions & 3 deletions packages/plugin-coverage/src/lib/runner/lcov/lcov-runner.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ SF:kw/__init__.py
DA:1,1,gG9L/J2A/IwO9tZM1raZxQ
DA:0,0,gG9L/J2A/IwO9tZM1raZxQ
LF:2
LH:1
LH:3
BRF:0
BRH:0
end_of_record
Expand Down Expand Up @@ -125,12 +125,14 @@ end_of_record
parseLcovFiles([path.join('coverage', 'pytest', 'lcov.info')]),
).resolves.toEqual([
expect.objectContaining({
lines: expect.objectContaining({
lines: {
found: 2,
hit: 2, // not 3
details: [
{ hit: 1, line: 1 },
// no { hit: 0, line: 0 },
],
}),
},
}),
]);
});
Expand Down