library/test/src/console.rs

   1 //! Module providing interface for running tests in the console.
   2
   3 use std::fs::File;
   4 use std::io;
   5 use std::io::prelude::Write;
   6 use std::time::Instant;
   7
   8 use super::{
   9     bench::fmt_bench_samples,
  10     cli::TestOpts,
  11     event::{CompletedTest, TestEvent},
  12     filter_tests,
  13     formatters::{JsonFormatter, JunitFormatter, OutputFormatter, PrettyFormatter, TerseFormatter},
  14     helpers::{concurrency::get_concurrency, metrics::MetricMap},
  15     options::{Options, OutputFormat},
  16     run_tests, term,
  17     test_result::TestResult,
  18     time::{TestExecTime, TestSuiteExecTime},
  19     types::{NamePadding, TestDesc, TestDescAndFn},
  20 };
  21
  22 /// Generic wrapper over stdout.
  23 pub enum OutputLocation<T> {
  24     Pretty(Box<term::StdoutTerminal>),
  25     Raw(T),
  26 }
  27
  28 impl<T: Write> Write for OutputLocation<T> {
  29     fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
  30         match *self {
  31             OutputLocation::Pretty(ref mut term) => term.write(buf),
  32             OutputLocation::Raw(ref mut stdout) => stdout.write(buf),
  33         }
  34     }
  35
  36     fn flush(&mut self) -> io::Result<()> {
  37         match *self {
  38             OutputLocation::Pretty(ref mut term) => term.flush(),
  39             OutputLocation::Raw(ref mut stdout) => stdout.flush(),
  40         }
  41     }
  42 }
  43
  44 pub struct ConsoleTestState {
  45     pub log_out: Option<File>,
  46     pub total: usize,
  47     pub passed: usize,
  48     pub failed: usize,
  49     pub ignored: usize,
  50     pub filtered_out: usize,
  51     pub measured: usize,
  52     pub exec_time: Option<TestSuiteExecTime>,
  53     pub metrics: MetricMap,
  54     pub failures: Vec<(TestDesc, Vec<u8>)>,
  55     pub not_failures: Vec<(TestDesc, Vec<u8>)>,
  56     pub time_failures: Vec<(TestDesc, Vec<u8>)>,
  57     pub options: Options,
  58 }
  59
  60 impl ConsoleTestState {
  61     pub fn new(opts: &TestOpts) -> io::Result<ConsoleTestState> {
  62         let log_out = match opts.logfile {
  63             Some(ref path) => Some(File::create(path)?),
  64             None => None,
  65         };
  66
  67         Ok(ConsoleTestState {
  68             log_out,
  69             total: 0,
  70             passed: 0,
  71             failed: 0,
  72             ignored: 0,
  73             filtered_out: 0,
  74             measured: 0,
  75             exec_time: None,
  76             metrics: MetricMap::new(),
  77             failures: Vec::new(),
  78             not_failures: Vec::new(),
  79             time_failures: Vec::new(),
  80             options: opts.options,
  81         })
  82     }
  83
  84     pub fn write_log<F, S>(&mut self, msg: F) -> io::Result<()>
  85     where
  86         S: AsRef<str>,
  87         F: FnOnce() -> S,
  88     {
  89         match self.log_out {
  90             None => Ok(()),
  91             Some(ref mut o) => {
  92                 let msg = msg();
  93                 let msg = msg.as_ref();
  94                 o.write_all(msg.as_bytes())
  95             }
  96         }
  97     }
  98
  99     pub fn write_log_result(
 100         &mut self,
 101         test: &TestDesc,
 102         result: &TestResult,
 103         exec_time: Option<&TestExecTime>,
 104     ) -> io::Result<()> {
 105         self.write_log(|| {
 106             format!(
 107                 "{} {}",
 108                 match *result {
 109                     TestResult::TrOk => "ok".to_owned(),
 110                     TestResult::TrFailed => "failed".to_owned(),
 111                     TestResult::TrFailedMsg(ref msg) => format!("failed: {}", msg),
 112                     TestResult::TrIgnored => "ignored".to_owned(),
 113                     TestResult::TrBench(ref bs) => fmt_bench_samples(bs),
 114                     TestResult::TrTimedFail => "failed (time limit exceeded)".to_owned(),
 115                 },
 116                 test.name,
 117             )
 118         })?;
 119         if let Some(exec_time) = exec_time {
 120             self.write_log(|| format!(" <{}>", exec_time))?;
 121         }
 122         self.write_log(|| "\n")
 123     }
 124
 125     fn current_test_count(&self) -> usize {
 126         self.passed + self.failed + self.ignored + self.measured
 127     }
 128 }
 129
 130 // List the tests to console, and optionally to logfile. Filters are honored.
 131 pub fn list_tests_console(opts: &TestOpts, tests: Vec<TestDescAndFn>) -> io::Result<()> {
 132     let mut output = match term::stdout() {
 133         None => OutputLocation::Raw(io::stdout()),
 134         Some(t) => OutputLocation::Pretty(t),
 135     };
 136
 137     let quiet = opts.format == OutputFormat::Terse;
 138     let mut st = ConsoleTestState::new(opts)?;
 139
 140     let mut ntest = 0;
 141     let mut nbench = 0;
 142
 143     for test in filter_tests(&opts, tests) {
 144         use crate::TestFn::*;
 145
 146         let TestDescAndFn { desc: TestDesc { name, .. }, testfn } = test;
 147
 148         let fntype = match testfn {
 149             StaticTestFn(..) | DynTestFn(..) => {
 150                 ntest += 1;
 151                 "test"
 152             }
 153             StaticBenchFn(..) | DynBenchFn(..) => {
 154                 nbench += 1;
 155                 "benchmark"
 156             }
 157         };
 158
 159         writeln!(output, "{}: {}", name, fntype)?;
 160         st.write_log(|| format!("{} {}\n", fntype, name))?;
 161     }
 162
 163     fn plural(count: u32, s: &str) -> String {
 164         match count {
 165             1 => format!("{} {}", 1, s),
 166             n => format!("{} {}s", n, s),
 167         }
 168     }
 169
 170     if !quiet {
 171         if ntest != 0 || nbench != 0 {
 172             writeln!(output)?;
 173         }
 174
 175         writeln!(output, "{}, {}", plural(ntest, "test"), plural(nbench, "benchmark"))?;
 176     }
 177
 178     Ok(())
 179 }
 180
 181 // Updates `ConsoleTestState` depending on result of the test execution.
 182 fn handle_test_result(st: &mut ConsoleTestState, completed_test: CompletedTest) {
 183     let test = completed_test.desc;
 184     let stdout = completed_test.stdout;
 185     match completed_test.result {
 186         TestResult::TrOk => {
 187             st.passed += 1;
 188             st.not_failures.push((test, stdout));
 189         }
 190         TestResult::TrIgnored => st.ignored += 1,
 191         TestResult::TrBench(bs) => {
 192             st.metrics.insert_metric(
 193                 test.name.as_slice(),
 194                 bs.ns_iter_summ.median,
 195                 bs.ns_iter_summ.max - bs.ns_iter_summ.min,
 196             );
 197             st.measured += 1
 198         }
 199         TestResult::TrFailed => {
 200             st.failed += 1;
 201             st.failures.push((test, stdout));
 202         }
 203         TestResult::TrFailedMsg(msg) => {
 204             st.failed += 1;
 205             let mut stdout = stdout;
 206             stdout.extend_from_slice(format!("note: {}", msg).as_bytes());
 207             st.failures.push((test, stdout));
 208         }
 209         TestResult::TrTimedFail => {
 210             st.failed += 1;
 211             st.time_failures.push((test, stdout));
 212         }
 213     }
 214 }
 215
 216 // Handler for events that occur during test execution.
 217 // It is provided as a callback to the `run_tests` function.
 218 fn on_test_event(
 219     event: &TestEvent,
 220     st: &mut ConsoleTestState,
 221     out: &mut dyn OutputFormatter,
 222 ) -> io::Result<()> {
 223     match (*event).clone() {
 224         TestEvent::TeFiltered(ref filtered_tests, shuffle_seed) => {
 225             st.total = filtered_tests.len();
 226             out.write_run_start(filtered_tests.len(), shuffle_seed)?;
 227         }
 228         TestEvent::TeFilteredOut(filtered_out) => {
 229             st.filtered_out = filtered_out;
 230         }
 231         TestEvent::TeWait(ref test) => out.write_test_start(test)?,
 232         TestEvent::TeTimeout(ref test) => out.write_timeout(test)?,
 233         TestEvent::TeResult(completed_test) => {
 234             let test = &completed_test.desc;
 235             let result = &completed_test.result;
 236             let exec_time = &completed_test.exec_time;
 237             let stdout = &completed_test.stdout;
 238
 239             st.write_log_result(test, result, exec_time.as_ref())?;
 240             out.write_result(test, result, exec_time.as_ref(), &*stdout, st)?;
 241             handle_test_result(st, completed_test);
 242         }
 243     }
 244
 245     Ok(())
 246 }
 247
 248 /// A simple console test runner.
 249 /// Runs provided tests reporting process and results to the stdout.
 250 pub fn run_tests_console(opts: &TestOpts, tests: Vec<TestDescAndFn>) -> io::Result<bool> {
 251     let output = match term::stdout() {
 252         None => OutputLocation::Raw(io::stdout()),
 253         Some(t) => OutputLocation::Pretty(t),
 254     };
 255
 256     let max_name_len = tests
 257         .iter()
 258         .max_by_key(|t| len_if_padded(*t))
 259         .map(|t| t.desc.name.as_slice().len())
 260         .unwrap_or(0);
 261
 262     let is_multithreaded = opts.test_threads.unwrap_or_else(get_concurrency) > 1;
 263
 264     let mut out: Box<dyn OutputFormatter> = match opts.format {
 265         OutputFormat::Pretty => Box::new(PrettyFormatter::new(
 266             output,
 267             opts.use_color(),
 268             max_name_len,
 269             is_multithreaded,
 270             opts.time_options,
 271         )),
 272         OutputFormat::Terse => {
 273             Box::new(TerseFormatter::new(output, opts.use_color(), max_name_len, is_multithreaded))
 274         }
 275         OutputFormat::Json => Box::new(JsonFormatter::new(output)),
 276         OutputFormat::Junit => Box::new(JunitFormatter::new(output)),
 277     };
 278     let mut st = ConsoleTestState::new(opts)?;
 279
 280     // Prevent the usage of `Instant` in some cases:
 281     // - It's currently not supported for wasm targets.
 282     // - We disable it for miri because it's not available when isolation is enabled.
 283     let is_instant_supported = !cfg!(target_family = "wasm") && !cfg!(miri);
 284
 285     let start_time = is_instant_supported.then(Instant::now);
 286     run_tests(opts, tests, |x| on_test_event(&x, &mut st, &mut *out))?;
 287     st.exec_time = start_time.map(|t| TestSuiteExecTime(t.elapsed()));
 288
 289     assert!(st.current_test_count() == st.total);
 290
 291     out.write_run_finish(&st)
 292 }
 293
 294 // Calculates padding for given test description.
 295 fn len_if_padded(t: &TestDescAndFn) -> usize {
 296     match t.testfn.padding() {
 297         NamePadding::PadNone => 0,
 298         NamePadding::PadOnRight => t.desc.name.as_slice().len(),
 299     }
 300 }