1 use std::{io, io::prelude::Write};
3 use super::OutputFormatter;
5 bench::fmt_bench_samples,
6 console::{ConsoleTestState, OutputLocation},
8 test_result::TestResult,
14 // insert a '\n' after 100 tests in quiet mode
15 const QUIET_MODE_MAX_COLUMN: usize = 100;
17 pub(crate) struct TerseFormatter<T> {
18 out: OutputLocation<T>,
20 is_multithreaded: bool,
21 /// Number of columns to fill when aligning names
25 total_test_count: usize,
28 impl<T: Write> TerseFormatter<T> {
30 out: OutputLocation<T>,
33 is_multithreaded: bool,
41 total_test_count: 0, // initialized later, when write_run_start is called
45 pub fn write_ok(&mut self) -> io::Result<()> {
46 self.write_short_result(".", term::color::GREEN)
49 pub fn write_failed(&mut self) -> io::Result<()> {
50 self.write_short_result("F", term::color::RED)
53 pub fn write_ignored(&mut self) -> io::Result<()> {
54 self.write_short_result("i", term::color::YELLOW)
57 pub fn write_bench(&mut self) -> io::Result<()> {
58 self.write_pretty("bench", term::color::CYAN)
61 pub fn write_short_result(
64 color: term::color::Color,
66 self.write_pretty(result, color)?;
67 if self.test_count % QUIET_MODE_MAX_COLUMN == QUIET_MODE_MAX_COLUMN - 1 {
68 // we insert a new line every 100 dots in order to flush the
69 // screen when dealing with line-buffered output (e.g., piping to
70 // `stamp` in the rust CI).
71 let out = format!(" {}/{}\n", self.test_count + 1, self.total_test_count);
72 self.write_plain(&out)?;
79 pub fn write_pretty(&mut self, word: &str, color: term::color::Color) -> io::Result<()> {
81 OutputLocation::Pretty(ref mut term) => {
85 term.write_all(word.as_bytes())?;
91 OutputLocation::Raw(ref mut stdout) => {
92 stdout.write_all(word.as_bytes())?;
98 pub fn write_plain<S: AsRef<str>>(&mut self, s: S) -> io::Result<()> {
100 self.out.write_all(s.as_bytes())?;
104 pub fn write_outputs(&mut self, state: &ConsoleTestState) -> io::Result<()> {
105 self.write_plain("\nsuccesses:\n")?;
106 let mut successes = Vec::new();
107 let mut stdouts = String::new();
108 for &(ref f, ref stdout) in &state.not_failures {
109 successes.push(f.name.to_string());
110 if !stdout.is_empty() {
111 stdouts.push_str(&format!("---- {} stdout ----\n", f.name));
112 let output = String::from_utf8_lossy(stdout);
113 stdouts.push_str(&output);
117 if !stdouts.is_empty() {
118 self.write_plain("\n")?;
119 self.write_plain(&stdouts)?;
122 self.write_plain("\nsuccesses:\n")?;
124 for name in &successes {
125 self.write_plain(&format!(" {name}\n"))?;
130 pub fn write_failures(&mut self, state: &ConsoleTestState) -> io::Result<()> {
131 self.write_plain("\nfailures:\n")?;
132 let mut failures = Vec::new();
133 let mut fail_out = String::new();
134 for &(ref f, ref stdout) in &state.failures {
135 failures.push(f.name.to_string());
136 if !stdout.is_empty() {
137 fail_out.push_str(&format!("---- {} stdout ----\n", f.name));
138 let output = String::from_utf8_lossy(stdout);
139 fail_out.push_str(&output);
143 if !fail_out.is_empty() {
144 self.write_plain("\n")?;
145 self.write_plain(&fail_out)?;
148 self.write_plain("\nfailures:\n")?;
150 for name in &failures {
151 self.write_plain(&format!(" {name}\n"))?;
156 fn write_test_name(&mut self, desc: &TestDesc) -> io::Result<()> {
157 let name = desc.padded_name(self.max_name_len, desc.name.padding());
158 if let Some(test_mode) = desc.test_mode() {
159 self.write_plain(&format!("test {name} - {test_mode} ... "))?;
161 self.write_plain(&format!("test {name} ... "))?;
168 impl<T: Write> OutputFormatter for TerseFormatter<T> {
169 fn write_run_start(&mut self, test_count: usize, shuffle_seed: Option<u64>) -> io::Result<()> {
170 self.total_test_count = test_count;
171 let noun = if test_count != 1 { "tests" } else { "test" };
172 let shuffle_seed_msg = if let Some(shuffle_seed) = shuffle_seed {
173 format!(" (shuffle seed: {shuffle_seed})")
177 self.write_plain(&format!("\nrunning {test_count} {noun}{shuffle_seed_msg}\n"))
180 fn write_test_start(&mut self, desc: &TestDesc) -> io::Result<()> {
181 // Remnants from old libtest code that used the padding value
182 // in order to indicate benchmarks.
183 // When running benchmarks, terse-mode should still print their name as if
184 // it is the Pretty formatter.
185 if !self.is_multithreaded && desc.name.padding() == NamePadding::PadOnRight {
186 self.write_test_name(desc)?;
196 _: Option<&time::TestExecTime>,
198 _: &ConsoleTestState,
199 ) -> io::Result<()> {
201 TestResult::TrOk => self.write_ok(),
202 TestResult::TrFailed | TestResult::TrFailedMsg(_) | TestResult::TrTimedFail => {
205 TestResult::TrIgnored => self.write_ignored(),
206 TestResult::TrBench(ref bs) => {
207 if self.is_multithreaded {
208 self.write_test_name(desc)?;
211 self.write_plain(&format!(": {}\n", fmt_bench_samples(bs)))
216 fn write_timeout(&mut self, desc: &TestDesc) -> io::Result<()> {
217 self.write_plain(&format!(
218 "test {} has been running for over {} seconds\n",
220 time::TEST_WARN_TIMEOUT_S
224 fn write_run_finish(&mut self, state: &ConsoleTestState) -> io::Result<bool> {
225 if state.options.display_output {
226 self.write_outputs(state)?;
228 let success = state.failed == 0;
230 self.write_failures(state)?;
233 self.write_plain("\ntest result: ")?;
236 // There's no parallelism at this point so it's safe to use color
237 self.write_pretty("ok", term::color::GREEN)?;
239 self.write_pretty("FAILED", term::color::RED)?;
243 ". {} passed; {} failed; {} ignored; {} measured; {} filtered out",
244 state.passed, state.failed, state.ignored, state.measured, state.filtered_out
247 self.write_plain(&s)?;
249 if let Some(ref exec_time) = state.exec_time {
250 let time_str = format!("; finished in {exec_time}");
251 self.write_plain(&time_str)?;
254 self.write_plain("\n\n")?;