feat(coverage): add option to ignore directories and files from coverage report #8321
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
zerosnacks
commented
Jul 1, 2024
Comment on lines
+42
to
+44
| /// Only show coverage for files that do not match the specified regex pattern. | ||
| #[arg(long = "no-match-coverage", visible_alias = "nmco", value_name = "REGEX")] | ||
| pub coverage_pattern_inverse: Option<regex::Regex>, |
There was a problem hiding this comment.
I've opted for no-match-coverage to stay in line with the no-match-* pattern established (no-match-test, no-match-contract, no-match-path)
See: #7301 (comment)
zerosnacks
requested review from
onbjerg,
DaniPopes,
Evalir and
mattsse
as code owners
zerosnacks
changed the title
mattsse
requested changes
Jul 1, 2024
crates/evm/coverage/src/lib.rs
Outdated
| /// | ||
| /// This function should only be called after all the sources were used, otherwise, the output | ||
| /// will be missing the ones that are dependent on them. | ||
| pub fn filter_out_ignored_sources(&mut self, filter: &impl CoverageFilter) { |
There was a problem hiding this comment.
let's just replace this with an Fn(&Path) -> bool
crates/evm/coverage/src/lib.rs
Outdated
Comment on lines
159
to
175
| let mut new_items = HashMap::new(); | ||
| for (version, items) in self.items.iter() { | ||
| let new_items_for_version: Vec<_> = items | ||
| .iter() | ||
| .filter(|item| { | ||
| self.source_paths | ||
| .get(&(version.clone(), item.loc.source_id)) | ||
| .map(|path| filter.matches_file_path(path)) | ||
| .unwrap_or(false) | ||
| }) | ||
| .cloned() | ||
| .collect(); | ||
| if !new_items_for_version.is_empty() { | ||
| new_items.insert(version.clone(), new_items_for_version); | ||
| } | ||
| } | ||
| self.items = new_items; |
There was a problem hiding this comment.
isn't this just a HashMap::retain?
mattsse
approved these changes
Jul 1, 2024
|
thanks for this 🥇 |
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
Follow-up of #7301 as I'm not able to push directly to the fork
This PR includes the commits of https://github.com/dimazhornyk
Closes: #2988
Solution
Contrary to #7301 I decided that for flexibility it is preferable to generalize beyond
globand instead use aregexon the filepath (not just file name)contractAis filtered out,contractBis preserved)This allows for a syntax like:
forge coverage --no-match-coverage "(script|test|Foo|Bar)"wherescript|testare obviously paths andFoo|Barfiles where a glob would be limited to a single folder and not individual filesThere is currently no warning applied when all sources are filtered out, that could be a follow up nice to have.