coverage: make crate_features key optional #181
Merged
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
roypat
requested review from
andreeaflorescu,
lauralt,
sameo and
ShadowCurse
as code owners
roypat
force-pushed
the
cov-all-features
branch
from
2d1b610 to
172cc77
Compare
roypat
changed the title
roypat
force-pushed
the
cov-all-features
branch
from
172cc77 to
20c7f0f
Compare
Currently, if a crate wishes to run the coverage test with some cargo features enabled, it must explicitly list them out in the `crate_features` key of the coverage json files. Change this so that if this key is omitted from the json file, then test_coverage.py passes `--all-features` to cargo. No functional change, as currently `crate_features` is a mandatory key, so to opt-in to this new behavior, crates must remove this key from their coverage json file(s). Signed-off-by: Patrick Roy <[email protected]>
roypat
force-pushed
the
cov-all-features
branch
from
20c7f0f to
e184399
Compare
|
LGTM, but should we document this behavior on the main readme or in https://github.com/rust-vmm/rust-vmm-ci/blob/main/coverage_config_x86_64.json.sample ? |
Mention that `crate_features` is now optional, and also update a very outdated reference to `cargo kcov` Signed-off-by: Patrick Roy <[email protected]>
roypat
force-pushed
the
cov-all-features
branch
from
deeb586 to
9b0cfe2
Compare
Ahh, yes, good catch. The README even still talked about |
stefano-garzarella
approved these changes
Mar 19, 2025
ShadowCurse
approved these changes
Mar 19, 2025
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.
Currently, if a crate wishes to run the coverage test with some cargo features enabled, it must explicitly list them out in the
crate_featureskey of the coverage json files.Change this so that if this key is omitted from the json file, then test_coverage.py passes
--all-featuresto cargo.No functional change, as currently
crate_featuresis a mandatory key, so to opt-in to this new behavior, crates must remove this key from their coverage json file(s).(even with the switch to codecov.io, I suspect we'll still keep these files around, as we'll still need a way to specify exclusions / feature sets, so I don't think this is throwaway work)
Summary of the PR
Please summarize here why the changes in this PR are needed.
Requirements
Before submitting your PR, please make sure you addressed the following
requirements:
git commit -s), and the commit message has max 60 characters for thesummary and max 75 characters for each description line.
test.
Release" section of CHANGELOG.md (if no such section exists, please create one).
unsafecode is properly documented.