clap/tests/subcommands.rs

385 lines
10 KiB
Rust
Raw Normal View History

2020-02-04 08:10:53 +00:00
mod utils;
2018-11-14 17:05:06 +00:00
use clap::{App, Arg, ErrorKind};
static VISIBLE_ALIAS_HELP: &str = "clap-test 2.6
2016-06-10 01:55:53 +00:00
USAGE:
clap-test [SUBCOMMAND]
2016-06-10 01:55:53 +00:00
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
help Prints this message or the help of the given subcommand(s)
test Some help [aliases: dongle, done]";
static INVISIBLE_ALIAS_HELP: &str = "clap-test 2.6
USAGE:
clap-test [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
help Prints this message or the help of the given subcommand(s)
test Some help";
2016-06-10 01:55:53 +00:00
2020-04-02 04:35:48 +00:00
static SUBCMD_ALPHA_ORDER: &str = "test 1
USAGE:
test [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
a1 blah a1
b1 blah b1
help Prints this message or the help of the given subcommand(s)";
static SUBCMD_DECL_ORDER: &str = "test 1
USAGE:
test [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
b1 blah b1
a1 blah a1
help Prints this message or the help of the given subcommand(s)";
#[cfg(feature = "suggestions")]
static DYM_SUBCMD: &str = "error: The subcommand 'subcm' wasn't recognized
2020-04-12 01:39:13 +00:00
Did you mean 'subcmd'?
If you believe you received this message in error, try re-running with 'dym -- subcm'
USAGE:
dym [SUBCOMMAND]
For more information try --help";
#[cfg(feature = "suggestions")]
static DYM_SUBCMD_AMBIGUOUS: &str = "error: The subcommand 'te' wasn't recognized
2020-04-12 01:39:13 +00:00
Did you mean 'test' or 'temp'?
If you believe you received this message in error, try re-running with 'dym -- te'
USAGE:
dym [SUBCOMMAND]
For more information try --help";
#[cfg(feature = "suggestions")]
static DYM_ARG: &str =
2018-01-25 04:05:05 +00:00
"error: Found argument '--subcm' which wasn't expected, or isn't valid in this context
2020-04-12 01:39:13 +00:00
Did you mean to put '--subcmdarg' after the subcommand 'subcmd'?
If you tried to supply `--subcm` as a PATTERN use `-- --subcm`
USAGE:
dym [SUBCOMMAND]
For more information try --help";
#[test]
fn subcommand() {
let m = App::new("test")
2018-01-25 04:05:05 +00:00
.subcommand(
App::new("some").arg(
Arg::new("test")
.short('t')
2018-01-25 04:05:05 +00:00
.long("test")
.takes_value(true)
.about("testing testing"),
2018-01-25 04:05:05 +00:00
),
2018-11-14 17:05:06 +00:00
)
.arg(Arg::new("other").long("other"))
.get_matches_from(vec!["myprog", "some", "--test", "testing"]);
assert_eq!(m.subcommand_name().unwrap(), "some");
let sub_m = m.subcommand_matches("some").unwrap();
assert!(sub_m.is_present("test"));
assert_eq!(sub_m.value_of("test").unwrap(), "testing");
}
#[test]
fn subcommand_none_given() {
let m = App::new("test")
2018-01-25 04:05:05 +00:00
.subcommand(
App::new("some").arg(
Arg::new("test")
.short('t')
2018-01-25 04:05:05 +00:00
.long("test")
.takes_value(true)
.about("testing testing"),
2018-01-25 04:05:05 +00:00
),
2018-11-14 17:05:06 +00:00
)
.arg(Arg::new("other").long("other"))
.get_matches_from(vec![""]);
assert!(m.subcommand_name().is_none());
}
#[test]
fn subcommand_multiple() {
let m = App::new("test")
.subcommands(vec![
App::new("some").arg(
Arg::new("test")
.short('t')
.long("test")
.takes_value(true)
.about("testing testing"),
2018-01-25 04:05:05 +00:00
),
App::new("add").arg(Arg::new("roster").short('r')),
])
.arg(Arg::new("other").long("other"))
.get_matches_from(vec!["myprog", "some", "--test", "testing"]);
assert!(m.subcommand_matches("some").is_some());
assert!(m.subcommand_matches("add").is_none());
assert_eq!(m.subcommand_name().unwrap(), "some");
let sub_m = m.subcommand_matches("some").unwrap();
assert!(sub_m.is_present("test"));
assert_eq!(sub_m.value_of("test").unwrap(), "testing");
}
2020-04-02 04:35:48 +00:00
#[test]
fn subcommand_display_order() {
2020-04-02 13:48:01 +00:00
let app_subcmd_alpha_order = App::new("test").version("1").subcommands(vec![
App::new("b1")
.about("blah b1")
.arg(Arg::new("test").short('t')),
2020-04-02 13:48:01 +00:00
App::new("a1")
.about("blah a1")
.arg(Arg::new("roster").short('r')),
2020-04-02 13:48:01 +00:00
]);
2020-04-02 04:35:48 +00:00
assert!(utils::compare_output(
app_subcmd_alpha_order,
"test --help",
SUBCMD_ALPHA_ORDER,
false,
));
let app_subcmd_decl_order = App::new("test")
.version("1")
.setting(clap::AppSettings::DeriveDisplayOrder)
.subcommands(vec![
2020-04-02 13:48:01 +00:00
App::new("b1")
.about("blah b1")
.arg(Arg::new("test").short('t')),
2020-04-02 13:48:01 +00:00
App::new("a1")
.about("blah a1")
.arg(Arg::new("roster").short('r')),
2020-04-02 04:35:48 +00:00
]);
assert!(utils::compare_output(
app_subcmd_decl_order,
"test --help",
SUBCMD_DECL_ORDER,
false,
));
}
#[test]
fn single_alias() {
let m = App::new("myprog")
.subcommand(App::new("test").alias("do-stuff"))
2018-01-25 04:05:05 +00:00
.get_matches_from(vec!["myprog", "do-stuff"]);
assert_eq!(m.subcommand_name(), Some("test"));
}
#[test]
fn multiple_aliases() {
let m = App::new("myprog")
.subcommand(App::new("test").aliases(&["do-stuff", "test-stuff"]))
2018-01-25 04:05:05 +00:00
.get_matches_from(vec!["myprog", "test-stuff"]);
assert_eq!(m.subcommand_name(), Some("test"));
}
#[test]
2018-01-25 04:05:05 +00:00
#[cfg(feature = "suggestions")]
fn subcmd_did_you_mean_output() {
let app = App::new("dym").subcommand(App::new("subcmd"));
2020-02-04 08:10:53 +00:00
assert!(utils::compare_output(app, "dym subcm", DYM_SUBCMD, true));
}
#[test]
#[cfg(feature = "suggestions")]
fn subcmd_did_you_mean_output_ambiguous() {
let app = App::new("dym")
.subcommand(App::new("test"))
.subcommand(App::new("temp"));
assert!(utils::compare_output(
app,
"dym te",
DYM_SUBCMD_AMBIGUOUS,
true
));
}
#[test]
2018-01-25 04:05:05 +00:00
#[cfg(feature = "suggestions")]
fn subcmd_did_you_mean_output_arg() {
2018-11-14 17:05:06 +00:00
let app =
App::new("dym").subcommand(App::new("subcmd").arg("-s --subcmdarg [subcmdarg] 'tests'"));
2020-02-04 08:10:53 +00:00
assert!(utils::compare_output(app, "dym --subcm foo", DYM_ARG, true));
}
#[test]
fn alias_help() {
let m = App::new("myprog")
.subcommand(App::new("test").alias("do-stuff"))
.try_get_matches_from(vec!["myprog", "help", "do-stuff"]);
assert!(m.is_err());
assert_eq!(m.unwrap_err().kind, ErrorKind::DisplayHelp);
2016-06-10 01:55:53 +00:00
}
#[test]
fn visible_aliases_help_output() {
2018-01-25 04:05:05 +00:00
let app = App::new("clap-test").version("2.6").subcommand(
App::new("test")
2016-06-10 01:55:53 +00:00
.about("Some help")
.alias("invisible")
.visible_alias("dongle")
2018-01-25 04:05:05 +00:00
.visible_alias("done"),
);
2020-02-04 08:10:53 +00:00
assert!(utils::compare_output(
2018-01-25 04:05:05 +00:00
app,
"clap-test --help",
VISIBLE_ALIAS_HELP,
false
));
2016-06-10 01:55:53 +00:00
}
#[test]
fn invisible_aliases_help_output() {
2018-11-14 17:05:06 +00:00
let app = App::new("clap-test")
.version("2.6")
.subcommand(App::new("test").about("Some help").alias("invisible"));
2020-02-04 08:10:53 +00:00
assert!(utils::compare_output(
2018-01-25 04:05:05 +00:00
app,
"clap-test --help",
INVISIBLE_ALIAS_HELP,
false
));
}
2020-02-14 16:22:01 +00:00
#[test]
fn replace() {
let m = App::new("prog")
.subcommand(App::new("module").subcommand(App::new("install").about("Install module")))
.replace("install", &["module", "install"])
.get_matches_from(vec!["prog", "install"]);
assert_eq!(m.subcommand_name(), Some("module"));
assert_eq!(
m.subcommand_matches("module").unwrap().subcommand_name(),
Some("install")
);
}
#[test]
fn issue_1031_args_with_same_name() {
let res = App::new("prog")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("--ui-path=<PATH>"))
.subcommand(App::new("signer"))
.try_get_matches_from(vec!["prog", "--ui-path", "signer"]);
assert!(res.is_ok(), "{:?}", res.unwrap_err().kind);
let m = res.unwrap();
assert_eq!(m.value_of("ui-path"), Some("signer"));
}
#[test]
fn issue_1031_args_with_same_name_no_more_vals() {
let res = App::new("prog")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("--ui-path=<PATH>"))
.subcommand(App::new("signer"))
.try_get_matches_from(vec!["prog", "--ui-path", "value", "signer"]);
assert!(res.is_ok(), "{:?}", res.unwrap_err().kind);
let m = res.unwrap();
assert_eq!(m.value_of("ui-path"), Some("value"));
assert_eq!(m.subcommand_name(), Some("signer"));
2018-01-25 04:05:05 +00:00
}
#[test]
fn issue_1161_multiple_hyphen_hyphen() {
// from example 22
let res = App::new("myprog")
.arg(Arg::new("eff").short('f'))
.arg(Arg::new("pea").short('p').takes_value(true))
.arg(Arg::new("slop").multiple(true).last(true))
.try_get_matches_from(vec![
2018-08-02 03:13:51 +00:00
"-f",
"-p=bob",
"--",
"sloppy",
"slop",
"-a",
"--",
"subprogram",
"position",
"args",
]);
assert!(res.is_ok(), "{:?}", res.unwrap_err().kind);
let m = res.unwrap();
2018-08-02 03:13:51 +00:00
let expected = Some(vec![
"sloppy",
"slop",
"-a",
"--",
"subprogram",
"position",
"args",
]);
let actual = m.values_of("slop").map(|vals| vals.collect::<Vec<_>>());
assert_eq!(expected, actual);
2018-08-02 03:13:51 +00:00
}
2020-03-05 12:02:48 +00:00
#[test]
fn issue_1722_not_emit_error_when_arg_follows_similar_to_a_subcommand() {
let m = App::new("myprog")
.subcommand(App::new("subcommand"))
.arg(Arg::new("argument"))
2020-03-05 12:02:48 +00:00
.try_get_matches_from(vec!["myprog", "--", "subcommand"]);
assert_eq!(m.unwrap().value_of("argument"), Some("subcommand"));
}
#[test]
fn subcommand_placeholder_test() {
let mut app = App::new("myprog")
.subcommand(App::new("subcommand"))
.subcommand_placeholder("TEST_PLACEHOLDER", "TEST_HEADER");
2020-07-07 07:23:00 +00:00
assert_eq!(
&app.generate_usage(),
"USAGE:\n myprog [TEST_PLACEHOLDER]"
);
let mut help_text = Vec::new();
2020-07-07 07:23:00 +00:00
app.write_help(&mut help_text)
.expect("Failed to write to internal buffer");
2020-07-07 07:23:00 +00:00
assert!(String::from_utf8(help_text)
.unwrap()
.contains("TEST_HEADER:"));
}