bazelbuild / bazelbuild/bazel

Document '-paths-for-coverage.txt' for code coverage

Open
#10,857 0 comments 0 reactions 0 assignees View on GitHub
coverage help wanted P3 team-Documentation team-Rules-Server type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 20h
Merged PRs (30d)
72

Description

### Description of the problem / feature request:

There is no documentation for `-paths-for-coverage.txt`.

### Feature requests: what underlying problem are you trying to solve with this feature?

In the process of using this 'feature' in https://github.com/bazelbuild/rules_scala/pull/1006 we just want to get some level of guarentee that this is not a hack and won't be broken anytime in the foreseeable future (or at least some level of transition plan to an alternative)

For reference the two places where this matters to us are:
https://github.com/bazelbuild/bazel/blob/567ca633d016572f5760bfd027c10616f2b8c2e4/src/java_tools/junitrunner/java/com/google/testing/coverage/JacocoCoverageRunner.java#L411
For parsing.

https://github.com/bazelbuild/bazel/blob/567ca633d016572f5760bfd027c10616f2b8c2e4/src/java_tools/junitrunner/java/com/google/testing/coverage/JacocoLCOVFormatter.java#L70
For using the set to find the source file.

Contributor guide

Open the contributing guide

Research direction

Start with the referenced JacocoCoverageRunner.java location to understand how '-paths-for-coverage.txt' is parsed, then read JacocoLCOVFormatter.java to see how the paths are used to find source files. Document the file's format, behavior, and any available transition guidance so users can assess whether relying on it is supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.