feat: add option to ignore directories from coverage report #7301
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
dimazhornyk
requested review from
Evalir,
onbjerg,
DaniPopes and
mattsse
as code owners
3 tasks
onbjerg
requested changes
Mar 12, 2024
| @@ -151,6 +154,30 @@ impl CoverageReport { | |||
| } | |||
| Ok(()) | |||
| } | |||
|
|
|||
| pub fn filter_out_ignored_sources(&mut self, filter: &impl CoverageFilter) { | |||
| self.items = new_items; | ||
| } | ||
|
|
||
| fn get_source_path(&self, version: &Version, source_id: usize) -> String { |
crates/forge/bin/cmd/test/filter.rs
Outdated
| @@ -40,6 +41,10 @@ pub struct FilterArgs { | |||
| value_name = "GLOB" | |||
| )] | |||
| pub path_pattern_inverse: Option<GlobMatcher>, | |||
|
|
|||
| /// Only show coverage for files that do not match the specified glob pattern. | |||
| #[arg(long = "no-coverage-path", visible_alias = "ncp", value_name = "GLOB")] | |||
|
Hi @dimazhornyk thanks for your PR! Looks like this is almost ready for review, would be great to get this merged To resolve the formatting issue make sure to run: |
|
sorry about dropping this @dimazhornyk ... if you don't have the capacity for fixing the conflicts, we can take it from here @zerosnacks |
2 tasks
2 tasks
zerosnacks
changed the base branch from
master
to
zerosnacks/ignore-directories-coverage
zerosnacks
changed the base branch from
zerosnacks/ignore-directories-coverage
to
master
|
Closing this PR in favor of #8321 I've included the commits of @dimazhornyk |
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.
Motivation
Some files shouldn't be displayed in a coverage report, e.g. utility contracts or dev contracts, and currently there is no way to ignore them from the coverage report. There is a popular issue describing the problem #2988.
Solution
This PR introduces such a possibility using a cli argument
--no-coverage-pathor config keyno_coverage_path.On the implementation side, it filters out all the ignored files right before the report output. It can't be done earlier because there may be files dependent on the ignored ones, which will not be covered if we remove the ignored files earlier.