Add documentation for using code coverage #14371
Closed
Conversation
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
I recently played with this, and found it difficult to get a good overview of what is required and how the tooling actually works. This tries to document all of that, including what the coverage report actually looks like, and how to use it. I've also added a section on remote execution, because it is currently *especially* hard to use there, and while these are bugs it is still useful information for anyone who needs to get coverage to run at the moment, as well as language-specific documentation because I know that the implementation is a bit different for each, and at least Python requires a few hacks to get to work.
TLATER
requested review from
aiuto,
floriographygoth,
gregestren and
jin
as code owners
|
@lfpino has had a glance over this before, can't seem to request a review from him, so I'll just add him here. |
lfpino
approved these changes
Dec 3, 2021
| - A bazel binary that includes [b01c859][python_coverage_commit], | ||
| which should be any Bazel >3.0. | ||
| - A [modified version of coverage.py][modified_coveragepy]. | ||
| <!-- TODO: Upstream an lcov implementation so that this becomes usable --> |
There was a problem hiding this comment.
nit: could you file issues for these TODOs once you get the approval from the Bazel team?
oquenchil
added
the
team-Rules-Server
c-mita
reviewed
Dec 9, 2021
c-mita
approved these changes
Dec 9, 2021
Bencodes
pushed a commit
to Bencodes/bazel
that referenced
this pull request
Jan 10, 2022
Includes notes for: * Using coverage with remote execution. * How the LCOV output can be used with genhtml to create HTML output. * How Python coverage can be achieved, albeit with some work. Closes bazelbuild#14371. PiperOrigin-RevId: 415362878
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi, sorry for the out-of-the-blue PR, but we've been working on getting code coverage to run in remote execution downstream, and written up these docs.
The basic local workflow is fairly easy (though I think it's still useful to document how
genhtmlis intended to be used), but there are a handful of issues with remote execution. The doc as-is just lists and explains them, as well as workarounds, but we intend to fix at least some those problems over the coming weeks.The python workflow is also quite rough at the moment, we're looking at making this simpler (see nedbat/coveragepy#587).
Nonetheless, it would be nice to have some review on this in the mean time, so that we can get it merged a bit more quickly, and at least have code coverage documented a bit better even if it is broken in some ways.
I think I may not have been diligent enough with checking whether it builds, so apologies if this just ends up causing a build failure. I hope CI will help a little with this.