Add --skip flag to exclude tests (#3432)

<!-- Reference any GitHub issues resolved by this PR -->

Closes #1512

## Introduced changes

<!-- A brief description of the changes -->

-

## Checklist

<!-- Make sure all of these are complete -->

- [x] Linked relevant issue
- [x] Updated relevant documentation
- [x] Added relevant tests
- [x] Performed self-review of the code
- [x] Added changes to `CHANGELOG.md`

Author: kkawula

CHANGELOG.md

@@ -9,8 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Forge
 
-#### Changed
+#### Added
+- `--skip` flag to allow excluding any test whose name contains the provided string
 
+#### Changed
+- Updated output format for `--exit-first` flag. Tests skipped due to preceding failures are no longer displayed in the summary. Alternative information is shown when applicable.
 - `storage address` was renamed to `contract address` in the output of `--trace-verbosity`
 
 #### Fixed

crates/forge-runner/src/lib.rs

@@ -158,7 +158,7 @@ fn run_with_fuzzing(
 ) -> JoinHandle<Result<TestCaseSummary<Fuzzing>>> {
     tokio::task::spawn(async move {
         if send.is_closed() {
-            return Ok(TestCaseSummary::Skipped {});
+            return Ok(TestCaseSummary::Interrupted {});
         }
 
         let (fuzzing_send, mut fuzzing_rec) = channel(1);
@@ -224,7 +224,7 @@ fn run_with_fuzzing(
             // get Passed after Skipped. To treat fuzzing a test as Passed
             // we have to ensure that all fuzzing subtests Passed
             if runs != fuzzer_runs.get() {
-                return Ok(TestCaseSummary::Skipped {});
+                return Ok(TestCaseSummary::Interrupted {});
             }
         }
 

crates/forge-runner/src/messages.rs

@@ -14,7 +14,7 @@ enum TestResultStatus {
     Passed,
     Failed,
     Ignored,
-    Skipped,
+    Interrupted,
 }
 
 impl From<&AnyTestCaseSummary> for TestResultStatus {
@@ -26,8 +26,8 @@ impl From<&AnyTestCaseSummary> for TestResultStatus {
             | AnyTestCaseSummary::Fuzzing(TestCaseSummary::Failed { .. }) => Self::Failed,
             AnyTestCaseSummary::Single(TestCaseSummary::Ignored { .. })
             | AnyTestCaseSummary::Fuzzing(TestCaseSummary::Ignored { .. }) => Self::Ignored,
-            AnyTestCaseSummary::Single(TestCaseSummary::Skipped { .. })
-            | AnyTestCaseSummary::Fuzzing(TestCaseSummary::Skipped { .. }) => Self::Skipped,
+            AnyTestCaseSummary::Single(TestCaseSummary::Interrupted { .. })
+            | AnyTestCaseSummary::Fuzzing(TestCaseSummary::Interrupted { .. }) => Self::Interrupted,
         }
     }
 }
@@ -120,7 +120,7 @@ impl TestResultMessage {
             match self.status {
                 TestResultStatus::Passed => return format!("\n\n{msg}"),
                 TestResultStatus::Failed => return format!("\n\nFailure data:{msg}"),
-                TestResultStatus::Ignored | TestResultStatus::Skipped => return String::new(),
+                TestResultStatus::Ignored | TestResultStatus::Interrupted => return String::new(),
             }
         }
         String::new()
@@ -131,8 +131,8 @@ impl TestResultMessage {
             TestResultStatus::Passed => format!("[{}]", style("PASS").green()),
             TestResultStatus::Failed => format!("[{}]", style("FAIL").red()),
             TestResultStatus::Ignored => format!("[{}]", style("IGNORE").yellow()),
-            TestResultStatus::Skipped => {
-                unreachable!("Skipped tests should not have visible message representation")
+            TestResultStatus::Interrupted => {
+                unreachable!("Interrupted tests should not have visible message representation")
             }
         }
     }

crates/forge-runner/src/running.rs

@@ -73,7 +73,7 @@ pub fn run_test(
         // a channel is used to receive information indicating
         // that the execution of the task is no longer necessary.
         if send.is_closed() {
-            return TestCaseSummary::Skipped {};
+            return TestCaseSummary::Interrupted {};
         }
         let run_result = run_test_case(
             &case,
@@ -83,7 +83,7 @@ pub fn run_test(
         );
 
         if send.is_closed() {
-            return TestCaseSummary::Skipped {};
+            return TestCaseSummary::Interrupted {};
         }
 
         extract_test_case_summary(
@@ -114,7 +114,7 @@ pub(crate) fn run_fuzz_test(
         // a channel is used to receive information indicating
         // that the execution of the task is no longer necessary.
         if send.is_closed() | fuzzing_send.is_closed() {
-            return TestCaseSummary::Skipped {};
+            return TestCaseSummary::Interrupted {};
         }
 
         let run_result = run_test_case(
@@ -128,7 +128,7 @@ pub(crate) fn run_fuzz_test(
         // remove it after improve exit-first tests
         // issue #1043
         if send.is_closed() {
-            return TestCaseSummary::Skipped {};
+            return TestCaseSummary::Interrupted {};
         }
 
         extract_test_case_summary(

crates/forge-runner/src/test_case_summary.rs

@@ -165,7 +165,7 @@ pub enum TestCaseSummary<T: TestType> {
         name: String,
     },
     /// Test case skipped due to exit first or execution interrupted, test result is ignored.
-    Skipped {},
+    Interrupted {},
 }
 
 #[derive(Debug)]
@@ -181,7 +181,7 @@ impl<T: TestType> TestCaseSummary<T> {
             TestCaseSummary::Failed { name, .. }
             | TestCaseSummary::Passed { name, .. }
             | TestCaseSummary::Ignored { name, .. } => Some(name),
-            TestCaseSummary::Skipped { .. } => None,
+            TestCaseSummary::Interrupted { .. } => None,
         }
     }
 
@@ -262,7 +262,7 @@ impl TestCaseSummary<Fuzzing> {
                 debugging_trace,
             },
             TestCaseSummary::Ignored { name } => TestCaseSummary::Ignored { name: name.clone() },
-            TestCaseSummary::Skipped {} => TestCaseSummary::Skipped {},
+            TestCaseSummary::Interrupted {} => TestCaseSummary::Interrupted {},
         }
     }
 }
@@ -472,11 +472,11 @@ impl AnyTestCaseSummary {
     }
 
     #[must_use]
-    pub fn is_skipped(&self) -> bool {
+    pub fn is_interrupted(&self) -> bool {
         matches!(
             self,
-            AnyTestCaseSummary::Single(TestCaseSummary::Skipped { .. })
-                | AnyTestCaseSummary::Fuzzing(TestCaseSummary::Skipped { .. })
+            AnyTestCaseSummary::Single(TestCaseSummary::Interrupted { .. })
+                | AnyTestCaseSummary::Fuzzing(TestCaseSummary::Interrupted { .. })
         )
     }
 

crates/forge-runner/src/test_target_summary.rs

@@ -25,10 +25,10 @@ impl TestTargetSummary {
     }
 
     #[must_use]
-    pub fn count_skipped(&self) -> usize {
+    pub fn count_interrupted(&self) -> usize {
         self.test_case_summaries
             .iter()
-            .filter(|tu| tu.is_skipped())
+            .filter(|tu| tu.is_interrupted())
             .count()
     }
 

crates/forge/src/lib.rs

@@ -152,6 +152,10 @@ pub struct TestArgs {
     #[arg(short, long)]
     exact: bool,
 
+    /// Skips any tests whose name contains the given SKIP string.
+    #[arg(long)]
+    skip: Vec<String>,
+
     /// Stop executing tests after the first failed test
     #[arg(short = 'x', long)]
     exit_first: bool,

crates/forge/src/run_tests/package.rs

@@ -87,6 +87,7 @@ impl RunForPackageArgs {
         let test_filter = TestsFilter::from_flags(
             args.test_filter.clone(),
             args.exact,
+            args.skip.clone(),
             args.only_ignored,
             args.include_ignored,
             args.rerun_failed,

crates/forge/src/run_tests/structs.rs

@@ -66,7 +66,7 @@ impl Message for CollectedTestsCountMessage {
 pub struct TestsSummaryMessage {
     passed: usize,
     failed: usize,
-    skipped: usize,
+    interrupted: usize,
     ignored: usize,
     filtered: Option<usize>,
 }
@@ -75,13 +75,16 @@ impl TestsSummaryMessage {
     pub fn new(summaries: &[TestTargetSummary], filtered: Option<usize>) -> Self {
         let passed = summaries.iter().map(TestTargetSummary::count_passed).sum();
         let failed = summaries.iter().map(TestTargetSummary::count_failed).sum();
-        let skipped = summaries.iter().map(TestTargetSummary::count_skipped).sum();
+        let interrupted = summaries
+            .iter()
+            .map(TestTargetSummary::count_interrupted)
+            .sum();
         let ignored = summaries.iter().map(TestTargetSummary::count_ignored).sum();
 
         Self {
             passed,
             failed,
-            skipped,
+            interrupted,
             ignored,
             filtered,
         }
@@ -94,13 +97,19 @@ impl Message for TestsSummaryMessage {
             .filtered
             .map_or_else(|| "other".to_string(), |v| v.to_string());
 
+        let interrupted = if self.interrupted > 0 {
+            format!("\nInterrupted execution of {} test(s).", self.interrupted)
+        } else {
+            String::new()
+        };
+
         format!(
-            "{}: {} passed, {} failed, {} skipped, {} ignored, {filtered} filtered out",
+            "{}: {} passed, {} failed, {} ignored, {filtered} filtered out{}",
             style("Tests").bold(),
             self.passed,
             self.failed,
-            self.skipped,
-            self.ignored
+            self.ignored,
+            interrupted
         )
     }
 

crates/forge/src/run_tests/test_target.rs

@@ -71,7 +71,7 @@ pub async fn run_for_test_target(
     while let Some(task) = tasks.next().await {
         let result = task??;
 
-        if !result.is_skipped() {
+        if !result.is_interrupted() {
             let test_result_message = TestResultMessage::new(
                 &result,
                 forge_config.output_config.detailed_resources,