use std::any::Any; #[cfg(unix)] use std::os::unix::process::ExitStatusExt; use std::process::ExitStatus; pub use self::TestResult::*; use super::bench::BenchSamples; use super::options::ShouldPanic; use super::time; use super::types::TestDesc; // Return code for secondary process. // Start somewhere other than 0 so we know the return code means what we think // it means. pub const TR_OK: i32 = 50; // On Windows we use __fastfail to abort, which is documented to use this // exception code. #[cfg(windows)] const STATUS_FAIL_FAST_EXCEPTION: i32 = 0xC0000409u32 as i32; // On Zircon (the Fuchsia kernel), an abort from userspace calls the // LLVM implementation of __builtin_trap(), e.g., ud2 on x86, which // raises a kernel exception. If a userspace process does not // otherwise arrange exception handling, the kernel kills the process // with this return code. #[cfg(target_os = "fuchsia")] const ZX_TASK_RETCODE_EXCEPTION_KILL: i32 = -1028; #[derive(Debug, Clone, PartialEq)] pub enum TestResult { TrOk, TrFailed, TrFailedMsg(String), TrIgnored, TrBench(BenchSamples), TrTimedFail, } /// Creates a `TestResult` depending on the raw result of test execution /// and associated data. pub fn calc_result<'a>( desc: &TestDesc, task_result: Result<(), &'a (dyn Any + 'static + Send)>, time_opts: Option<&time::TestTimeOptions>, exec_time: Option<&time::TestExecTime>, ) -> TestResult { let result = match (&desc.should_panic, task_result) { (&ShouldPanic::No, Ok(())) | (&ShouldPanic::Yes, Err(_)) => TestResult::TrOk, (&ShouldPanic::YesWithMessage(msg), Err(err)) => { let maybe_panic_str = err .downcast_ref::() .map(|e| &**e) .or_else(|| err.downcast_ref::<&'static str>().copied()); if maybe_panic_str.map(|e| e.contains(msg)).unwrap_or(false) { TestResult::TrOk } else if let Some(panic_str) = maybe_panic_str { TestResult::TrFailedMsg(format!( r#"panic did not contain expected string panic message: `{panic_str:?}`, expected substring: `{msg:?}`"# )) } else { TestResult::TrFailedMsg(format!( r#"expected panic with string value, found non-string value: `{:?}` expected substring: `{:?}`"#, (*err).type_id(), msg )) } } (&ShouldPanic::Yes, Ok(())) | (&ShouldPanic::YesWithMessage(_), Ok(())) => { TestResult::TrFailedMsg("test did not panic as expected".to_string()) } _ => TestResult::TrFailed, }; // If test is already failed (or allowed to fail), do not change the result. if result != TestResult::TrOk { return result; } // Check if test is failed due to timeout. if let (Some(opts), Some(time)) = (time_opts, exec_time) { if opts.error_on_excess && opts.is_critical(desc, time) { return TestResult::TrTimedFail; } } result } /// Creates a `TestResult` depending on the exit code of test subprocess. pub fn get_result_from_exit_code( desc: &TestDesc, status: ExitStatus, time_opts: Option<&time::TestTimeOptions>, exec_time: Option<&time::TestExecTime>, ) -> TestResult { let result = match status.code() { Some(TR_OK) => TestResult::TrOk, #[cfg(windows)] Some(STATUS_FAIL_FAST_EXCEPTION) => TestResult::TrFailed, #[cfg(unix)] None => match status.signal() { Some(libc::SIGABRT) => TestResult::TrFailed, Some(signal) => { TestResult::TrFailedMsg(format!("child process exited with signal {signal}")) } None => unreachable!("status.code() returned None but status.signal() was None"), }, // Upon an abort, Fuchsia returns the status code ZX_TASK_RETCODE_EXCEPTION_KILL. #[cfg(target_os = "fuchsia")] Some(ZX_TASK_RETCODE_EXCEPTION_KILL) => TestResult::TrFailed, #[cfg(not(unix))] None => TestResult::TrFailedMsg(format!("unknown return code")), #[cfg(any(windows, unix))] Some(code) => TestResult::TrFailedMsg(format!("got unexpected return code {code}")), #[cfg(not(any(windows, unix)))] Some(_) => TestResult::TrFailed, }; // If test is already failed (or allowed to fail), do not change the result. if result != TestResult::TrOk { return result; } // Check if test is failed due to timeout. if let (Some(opts), Some(time)) = (time_opts, exec_time) { if opts.error_on_excess && opts.is_critical(desc, time) { return TestResult::TrTimedFail; } } result }