Improve coverage reports #1548
Merged
Improve coverage reports #1548
Conversation
This file contains hidden or 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
- When covering a project with multiple packages, the project coverage report
will produce a table of individual coverage reports for each package. The
links in this table don't go anywhere when a package is uncovered (they are
broken links).
- By producing an empty coverage report when a package has no coverage, we fix
the broken links, and provide a tad more information about the coverage
state of that package.
- Provide a link to the union/all coverage report. - Format the reports as a list instead of a table of one column. - Provide better explanation of what each report means.
- Modules that have no coverage at all are simply not included in the HTML reports generated by HPC. - Add a warning to the project coverage report index page so users are aware of this limitation of HPC.
9 tasks
|
bors try |
|
Converting to draft while I figure out a few niggling issues I discovered - sorry @hamishmack ! |
tryBuild failed: |
|
Nice! |
sevanspowell
force-pushed
the
sevanspowell/improve-coverage-reports
branch
2 times, most recently
from
2c0f423 to
521c657
Compare
|
bors try |
tryBuild succeeded: |
- Remove the concept of "package boundaries" from the "coverageReport" function.
- The "coverageReport" is now a function of:
- arbitrary checks generating tix files
- arbitrary mix modules
- This more closely reflects the usage of hpc, which doesn't care about package
boundaries.
- Use this new "coverageReport" function to simplify the "projectCoverageReport"
implementation. A project coverage report now simply:
- copies out constituent coverage reports.
- writes out an "all coverage report" using all checks in the project and all
mix modules..
- writes out a summary index page.
sevanspowell
force-pushed
the
sevanspowell/improve-coverage-reports
branch
from
521c657 to
e01f641
Compare
|
bors try |
tryBuild succeeded: |
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.
After a request from the ouroboros-network team to add coverage reports to their repository, I realized the coverage reports provided by haskell.nix have a few deficiencies:
hpcexecutable provided by GHC (https://gitlab.haskell.org/ghc/ghc/-/tree/ghc-8.10.7-release/utils/hpc). There's no easy way (from bash) to generate a .tix file that provides 0% coverage.