library/test/src/lib.rs

   1 //! Support code for rustc's built in unit-test and micro-benchmarking
   2 //! framework.
   3 //!
   4 //! Almost all user code will only be interested in `Bencher` and
   5 //! `black_box`. All other interactions (such as writing tests and
   6 //! benchmarks themselves) should be done via the `#[test]` and
   7 //! `#[bench]` attributes.
   8 //!
   9 //! See the [Testing Chapter](../book/ch11-00-testing.html) of the book for more
  10 //! details.
  11
  12 // Currently, not much of this is meant for users. It is intended to
  13 // support the simplest interface possible for representing and
  14 // running tests while providing a base that other test frameworks may
  15 // build off of.
  16
  17 #![unstable(feature = "test", issue = "50297")]
  18 #![doc(test(attr(deny(warnings))))]
  19 #![feature(internal_output_capture)]
  20 #![feature(is_terminal)]
  21 #![feature(staged_api)]
  22 #![feature(process_exitcode_internals)]
  23 #![feature(panic_can_unwind)]
  24 #![feature(test)]
  25
  26 // Public reexports
  27 pub use self::bench::{black_box, Bencher};
  28 pub use self::console::run_tests_console;
  29 pub use self::options::{ColorConfig, Options, OutputFormat, RunIgnored, ShouldPanic};
  30 pub use self::types::TestName::*;
  31 pub use self::types::*;
  32 pub use self::ColorConfig::*;
  33 pub use cli::TestOpts;
  34
  35 // Module to be used by rustc to compile tests in libtest
  36 pub mod test {
  37     pub use crate::{
  38         assert_test_result,
  39         bench::Bencher,
  40         cli::{parse_opts, TestOpts},
  41         filter_tests,
  42         helpers::metrics::{Metric, MetricMap},
  43         options::{Concurrent, Options, RunIgnored, RunStrategy, ShouldPanic},
  44         run_test, test_main, test_main_static,
  45         test_result::{TestResult, TrFailed, TrFailedMsg, TrIgnored, TrOk},
  46         time::{TestExecTime, TestTimeOptions},
  47         types::{
  48             DynTestFn, DynTestName, StaticBenchFn, StaticTestFn, StaticTestName, TestDesc,
  49             TestDescAndFn, TestId, TestName, TestType,
  50         },
  51     };
  52 }
  53
  54 use std::{
  55     collections::VecDeque,
  56     env, io,
  57     io::prelude::Write,
  58     mem::ManuallyDrop,
  59     panic::{self, catch_unwind, AssertUnwindSafe, PanicInfo},
  60     process::{self, Command, Termination},
  61     sync::mpsc::{channel, Sender},
  62     sync::{Arc, Mutex},
  63     thread,
  64     time::{Duration, Instant},
  65 };
  66
  67 pub mod bench;
  68 mod cli;
  69 mod console;
  70 mod event;
  71 mod formatters;
  72 mod helpers;
  73 mod options;
  74 pub mod stats;
  75 mod term;
  76 mod test_result;
  77 mod time;
  78 mod types;
  79
  80 #[cfg(test)]
  81 mod tests;
  82
  83 use core::any::Any;
  84 use event::{CompletedTest, TestEvent};
  85 use helpers::concurrency::get_concurrency;
  86 use helpers::exit_code::get_exit_code;
  87 use helpers::shuffle::{get_shuffle_seed, shuffle_tests};
  88 use options::{Concurrent, RunStrategy};
  89 use test_result::*;
  90 use time::TestExecTime;
  91
  92 // Process exit code to be used to indicate test failures.
  93 const ERROR_EXIT_CODE: i32 = 101;
  94
  95 const SECONDARY_TEST_INVOKER_VAR: &str = "__RUST_TEST_INVOKE";
  96
  97 // The default console test runner. It accepts the command line
  98 // arguments and a vector of test_descs.
  99 pub fn test_main(args: &[String], tests: Vec<TestDescAndFn>, options: Option<Options>) {
 100     let mut opts = match cli::parse_opts(args) {
 101         Some(Ok(o)) => o,
 102         Some(Err(msg)) => {
 103             eprintln!("error: {msg}");
 104             process::exit(ERROR_EXIT_CODE);
 105         }
 106         None => return,
 107     };
 108     if let Some(options) = options {
 109         opts.options = options;
 110     }
 111     if opts.list {
 112         if let Err(e) = console::list_tests_console(&opts, tests) {
 113             eprintln!("error: io error when listing tests: {e:?}");
 114             process::exit(ERROR_EXIT_CODE);
 115         }
 116     } else {
 117         if !opts.nocapture {
 118             // If we encounter a non-unwinding panic, flush any captured output from the current test,
 119             // and stop  capturing output to ensure that the non-unwinding panic message is visible.
 120             // We also acquire the locks for both output streams to prevent output from other threads
 121             // from interleaving with the panic message or appearing after it.
 122             let builtin_panic_hook = panic::take_hook();
 123             let hook = Box::new({
 124                 move |info: &'_ PanicInfo<'_>| {
 125                     if !info.can_unwind() {
 126                         std::mem::forget(std::io::stderr().lock());
 127                         let mut stdout = ManuallyDrop::new(std::io::stdout().lock());
 128                         if let Some(captured) = io::set_output_capture(None) {
 129                             if let Ok(data) = captured.lock() {
 130                                 let _ = stdout.write_all(&data);
 131                                 let _ = stdout.flush();
 132                             }
 133                         }
 134                     }
 135                     builtin_panic_hook(info);
 136                 }
 137             });
 138             panic::set_hook(hook);
 139         }
 140         match console::run_tests_console(&opts, tests) {
 141             Ok(true) => {}
 142             Ok(false) => process::exit(ERROR_EXIT_CODE),
 143             Err(e) => {
 144                 eprintln!("error: io error when listing tests: {e:?}");
 145                 process::exit(ERROR_EXIT_CODE);
 146             }
 147         }
 148     }
 149 }
 150
 151 /// A variant optimized for invocation with a static test vector.
 152 /// This will panic (intentionally) when fed any dynamic tests.
 153 ///
 154 /// This is the entry point for the main function generated by `rustc --test`
 155 /// when panic=unwind.
 156 pub fn test_main_static(tests: &[&TestDescAndFn]) {
 157     let args = env::args().collect::<Vec<_>>();
 158     let owned_tests: Vec<_> = tests.iter().map(make_owned_test).collect();
 159     test_main(&args, owned_tests, None)
 160 }
 161
 162 /// A variant optimized for invocation with a static test vector.
 163 /// This will panic (intentionally) when fed any dynamic tests.
 164 ///
 165 /// Runs tests in panic=abort mode, which involves spawning subprocesses for
 166 /// tests.
 167 ///
 168 /// This is the entry point for the main function generated by `rustc --test`
 169 /// when panic=abort.
 170 pub fn test_main_static_abort(tests: &[&TestDescAndFn]) {
 171     // If we're being run in SpawnedSecondary mode, run the test here. run_test
 172     // will then exit the process.
 173     if let Ok(name) = env::var(SECONDARY_TEST_INVOKER_VAR) {
 174         env::remove_var(SECONDARY_TEST_INVOKER_VAR);
 175         let test = tests
 176             .iter()
 177             .filter(|test| test.desc.name.as_slice() == name)
 178             .map(make_owned_test)
 179             .next()
 180             .unwrap_or_else(|| panic!("couldn't find a test with the provided name '{name}'"));
 181         let TestDescAndFn { desc, testfn } = test;
 182         let testfn = match testfn {
 183             StaticTestFn(f) => f,
 184             _ => panic!("only static tests are supported"),
 185         };
 186         run_test_in_spawned_subprocess(desc, Box::new(testfn));
 187     }
 188
 189     let args = env::args().collect::<Vec<_>>();
 190     let owned_tests: Vec<_> = tests.iter().map(make_owned_test).collect();
 191     test_main(&args, owned_tests, Some(Options::new().panic_abort(true)))
 192 }
 193
 194 /// Clones static values for putting into a dynamic vector, which test_main()
 195 /// needs to hand out ownership of tests to parallel test runners.
 196 ///
 197 /// This will panic when fed any dynamic tests, because they cannot be cloned.
 198 fn make_owned_test(test: &&TestDescAndFn) -> TestDescAndFn {
 199     match test.testfn {
 200         StaticTestFn(f) => TestDescAndFn { testfn: StaticTestFn(f), desc: test.desc.clone() },
 201         StaticBenchFn(f) => TestDescAndFn { testfn: StaticBenchFn(f), desc: test.desc.clone() },
 202         _ => panic!("non-static tests passed to test::test_main_static"),
 203     }
 204 }
 205
 206 /// Invoked when unit tests terminate. Returns `Result::Err` if the test is
 207 /// considered a failure. By default, invokes `report() and checks for a `0`
 208 /// result.
 209 pub fn assert_test_result<T: Termination>(result: T) -> Result<(), String> {
 210     let code = result.report().to_i32();
 211     if code == 0 {
 212         Ok(())
 213     } else {
 214         Err(format!(
 215             "the test returned a termination value with a non-zero status code \
 216              ({}) which indicates a failure",
 217             code
 218         ))
 219     }
 220 }
 221
 222 struct FilteredTests {
 223     tests: Vec<(TestId, TestDescAndFn)>,
 224     benchs: Vec<(TestId, TestDescAndFn)>,
 225     next_id: usize,
 226 }
 227
 228 impl FilteredTests {
 229     fn add_bench(&mut self, desc: TestDesc, testfn: TestFn) {
 230         let test = TestDescAndFn { desc, testfn };
 231         self.benchs.push((TestId(self.next_id), test));
 232         self.next_id += 1;
 233     }
 234     fn add_test(&mut self, desc: TestDesc, testfn: TestFn) {
 235         let test = TestDescAndFn { desc, testfn };
 236         self.tests.push((TestId(self.next_id), test));
 237         self.next_id += 1;
 238     }
 239     fn add_bench_as_test(
 240         &mut self,
 241         desc: TestDesc,
 242         benchfn: impl Fn(&mut Bencher) -> Result<(), String> + Send + 'static,
 243     ) {
 244         let testfn = DynTestFn(Box::new(move || {
 245             bench::run_once(|b| __rust_begin_short_backtrace(|| benchfn(b)))
 246         }));
 247         self.add_test(desc, testfn);
 248     }
 249 }
 250
 251 pub fn run_tests<F>(
 252     opts: &TestOpts,
 253     tests: Vec<TestDescAndFn>,
 254     mut notify_about_test_event: F,
 255 ) -> io::Result<()>
 256 where
 257     F: FnMut(TestEvent) -> io::Result<()>,
 258 {
 259     use std::collections::{self, HashMap};
 260     use std::hash::BuildHasherDefault;
 261     use std::sync::mpsc::RecvTimeoutError;
 262
 263     struct RunningTest {
 264         join_handle: Option<thread::JoinHandle<()>>,
 265     }
 266
 267     // Use a deterministic hasher
 268     type TestMap =
 269         HashMap<TestId, RunningTest, BuildHasherDefault<collections::hash_map::DefaultHasher>>;
 270
 271     struct TimeoutEntry {
 272         id: TestId,
 273         desc: TestDesc,
 274         timeout: Instant,
 275     }
 276
 277     let tests_len = tests.len();
 278
 279     let mut filtered = FilteredTests { tests: Vec::new(), benchs: Vec::new(), next_id: 0 };
 280
 281     for test in filter_tests(opts, tests) {
 282         let mut desc = test.desc;
 283         desc.name = desc.name.with_padding(test.testfn.padding());
 284
 285         match test.testfn {
 286             DynBenchFn(benchfn) => {
 287                 if opts.bench_benchmarks {
 288                     filtered.add_bench(desc, DynBenchFn(benchfn));
 289                 } else {
 290                     filtered.add_bench_as_test(desc, benchfn);
 291                 }
 292             }
 293             StaticBenchFn(benchfn) => {
 294                 if opts.bench_benchmarks {
 295                     filtered.add_bench(desc, StaticBenchFn(benchfn));
 296                 } else {
 297                     filtered.add_bench_as_test(desc, benchfn);
 298                 }
 299             }
 300             testfn => {
 301                 filtered.add_test(desc, testfn);
 302             }
 303         };
 304     }
 305
 306     let filtered_out = tests_len - filtered.tests.len();
 307     let event = TestEvent::TeFilteredOut(filtered_out);
 308     notify_about_test_event(event)?;
 309
 310     let shuffle_seed = get_shuffle_seed(opts);
 311
 312     let event = TestEvent::TeFiltered(filtered.tests.len(), shuffle_seed);
 313     notify_about_test_event(event)?;
 314
 315     let concurrency = opts.test_threads.unwrap_or_else(get_concurrency);
 316
 317     let mut remaining = filtered.tests;
 318     if let Some(shuffle_seed) = shuffle_seed {
 319         shuffle_tests(shuffle_seed, &mut remaining);
 320     }
 321     // Store the tests in a VecDeque so we can efficiently remove the first element to run the
 322     // tests in the order they were passed (unless shuffled).
 323     let mut remaining = VecDeque::from(remaining);
 324     let mut pending = 0;
 325
 326     let (tx, rx) = channel::<CompletedTest>();
 327     let run_strategy = if opts.options.panic_abort && !opts.force_run_in_process {
 328         RunStrategy::SpawnPrimary
 329     } else {
 330         RunStrategy::InProcess
 331     };
 332
 333     let mut running_tests: TestMap = HashMap::default();
 334     let mut timeout_queue: VecDeque<TimeoutEntry> = VecDeque::new();
 335
 336     fn get_timed_out_tests(
 337         running_tests: &TestMap,
 338         timeout_queue: &mut VecDeque<TimeoutEntry>,
 339     ) -> Vec<TestDesc> {
 340         let now = Instant::now();
 341         let mut timed_out = Vec::new();
 342         while let Some(timeout_entry) = timeout_queue.front() {
 343             if now < timeout_entry.timeout {
 344                 break;
 345             }
 346             let timeout_entry = timeout_queue.pop_front().unwrap();
 347             if running_tests.contains_key(&timeout_entry.id) {
 348                 timed_out.push(timeout_entry.desc);
 349             }
 350         }
 351         timed_out
 352     }
 353
 354     fn calc_timeout(timeout_queue: &VecDeque<TimeoutEntry>) -> Option<Duration> {
 355         timeout_queue.front().map(|&TimeoutEntry { timeout: next_timeout, .. }| {
 356             let now = Instant::now();
 357             if next_timeout >= now { next_timeout - now } else { Duration::new(0, 0) }
 358         })
 359     }
 360
 361     if concurrency == 1 {
 362         while !remaining.is_empty() {
 363             let (id, test) = remaining.pop_front().unwrap();
 364             let event = TestEvent::TeWait(test.desc.clone());
 365             notify_about_test_event(event)?;
 366             let join_handle =
 367                 run_test(opts, !opts.run_tests, id, test, run_strategy, tx.clone(), Concurrent::No);
 368             assert!(join_handle.is_none());
 369             let completed_test = rx.recv().unwrap();
 370
 371             let event = TestEvent::TeResult(completed_test);
 372             notify_about_test_event(event)?;
 373         }
 374     } else {
 375         while pending > 0 || !remaining.is_empty() {
 376             while pending < concurrency && !remaining.is_empty() {
 377                 let (id, test) = remaining.pop_front().unwrap();
 378                 let timeout = time::get_default_test_timeout();
 379                 let desc = test.desc.clone();
 380
 381                 let event = TestEvent::TeWait(desc.clone());
 382                 notify_about_test_event(event)?; //here no pad
 383                 let join_handle = run_test(
 384                     opts,
 385                     !opts.run_tests,
 386                     id,
 387                     test,
 388                     run_strategy,
 389                     tx.clone(),
 390                     Concurrent::Yes,
 391                 );
 392                 running_tests.insert(id, RunningTest { join_handle });
 393                 timeout_queue.push_back(TimeoutEntry { id, desc, timeout });
 394                 pending += 1;
 395             }
 396
 397             let mut res;
 398             loop {
 399                 if let Some(timeout) = calc_timeout(&timeout_queue) {
 400                     res = rx.recv_timeout(timeout);
 401                     for test in get_timed_out_tests(&running_tests, &mut timeout_queue) {
 402                         let event = TestEvent::TeTimeout(test);
 403                         notify_about_test_event(event)?;
 404                     }
 405
 406                     match res {
 407                         Err(RecvTimeoutError::Timeout) => {
 408                             // Result is not yet ready, continue waiting.
 409                         }
 410                         _ => {
 411                             // We've got a result, stop the loop.
 412                             break;
 413                         }
 414                     }
 415                 } else {
 416                     res = rx.recv().map_err(|_| RecvTimeoutError::Disconnected);
 417                     break;
 418                 }
 419             }
 420
 421             let mut completed_test = res.unwrap();
 422             let running_test = running_tests.remove(&completed_test.id).unwrap();
 423             if let Some(join_handle) = running_test.join_handle {
 424                 if let Err(_) = join_handle.join() {
 425                     if let TrOk = completed_test.result {
 426                         completed_test.result =
 427                             TrFailedMsg("panicked after reporting success".to_string());
 428                     }
 429                 }
 430             }
 431
 432             let event = TestEvent::TeResult(completed_test);
 433             notify_about_test_event(event)?;
 434             pending -= 1;
 435         }
 436     }
 437
 438     if opts.bench_benchmarks {
 439         // All benchmarks run at the end, in serial.
 440         for (id, b) in filtered.benchs {
 441             let event = TestEvent::TeWait(b.desc.clone());
 442             notify_about_test_event(event)?;
 443             run_test(opts, false, id, b, run_strategy, tx.clone(), Concurrent::No);
 444             let completed_test = rx.recv().unwrap();
 445
 446             let event = TestEvent::TeResult(completed_test);
 447             notify_about_test_event(event)?;
 448         }
 449     }
 450     Ok(())
 451 }
 452
 453 pub fn filter_tests(opts: &TestOpts, tests: Vec<TestDescAndFn>) -> Vec<TestDescAndFn> {
 454     let mut filtered = tests;
 455     let matches_filter = |test: &TestDescAndFn, filter: &str| {
 456         let test_name = test.desc.name.as_slice();
 457
 458         match opts.filter_exact {
 459             true => test_name == filter,
 460             false => test_name.contains(filter),
 461         }
 462     };
 463
 464     // Remove tests that don't match the test filter
 465     if !opts.filters.is_empty() {
 466         filtered.retain(|test| opts.filters.iter().any(|filter| matches_filter(test, filter)));
 467     }
 468
 469     // Skip tests that match any of the skip filters
 470     if !opts.skip.is_empty() {
 471         filtered.retain(|test| !opts.skip.iter().any(|sf| matches_filter(test, sf)));
 472     }
 473
 474     // Excludes #[should_panic] tests
 475     if opts.exclude_should_panic {
 476         filtered.retain(|test| test.desc.should_panic == ShouldPanic::No);
 477     }
 478
 479     // maybe unignore tests
 480     match opts.run_ignored {
 481         RunIgnored::Yes => {
 482             filtered.iter_mut().for_each(|test| test.desc.ignore = false);
 483         }
 484         RunIgnored::Only => {
 485             filtered.retain(|test| test.desc.ignore);
 486             filtered.iter_mut().for_each(|test| test.desc.ignore = false);
 487         }
 488         RunIgnored::No => {}
 489     }
 490
 491     filtered
 492 }
 493
 494 pub fn convert_benchmarks_to_tests(tests: Vec<TestDescAndFn>) -> Vec<TestDescAndFn> {
 495     // convert benchmarks to tests, if we're not benchmarking them
 496     tests
 497         .into_iter()
 498         .map(|x| {
 499             let testfn = match x.testfn {
 500                 DynBenchFn(benchfn) => DynTestFn(Box::new(move || {
 501                     bench::run_once(|b| __rust_begin_short_backtrace(|| benchfn(b)))
 502                 })),
 503                 StaticBenchFn(benchfn) => DynTestFn(Box::new(move || {
 504                     bench::run_once(|b| __rust_begin_short_backtrace(|| benchfn(b)))
 505                 })),
 506                 f => f,
 507             };
 508             TestDescAndFn { desc: x.desc, testfn }
 509         })
 510         .collect()
 511 }
 512
 513 pub fn run_test(
 514     opts: &TestOpts,
 515     force_ignore: bool,
 516     id: TestId,
 517     test: TestDescAndFn,
 518     strategy: RunStrategy,
 519     monitor_ch: Sender<CompletedTest>,
 520     concurrency: Concurrent,
 521 ) -> Option<thread::JoinHandle<()>> {
 522     let TestDescAndFn { desc, testfn } = test;
 523
 524     // Emscripten can catch panics but other wasm targets cannot
 525     let ignore_because_no_process_support = desc.should_panic != ShouldPanic::No
 526         && cfg!(target_family = "wasm")
 527         && !cfg!(target_os = "emscripten");
 528
 529     if force_ignore || desc.ignore || ignore_because_no_process_support {
 530         let message = CompletedTest::new(id, desc, TrIgnored, None, Vec::new());
 531         monitor_ch.send(message).unwrap();
 532         return None;
 533     }
 534
 535     struct TestRunOpts {
 536         pub strategy: RunStrategy,
 537         pub nocapture: bool,
 538         pub concurrency: Concurrent,
 539         pub time: Option<time::TestTimeOptions>,
 540     }
 541
 542     fn run_test_inner(
 543         id: TestId,
 544         desc: TestDesc,
 545         monitor_ch: Sender<CompletedTest>,
 546         testfn: Box<dyn FnOnce() -> Result<(), String> + Send>,
 547         opts: TestRunOpts,
 548     ) -> Option<thread::JoinHandle<()>> {
 549         let concurrency = opts.concurrency;
 550         let name = desc.name.clone();
 551
 552         let runtest = move || match opts.strategy {
 553             RunStrategy::InProcess => run_test_in_process(
 554                 id,
 555                 desc,
 556                 opts.nocapture,
 557                 opts.time.is_some(),
 558                 testfn,
 559                 monitor_ch,
 560                 opts.time,
 561             ),
 562             RunStrategy::SpawnPrimary => spawn_test_subprocess(
 563                 id,
 564                 desc,
 565                 opts.nocapture,
 566                 opts.time.is_some(),
 567                 monitor_ch,
 568                 opts.time,
 569             ),
 570         };
 571
 572         // If the platform is single-threaded we're just going to run
 573         // the test synchronously, regardless of the concurrency
 574         // level.
 575         let supports_threads = !cfg!(target_os = "emscripten") && !cfg!(target_family = "wasm");
 576         if concurrency == Concurrent::Yes && supports_threads {
 577             let cfg = thread::Builder::new().name(name.as_slice().to_owned());
 578             let mut runtest = Arc::new(Mutex::new(Some(runtest)));
 579             let runtest2 = runtest.clone();
 580             match cfg.spawn(move || runtest2.lock().unwrap().take().unwrap()()) {
 581                 Ok(handle) => Some(handle),
 582                 Err(e) if e.kind() == io::ErrorKind::WouldBlock => {
 583                     // `ErrorKind::WouldBlock` means hitting the thread limit on some
 584                     // platforms, so run the test synchronously here instead.
 585                     Arc::get_mut(&mut runtest).unwrap().get_mut().unwrap().take().unwrap()();
 586                     None
 587                 }
 588                 Err(e) => panic!("failed to spawn thread to run test: {e}"),
 589             }
 590         } else {
 591             runtest();
 592             None
 593         }
 594     }
 595
 596     let test_run_opts =
 597         TestRunOpts { strategy, nocapture: opts.nocapture, concurrency, time: opts.time_options };
 598
 599     match testfn {
 600         DynBenchFn(benchfn) => {
 601             // Benchmarks aren't expected to panic, so we run them all in-process.
 602             crate::bench::benchmark(id, desc, monitor_ch, opts.nocapture, benchfn);
 603             None
 604         }
 605         StaticBenchFn(benchfn) => {
 606             // Benchmarks aren't expected to panic, so we run them all in-process.
 607             crate::bench::benchmark(id, desc, monitor_ch, opts.nocapture, benchfn);
 608             None
 609         }
 610         DynTestFn(f) => {
 611             match strategy {
 612                 RunStrategy::InProcess => (),
 613                 _ => panic!("Cannot run dynamic test fn out-of-process"),
 614             };
 615             run_test_inner(
 616                 id,
 617                 desc,
 618                 monitor_ch,
 619                 Box::new(move || __rust_begin_short_backtrace(f)),
 620                 test_run_opts,
 621             )
 622         }
 623         StaticTestFn(f) => run_test_inner(
 624             id,
 625             desc,
 626             monitor_ch,
 627             Box::new(move || __rust_begin_short_backtrace(f)),
 628             test_run_opts,
 629         ),
 630     }
 631 }
 632
 633 /// Fixed frame used to clean the backtrace with `RUST_BACKTRACE=1`.
 634 #[inline(never)]
 635 fn __rust_begin_short_backtrace<T, F: FnOnce() -> T>(f: F) -> T {
 636     let result = f();
 637
 638     // prevent this frame from being tail-call optimised away
 639     black_box(result)
 640 }
 641
 642 fn run_test_in_process(
 643     id: TestId,
 644     desc: TestDesc,
 645     nocapture: bool,
 646     report_time: bool,
 647     testfn: Box<dyn FnOnce() -> Result<(), String> + Send>,
 648     monitor_ch: Sender<CompletedTest>,
 649     time_opts: Option<time::TestTimeOptions>,
 650 ) {
 651     // Buffer for capturing standard I/O
 652     let data = Arc::new(Mutex::new(Vec::new()));
 653
 654     if !nocapture {
 655         io::set_output_capture(Some(data.clone()));
 656     }
 657
 658     let start = report_time.then(Instant::now);
 659     let result = fold_err(catch_unwind(AssertUnwindSafe(testfn)));
 660     let exec_time = start.map(|start| {
 661         let duration = start.elapsed();
 662         TestExecTime(duration)
 663     });
 664
 665     io::set_output_capture(None);
 666
 667     let test_result = match result {
 668         Ok(()) => calc_result(&desc, Ok(()), &time_opts, &exec_time),
 669         Err(e) => calc_result(&desc, Err(e.as_ref()), &time_opts, &exec_time),
 670     };
 671     let stdout = data.lock().unwrap_or_else(|e| e.into_inner()).to_vec();
 672     let message = CompletedTest::new(id, desc, test_result, exec_time, stdout);
 673     monitor_ch.send(message).unwrap();
 674 }
 675
 676 fn fold_err<T, E>(
 677     result: Result<Result<T, E>, Box<dyn Any + Send>>,
 678 ) -> Result<T, Box<dyn Any + Send>>
 679 where
 680     E: Send + 'static,
 681 {
 682     match result {
 683         Ok(Err(e)) => Err(Box::new(e)),
 684         Ok(Ok(v)) => Ok(v),
 685         Err(e) => Err(e),
 686     }
 687 }
 688
 689 fn spawn_test_subprocess(
 690     id: TestId,
 691     desc: TestDesc,
 692     nocapture: bool,
 693     report_time: bool,
 694     monitor_ch: Sender<CompletedTest>,
 695     time_opts: Option<time::TestTimeOptions>,
 696 ) {
 697     let (result, test_output, exec_time) = (|| {
 698         let args = env::args().collect::<Vec<_>>();
 699         let current_exe = &args[0];
 700
 701         let mut command = Command::new(current_exe);
 702         command.env(SECONDARY_TEST_INVOKER_VAR, desc.name.as_slice());
 703         if nocapture {
 704             command.stdout(process::Stdio::inherit());
 705             command.stderr(process::Stdio::inherit());
 706         }
 707
 708         let start = report_time.then(Instant::now);
 709         let output = match command.output() {
 710             Ok(out) => out,
 711             Err(e) => {
 712                 let err = format!("Failed to spawn {} as child for test: {:?}", args[0], e);
 713                 return (TrFailed, err.into_bytes(), None);
 714             }
 715         };
 716         let exec_time = start.map(|start| {
 717             let duration = start.elapsed();
 718             TestExecTime(duration)
 719         });
 720
 721         let std::process::Output { stdout, stderr, status } = output;
 722         let mut test_output = stdout;
 723         formatters::write_stderr_delimiter(&mut test_output, &desc.name);
 724         test_output.extend_from_slice(&stderr);
 725
 726         let result = match (|| -> Result<TestResult, String> {
 727             let exit_code = get_exit_code(status)?;
 728             Ok(get_result_from_exit_code(&desc, exit_code, &time_opts, &exec_time))
 729         })() {
 730             Ok(r) => r,
 731             Err(e) => {
 732                 write!(&mut test_output, "Unexpected error: {}", e).unwrap();
 733                 TrFailed
 734             }
 735         };
 736
 737         (result, test_output, exec_time)
 738     })();
 739
 740     let message = CompletedTest::new(id, desc, result, exec_time, test_output);
 741     monitor_ch.send(message).unwrap();
 742 }
 743
 744 fn run_test_in_spawned_subprocess(
 745     desc: TestDesc,
 746     testfn: Box<dyn FnOnce() -> Result<(), String> + Send>,
 747 ) -> ! {
 748     let builtin_panic_hook = panic::take_hook();
 749     let record_result = Arc::new(move |panic_info: Option<&'_ PanicInfo<'_>>| {
 750         let test_result = match panic_info {
 751             Some(info) => calc_result(&desc, Err(info.payload()), &None, &None),
 752             None => calc_result(&desc, Ok(()), &None, &None),
 753         };
 754
 755         // We don't support serializing TrFailedMsg, so just
 756         // print the message out to stderr.
 757         if let TrFailedMsg(msg) = &test_result {
 758             eprintln!("{msg}");
 759         }
 760
 761         if let Some(info) = panic_info {
 762             builtin_panic_hook(info);
 763         }
 764
 765         if let TrOk = test_result {
 766             process::exit(test_result::TR_OK);
 767         } else {
 768             process::exit(test_result::TR_FAILED);
 769         }
 770     });
 771     let record_result2 = record_result.clone();
 772     panic::set_hook(Box::new(move |info| record_result2(Some(&info))));
 773     if let Err(message) = testfn() {
 774         panic!("{}", message);
 775     }
 776     record_result(None);
 777     unreachable!("panic=abort callback should have exited the process")
 778 }