bazelbuild/bazel

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

Open

#10,857 opened on Feb 25, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (25,384 stars) (4,465 forks)batch import
P3coveragehelp wantedteam-Documentationteam-Rules-Servertype: documentation (cleanup)

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

Tech stack
java
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with Bazelunderstanding of code coverage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the usage of ' paths for coverage.txt' in the linked source files (JacocoCoverageRunner.java and JacocoLCOVFormatter.java). Understand how the file is created and consumed. Then write documentation explaining its purpose and format, and possibly add examples. Check if there are any existing docs for coverage to follow the style.