fix(test): Expose '--no-capture' in favor of `--nocapture` #139224

epage · 2025-04-01T21:22:44Z

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 #134283).
Most of pytests 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.

I expect we'll warn about --nocapture being deprecated in the future after a sufficient transition period has been allowed.
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 #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 libtest 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 fix(libtest): Deprecate '--logfile' #134283

Regarding the implementation, I moved --nocapture out of optgroups(), into parse_opts(), out of an abundance of caution in passing the options without a deprecated value to the usage generation. However, the usage does not actually show optional flags, so this could potentially be dropped, simplifying the PR.

Note: compiletest added --no-capture instead of --nocapture in #134809

T-testing-devex FCP: #133073 (comment)

Fixes #133073

rustbot · 2025-04-01T21:22:49Z

r? @joboet

rustbot has assigned @joboet.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

epage · 2025-04-01T21:23:17Z

library/test/src/cli.rs

+    let mut opts = optgroups();
+    // Flags hidden from `usage`
+    opts.optflag("", "nocapture", "Deprecated, use `--no-capture`");


From PR description:

Regarding the implementation, I moved --nocapture out of optgroups(), into parse_opts(), out of an abundance of caution in passing the options without a deprecated value to the usage generation. However, the usage does not actually show optional flags, so this could potentially be dropped, simplifying the PR.

jieyouxu · 2025-04-01T21:50:56Z

You'll probably also have to adjust compiletest to use the new field name.

library/test/src/cli.rs

joboet · 2025-04-03T08:56:44Z

I think Thom is more familiar with test.
r? @thomcc

rustbot · 2025-04-10T20:29:47Z

Some changes occurred in src/tools/compiletest

cc @jieyouxu

src/tools/compiletest/src/executor.rs

rfcbot · 2025-04-15T15:16:37Z

🔔 This is now entering its final comment period, as per the review above. 🔔

This will help with hiding some options in `--help`

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

rfcbot · 2025-04-25T15:22:08Z

The final comment period, with a disposition to merge, as per the review above, is now complete.

As the automated representative of the governance process, I would like to thank the author for their work and everyone else who contributed.

This will be merged soon.

thomcc · 2025-04-27T22:10:19Z

@bors r+

bors · 2025-04-27T22:10:21Z

📌 Commit aa8670f has been approved by thomcc

It is now in the queue for this repository.

fix(test): Expose '--no-capture' in favor of `--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. I expect we'll warn about `--nocapture` being deprecated in the future after a sufficient transition period has been allowed. 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 Regarding the implementation, I moved `--nocapture` out of `optgroups()`, into `parse_opts()`, out of an abundance of caution in passing the options without a deprecated value to the usage generation. However, the usage does not actually show optional flags, so this could potentially be dropped, simplifying the PR. Note: `compiletest` added `--no-capture` instead of `--nocapture` in rust-lang#134809 T-testing-devex FCP: rust-lang#133073 (comment) Fixes rust-lang#133073

…enton Rollup of 10 pull requests Successful merges: - rust-lang#136160 (Remove backticks from `ShouldPanic::YesWithMessage`'s `TrFailedMsg`) - rust-lang#138395 (Download GCC from CI on test builders) - rust-lang#138737 (uefi: Update r-efi) - rust-lang#138939 (Add `Arc::is_unique`) - rust-lang#139224 (fix(test): Expose '--no-capture' in favor of `--nocapture`) - rust-lang#139546 (std(docs): clarify how std::fs::set_permisions works with symlinks) - rust-lang#139883 (crashes: more tests) - rust-lang#140345 (Avoid re-interning in `LateContext::get_def_path`) - rust-lang#140351 (docs: fix incorrect stability markers on `std::{todo, matches}`) - rust-lang#140359 (specify explicit safety guidance for from_utf8_unchecked) r? `@ghost` `@rustbot` modify labels: rollup

fix(test): Expose '--no-capture' in favor of `--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. I expect we'll warn about `--nocapture` being deprecated in the future after a sufficient transition period has been allowed. 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 Regarding the implementation, I moved `--nocapture` out of `optgroups()`, into `parse_opts()`, out of an abundance of caution in passing the options without a deprecated value to the usage generation. However, the usage does not actually show optional flags, so this could potentially be dropped, simplifying the PR. Note: `compiletest` added `--no-capture` instead of `--nocapture` in rust-lang#134809 T-testing-devex FCP: rust-lang#133073 (comment) Fixes rust-lang#133073

…enton Rollup of 9 pull requests Successful merges: - rust-lang#138395 (Download GCC from CI on test builders) - rust-lang#138737 (uefi: Update r-efi) - rust-lang#138939 (Add `Arc::is_unique`) - rust-lang#139224 (fix(test): Expose '--no-capture' in favor of `--nocapture`) - rust-lang#139546 (std(docs): clarify how std::fs::set_permisions works with symlinks) - rust-lang#139883 (crashes: more tests) - rust-lang#140345 (Avoid re-interning in `LateContext::get_def_path`) - rust-lang#140351 (docs: fix incorrect stability markers on `std::{todo, matches}`) - rust-lang#140359 (specify explicit safety guidance for from_utf8_unchecked) r? `@ghost` `@rustbot` modify labels: rollup

…enton Rollup of 8 pull requests Successful merges: - rust-lang#138395 (Download GCC from CI on test builders) - rust-lang#138737 (uefi: Update r-efi) - rust-lang#138939 (Add `Arc::is_unique`) - rust-lang#139224 (fix(test): Expose '--no-capture' in favor of `--nocapture`) - rust-lang#139546 (std(docs): clarify how std::fs::set_permisions works with symlinks) - rust-lang#140345 (Avoid re-interning in `LateContext::get_def_path`) - rust-lang#140351 (docs: fix incorrect stability markers on `std::{todo, matches}`) - rust-lang#140359 (specify explicit safety guidance for from_utf8_unchecked) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#139224 - epage:nocapture, r=thomcc fix(test): Expose '--no-capture' in favor of `--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. I expect we'll warn about `--nocapture` being deprecated in the future after a sufficient transition period has been allowed. 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 Regarding the implementation, I moved `--nocapture` out of `optgroups()`, into `parse_opts()`, out of an abundance of caution in passing the options without a deprecated value to the usage generation. However, the usage does not actually show optional flags, so this could potentially be dropped, simplifying the PR. Note: `compiletest` added `--no-capture` instead of `--nocapture` in rust-lang#134809 T-testing-devex FCP: rust-lang#133073 (comment) Fixes rust-lang#133073

rustbot assigned joboet Apr 1, 2025

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Apr 1, 2025

epage commented Apr 1, 2025

View reviewed changes

epage added A-libtest Area: `#[test]` / the `test` library T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. labels Apr 1, 2025

This comment has been minimized.

Sign in to view

Noratrieb reviewed Apr 2, 2025

View reviewed changes

library/test/src/cli.rs Outdated Show resolved Hide resolved

rustbot assigned thomcc and unassigned joboet Apr 3, 2025

epage force-pushed the nocapture branch from 5bcfcd7 to b1e451f Compare April 10, 2025 20:29

rustbot added A-compiletest Area: The compiletest test runner A-testsuite Area: The testsuite used to check the correctness of rustc T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Apr 10, 2025

epage changed the title ~~fix(test): Expose '--no-capture', deprecating '--nocapture'~~ fix(test): Expose '--no-capture' in favor of --nocapture Apr 10, 2025

This comment has been minimized.

Sign in to view

epage force-pushed the nocapture branch from b1e451f to 4b43f4f Compare April 10, 2025 20:42

This comment has been minimized.

Sign in to view

jieyouxu self-assigned this Apr 10, 2025

jieyouxu reviewed Apr 11, 2025

View reviewed changes

src/tools/compiletest/src/executor.rs Outdated Show resolved Hide resolved

jieyouxu removed their assignment Apr 11, 2025

epage force-pushed the nocapture branch from 4b43f4f to 68e615c Compare April 11, 2025 15:19

This comment has been minimized.

Sign in to view

epage force-pushed the nocapture branch from 68e615c to 71a8f91 Compare April 11, 2025 16:20

epage added I-libs-api-nominated Nominated for discussion during a libs-api team meeting. and removed T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Apr 14, 2025

epage force-pushed the nocapture branch from 71a8f91 to 8894d7f Compare April 17, 2025 18:30

epage added 2 commits April 17, 2025 13:30

refactor(test): Decouple parsing from help generation

11f7290

This will help with hiding some options in `--help`

epage force-pushed the nocapture branch from 8894d7f to aa8670f Compare April 17, 2025 18:31

rustbot mentioned this pull request Apr 25, 2025

Tracking issue for release notes of #139224: fix(test): Expose '--no-capture' in favor of --nocapture #140296

Open

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 27, 2025

ChrisDenton mentioned this pull request Apr 28, 2025

Rollup of 10 pull requests #140376

Closed

ChrisDenton mentioned this pull request Apr 28, 2025

Rollup of 9 pull requests #140377

Closed

ChrisDenton mentioned this pull request Apr 28, 2025

Rollup of 8 pull requests #140378

Merged

bors merged commit 8ee9029 into rust-lang:master Apr 28, 2025
6 checks passed

rustbot added this to the 1.88.0 milestone Apr 28, 2025

epage deleted the nocapture branch April 28, 2025 11:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(test): Expose '--no-capture' in favor of `--nocapture` #139224

fix(test): Expose '--no-capture' in favor of `--nocapture` #139224

epage commented Apr 1, 2025 •

edited

Loading

rustbot commented Apr 1, 2025

epage Apr 1, 2025

This comment has been minimized.

jieyouxu commented Apr 1, 2025

joboet commented Apr 3, 2025

rustbot commented Apr 10, 2025

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

rfcbot commented Apr 15, 2025

rfcbot commented Apr 25, 2025

thomcc commented Apr 27, 2025

bors commented Apr 27, 2025

fix(test): Expose '--no-capture' in favor of --nocapture #139224

fix(test): Expose '--no-capture' in favor of --nocapture #139224

Conversation

epage commented Apr 1, 2025 • edited Loading

rustbot commented Apr 1, 2025

epage Apr 1, 2025

Choose a reason for hiding this comment

This comment has been minimized.

jieyouxu commented Apr 1, 2025

joboet commented Apr 3, 2025

rustbot commented Apr 10, 2025

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

rfcbot commented Apr 15, 2025

rfcbot commented Apr 25, 2025

thomcc commented Apr 27, 2025

bors commented Apr 27, 2025

fix(test): Expose '--no-capture' in favor of `--nocapture` #139224

fix(test): Expose '--no-capture' in favor of `--nocapture` #139224

epage commented Apr 1, 2025 •

edited

Loading