-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(coverage): add option to ignore directories and files from coverage report #8321
Merged
Merged
Changes from 14 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
3e7a3c1
feat: add option to ignore directories from coverage report
dimazhornyk 92baf15
resolve conflict with master
dimazhornyk 2e94a0c
add docs, rename no-coverage-path to ignore-coverage-path
dimazhornyk 0b609db
Merge branch 'master' into ignore-directories-coverage
dimazhornyk bf3244e
cargo fmt
dimazhornyk fb7f367
fix merge conflicts
zerosnacks 2a2faf8
small refactor
zerosnacks f03bbf8
revert formatting changes
zerosnacks 880d7a7
revert formatting
zerosnacks ca0c1fc
path_pattern_ignore_coverage -> coverage_pattern_inverse
zerosnacks 95b7de2
use regex instead of glob
zerosnacks 20647f9
re-enable ignoring of sources after report
zerosnacks da168be
fix formatting
zerosnacks 16c07a1
add basic filter test
zerosnacks 0aceec3
remove redundant Path cast
zerosnacks 286873c
use HashMap::retain
zerosnacks 1549542
greatly simplify, remove CoverageFilter
zerosnacks fbee819
move constants out of filter map
zerosnacks File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
use clap::Parser; | ||
use forge::TestFilter; | ||
use foundry_common::{CoverageFilter, TestFilter}; | ||
use foundry_compilers::{FileFilter, ProjectPathsConfig}; | ||
use foundry_config::{filter::GlobMatcher, Config}; | ||
use std::{fmt, path::Path}; | ||
|
@@ -38,6 +38,10 @@ pub struct FilterArgs { | |
value_name = "GLOB" | ||
)] | ||
pub path_pattern_inverse: Option<GlobMatcher>, | ||
|
||
/// 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>, | ||
Comment on lines
+42
to
+44
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've opted for See: #7301 (comment) |
||
} | ||
|
||
impl FilterArgs { | ||
|
@@ -71,6 +75,9 @@ impl FilterArgs { | |
if self.path_pattern_inverse.is_none() { | ||
self.path_pattern_inverse = config.path_pattern_inverse.clone().map(Into::into); | ||
} | ||
if self.coverage_pattern_inverse.is_none() { | ||
self.coverage_pattern_inverse = config.coverage_pattern_inverse.clone().map(Into::into); | ||
} | ||
ProjectPathsAwareFilter { args_filter: self, paths: config.project_paths() } | ||
} | ||
} | ||
|
@@ -84,6 +91,7 @@ impl fmt::Debug for FilterArgs { | |
.field("no-match-contract", &self.contract_pattern_inverse.as_ref().map(|r| r.as_str())) | ||
.field("match-path", &self.path_pattern.as_ref().map(|g| g.as_str())) | ||
.field("no-match-path", &self.path_pattern_inverse.as_ref().map(|g| g.as_str())) | ||
.field("no-match-coverage", &self.coverage_pattern_inverse.as_ref().map(|g| g.as_str())) | ||
.finish_non_exhaustive() | ||
} | ||
} | ||
|
@@ -132,6 +140,17 @@ impl TestFilter for FilterArgs { | |
} | ||
} | ||
|
||
impl CoverageFilter for FilterArgs { | ||
/// Returns true if the file path does not match the ignore coverage pattern. | ||
fn matches_file_path(&self, path: &Path) -> bool { | ||
let mut ok = true; | ||
if let Some(re) = &self.coverage_pattern_inverse { | ||
ok = ok && !re.is_match(&path.to_string_lossy()); | ||
} | ||
ok | ||
} | ||
} | ||
|
||
impl fmt::Display for FilterArgs { | ||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
if let Some(p) = &self.test_pattern { | ||
|
@@ -152,6 +171,9 @@ impl fmt::Display for FilterArgs { | |
if let Some(p) = &self.path_pattern_inverse { | ||
writeln!(f, "\tno-match-path: `{}`", p.as_str())?; | ||
} | ||
if let Some(p) = &self.coverage_pattern_inverse { | ||
writeln!(f, "\tno-match-coverage: `{}`", p.as_str())?; | ||
} | ||
Ok(()) | ||
} | ||
} | ||
|
@@ -206,6 +228,14 @@ impl TestFilter for ProjectPathsAwareFilter { | |
} | ||
} | ||
|
||
impl CoverageFilter for ProjectPathsAwareFilter { | ||
/// Returns true if the file path does not match the ignore coverage pattern. | ||
fn matches_file_path(&self, mut path: &Path) -> bool { | ||
path = path.strip_prefix(&self.paths.root).unwrap_or(path); | ||
self.args_filter.matches_file_path(path) | ||
} | ||
} | ||
|
||
impl fmt::Display for ProjectPathsAwareFilter { | ||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
self.args_filter.fmt(f) | ||
|
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's just replace this with an
Fn(&Path) -> bool