mirror of
https://github.com/rust-lang/cargo
synced 2024-08-25 02:25:46 +00:00
192 lines
5.5 KiB
Rust
192 lines
5.5 KiB
Rust
//! Tests for cargo's help output.
|
|
|
|
use cargo_test_support::registry::Package;
|
|
use cargo_test_support::{basic_manifest, cargo_exe, cargo_process, paths, process, project};
|
|
use std::fs;
|
|
use std::path::Path;
|
|
use std::str::from_utf8;
|
|
|
|
#[cargo_test]
|
|
fn help() {
|
|
cargo_process("").run();
|
|
cargo_process("help").run();
|
|
cargo_process("-h").run();
|
|
cargo_process("help build").run();
|
|
cargo_process("build -h").run();
|
|
cargo_process("help help").run();
|
|
// Ensure that help output goes to stdout, not stderr.
|
|
cargo_process("search --help").with_stderr("").run();
|
|
cargo_process("search --help")
|
|
.with_stdout_contains("[..] --frozen [..]")
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn help_external_subcommand() {
|
|
// Check that `help external-subcommand` forwards the --help flag to the
|
|
// given subcommand.
|
|
Package::new("cargo-fake-help", "1.0.0")
|
|
.file(
|
|
"src/main.rs",
|
|
r#"
|
|
fn main() {
|
|
if ::std::env::args().nth(2) == Some(String::from("--help")) {
|
|
println!("fancy help output");
|
|
}
|
|
}
|
|
"#,
|
|
)
|
|
.publish();
|
|
cargo_process("install cargo-fake-help").run();
|
|
cargo_process("help fake-help")
|
|
.with_stdout("fancy help output\n")
|
|
.run();
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn z_flags_help() {
|
|
// Test that the output of `cargo -Z help` shows a different help screen with
|
|
// all the `-Z` flags.
|
|
cargo_process("-Z help")
|
|
.with_stdout_contains(
|
|
" -Z allow-features[..]-- Allow *only* the listed unstable features",
|
|
)
|
|
.run();
|
|
}
|
|
|
|
fn help_with_man(display_command: &str) {
|
|
// Build a "man" process that just echoes the contents.
|
|
let p = project()
|
|
.at(display_command)
|
|
.file("Cargo.toml", &basic_manifest(display_command, "1.0.0"))
|
|
.file(
|
|
"src/main.rs",
|
|
&r#"
|
|
fn main() {
|
|
eprintln!("custom __COMMAND__");
|
|
let path = std::env::args().skip(1).next().unwrap();
|
|
let mut f = std::fs::File::open(path).unwrap();
|
|
std::io::copy(&mut f, &mut std::io::stdout()).unwrap();
|
|
}
|
|
"#
|
|
.replace("__COMMAND__", display_command),
|
|
)
|
|
.build();
|
|
p.cargo("build").run();
|
|
|
|
help_with_man_and_path(display_command, "build", "build", &p.target_debug_dir());
|
|
}
|
|
|
|
fn help_with_man_and_path(
|
|
display_command: &str,
|
|
subcommand: &str,
|
|
actual_subcommand: &str,
|
|
path: &Path,
|
|
) {
|
|
let contents = if display_command == "man" {
|
|
fs::read_to_string(format!("src/etc/man/cargo-{}.1", actual_subcommand)).unwrap()
|
|
} else {
|
|
fs::read_to_string(format!(
|
|
"src/doc/man/generated_txt/cargo-{}.txt",
|
|
actual_subcommand
|
|
))
|
|
.unwrap()
|
|
};
|
|
|
|
let output = process(&cargo_exe())
|
|
.arg("help")
|
|
.arg(subcommand)
|
|
.env("PATH", path)
|
|
.exec_with_output()
|
|
.unwrap();
|
|
assert!(output.status.success());
|
|
let stderr = from_utf8(&output.stderr).unwrap();
|
|
if display_command.is_empty() {
|
|
assert_eq!(stderr, "");
|
|
} else {
|
|
assert_eq!(stderr, format!("custom {}\n", display_command));
|
|
}
|
|
let stdout = from_utf8(&output.stdout).unwrap();
|
|
assert_eq!(stdout, contents);
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn help_man() {
|
|
// Checks that `help command` displays the man page using the given command.
|
|
help_with_man("man");
|
|
help_with_man("less");
|
|
help_with_man("more");
|
|
|
|
// Check with no commands in PATH.
|
|
help_with_man_and_path("", "build", "build", Path::new(""));
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn help_alias() {
|
|
// Check that `help some_alias` will resolve.
|
|
help_with_man_and_path("", "b", "build", Path::new(""));
|
|
|
|
let config = paths::root().join(".cargo/config");
|
|
fs::create_dir_all(config.parent().unwrap()).unwrap();
|
|
fs::write(
|
|
config,
|
|
r#"
|
|
[alias]
|
|
my-alias = ["build", "--release"]
|
|
"#,
|
|
)
|
|
.unwrap();
|
|
help_with_man_and_path("", "my-alias", "build", Path::new(""));
|
|
}
|
|
|
|
#[cargo_test]
|
|
fn alias_z_flag_help() {
|
|
cargo_process("build -Z help")
|
|
.with_stdout_contains(
|
|
" -Z allow-features[..]-- Allow *only* the listed unstable features",
|
|
)
|
|
.run();
|
|
|
|
cargo_process("run -Z help")
|
|
.with_stdout_contains(
|
|
" -Z allow-features[..]-- Allow *only* the listed unstable features",
|
|
)
|
|
.run();
|
|
|
|
cargo_process("check -Z help")
|
|
.with_stdout_contains(
|
|
" -Z allow-features[..]-- Allow *only* the listed unstable features",
|
|
)
|
|
.run();
|
|
|
|
cargo_process("test -Z help")
|
|
.with_stdout_contains(
|
|
" -Z allow-features[..]-- Allow *only* the listed unstable features",
|
|
)
|
|
.run();
|
|
|
|
cargo_process("b -Z help")
|
|
.with_stdout_contains(
|
|
" -Z allow-features[..]-- Allow *only* the listed unstable features",
|
|
)
|
|
.run();
|
|
|
|
cargo_process("r -Z help")
|
|
.with_stdout_contains(
|
|
" -Z allow-features[..]-- Allow *only* the listed unstable features",
|
|
)
|
|
.run();
|
|
|
|
cargo_process("c -Z help")
|
|
.with_stdout_contains(
|
|
" -Z allow-features[..]-- Allow *only* the listed unstable features",
|
|
)
|
|
.run();
|
|
|
|
cargo_process("t -Z help")
|
|
.with_stdout_contains(
|
|
" -Z allow-features[..]-- Allow *only* the listed unstable features",
|
|
)
|
|
.run();
|
|
}
|