Skip to content

Commit 74dfc1d

Browse files
borsbors
committed
Auto merge of #31887 - SimonSapin:quiet-test, r=alexcrichton
Shorter output for `rustc --test` binaries. Until now, a program created with `rustc --test` prints at least one line per test. This can be very verbose, especially with [data-driven tests](https://internals.rust-lang.org/t/test-and-external-test-harnesses/3145) when hundreds or thousands of tests is not rare. This changes the default output to one character per test (except metrics and benchmarks results which have additional data to show): ``` Running target/debug/wpt-75c594dc1e6e6187 running 314 tests .............................................................................. .............................................................................. .............................................................................. .............................................................................. .. test result: ok. 314 passed; 0 failed; 0 ignored; 0 measured ``` <s>The previous behavior is available by passing `--verbose` to the test program. Maybe `cargo test --verbose` could be changed to do that?</s> **Edit:** the default is now unchanged, `-q` or `--quiet` enables the new output.
2 parents 1efa752 + d23fd71 commit 74dfc1d

File tree

4 files changed

+44
-17
lines changed

4 files changed

+44
-17
lines changed

‎src/compiletest/common.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -155,5 +155,8 @@ pub struct Config {
155155
pub lldb_python_dir: Option<String>,
156156

157157
// Explain what's going on
158-
pub verbose: bool
158+
pub verbose: bool,
159+
160+
// Print one character per test instead of one line
161+
pub quiet: bool,
159162
}

‎src/compiletest/compiletest.rs

+4
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ pub fn parse_config(args: Vec<String> ) -> Config {
7777
optopt("", "host-rustcflags", "flags to pass to rustc for host", "FLAGS"),
7878
optopt("", "target-rustcflags", "flags to pass to rustc for target", "FLAGS"),
7979
optflag("", "verbose", "run tests verbosely, showing all output"),
80+
optflag("", "quiet", "print one character per test instead of one line"),
8081
optopt("", "logfile", "file to log test execution to", "FILE"),
8182
optopt("", "target", "the target to build for", "TARGET"),
8283
optopt("", "host", "the host to build for", "HOST"),
@@ -151,6 +152,7 @@ pub fn parse_config(args: Vec<String> ) -> Config {
151152
!opt_str2(matches.opt_str("adb-test-dir")).is_empty(),
152153
lldb_python_dir: matches.opt_str("lldb-python-dir"),
153154
verbose: matches.opt_present("verbose"),
155+
quiet: matches.opt_present("quiet"),
154156
}
155157
}
156158

@@ -184,6 +186,7 @@ pub fn log_config(config: &Config) {
184186
logv(c, format!("adb_device_status: {}",
185187
config.adb_device_status));
186188
logv(c, format!("verbose: {}", config.verbose));
189+
logv(c, format!("quiet: {}", config.quiet));
187190
logv(c, format!("\n"));
188191
}
189192

@@ -247,6 +250,7 @@ pub fn test_opts(config: &Config) -> test::TestOpts {
247250
test::TestOpts {
248251
filter: config.filter.clone(),
249252
run_ignored: config.run_ignored,
253+
quiet: config.quiet,
250254
logfile: config.logfile.clone(),
251255
run_tests: true,
252256
bench_benchmarks: true,

‎src/libtest/lib.rs

+34-16
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ impl fmt::Display for TestName {
106106
}
107107
}
108108

109-
#[derive(Clone, Copy)]
109+
#[derive(Clone, Copy, PartialEq, Eq)]
110110
enum NamePadding {
111111
PadNone,
112112
PadOnRight,
@@ -298,6 +298,7 @@ pub struct TestOpts {
298298
pub logfile: Option<PathBuf>,
299299
pub nocapture: bool,
300300
pub color: ColorConfig,
301+
pub quiet: bool,
301302
}
302303

303304
impl TestOpts {
@@ -311,6 +312,7 @@ impl TestOpts {
311312
logfile: None,
312313
nocapture: false,
313314
color: AutoColor,
315+
quiet: false,
314316
}
315317
}
316318
}
@@ -328,6 +330,7 @@ fn optgroups() -> Vec<getopts::OptGroup> {
328330
of stdout", "PATH"),
329331
getopts::optflag("", "nocapture", "don't capture stdout/stderr of each \
330332
task, allow printing directly"),
333+
getopts::optflag("q", "quiet", "Display one character per test instead of one line"),
331334
getopts::optopt("", "color", "Configure coloring of output:
332335
auto = colorize if stdout is a tty and tests are run on serially (default);
333336
always = always colorize output;
@@ -385,6 +388,7 @@ pub fn parse_opts(args: &[String]) -> Option<OptRes> {
385388
};
386389

387390
let run_ignored = matches.opt_present("ignored");
391+
let quiet = matches.opt_present("quiet");
388392

389393
let logfile = matches.opt_str("logfile");
390394
let logfile = logfile.map(|s| PathBuf::from(&s));
@@ -417,6 +421,7 @@ pub fn parse_opts(args: &[String]) -> Option<OptRes> {
417421
logfile: logfile,
418422
nocapture: nocapture,
419423
color: color,
424+
quiet: quiet,
420425
};
421426

422427
Some(Ok(test_opts))
@@ -448,6 +453,7 @@ struct ConsoleTestState<T> {
448453
log_out: Option<File>,
449454
out: OutputLocation<T>,
450455
use_color: bool,
456+
quiet: bool,
451457
total: usize,
452458
passed: usize,
453459
failed: usize,
@@ -473,6 +479,7 @@ impl<T: Write> ConsoleTestState<T> {
473479
out: out,
474480
log_out: log_out,
475481
use_color: use_color(opts),
482+
quiet: opts.quiet,
476483
total: 0,
477484
passed: 0,
478485
failed: 0,
@@ -485,15 +492,15 @@ impl<T: Write> ConsoleTestState<T> {
485492
}
486493

487494
pub fn write_ok(&mut self) -> io::Result<()> {
488-
self.write_pretty("ok", term::color::GREEN)
495+
self.write_short_result("ok", ".", term::color::GREEN)
489496
}
490497

491498
pub fn write_failed(&mut self) -> io::Result<()> {
492-
self.write_pretty("FAILED", term::color::RED)
499+
self.write_short_result("FAILED", "F", term::color::RED)
493500
}
494501

495502
pub fn write_ignored(&mut self) -> io::Result<()> {
496-
self.write_pretty("ignored", term::color::YELLOW)
503+
self.write_short_result("ignored", "i", term::color::YELLOW)
497504
}
498505

499506
pub fn write_metric(&mut self) -> io::Result<()> {
@@ -504,6 +511,16 @@ impl<T: Write> ConsoleTestState<T> {
504511
self.write_pretty("bench", term::color::CYAN)
505512
}
506513

514+
pub fn write_short_result(&mut self, verbose: &str, quiet: &str, color: term::color::Color)
515+
-> io::Result<()> {
516+
if self.quiet {
517+
self.write_pretty(quiet, color)
518+
} else {
519+
try!(self.write_pretty(verbose, color));
520+
self.write_plain("\n")
521+
}
522+
}
523+
507524
pub fn write_pretty(&mut self, word: &str, color: term::color::Color) -> io::Result<()> {
508525
match self.out {
509526
Pretty(ref mut term) => {
@@ -547,28 +564,28 @@ impl<T: Write> ConsoleTestState<T> {
547564
}
548565

549566
pub fn write_test_start(&mut self, test: &TestDesc, align: NamePadding) -> io::Result<()> {
550-
let name = test.padded_name(self.max_name_len, align);
551-
self.write_plain(&format!("test {} ... ", name))
567+
if self.quiet && align != PadOnRight {
568+
Ok(())
569+
} else {
570+
let name = test.padded_name(self.max_name_len, align);
571+
self.write_plain(&format!("test {} ... ", name))
572+
}
552573
}
553574

554575
pub fn write_result(&mut self, result: &TestResult) -> io::Result<()> {
555-
try!(match *result {
576+
match *result {
556577
TrOk => self.write_ok(),
557578
TrFailed => self.write_failed(),
558579
TrIgnored => self.write_ignored(),
559580
TrMetrics(ref mm) => {
560581
try!(self.write_metric());
561-
self.write_plain(&format!(": {}", mm.fmt_metrics()))
582+
self.write_plain(&format!(": {}\n", mm.fmt_metrics()))
562583
}
563584
TrBench(ref bs) => {
564585
try!(self.write_bench());
565-
566-
try!(self.write_plain(&format!(": {}", fmt_bench_samples(bs))));
567-
568-
Ok(())
586+
self.write_plain(&format!(": {}\n", fmt_bench_samples(bs)))
569587
}
570-
});
571-
self.write_plain("\n")
588+
}
572589
}
573590

574591
pub fn write_log(&mut self, test: &TestDesc, result: &TestResult) -> io::Result<()> {
@@ -626,9 +643,9 @@ impl<T: Write> ConsoleTestState<T> {
626643
try!(self.write_plain("\ntest result: "));
627644
if success {
628645
// There's no parallelism at this point so it's safe to use color
629-
try!(self.write_ok());
646+
try!(self.write_pretty("ok", term::color::GREEN));
630647
} else {
631-
try!(self.write_failed());
648+
try!(self.write_pretty("FAILED", term::color::RED));
632649
}
633650
let s = format!(". {} passed; {} failed; {} ignored; {} measured\n\n",
634651
self.passed,
@@ -755,6 +772,7 @@ fn should_sort_failures_before_printing_them() {
755772
log_out: None,
756773
out: Raw(Vec::new()),
757774
use_color: false,
775+
quiet: false,
758776
total: 0,
759777
passed: 0,
760778
failed: 0,

‎src/test/run-make/test-harness/Makefile

+2
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ all:
55
$(RUSTC) --test test-ignore-cfg.rs --cfg ignorecfg
66
$(call RUN,test-ignore-cfg) | grep 'shouldnotignore ... ok'
77
$(call RUN,test-ignore-cfg) | grep 'shouldignore ... ignored'
8+
$(call RUN,test-ignore-cfg --quiet) | grep "^i\.$$"
9+
$(call RUN,test-ignore-cfg --quiet) | grep -v 'should'

0 commit comments

Comments
 (0)