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::bench::{black_box, Bencher};
36 pub use self::console::run_tests_console;
37 pub use self::options::{ColorConfig, Options, OutputFormat, RunIgnored, ShouldPanic};
38 pub use self::types::TestName::*;
39 pub use self::types::*;
40 pub use self::ColorConfig::*;
41 pub use cli::TestOpts;
43 // Module to be used by rustc to compile tests in libtest
48 cli::{parse_opts, TestOpts},
50 helpers::metrics::{Metric, MetricMap},
51 options::{Options, RunIgnored, RunStrategy, ShouldPanic},
52 run_test, test_main, test_main_static,
53 test_result::{TestResult, TrFailed, TrFailedMsg, TrIgnored, TrOk},
54 time::{TestExecTime, TestTimeOptions},
56 DynTestFn, DynTestName, StaticBenchFn, StaticTestFn, StaticTestName, TestDesc,
57 TestDescAndFn, TestName, TestType,
65 panic::{self, catch_unwind, AssertUnwindSafe, PanicInfo},
67 process::{Command, Termination},
68 sync::mpsc::{channel, Sender},
71 time::{Duration, Instant},
89 use event::{CompletedTest, TestEvent};
90 use helpers::concurrency::get_concurrency;
91 use helpers::exit_code::get_exit_code;
92 use helpers::sink::Sink;
93 use options::{Concurrent, RunStrategy};
95 use time::TestExecTime;
97 // Process exit code to be used to indicate test failures.
98 const ERROR_EXIT_CODE: i32 = 101;
100 const SECONDARY_TEST_INVOKER_VAR: &'static str = "__RUST_TEST_INVOKE";
102 // The default console test runner. It accepts the command line
103 // arguments and a vector of test_descs.
104 pub fn test_main(args: &[String], tests: Vec<TestDescAndFn>, options: Option<Options>) {
105 let mut opts = match cli::parse_opts(args) {
108 eprintln!("error: {}", msg);
109 process::exit(ERROR_EXIT_CODE);
113 if let Some(options) = options {
114 opts.options = options;
117 if let Err(e) = console::list_tests_console(&opts, tests) {
118 eprintln!("error: io error when listing tests: {:?}", e);
119 process::exit(ERROR_EXIT_CODE);
122 match console::run_tests_console(&opts, tests) {
124 Ok(false) => process::exit(ERROR_EXIT_CODE),
126 eprintln!("error: io error when listing tests: {:?}", e);
127 process::exit(ERROR_EXIT_CODE);
133 /// A variant optimized for invocation with a static test vector.
134 /// This will panic (intentionally) when fed any dynamic tests.
136 /// This is the entry point for the main function generated by `rustc --test`
137 /// when panic=unwind.
138 pub fn test_main_static(tests: &[&TestDescAndFn]) {
139 let args = env::args().collect::<Vec<_>>();
140 let owned_tests: Vec<_> = tests.iter().map(make_owned_test).collect();
141 test_main(&args, owned_tests, None)
144 /// A variant optimized for invocation with a static test vector.
145 /// This will panic (intentionally) when fed any dynamic tests.
147 /// Runs tests in panic=abort mode, which involves spawning subprocesses for
150 /// This is the entry point for the main function generated by `rustc --test`
151 /// when panic=abort.
152 pub fn test_main_static_abort(tests: &[&TestDescAndFn]) {
153 // If we're being run in SpawnedSecondary mode, run the test here. run_test
154 // will then exit the process.
155 if let Ok(name) = env::var(SECONDARY_TEST_INVOKER_VAR) {
158 .filter(|test| test.desc.name.as_slice() == name)
159 .map(make_owned_test)
161 .expect("couldn't find a test with the provided name");
162 let TestDescAndFn { desc, testfn } = test;
163 let testfn = match testfn {
164 StaticTestFn(f) => f,
165 _ => panic!("only static tests are supported"),
167 run_test_in_spawned_subprocess(desc, Box::new(testfn));
170 let args = env::args().collect::<Vec<_>>();
171 let owned_tests: Vec<_> = tests.iter().map(make_owned_test).collect();
172 test_main(&args, owned_tests, Some(Options::new().panic_abort(true)))
175 /// Clones static values for putting into a dynamic vector, which test_main()
176 /// needs to hand out ownership of tests to parallel test runners.
178 /// This will panic when fed any dynamic tests, because they cannot be cloned.
179 fn make_owned_test(test: &&TestDescAndFn) -> TestDescAndFn {
181 StaticTestFn(f) => TestDescAndFn { testfn: StaticTestFn(f), desc: test.desc.clone() },
182 StaticBenchFn(f) => TestDescAndFn { testfn: StaticBenchFn(f), desc: test.desc.clone() },
183 _ => panic!("non-static tests passed to test::test_main_static"),
187 /// Invoked when unit tests terminate. Should panic if the unit
188 /// Tests is considered a failure. By default, invokes `report()`
189 /// and checks for a `0` result.
190 pub fn assert_test_result<T: Termination>(result: T) {
191 let code = result.report();
194 "the test returned a termination value with a non-zero status code ({}) \
195 which indicates a failure",
202 tests: Vec<TestDescAndFn>,
203 mut notify_about_test_event: F,
206 F: FnMut(TestEvent) -> io::Result<()>,
208 use std::collections::{self, HashMap};
209 use std::hash::BuildHasherDefault;
210 use std::sync::mpsc::RecvTimeoutError;
211 // Use a deterministic hasher
213 HashMap<TestDesc, Instant, BuildHasherDefault<collections::hash_map::DefaultHasher>>;
215 let tests_len = tests.len();
217 let mut filtered_tests = filter_tests(opts, tests);
218 if !opts.bench_benchmarks {
219 filtered_tests = convert_benchmarks_to_tests(filtered_tests);
222 let filtered_tests = {
223 let mut filtered_tests = filtered_tests;
224 for test in filtered_tests.iter_mut() {
225 test.desc.name = test.desc.name.with_padding(test.testfn.padding());
231 let filtered_out = tests_len - filtered_tests.len();
232 let event = TestEvent::TeFilteredOut(filtered_out);
233 notify_about_test_event(event)?;
235 let filtered_descs = filtered_tests.iter().map(|t| t.desc.clone()).collect();
237 let event = TestEvent::TeFiltered(filtered_descs);
238 notify_about_test_event(event)?;
240 let (filtered_tests, filtered_benchs): (Vec<_>, _) =
241 filtered_tests.into_iter().partition(|e| match e.testfn {
242 StaticTestFn(_) | DynTestFn(_) => true,
246 let concurrency = opts.test_threads.unwrap_or_else(get_concurrency);
248 let mut remaining = filtered_tests;
252 let (tx, rx) = channel::<CompletedTest>();
253 let run_strategy = if opts.options.panic_abort && !opts.force_run_in_process {
254 RunStrategy::SpawnPrimary
256 RunStrategy::InProcess
259 let mut running_tests: TestMap = HashMap::default();
261 fn get_timed_out_tests(running_tests: &mut TestMap) -> Vec<TestDesc> {
262 let now = Instant::now();
263 let timed_out = running_tests
265 .filter_map(|(desc, timeout)| if &now >= timeout { Some(desc.clone()) } else { None })
267 for test in &timed_out {
268 running_tests.remove(test);
273 fn calc_timeout(running_tests: &TestMap) -> Option<Duration> {
274 running_tests.values().min().map(|next_timeout| {
275 let now = Instant::now();
276 if *next_timeout >= now { *next_timeout - now } else { Duration::new(0, 0) }
280 if concurrency == 1 {
281 while !remaining.is_empty() {
282 let test = remaining.pop().unwrap();
283 let event = TestEvent::TeWait(test.desc.clone());
284 notify_about_test_event(event)?;
285 run_test(opts, !opts.run_tests, test, run_strategy, tx.clone(), Concurrent::No);
286 let completed_test = rx.recv().unwrap();
288 let event = TestEvent::TeResult(completed_test);
289 notify_about_test_event(event)?;
292 while pending > 0 || !remaining.is_empty() {
293 while pending < concurrency && !remaining.is_empty() {
294 let test = remaining.pop().unwrap();
295 let timeout = time::get_default_test_timeout();
296 running_tests.insert(test.desc.clone(), timeout);
298 let event = TestEvent::TeWait(test.desc.clone());
299 notify_about_test_event(event)?; //here no pad
300 run_test(opts, !opts.run_tests, test, run_strategy, tx.clone(), Concurrent::Yes);
306 if let Some(timeout) = calc_timeout(&running_tests) {
307 res = rx.recv_timeout(timeout);
308 for test in get_timed_out_tests(&mut running_tests) {
309 let event = TestEvent::TeTimeout(test);
310 notify_about_test_event(event)?;
314 Err(RecvTimeoutError::Timeout) => {
315 // Result is not yet ready, continue waiting.
318 // We've got a result, stop the loop.
323 res = rx.recv().map_err(|_| RecvTimeoutError::Disconnected);
328 let completed_test = res.unwrap();
329 running_tests.remove(&completed_test.desc);
331 let event = TestEvent::TeResult(completed_test);
332 notify_about_test_event(event)?;
337 if opts.bench_benchmarks {
338 // All benchmarks run at the end, in serial.
339 for b in filtered_benchs {
340 let event = TestEvent::TeWait(b.desc.clone());
341 notify_about_test_event(event)?;
342 run_test(opts, false, b, run_strategy, tx.clone(), Concurrent::No);
343 let completed_test = rx.recv().unwrap();
345 let event = TestEvent::TeResult(completed_test);
346 notify_about_test_event(event)?;
352 pub fn filter_tests(opts: &TestOpts, tests: Vec<TestDescAndFn>) -> Vec<TestDescAndFn> {
353 let mut filtered = tests;
354 let matches_filter = |test: &TestDescAndFn, filter: &str| {
355 let test_name = test.desc.name.as_slice();
357 match opts.filter_exact {
358 true => test_name == filter,
359 false => test_name.contains(filter),
363 // Remove tests that don't match the test filter
364 if let Some(ref filter) = opts.filter {
365 filtered.retain(|test| matches_filter(test, filter));
368 // Skip tests that match any of the skip filters
369 filtered.retain(|test| !opts.skip.iter().any(|sf| matches_filter(test, sf)));
371 // Excludes #[should_panic] tests
372 if opts.exclude_should_panic {
373 filtered.retain(|test| test.desc.should_panic == ShouldPanic::No);
376 // maybe unignore tests
377 match opts.run_ignored {
379 filtered.iter_mut().for_each(|test| test.desc.ignore = false);
381 RunIgnored::Only => {
382 filtered.retain(|test| test.desc.ignore);
383 filtered.iter_mut().for_each(|test| test.desc.ignore = false);
388 // Sort the tests alphabetically
389 filtered.sort_by(|t1, t2| t1.desc.name.as_slice().cmp(t2.desc.name.as_slice()));
394 pub fn convert_benchmarks_to_tests(tests: Vec<TestDescAndFn>) -> Vec<TestDescAndFn> {
395 // convert benchmarks to tests, if we're not benchmarking them
399 let testfn = match x.testfn {
400 DynBenchFn(bench) => DynTestFn(Box::new(move || {
401 bench::run_once(|b| __rust_begin_short_backtrace(|| bench.run(b)))
403 StaticBenchFn(benchfn) => DynTestFn(Box::new(move || {
404 bench::run_once(|b| __rust_begin_short_backtrace(|| benchfn(b)))
408 TestDescAndFn { desc: x.desc, testfn }
417 strategy: RunStrategy,
418 monitor_ch: Sender<CompletedTest>,
419 concurrency: Concurrent,
421 let TestDescAndFn { desc, testfn } = test;
423 // Emscripten can catch panics but other wasm targets cannot
424 let ignore_because_no_process_support = desc.should_panic != ShouldPanic::No
425 && cfg!(target_arch = "wasm32")
426 && !cfg!(target_os = "emscripten");
428 if force_ignore || desc.ignore || ignore_because_no_process_support {
429 let message = CompletedTest::new(desc, TrIgnored, None, Vec::new());
430 monitor_ch.send(message).unwrap();
435 pub strategy: RunStrategy,
437 pub concurrency: Concurrent,
438 pub time: Option<time::TestTimeOptions>,
443 monitor_ch: Sender<CompletedTest>,
444 testfn: Box<dyn FnOnce() + Send>,
447 let concurrency = opts.concurrency;
448 let name = desc.name.clone();
450 let runtest = move || match opts.strategy {
451 RunStrategy::InProcess => run_test_in_process(
459 RunStrategy::SpawnPrimary => {
460 spawn_test_subprocess(desc, opts.time.is_some(), monitor_ch, opts.time)
464 // If the platform is single-threaded we're just going to run
465 // the test synchronously, regardless of the concurrency
467 let supports_threads = !cfg!(target_os = "emscripten") && !cfg!(target_arch = "wasm32");
468 if concurrency == Concurrent::Yes && supports_threads {
469 let cfg = thread::Builder::new().name(name.as_slice().to_owned());
470 cfg.spawn(runtest).unwrap();
477 TestRunOpts { strategy, nocapture: opts.nocapture, concurrency, time: opts.time_options };
480 DynBenchFn(bencher) => {
481 // Benchmarks aren't expected to panic, so we run them all in-process.
482 crate::bench::benchmark(desc, monitor_ch, opts.nocapture, |harness| {
486 StaticBenchFn(benchfn) => {
487 // Benchmarks aren't expected to panic, so we run them all in-process.
488 crate::bench::benchmark(desc, monitor_ch, opts.nocapture, |harness| {
489 (benchfn.clone())(harness)
494 RunStrategy::InProcess => (),
495 _ => panic!("Cannot run dynamic test fn out-of-process"),
500 Box::new(move || __rust_begin_short_backtrace(f)),
504 StaticTestFn(f) => run_test_inner(
507 Box::new(move || __rust_begin_short_backtrace(f)),
513 /// Fixed frame used to clean the backtrace with `RUST_BACKTRACE=1`.
515 fn __rust_begin_short_backtrace<F: FnOnce()>(f: F) {
519 fn run_test_in_process(
523 testfn: Box<dyn FnOnce() + Send>,
524 monitor_ch: Sender<CompletedTest>,
525 time_opts: Option<time::TestTimeOptions>,
527 // Buffer for capturing standard I/O
528 let data = Arc::new(Mutex::new(Vec::new()));
530 let oldio = if !nocapture {
532 io::set_print(Some(Sink::new_boxed(&data))),
533 io::set_panic(Some(Sink::new_boxed(&data))),
539 let start = report_time.then(Instant::now);
540 let result = catch_unwind(AssertUnwindSafe(testfn));
541 let exec_time = start.map(|start| {
542 let duration = start.elapsed();
543 TestExecTime(duration)
546 if let Some((printio, panicio)) = oldio {
547 io::set_print(printio);
548 io::set_panic(panicio);
551 let test_result = match result {
552 Ok(()) => calc_result(&desc, Ok(()), &time_opts, &exec_time),
553 Err(e) => calc_result(&desc, Err(e.as_ref()), &time_opts, &exec_time),
555 let stdout = data.lock().unwrap().to_vec();
556 let message = CompletedTest::new(desc.clone(), test_result, exec_time, stdout);
557 monitor_ch.send(message).unwrap();
560 fn spawn_test_subprocess(
563 monitor_ch: Sender<CompletedTest>,
564 time_opts: Option<time::TestTimeOptions>,
566 let (result, test_output, exec_time) = (|| {
567 let args = env::args().collect::<Vec<_>>();
568 let current_exe = &args[0];
570 let start = report_time.then(Instant::now);
571 let output = match Command::new(current_exe)
572 .env(SECONDARY_TEST_INVOKER_VAR, desc.name.as_slice())
577 let err = format!("Failed to spawn {} as child for test: {:?}", args[0], e);
578 return (TrFailed, err.into_bytes(), None);
581 let exec_time = start.map(|start| {
582 let duration = start.elapsed();
583 TestExecTime(duration)
586 let std::process::Output { stdout, stderr, status } = output;
587 let mut test_output = stdout;
588 formatters::write_stderr_delimiter(&mut test_output, &desc.name);
589 test_output.extend_from_slice(&stderr);
591 let result = match (|| -> Result<TestResult, String> {
592 let exit_code = get_exit_code(status)?;
593 Ok(get_result_from_exit_code(&desc, exit_code, &time_opts, &exec_time))
597 write!(&mut test_output, "Unexpected error: {}", e).unwrap();
602 (result, test_output, exec_time)
605 let message = CompletedTest::new(desc.clone(), result, exec_time, test_output);
606 monitor_ch.send(message).unwrap();
609 fn run_test_in_spawned_subprocess(desc: TestDesc, testfn: Box<dyn FnOnce() + Send>) -> ! {
610 let builtin_panic_hook = panic::take_hook();
611 let record_result = Arc::new(move |panic_info: Option<&'_ PanicInfo<'_>>| {
612 let test_result = match panic_info {
613 Some(info) => calc_result(&desc, Err(info.payload()), &None, &None),
614 None => calc_result(&desc, Ok(()), &None, &None),
617 // We don't support serializing TrFailedMsg, so just
618 // print the message out to stderr.
619 if let TrFailedMsg(msg) = &test_result {
620 eprintln!("{}", msg);
623 if let Some(info) = panic_info {
624 builtin_panic_hook(info);
627 if let TrOk = test_result {
628 process::exit(test_result::TR_OK);
630 process::exit(test_result::TR_FAILED);
633 let record_result2 = record_result.clone();
634 panic::set_hook(Box::new(move |info| record_result2(Some(&info))));
637 unreachable!("panic=abort callback should have exited the process")