Introduce a dedicated AbortCheck type

Author: oli-obk

examples/rustc_basic.rs

@@ -1,14 +1,12 @@
 #[cfg(feature = "rustc")]
-use std::sync::atomic::Ordering;
-#[cfg(feature = "rustc")]
 use ui_test::{run_tests, Config};
 
 #[cfg(feature = "rustc")]
 #[cfg_attr(test, test)]
 fn main() -> ui_test::color_eyre::Result<()> {
     let config = Config::rustc("examples_tests/rustc_basic");
     let abort_check = config.abort_check.clone();
-    ctrlc::set_handler(move || abort_check.store(true, Ordering::Relaxed))?;
+    ctrlc::set_handler(move || abort_check.abort())?;
 
     // Compile all `.rs` files in the given directory (relative to your
     // Cargo.toml) and compare their output against the corresponding

examples/rustc_twice_with_different_flags.rs

@@ -1,6 +1,4 @@
 #[cfg(feature = "rustc")]
-use std::sync::atomic::Ordering;
-#[cfg(feature = "rustc")]
 use ui_test::{
     default_file_filter, default_per_file_config, run_tests_generic, status_emitter, Config,
 };
@@ -10,7 +8,7 @@ use ui_test::{
 fn main() -> ui_test::color_eyre::Result<()> {
     let config = Config::rustc("examples_tests/rustc_basic");
     let abort_check = config.abort_check.clone();
-    ctrlc::set_handler(move || abort_check.store(true, Ordering::Relaxed))?;
+    ctrlc::set_handler(move || abort_check.abort())?;
 
     // Compile all `.rs` files in the given directory (relative to your
     // Cargo.toml) and compare their output against the corresponding

src/config.rs

@@ -61,10 +61,26 @@ pub struct Config {
     pub custom_comments: BTreeMap<&'static str, CommandParserFunc>,
     /// Custom diagnostic extractor (invoked on the output of tests)
     pub diagnostic_extractor: fn(&Path, &[u8]) -> Diagnostics,
-    /// An atomic bool that can be set to `true` to abort all tests.
-    /// Will not cancel child processes, but if set from a Ctrl+C handler,
-    /// the pressing of Ctrl+C will already have cancelled child processes.
-    pub abort_check: Arc<AtomicBool>,
+    /// Handle to the global abort check.
+    pub abort_check: AbortCheck,
+}
+
+/// An atomic bool that can be set to `true` to abort all tests.
+/// Will not cancel child processes, but if set from a Ctrl+C handler,
+/// the pressing of Ctrl+C will already have cancelled child processes.
+#[derive(Clone, Debug, Default)]
+pub struct AbortCheck(Arc<AtomicBool>);
+
+impl AbortCheck {
+    /// Whether any test has been aborted.
+    pub fn aborted(&self) -> bool {
+        self.0.load(std::sync::atomic::Ordering::Relaxed)
+    }
+
+    /// Inform everyone that an abort has been requested
+    pub fn abort(&self) {
+        self.0.store(true, std::sync::atomic::Ordering::Relaxed)
+    }
 }
 
 /// Function that performs the actual output conflict handling.
@@ -439,7 +455,7 @@ impl Config {
     }
 
     pub(crate) fn aborted(&self) -> bool {
-        self.abort_check.load(std::sync::atomic::Ordering::Relaxed)
+        self.abort_check.aborted()
     }
 }
 

src/lib.rs

@@ -33,7 +33,6 @@ use std::panic::AssertUnwindSafe;
 use std::path::Path;
 #[cfg(feature = "rustc")]
 use std::process::Command;
-use std::sync::atomic::Ordering;
 use std::sync::Arc;
 use test_result::TestRun;
 pub use test_result::{Errored, TestOk};
@@ -323,7 +322,7 @@ pub fn run_tests_generic(
         },
         |finished_files_recv| {
             for run in finished_files_recv {
-                let aborted = run.abort_check.load(Ordering::Relaxed);
+                let aborted = run.abort_check.aborted();
                 run.status.done(&run.result, aborted);
 
                 // Do not write summaries for cancelled tests
@@ -340,7 +339,7 @@ pub fn run_tests_generic(
     let mut aborted = false;
 
     for run in results {
-        aborted |= run.abort_check.load(Ordering::Relaxed);
+        aborted |= run.abort_check.aborted();
         match run.result {
             Ok(TestOk::Ok) => succeeded += 1,
             Ok(TestOk::Ignored) => ignored += 1,

src/test_result.rs

@@ -1,8 +1,7 @@
 //! Various data structures used for carrying information about test success or failure
 
-use crate::{status_emitter::TestStatus, Error};
+use crate::{status_emitter::TestStatus, AbortCheck, Error};
 use color_eyre::eyre::Result;
-use std::sync::{atomic::AtomicBool, Arc};
 
 /// The possible non-failure results a single test can have.
 #[derive(Debug)]
@@ -52,5 +51,5 @@ pub struct TestRun {
     /// Usually created via `for_revsion` or `for_path`
     pub status: Box<dyn TestStatus>,
     /// Whether the run was aborted prematurely
-    pub abort_check: Arc<AtomicBool>,
+    pub abort_check: AbortCheck,
 }

tests/integrations/basic-fail/Cargo.stdout

@@ -490,9 +490,9 @@ tests/actual_tests_bless/revisions.rs ... ok
 tests/actual_tests_bless/revisions.rs (revision `foo`) ... ok
 tests/actual_tests_bless/revisions.rs (revision `bar`) ... ok
 tests/actual_tests_bless/revisions_bad.rs ... ok
+tests/actual_tests_bless/revisions_filter.rs ... ok
 tests/actual_tests_bless/revisions_bad.rs (revision `foo`) ... ok
 tests/actual_tests_bless/revisions_bad.rs (revision `bar`) ... FAILED
-tests/actual_tests_bless/revisions_filter.rs ... ok
 tests/actual_tests_bless/revisions_filter.rs (revision `foo`) ... ignored (in-test comment)
 tests/actual_tests_bless/revisions_filter.rs (revision `bar`) ... ignored (in-test comment)
 tests/actual_tests_bless/revisions_filter2.rs ... ok