Skip to content

Commit 71a8f91

Browse files
committed
fix(test): Expose '--no-capture', deprecating '--nocapture'
This improves consistency with commonly expected CLI conventions, avoiding a common stutter people make when running tests (trying what they expect and then having to check the docs to then user whats accepted). An alternative could have been to take a value, like `--capture <value>` (e.g. `pytest` does this). Overall, we're shifting focus for features to custom test harnesses (see rust-lang#134283). Most of `pytest`s modes will likely be irrelevant in that situation. As for the rest, its too early to tell which, if any, may be relevant, so we're sticking with this small, quality of life improvement. By deprecating `--nocapture`, we intend that custom test harnesses do not need to support it for reasons outside of their own compatibility requirements, much like the deprecation in rust-lang#134283 I'm punting for now on the naming of `RUST_TEST_NOCAPTURE`. I feel like T-testing-devex should do a wider look at environment variables role in lib`test` before evaluating whether to - Deprecate it in favor of the user passing CLI flags or the test runner providing its own config - Deprecate in favor of `RUST_TEST_NO_CAPTURE` - Deprecate in favor of `RUST_TEST_CAPTURE` Other CLI flags were evaluated for casing consistency: - `--logfile` has the same problem but was deprecated in rust-lang#134283 Fixes rust-lang#133073
1 parent ac8b0e2 commit 71a8f91

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

library/test/src/cli.rs

+7-4
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ fn optgroups() -> getopts::Options {
6161
.optopt("", "logfile", "Write logs to the specified file (deprecated)", "PATH")
6262
.optflag(
6363
"",
64-
"nocapture",
64+
"no-capture",
6565
"don't capture stdout/stderr of each \
6666
task, allow printing directly",
6767
)
@@ -172,7 +172,7 @@ tests in the same order again. Note that --shuffle and --shuffle-seed do not
172172
affect whether the tests are run in parallel.
173173
174174
All tests have their standard output and standard error captured by default.
175-
This can be overridden with the --nocapture flag or setting RUST_TEST_NOCAPTURE
175+
This can be overridden with the --no-capture flag or setting RUST_TEST_NOCAPTURE
176176
environment variable to a value other than "0". Logging is not captured by default.
177177
178178
Test Attributes:
@@ -199,7 +199,10 @@ Test Attributes:
199199
/// otherwise creates a `TestOpts` object and returns it.
200200
pub fn parse_opts(args: &[String]) -> Option<OptRes> {
201201
// Parse matches.
202-
let opts = optgroups();
202+
let mut opts = optgroups();
203+
// Flags hidden from `usage`
204+
opts.optflag("", "nocapture", "Deprecated, use `--no-capture`");
205+
203206
let binary = args.first().map(|c| &**c).unwrap_or("...");
204207
let args = args.get(1..).unwrap_or(args);
205208
let matches = match opts.parse(args) {
@@ -447,7 +450,7 @@ fn get_color_config(matches: &getopts::Matches) -> OptPartRes<ColorConfig> {
447450
}
448451

449452
fn get_nocapture(matches: &getopts::Matches) -> OptPartRes<bool> {
450-
let mut nocapture = matches.opt_present("nocapture");
453+
let mut nocapture = matches.opt_present("nocapture") || matches.opt_present("no-capture");
451454
if !nocapture {
452455
nocapture = match env::var("RUST_TEST_NOCAPTURE") {
453456
Ok(val) => &val != "0",

0 commit comments

Comments
 (0)