Skip to content

fix: doctest respects Cargo's color options #14425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 20, 2024
Merged

fix: doctest respects Cargo's color options #14425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/cargo/ops/cargo_test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use crate::core::compiler::{Compilation, CompileKind, Doctest, Metadata, Unit, UnitOutput};
use crate::core::profiles::PanicStrategy;
use crate::core::shell::ColorChoice;
use crate::core::shell::Verbosity;
use crate::core::{TargetKind, Workspace};
use crate::ops;
Expand Down Expand Up @@ -176,6 +177,7 @@ fn run_doc_tests(
let gctx = ws.gctx();
let mut errors = Vec::new();
let doctest_xcompile = gctx.cli_unstable().doctest_xcompile;
let color = gctx.shell().color_choice();

for doctest_info in &compilation.to_doc_test {
let Doctest {
Expand Down Expand Up @@ -215,6 +217,14 @@ fn run_doc_tests(
for (var, value) in env {
p.env(var, value);
}

let color_arg = match color {
ColorChoice::Always => "always",
ColorChoice::Never => "never",
ColorChoice::CargoAuto => "auto",
};
p.arg("--color").arg(color_arg);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just want to call out that this may break others' builds if they already have --color in their RUSTDOCFLAGS. rustdoc doesn't allow more then one occurrence of the --color flag. While we don't consider this a breaking change, this is worth mentioning in changelog.


p.arg("--crate-name").arg(&unit.target.crate_name());
p.arg("--test");

Expand Down
2 changes: 1 addition & 1 deletion tests/testsuite/build_script.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2871,7 +2871,7 @@ fn env_test() {
[RUNNING] `[ROOT]/foo/target/debug/deps/foo-[HASH][EXE]`
[RUNNING] `[ROOT]/foo/target/debug/deps/test-[HASH][EXE]`
[DOCTEST] foo
[RUNNING] `rustdoc --edition=2015 --crate-type lib --crate-name foo[..]`
[RUNNING] `rustdoc --edition=2015 --crate-type lib --color auto --crate-name foo[..]`

"#]])
.with_stdout_data(str![[r#"
Expand Down
2 changes: 1 addition & 1 deletion tests/testsuite/lto.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,7 @@ fn cdylib_and_rlib() {
[RUNNING] `[ROOT]/foo/target/release/deps/bar-[HASH][EXE]`
[RUNNING] `[ROOT]/foo/target/release/deps/b-[HASH][EXE]`
[DOCTEST] bar
[RUNNING] `rustdoc --edition=2015 --crate-type cdylib --crate-type rlib --crate-name bar --test [..]-C lto [..]
[RUNNING] `rustdoc --edition=2015 --crate-type cdylib --crate-type rlib --color auto --crate-name bar --test [..]-C lto [..]

"#]].unordered())
.run();
Expand Down
2 changes: 1 addition & 1 deletion tests/testsuite/test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5555,7 +5555,7 @@ fn cargo_test_print_env_verbose() {
[FINISHED] `test` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
[RUNNING] `[..]CARGO_MANIFEST_DIR=[ROOT]/foo[..] [ROOT]/foo/target/debug/deps/foo-[HASH][EXE]`
[DOCTEST] foo
[RUNNING] `[..]CARGO_MANIFEST_DIR=[ROOT]/foo[..] rustdoc --edition=2015 --crate-type lib --crate-name foo[..]`
[RUNNING] `[..]CARGO_MANIFEST_DIR=[ROOT]/foo[..] rustdoc --edition=2015 --crate-type lib --color auto --crate-name foo[..]`

"#]]).run();
}
Expand Down