1 //! Support code for rustc's built in unit-test and micro-benchmarking
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.
9 //! See the [Testing Chapter](../book/ch11-00-testing.html) of the book for more details.
11 // Currently, not much of this is meant for users. It is intended to
12 // support the simplest interface possible for representing and
13 // running tests while providing a base that other test frameworks may
16 // N.B., this is also specified in this crate's Cargo.toml, but libsyntax contains logic specific to
17 // this crate, which relies on this attribute (rather than the value of `--crate-name` passed by
18 // cargo) to detect this crate.
20 #![crate_name = "test"]
21 #![unstable(feature = "test", issue = "50297")]
22 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/", test(attr(deny(warnings))))]
24 #![cfg_attr(any(unix, target_os = "cloudabi"), feature(libc))]
25 #![feature(rustc_private)]
27 #![feature(bool_to_option)]
28 #![feature(set_stdio)]
29 #![feature(panic_unwind)]
30 #![feature(staged_api)]
31 #![feature(termination_trait_lib)]
35 pub use self::ColorConfig::*;
36 pub use self::types::*;
37 pub use self::types::TestName::*;
38 pub use self::options::{ColorConfig, Options, OutputFormat, RunIgnored, ShouldPanic};
39 pub use self::bench::{Bencher, black_box};
40 pub use self::console::run_tests_console;
41 pub use cli::TestOpts;
43 // Module to be used by rustc to compile tests in libtest
47 cli::{parse_opts, TestOpts},
48 helpers::metrics::{Metric, MetricMap},
49 options::{ShouldPanic, Options, RunIgnored, RunStrategy},
50 test_result::{TestResult, TrFailed, TrFailedMsg, TrIgnored, TrOk},
51 time::{TestTimeOptions, TestExecTime},
53 DynTestFn, DynTestName, StaticBenchFn, StaticTestFn, StaticTestName,
54 TestDesc, TestDescAndFn, TestName, TestType,
56 assert_test_result, filter_tests, run_test, test_main, test_main_static,
64 panic::{self, catch_unwind, AssertUnwindSafe, PanicInfo},
66 process::{Command, Termination},
67 sync::mpsc::{channel, Sender},
70 time::{Duration, Instant},
89 use time::TestExecTime;
90 use options::{RunStrategy, Concurrent};
91 use event::{CompletedTest, TestEvent};
92 use helpers::sink::Sink;
93 use helpers::concurrency::get_concurrency;
94 use helpers::exit_code::get_exit_code;
96 // Process exit code to be used to indicate test failures.
97 const ERROR_EXIT_CODE: i32 = 101;
99 const SECONDARY_TEST_INVOKER_VAR: &'static str = "__RUST_TEST_INVOKE";
101 // The default console test runner. It accepts the command line
102 // arguments and a vector of test_descs.
103 pub fn test_main(args: &[String], tests: Vec<TestDescAndFn>, options: Option<Options>) {
104 let mut opts = match cli::parse_opts(args) {
107 eprintln!("error: {}", msg);
108 process::exit(ERROR_EXIT_CODE);
112 if let Some(options) = options {
113 opts.options = options;
116 if let Err(e) = console::list_tests_console(&opts, tests) {
117 eprintln!("error: io error when listing tests: {:?}", e);
118 process::exit(ERROR_EXIT_CODE);
121 match console::run_tests_console(&opts, tests) {
123 Ok(false) => process::exit(ERROR_EXIT_CODE),
125 eprintln!("error: io error when listing tests: {:?}", e);
126 process::exit(ERROR_EXIT_CODE);
132 /// A variant optimized for invocation with a static test vector.
133 /// This will panic (intentionally) when fed any dynamic tests.
135 /// This is the entry point for the main function generated by `rustc --test`
136 /// when panic=unwind.
137 pub fn test_main_static(tests: &[&TestDescAndFn]) {
138 let args = env::args().collect::<Vec<_>>();
139 let owned_tests: Vec<_> = tests.iter().map(make_owned_test).collect();
140 test_main(&args, owned_tests, None)
143 /// A variant optimized for invocation with a static test vector.
144 /// This will panic (intentionally) when fed any dynamic tests.
146 /// Runs tests in panic=abort mode, which involves spawning subprocesses for
149 /// This is the entry point for the main function generated by `rustc --test`
150 /// when panic=abort.
151 pub fn test_main_static_abort(tests: &[&TestDescAndFn]) {
152 // If we're being run in SpawnedSecondary mode, run the test here. run_test
153 // will then exit the process.
154 if let Ok(name) = env::var(SECONDARY_TEST_INVOKER_VAR) {
157 .filter(|test| test.desc.name.as_slice() == name)
158 .map(make_owned_test)
160 .expect("couldn't find a test with the provided name");
161 let TestDescAndFn { desc, testfn } = test;
162 let testfn = match testfn {
163 StaticTestFn(f) => f,
164 _ => panic!("only static tests are supported"),
166 run_test_in_spawned_subprocess(desc, Box::new(testfn));
169 let args = env::args().collect::<Vec<_>>();
170 let owned_tests: Vec<_> = tests.iter().map(make_owned_test).collect();
171 test_main(&args, owned_tests, Some(Options::new().panic_abort(true)))
174 /// Clones static values for putting into a dynamic vector, which test_main()
175 /// needs to hand out ownership of tests to parallel test runners.
177 /// This will panic when fed any dynamic tests, because they cannot be cloned.
178 fn make_owned_test(test: &&TestDescAndFn) -> TestDescAndFn {
180 StaticTestFn(f) => TestDescAndFn {
181 testfn: StaticTestFn(f),
182 desc: test.desc.clone(),
184 StaticBenchFn(f) => TestDescAndFn {
185 testfn: StaticBenchFn(f),
186 desc: test.desc.clone(),
188 _ => panic!("non-static tests passed to test::test_main_static"),
192 /// Invoked when unit tests terminate. Should panic if the unit
193 /// Tests is considered a failure. By default, invokes `report()`
194 /// and checks for a `0` result.
195 pub fn assert_test_result<T: Termination>(result: T) {
196 let code = result.report();
199 "the test returned a termination value with a non-zero status code ({}) \
200 which indicates a failure",
207 tests: Vec<TestDescAndFn>,
208 mut notify_about_test_event: F
211 F: FnMut(TestEvent) -> io::Result<()>,
213 use std::collections::{self, HashMap};
214 use std::hash::BuildHasherDefault;
215 use std::sync::mpsc::RecvTimeoutError;
216 // Use a deterministic hasher
218 HashMap<TestDesc, Instant, BuildHasherDefault<collections::hash_map::DefaultHasher>>;
220 let tests_len = tests.len();
222 let mut filtered_tests = filter_tests(opts, tests);
223 if !opts.bench_benchmarks {
224 filtered_tests = convert_benchmarks_to_tests(filtered_tests);
227 let filtered_tests = {
228 let mut filtered_tests = filtered_tests;
229 for test in filtered_tests.iter_mut() {
230 test.desc.name = test.desc.name.with_padding(test.testfn.padding());
236 let filtered_out = tests_len - filtered_tests.len();
237 let event = TestEvent::TeFilteredOut(filtered_out);
238 notify_about_test_event(event)?;
240 let filtered_descs = filtered_tests.iter().map(|t| t.desc.clone()).collect();
242 let event = TestEvent::TeFiltered(filtered_descs);
243 notify_about_test_event(event)?;
245 let (filtered_tests, filtered_benchs): (Vec<_>, _) =
246 filtered_tests.into_iter().partition(|e| match e.testfn {
247 StaticTestFn(_) | DynTestFn(_) => true,
251 let concurrency = opts.test_threads.unwrap_or_else(get_concurrency);
253 let mut remaining = filtered_tests;
257 let (tx, rx) = channel::<CompletedTest>();
258 let run_strategy = if opts.options.panic_abort && !opts.force_run_in_process {
259 RunStrategy::SpawnPrimary
261 RunStrategy::InProcess
264 let mut running_tests: TestMap = HashMap::default();
266 fn get_timed_out_tests(running_tests: &mut TestMap) -> Vec<TestDesc> {
267 let now = Instant::now();
268 let timed_out = running_tests
270 .filter_map(|(desc, timeout)| {
278 for test in &timed_out {
279 running_tests.remove(test);
284 fn calc_timeout(running_tests: &TestMap) -> Option<Duration> {
285 running_tests.values().min().map(|next_timeout| {
286 let now = Instant::now();
287 if *next_timeout >= now {
295 if concurrency == 1 {
296 while !remaining.is_empty() {
297 let test = remaining.pop().unwrap();
298 let event = TestEvent::TeWait(test.desc.clone());
299 notify_about_test_event(event)?;
300 run_test(opts, !opts.run_tests, test, run_strategy, tx.clone(), Concurrent::No);
301 let completed_test = rx.recv().unwrap();
303 let event = TestEvent::TeResult(completed_test);
304 notify_about_test_event(event)?;
307 while pending > 0 || !remaining.is_empty() {
308 while pending < concurrency && !remaining.is_empty() {
309 let test = remaining.pop().unwrap();
310 let timeout = time::get_default_test_timeout();
311 running_tests.insert(test.desc.clone(), timeout);
313 let event = TestEvent::TeWait(test.desc.clone());
314 notify_about_test_event(event)?; //here no pad
315 run_test(opts, !opts.run_tests, test, run_strategy, tx.clone(), Concurrent::Yes);
321 if let Some(timeout) = calc_timeout(&running_tests) {
322 res = rx.recv_timeout(timeout);
323 for test in get_timed_out_tests(&mut running_tests) {
324 let event = TestEvent::TeTimeout(test);
325 notify_about_test_event(event)?;
329 Err(RecvTimeoutError::Timeout) => {
330 // Result is not yet ready, continue waiting.
333 // We've got a result, stop the loop.
338 res = rx.recv().map_err(|_| RecvTimeoutError::Disconnected);
343 let completed_test = res.unwrap();
344 running_tests.remove(&completed_test.desc);
346 let event = TestEvent::TeResult(completed_test);
347 notify_about_test_event(event)?;
352 if opts.bench_benchmarks {
353 // All benchmarks run at the end, in serial.
354 for b in filtered_benchs {
355 let event = TestEvent::TeWait(b.desc.clone());
356 notify_about_test_event(event)?;
357 run_test(opts, false, b, run_strategy, tx.clone(), Concurrent::No);
358 let completed_test = rx.recv().unwrap();
360 let event = TestEvent::TeResult(completed_test);
361 notify_about_test_event(event)?;
367 pub fn filter_tests(opts: &TestOpts, tests: Vec<TestDescAndFn>) -> Vec<TestDescAndFn> {
368 let mut filtered = tests;
369 let matches_filter = |test: &TestDescAndFn, filter: &str| {
370 let test_name = test.desc.name.as_slice();
372 match opts.filter_exact {
373 true => test_name == filter,
374 false => test_name.contains(filter),
378 // Remove tests that don't match the test filter
379 if let Some(ref filter) = opts.filter {
380 filtered.retain(|test| matches_filter(test, filter));
383 // Skip tests that match any of the skip filters
384 filtered.retain(|test| !opts.skip.iter().any(|sf| matches_filter(test, sf)));
386 // Excludes #[should_panic] tests
387 if opts.exclude_should_panic {
388 filtered.retain(|test| test.desc.should_panic == ShouldPanic::No);
391 // maybe unignore tests
392 match opts.run_ignored {
396 .for_each(|test| test.desc.ignore = false);
398 RunIgnored::Only => {
399 filtered.retain(|test| test.desc.ignore);
402 .for_each(|test| test.desc.ignore = false);
407 // Sort the tests alphabetically
408 filtered.sort_by(|t1, t2| t1.desc.name.as_slice().cmp(t2.desc.name.as_slice()));
413 pub fn convert_benchmarks_to_tests(tests: Vec<TestDescAndFn>) -> Vec<TestDescAndFn> {
414 // convert benchmarks to tests, if we're not benchmarking them
418 let testfn = match x.testfn {
419 DynBenchFn(bench) => DynTestFn(Box::new(move || {
420 bench::run_once(|b| __rust_begin_short_backtrace(|| bench.run(b)))
422 StaticBenchFn(benchfn) => DynTestFn(Box::new(move || {
423 bench::run_once(|b| __rust_begin_short_backtrace(|| benchfn(b)))
439 strategy: RunStrategy,
440 monitor_ch: Sender<CompletedTest>,
441 concurrency: Concurrent,
443 let TestDescAndFn { desc, testfn } = test;
445 // Emscripten can catch panics but other wasm targets cannot
446 let ignore_because_no_process_support = desc.should_panic != ShouldPanic::No
447 && cfg!(target_arch = "wasm32") && !cfg!(target_os = "emscripten");
449 if force_ignore || desc.ignore || ignore_because_no_process_support {
450 let message = CompletedTest::new(desc, TrIgnored, None, Vec::new());
451 monitor_ch.send(message).unwrap();
456 pub strategy: RunStrategy,
458 pub concurrency: Concurrent,
459 pub time: Option<time::TestTimeOptions>,
464 monitor_ch: Sender<CompletedTest>,
465 testfn: Box<dyn FnOnce() + Send>,
468 let concurrency = opts.concurrency;
469 let name = desc.name.clone();
471 let runtest = move || {
472 match opts.strategy {
473 RunStrategy::InProcess =>
482 RunStrategy::SpawnPrimary =>
483 spawn_test_subprocess(desc, opts.time.is_some(), monitor_ch, opts.time),
487 // If the platform is single-threaded we're just going to run
488 // the test synchronously, regardless of the concurrency
490 let supports_threads = !cfg!(target_os = "emscripten") && !cfg!(target_arch = "wasm32");
491 if concurrency == Concurrent::Yes && supports_threads {
492 let cfg = thread::Builder::new().name(name.as_slice().to_owned());
493 cfg.spawn(runtest).unwrap();
499 let test_run_opts = TestRunOpts {
501 nocapture: opts.nocapture,
503 time: opts.time_options
507 DynBenchFn(bencher) => {
508 // Benchmarks aren't expected to panic, so we run them all in-process.
509 crate::bench::benchmark(desc, monitor_ch, opts.nocapture, |harness| {
513 StaticBenchFn(benchfn) => {
514 // Benchmarks aren't expected to panic, so we run them all in-process.
515 crate::bench::benchmark(desc, monitor_ch, opts.nocapture, |harness| {
516 (benchfn.clone())(harness)
521 RunStrategy::InProcess => (),
522 _ => panic!("Cannot run dynamic test fn out-of-process"),
527 Box::new(move || __rust_begin_short_backtrace(f)),
531 StaticTestFn(f) => run_test_inner(
534 Box::new(move || __rust_begin_short_backtrace(f)),
540 /// Fixed frame used to clean the backtrace with `RUST_BACKTRACE=1`.
542 fn __rust_begin_short_backtrace<F: FnOnce()>(f: F) {
546 fn run_test_in_process(
550 testfn: Box<dyn FnOnce() + Send>,
551 monitor_ch: Sender<CompletedTest>,
552 time_opts: Option<time::TestTimeOptions>,
554 // Buffer for capturing standard I/O
555 let data = Arc::new(Mutex::new(Vec::new()));
557 let oldio = if !nocapture {
559 io::set_print(Some(Sink::new_boxed(&data))),
560 io::set_panic(Some(Sink::new_boxed(&data))),
566 let start = report_time.then(Instant::now);
567 let result = catch_unwind(AssertUnwindSafe(testfn));
568 let exec_time = start.map(|start| {
569 let duration = start.elapsed();
570 TestExecTime(duration)
573 if let Some((printio, panicio)) = oldio {
574 io::set_print(printio);
575 io::set_panic(panicio);
578 let test_result = match result {
579 Ok(()) => calc_result(&desc, Ok(()), &time_opts, &exec_time),
580 Err(e) => calc_result(&desc, Err(e.as_ref()), &time_opts, &exec_time),
582 let stdout = data.lock().unwrap().to_vec();
583 let message = CompletedTest::new(desc.clone(), test_result, exec_time, stdout);
584 monitor_ch.send(message).unwrap();
587 fn spawn_test_subprocess(
590 monitor_ch: Sender<CompletedTest>,
591 time_opts: Option<time::TestTimeOptions>,
593 let (result, test_output, exec_time) = (|| {
594 let args = env::args().collect::<Vec<_>>();
595 let current_exe = &args[0];
597 let start = report_time.then(Instant::now);
598 let output = match Command::new(current_exe)
599 .env(SECONDARY_TEST_INVOKER_VAR, desc.name.as_slice())
603 let err = format!("Failed to spawn {} as child for test: {:?}", args[0], e);
604 return (TrFailed, err.into_bytes(), None);
607 let exec_time = start.map(|start| {
608 let duration = start.elapsed();
609 TestExecTime(duration)
612 let std::process::Output { stdout, stderr, status } = output;
613 let mut test_output = stdout;
614 formatters::write_stderr_delimiter(&mut test_output, &desc.name);
615 test_output.extend_from_slice(&stderr);
617 let result = match (|| -> Result<TestResult, String> {
618 let exit_code = get_exit_code(status)?;
619 Ok(get_result_from_exit_code(&desc, exit_code, &time_opts, &exec_time))
623 write!(&mut test_output, "Unexpected error: {}", e).unwrap();
628 (result, test_output, exec_time)
631 let message = CompletedTest::new(desc.clone(), result, exec_time, test_output);
632 monitor_ch.send(message).unwrap();
635 fn run_test_in_spawned_subprocess(
637 testfn: Box<dyn FnOnce() + Send>,
639 let builtin_panic_hook = panic::take_hook();
640 let record_result = Arc::new(move |panic_info: Option<&'_ PanicInfo<'_>>| {
641 let test_result = match panic_info {
642 Some(info) => calc_result(&desc, Err(info.payload()), &None, &None),
643 None => calc_result(&desc, Ok(()), &None, &None),
646 // We don't support serializing TrFailedMsg, so just
647 // print the message out to stderr.
648 if let TrFailedMsg(msg) = &test_result {
649 eprintln!("{}", msg);
652 if let Some(info) = panic_info {
653 builtin_panic_hook(info);
656 if let TrOk = test_result {
657 process::exit(test_result::TR_OK);
659 process::exit(test_result::TR_FAILED);
662 let record_result2 = record_result.clone();
663 panic::set_hook(Box::new(move |info| record_result2(Some(&info))));
666 unreachable!("panic=abort callback should have exited the process")