1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
// Copyright (c) The nextest Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0
//! Filtering tests based on user-specified parameters.
//!
//! The main structure in this module is [`TestFilter`], which is created by a [`TestFilterBuilder`].
#![allow(clippy::nonminimal_bool)]
// nonminimal_bool fires on one of the conditions below and appears to suggest an incorrect
// result
use crate::{
errors::TestFilterBuilderError,
list::RustTestArtifact,
partition::{Partitioner, PartitionerBuilder},
};
use aho_corasick::AhoCorasick;
use nextest_filtering::{FilteringExpr, TestQuery};
use nextest_metadata::{FilterMatch, MismatchReason};
/// Whether to run ignored tests.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Default)]
pub enum RunIgnored {
/// Only run tests that aren't ignored.
///
/// This is the default.
#[default]
Default,
/// Only run tests that are ignored.
IgnoredOnly,
/// Run both ignored and non-ignored tests.
All,
}
/// A builder for `TestFilter` instances.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct TestFilterBuilder {
run_ignored: RunIgnored,
partitioner_builder: Option<PartitionerBuilder>,
name_match: NameMatch,
exprs: Vec<FilteringExpr>,
}
#[derive(Clone, Debug)]
enum NameMatch {
EmptyPatterns,
MatchSet {
patterns: Vec<String>,
matcher: Box<AhoCorasick>,
},
}
impl PartialEq for NameMatch {
fn eq(&self, other: &Self) -> bool {
match (self, other) {
(Self::EmptyPatterns, Self::EmptyPatterns) => true,
(Self::MatchSet { patterns: sp, .. }, Self::MatchSet { patterns: op, .. })
if sp == op =>
{
true
}
_ => false,
}
}
}
impl Eq for NameMatch {}
impl TestFilterBuilder {
/// Creates a new `TestFilterBuilder` from the given patterns.
///
/// If an empty slice is passed, the test filter matches all possible test names.
pub fn new(
run_ignored: RunIgnored,
partitioner_builder: Option<PartitionerBuilder>,
patterns: impl IntoIterator<Item = impl Into<String>>,
exprs: Vec<FilteringExpr>,
) -> Result<Self, TestFilterBuilderError> {
let mut patterns: Vec<_> = patterns.into_iter().map(|s| s.into()).collect();
patterns.sort_unstable();
let name_match = if patterns.is_empty() {
NameMatch::EmptyPatterns
} else {
let matcher = Box::new(AhoCorasick::new(&patterns)?);
NameMatch::MatchSet { patterns, matcher }
};
Ok(Self {
run_ignored,
partitioner_builder,
name_match,
exprs,
})
}
/// Creates a new `TestFilterBuilder` that matches any pattern by name.
pub fn any(run_ignored: RunIgnored) -> Self {
Self {
run_ignored,
partitioner_builder: None,
name_match: NameMatch::EmptyPatterns,
exprs: Vec::new(),
}
}
/// Returns a value indicating whether this binary should or should not be run to obtain the
/// list of tests within it.
///
/// This method is implemented directly on `TestFilterBuilder`. The statefulness of `TestFilter`
/// is only used for counted test partitioning, and is not currently relevant for binaries.
pub fn should_obtain_test_list_from_binary(&self, test_binary: &RustTestArtifact<'_>) -> bool {
if self.exprs.is_empty() {
// No expressions means match all tests.
return true;
}
for expr in &self.exprs {
// If this is a definite or probable match, then we should run this binary
if expr
.matches_binary(&test_binary.to_binary_query())
.unwrap_or(true)
{
return true;
}
}
false
}
/// Creates a new test filter scoped to a single binary.
///
/// This test filter may be stateful.
pub fn build(&self) -> TestFilter<'_> {
let partitioner = self
.partitioner_builder
.as_ref()
.map(|partitioner_builder| partitioner_builder.build());
TestFilter {
builder: self,
partitioner,
}
}
}
/// Test filter, scoped to a single binary.
#[derive(Debug)]
pub struct TestFilter<'builder> {
builder: &'builder TestFilterBuilder,
partitioner: Option<Box<dyn Partitioner>>,
}
impl<'filter> TestFilter<'filter> {
/// Returns an enum describing the match status of this filter.
pub fn filter_match(
&mut self,
test_binary: &RustTestArtifact<'_>,
test_name: &str,
ignored: bool,
) -> FilterMatch {
self.filter_ignored_mismatch(ignored)
.or_else(|| {
// ---
// NOTE
// ---
//
// Previously, if either expression OR string filters matched, we'd run the tests.
// The current (stable) implementation is that *both* the expression AND the string
// filters should match.
//
// This is because we try and skip running test binaries which don't match
// expression filters. So for example:
//
// cargo nextest run -E 'binary(foo)' test_bar
//
// would not even get to the point of enumerating the tests not in binary(foo), thus
// not running any test_bars in the workspace. But, with the OR semantics:
//
// cargo nextest run -E 'binary(foo) or test(test_foo)' test_bar
//
// would run all the test_bars in the repo. This is inconsistent, so nextest must
// use AND semantics.
use FilterNameMatch::*;
match (
self.filter_name_match(test_name),
self.filter_expression_match(test_binary, test_name),
) {
// Tests must be accepted by both expressions and filters.
(
MatchEmptyPatterns | MatchWithPatterns,
MatchEmptyPatterns | MatchWithPatterns,
) => None,
// If rejected by at least one of the filtering strategies, the test is rejected
(_, Mismatch(reason)) | (Mismatch(reason), _) => {
Some(FilterMatch::Mismatch { reason })
}
}
})
// Note that partition-based filtering MUST come after all other kinds of filtering,
// so that count-based bucketing applies after ignored, name and expression matching.
// This also means that mutable count state must be maintained by the partitioner.
.or_else(|| self.filter_partition_mismatch(test_name))
.unwrap_or(FilterMatch::Matches)
}
fn filter_ignored_mismatch(&self, ignored: bool) -> Option<FilterMatch> {
match self.builder.run_ignored {
RunIgnored::IgnoredOnly => {
if !ignored {
return Some(FilterMatch::Mismatch {
reason: MismatchReason::Ignored,
});
}
}
RunIgnored::Default => {
if ignored {
return Some(FilterMatch::Mismatch {
reason: MismatchReason::Ignored,
});
}
}
_ => {}
}
None
}
fn filter_name_match(&self, test_name: &str) -> FilterNameMatch {
match &self.builder.name_match {
NameMatch::EmptyPatterns => FilterNameMatch::MatchEmptyPatterns,
NameMatch::MatchSet { matcher, .. } => {
if matcher.is_match(test_name) {
FilterNameMatch::MatchWithPatterns
} else {
FilterNameMatch::Mismatch(MismatchReason::String)
}
}
}
}
fn filter_expression_match(
&self,
test_binary: &RustTestArtifact<'_>,
test_name: &str,
) -> FilterNameMatch {
let query = TestQuery {
binary_query: test_binary.to_binary_query(),
test_name,
};
if self.builder.exprs.is_empty() {
FilterNameMatch::MatchEmptyPatterns
} else if self
.builder
.exprs
.iter()
.any(|expr| expr.matches_test(&query))
{
FilterNameMatch::MatchWithPatterns
} else {
FilterNameMatch::Mismatch(MismatchReason::Expression)
}
}
fn filter_partition_mismatch(&mut self, test_name: &str) -> Option<FilterMatch> {
let partition_match = match &mut self.partitioner {
Some(partitioner) => partitioner.test_matches(test_name),
None => true,
};
if partition_match {
None
} else {
Some(FilterMatch::Mismatch {
reason: MismatchReason::Partition,
})
}
}
}
#[derive(Clone, Debug)]
enum FilterNameMatch {
/// Match because there are no patterns.
MatchEmptyPatterns,
/// Matches with non-empty patterns.
MatchWithPatterns,
/// Mismatch.
Mismatch(MismatchReason),
}
impl FilterNameMatch {
#[cfg(test)]
fn is_match(&self) -> bool {
match self {
Self::MatchEmptyPatterns | Self::MatchWithPatterns => true,
Self::Mismatch(_) => false,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use proptest::{collection::vec, prelude::*};
use test_strategy::proptest;
#[proptest(cases = 50)]
fn proptest_empty(#[strategy(vec(any::<String>(), 0..16))] test_names: Vec<String>) {
let patterns: &[String] = &[];
let test_filter =
TestFilterBuilder::new(RunIgnored::Default, None, patterns, Vec::new()).unwrap();
let single_filter = test_filter.build();
for test_name in test_names {
prop_assert!(single_filter.filter_name_match(&test_name).is_match());
}
}
// Test that exact names match.
#[proptest(cases = 50)]
fn proptest_exact(#[strategy(vec(any::<String>(), 0..16))] test_names: Vec<String>) {
let test_filter =
TestFilterBuilder::new(RunIgnored::Default, None, &test_names, Vec::new()).unwrap();
let single_filter = test_filter.build();
for test_name in test_names {
prop_assert!(single_filter.filter_name_match(&test_name).is_match());
}
}
// Test that substrings match.
#[proptest(cases = 50)]
fn proptest_substring(
#[strategy(vec([any::<String>(); 3], 0..16))] substring_prefix_suffixes: Vec<[String; 3]>,
) {
let mut patterns = Vec::with_capacity(substring_prefix_suffixes.len());
let mut test_names = Vec::with_capacity(substring_prefix_suffixes.len());
for [substring, prefix, suffix] in substring_prefix_suffixes {
test_names.push(prefix + &substring + &suffix);
patterns.push(substring);
}
let test_filter =
TestFilterBuilder::new(RunIgnored::Default, None, &patterns, Vec::new()).unwrap();
let single_filter = test_filter.build();
for test_name in test_names {
prop_assert!(single_filter.filter_name_match(&test_name).is_match());
}
}
// Test that dropping a character from a string doesn't match.
#[proptest(cases = 50)]
fn proptest_no_match(substring: String, prefix: String, suffix: String) {
prop_assume!(!substring.is_empty() && !(prefix.is_empty() && suffix.is_empty()));
let pattern = prefix + &substring + &suffix;
let test_filter =
TestFilterBuilder::new(RunIgnored::Default, None, [pattern], Vec::new()).unwrap();
let single_filter = test_filter.build();
prop_assert!(!single_filter.filter_name_match(&substring).is_match());
}
// /// Creates a fake test binary instance.
// fn make_test_binary() -> TestBinary {
// TestBinary {
// binary: "/fake/path".into(),
// binary_id: "fake-id".to_owned(),
// cwd: "/fake".into(),
// }
// }
}