Skip to content

Add --color to test binary options #14760

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

Closed
wants to merge 1 commit into from
Closed

Add --color to test binary options #14760

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
1 change: 1 addition & 0 deletions src/compiletest/compiletest.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,7 @@ pub fn test_opts(config: &Config) -> test::TestOpts {
save_metrics: config.save_metrics.clone(),
test_shard: config.test_shard.clone(),
nocapture: false,
color: test::AutoColor,
}
}

Expand Down
35 changes: 31 additions & 4 deletions src/libtest/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,12 @@ pub fn test_main_static_x(args: &[~str], tests: &[TestDescAndFn]) {
tests)
}

pub enum ColorConfig {
AutoColor,
AlwaysColor,
NeverColor,
}

pub struct TestOpts {
pub filter: Option<Regex>,
pub run_ignored: bool,
Expand All @@ -282,6 +288,7 @@ pub struct TestOpts {
pub test_shard: Option<(uint,uint)>,
pub logfile: Option<Path>,
pub nocapture: bool,
pub color: ColorConfig,
}

impl TestOpts {
Expand All @@ -298,6 +305,7 @@ impl TestOpts {
test_shard: None,
logfile: None,
nocapture: false,
color: AutoColor,
}
}
}
Expand All @@ -324,7 +332,11 @@ fn optgroups() -> Vec<getopts::OptGroup> {
getopts::optopt("", "test-shard", "run shard A, of B shards, worth of the testsuite",
"A.B"),
getopts::optflag("", "nocapture", "don't capture stdout/stderr of each \
task, allow printing directly"))
task, allow printing directly"),
getopts::optopt("", "color", "Configure coloring of output:
auto = colorize if stdout is a tty and tests are run on serially (default);
Copy link
Member

Choose a reason for hiding this comment

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

Do you mean for this to be indented 12 spaces in the final output?

Copy link
Member Author

Choose a reason for hiding this comment

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

It's not. Getopts strips newlines, looks like.

always = always colorize output;
never = never colorize output;", "auto|always|never"))
}

fn usage(binary: &str) {
Expand Down Expand Up @@ -406,6 +418,16 @@ pub fn parse_opts(args: &[String]) -> Option<OptRes> {
nocapture = os::getenv("RUST_TEST_NOCAPTURE").is_some();
}

let color = match matches.opt_str("color").as_ref().map(|s| s.as_slice()) {
Some("auto") | None => AutoColor,
Some("always") => AlwaysColor,
Some("never") => NeverColor,

Some(v) => return Some(Err(format!("argument for --color must be \
auto, always, or never (was {})",
v))),
};

let test_opts = TestOpts {
filter: filter,
run_ignored: run_ignored,
Expand All @@ -417,6 +439,7 @@ pub fn parse_opts(args: &[String]) -> Option<OptRes> {
test_shard: test_shard,
logfile: logfile,
nocapture: nocapture,
color: color,
};

Some(Ok(test_opts))
Expand Down Expand Up @@ -492,7 +515,7 @@ impl<T: Writer> ConsoleTestState<T> {
Ok(ConsoleTestState {
out: out,
log_out: log_out,
use_color: use_color(),
use_color: use_color(opts),
total: 0u,
passed: 0u,
failed: 0u,
Expand Down Expand Up @@ -867,8 +890,12 @@ fn should_sort_failures_before_printing_them() {
assert!(apos < bpos);
}

fn use_color() -> bool {
get_concurrency() == 1 && io::stdout().get_ref().isatty()
fn use_color(opts: &TestOpts) -> bool {
match opts.color {
AutoColor => get_concurrency() == 1 && io::stdout().get_ref().isatty(),
AlwaysColor => true,
NeverColor => false,
}
}

#[deriving(Clone)]
Expand Down