1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
//! Definition of the `Printer`.
//!
//! This is just an abstraction for everything that is printed to the screen
//! (or logfile, if specified). These parameters influence printing:
//! - `color`
//! - `format` (and `quiet`)
//! - `logfile`
use std::{fs::File, io::Write, time::Duration};
use anstream::AutoStream;
use anstyle::{AnsiColor, Color, Style};
use crate::{
Arguments, ColorSetting, Conclusion, Failed, FormatSetting, Measurement, Outcome, TestInfo,
Trial,
};
pub(crate) struct Printer {
out: Box<dyn Write>,
format: FormatSetting,
name_width: usize,
kind_width: usize,
}
impl Printer {
/// Creates a new printer configured by the given arguments (`format`,
/// `quiet`, `color` and `logfile` options).
pub(crate) fn new(args: &Arguments, tests: &[Trial]) -> Self {
let color_arg = args.color.unwrap_or(ColorSetting::Auto);
// Determine target of all output
let out: Box<dyn Write> = if let Some(logfile) = &args.logfile {
let f = File::create(logfile).expect("failed to create logfile");
if color_arg == ColorSetting::Always {
Box::new(AutoStream::always(f))
} else {
Box::new(AutoStream::never(f))
}
} else {
let choice = match color_arg {
ColorSetting::Auto => anstream::ColorChoice::Auto,
ColorSetting::Always => anstream::ColorChoice::Always,
ColorSetting::Never => anstream::ColorChoice::Never,
};
Box::new(AutoStream::new(std::io::stdout(), choice))
};
// Determine correct format
let format = if args.quiet {
FormatSetting::Terse
} else {
args.format.unwrap_or(FormatSetting::Pretty)
};
// Determine max test name length to do nice formatting later.
//
// Unicode is hard and there is no way we can properly align/pad the
// test names and outcomes. Counting the number of code points is just
// a cheap way that works in most cases. Usually, these names are
// ASCII.
let name_width = tests.iter()
.map(|test| test.info.name.chars().count())
.max()
.unwrap_or(0);
let kind_width = tests.iter()
.map(|test| {
if test.info.kind.is_empty() {
0
} else {
// The two braces [] and one space
test.info.kind.chars().count() + 3
}
})
.max()
.unwrap_or(0);
Self {
out,
format,
name_width,
kind_width,
}
}
/// Prints the first line "running 3 tests".
pub(crate) fn print_title(&mut self, num_tests: u64) {
match self.format {
FormatSetting::Pretty | FormatSetting::Terse => {
let plural_s = if num_tests == 1 { "" } else { "s" };
writeln!(self.out).unwrap();
writeln!(self.out, "running {} test{}", num_tests, plural_s).unwrap();
}
FormatSetting::Json => writeln!(
self.out,
r#"{{ "type": "suite", "event": "started", "test_count": {} }}"#,
num_tests
)
.unwrap(),
}
}
/// Prints the text announcing the test (e.g. "test foo::bar ... "). Prints
/// nothing in terse mode.
pub(crate) fn print_test(&mut self, info: &TestInfo) {
let TestInfo { name, kind, .. } = info;
match self.format {
FormatSetting::Pretty => {
let kind = if kind.is_empty() {
String::new()
} else {
format!("[{}] ", kind)
};
write!(
self.out,
"test {: <2$}{: <3$} ... ",
kind,
name,
self.kind_width,
self.name_width,
).unwrap();
self.out.flush().unwrap();
}
FormatSetting::Terse => {
// In terse mode, nothing is printed before the job. Only
// `print_single_outcome` prints one character.
}
FormatSetting::Json => {
writeln!(
self.out,
r#"{{ "type": "test", "event": "started", "name": "{}" }}"#,
escape8259::escape(name),
)
.unwrap();
}
}
}
/// Prints the outcome of a single tests. `ok` or `FAILED` in pretty mode
/// and `.` or `F` in terse mode.
pub(crate) fn print_single_outcome(&mut self, info: &TestInfo, outcome: &Outcome) {
match self.format {
FormatSetting::Pretty => {
self.print_outcome_pretty(outcome);
writeln!(self.out).unwrap();
}
FormatSetting::Terse => {
let c = match outcome {
Outcome::Passed => '.',
Outcome::Failed { .. } => 'F',
Outcome::Ignored => 'i',
Outcome::Measured { .. } => {
// Benchmark are never printed in terse mode... for
// some reason.
self.print_outcome_pretty(outcome);
writeln!(self.out).unwrap();
return;
}
};
let style = color_of_outcome(outcome);
write!(self.out, "{style}{}{style:#}", c).unwrap();
}
FormatSetting::Json => {
if let Outcome::Measured(Measurement { avg, variance }) = outcome {
writeln!(
self.out,
r#"{{ "type": "bench", "name": "{}", "median": {}, "deviation": {} }}"#,
escape8259::escape(&info.name),
avg,
variance,
)
.unwrap();
} else {
writeln!(
self.out,
r#"{{ "type": "test", "name": "{}", "event": "{}"{} }}"#,
escape8259::escape(&info.name),
match outcome {
Outcome::Passed => "ok",
Outcome::Failed(_) => "failed",
Outcome::Ignored => "ignored",
Outcome::Measured(_) => unreachable!(),
},
match outcome {
Outcome::Failed(Failed { msg: Some(msg) }) => {
format!(
r#", "stdout": "Error: \"{}\"\n""#,
escape8259::escape(msg),
)
}
_ => "".into(),
}
)
.unwrap();
}
}
}
}
/// Prints the summary line after all tests have been executed.
pub(crate) fn print_summary(&mut self, conclusion: &Conclusion, execution_time: Duration) {
match self.format {
FormatSetting::Pretty | FormatSetting::Terse => {
let outcome = if conclusion.has_failed() {
Outcome::Failed(Failed { msg: None })
} else {
Outcome::Passed
};
writeln!(self.out).unwrap();
write!(self.out, "test result: ").unwrap();
self.print_outcome_pretty(&outcome);
writeln!(
self.out,
". {} passed; {} failed; {} ignored; {} measured; \
{} filtered out; finished in {:.2}s",
conclusion.num_passed,
conclusion.num_failed,
conclusion.num_ignored,
conclusion.num_measured,
conclusion.num_filtered_out,
execution_time.as_secs_f64()
).unwrap();
writeln!(self.out).unwrap();
}
FormatSetting::Json => {
writeln!(
self.out,
concat!(
r#"{{ "type": "suite", "event": "{}", "passed": {}, "failed": {},"#,
r#" "ignored": {}, "measured": {}, "filtered_out": {}, "exec_time": {} }}"#,
),
if conclusion.num_failed > 0 { "failed" } else { "ok" },
conclusion.num_passed,
conclusion.num_failed,
conclusion.num_ignored,
conclusion.num_measured,
conclusion.num_filtered_out,
execution_time.as_secs_f64()
)
.unwrap();
}
}
}
/// Prints a list of all tests. Used if `--list` is set.
pub(crate) fn print_list(&mut self, tests: &[Trial], ignored: bool) {
Self::write_list(tests, ignored, &mut self.out).unwrap();
}
pub(crate) fn write_list(
tests: &[Trial],
ignored: bool,
mut out: impl std::io::Write,
) -> std::io::Result<()> {
for test in tests {
// libtest prints out:
// * all tests without `--ignored`
// * just the ignored tests with `--ignored`
if ignored && !test.info.is_ignored {
continue;
}
let kind = if test.info.kind.is_empty() {
String::new()
} else {
format!("[{}] ", test.info.kind)
};
writeln!(
out,
"{}{}: {}",
kind,
test.info.name,
if test.info.is_bench { "bench" } else { "test" },
)?;
}
Ok(())
}
/// Prints a list of failed tests with their messages. This is only called
/// if there were any failures.
pub(crate) fn print_failures(&mut self, fails: &[(TestInfo, Option<String>)]) {
if self.format == FormatSetting::Json {
return;
}
writeln!(self.out).unwrap();
writeln!(self.out, "failures:").unwrap();
writeln!(self.out).unwrap();
// Print messages of all tests
for (test_info, msg) in fails {
writeln!(self.out, "---- {} ----", test_info.name).unwrap();
if let Some(msg) = msg {
writeln!(self.out, "{}", msg).unwrap();
}
writeln!(self.out).unwrap();
}
// Print summary list of failed tests
writeln!(self.out).unwrap();
writeln!(self.out, "failures:").unwrap();
for (test_info, _) in fails {
writeln!(self.out, " {}", test_info.name).unwrap();
}
}
/// Prints a colored 'ok'/'FAILED'/'ignored'/'bench'.
fn print_outcome_pretty(&mut self, outcome: &Outcome) {
let s = match outcome {
Outcome::Passed => "ok",
Outcome::Failed { .. } => "FAILED",
Outcome::Ignored => "ignored",
Outcome::Measured { .. } => "bench",
};
let style = color_of_outcome(outcome);
write!(self.out, "{style}{}{style:#}", s).unwrap();
if let Outcome::Measured(Measurement { avg, variance }) = outcome {
write!(
self.out,
": {:>11} ns/iter (+/- {})",
fmt_with_thousand_sep(*avg),
fmt_with_thousand_sep(*variance),
).unwrap();
}
}
}
/// Formats the given integer with `,` as thousand separator.
pub fn fmt_with_thousand_sep(mut v: u64) -> String {
let mut out = String::new();
while v >= 1000 {
out = format!(",{:03}{}", v % 1000, out);
v /= 1000;
}
out = format!("{}{}", v, out);
out
}
/// Returns the `ColorSpec` associated with the given outcome.
fn color_of_outcome(outcome: &Outcome) -> Style {
let color = match outcome {
Outcome::Passed => AnsiColor::Green,
Outcome::Failed { .. } => AnsiColor::Red,
Outcome::Ignored => AnsiColor::Yellow,
Outcome::Measured { .. } => AnsiColor::Cyan,
};
Style::new().fg_color(Some(Color::Ansi(color)))
}