clap/tests/opts.rs

522 lines
17 KiB
Rust
Raw Normal View History

2020-02-04 08:10:53 +00:00
mod utils;
use clap::{App, Arg, ArgMatches, ArgSettings, ErrorKind};
#[cfg(feature = "suggestions")]
static DYM: &str =
2018-01-25 04:05:05 +00:00
"error: Found argument '--optio' which wasn't expected, or isn't valid in this context
2020-04-12 01:39:13 +00:00
\tDid you mean '--option'?
\tIf you tried to supply `--optio` as a value rather than a flag, use `-- --optio`
USAGE:
clap-test --option <opt>...
For more information try --help";
#[cfg(feature = "suggestions")]
static DYM_ISSUE_1073: &str =
"error: Found argument '--files-without-matches' which wasn't expected, or isn't valid in this context
2020-04-12 01:39:13 +00:00
\tDid you mean '--files-without-match'?
\tIf you tried to supply `--files-without-matches` as a value rather than a flag, use `-- --files-without-matches`
USAGE:
ripgrep-616 --files-without-match
For more information try --help";
#[test]
fn require_equals_fail() {
let res = App::new("prog")
2018-01-25 04:05:05 +00:00
.arg(
Arg::new("cfg")
.setting(ArgSettings::RequireEquals)
.setting(ArgSettings::TakesValue)
2018-01-25 04:05:05 +00:00
.long("config"),
)
.try_get_matches_from(vec!["prog", "--config", "file.conf"]);
assert!(res.is_err());
assert_eq!(res.unwrap_err().kind, ErrorKind::EmptyValue);
}
#[test]
fn require_equals_min_values_zero() {
let res = App::new("prog")
2018-01-25 04:05:05 +00:00
.arg(
Arg::new("cfg")
.setting(ArgSettings::RequireEquals)
2018-01-25 04:05:05 +00:00
.min_values(0)
.long("config"),
)
.arg(Arg::new("cmd"))
.try_get_matches_from(vec!["prog", "--config", "cmd"]);
assert!(res.is_ok());
let m = res.unwrap();
assert!(m.is_present("cfg"));
assert_eq!(m.value_of("cmd"), Some("cmd"));
}
#[test]
fn double_hyphen_as_value() {
let res = App::new("prog")
2018-01-25 04:05:05 +00:00
.arg(
Arg::new("cfg")
.setting(ArgSettings::AllowHyphenValues)
2018-01-25 04:05:05 +00:00
.long("config"),
)
.try_get_matches_from(vec!["prog", "--config", "--"]);
assert!(res.is_ok(), "{:?}", res);
assert_eq!(res.unwrap().value_of("cfg"), Some("--"));
}
#[test]
fn require_equals_no_empty_values_fail() {
let res = App::new("prog")
2018-01-25 04:05:05 +00:00
.arg(
Arg::new("cfg")
.setting(ArgSettings::RequireEquals)
2018-01-25 04:05:05 +00:00
.long("config"),
)
.arg(Arg::new("some"))
.try_get_matches_from(vec!["prog", "--config=", "file.conf"]);
assert!(res.is_err());
assert_eq!(res.unwrap_err().kind, ErrorKind::EmptyValue);
}
#[test]
fn require_equals_empty_vals_pass() {
let res = App::new("prog")
2018-01-25 04:05:05 +00:00
.arg(
Arg::new("cfg")
.setting(ArgSettings::RequireEquals)
.setting(ArgSettings::AllowEmptyValues)
2018-01-25 04:05:05 +00:00
.long("config"),
)
.try_get_matches_from(vec!["prog", "--config="]);
assert!(res.is_ok());
}
#[test]
fn require_equals_pass() {
let res = App::new("prog")
2018-01-25 04:05:05 +00:00
.arg(
Arg::new("cfg")
.setting(ArgSettings::RequireEquals)
2018-01-25 04:05:05 +00:00
.long("config"),
)
.try_get_matches_from(vec!["prog", "--config=file.conf"]);
assert!(res.is_ok());
}
#[test]
fn stdin_char() {
let r = App::new("opts")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("-f [flag] 'some flag'"))
.try_get_matches_from(vec!["", "-f", "-"]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("f"));
assert_eq!(m.value_of("f").unwrap(), "-");
}
#[test]
fn opts_using_short() {
let r = App::new("opts")
2018-01-25 04:05:05 +00:00
.args(&[
2018-04-21 18:59:19 +00:00
Arg::from("-f [flag] 'some flag'"),
Arg::from("-c [color] 'some other flag'"),
2018-01-25 04:05:05 +00:00
])
.try_get_matches_from(vec!["", "-f", "some", "-c", "other"]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("f"));
assert_eq!(m.value_of("f").unwrap(), "some");
assert!(m.is_present("c"));
assert_eq!(m.value_of("c").unwrap(), "other");
}
#[test]
fn lots_o_vals() {
let r = App::new("opts")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("-o [opt]... 'some opt'"))
.try_get_matches_from(vec![
2018-01-25 04:05:05 +00:00
"", "-o", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some", "some", "some", "some", "some", "some", "some", "some", "some", "some",
"some", "some",
]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("o"));
assert_eq!(m.values_of("o").unwrap().count(), 297); // i.e. more than u8
}
#[test]
fn opts_using_long_space() {
let r = App::new("opts")
2018-01-25 04:05:05 +00:00
.args(&[
2018-04-21 18:59:19 +00:00
Arg::from("--flag [flag] 'some flag'"),
Arg::from("--color [color] 'some other flag'"),
2018-01-25 04:05:05 +00:00
])
.try_get_matches_from(vec!["", "--flag", "some", "--color", "other"]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("flag"));
assert_eq!(m.value_of("flag").unwrap(), "some");
assert!(m.is_present("color"));
assert_eq!(m.value_of("color").unwrap(), "other");
}
#[test]
fn opts_using_long_equals() {
let r = App::new("opts")
2018-01-25 04:05:05 +00:00
.args(&[
2018-04-21 18:59:19 +00:00
Arg::from("--flag [flag] 'some flag'"),
Arg::from("--color [color] 'some other flag'"),
2018-01-25 04:05:05 +00:00
])
.try_get_matches_from(vec!["", "--flag=some", "--color=other"]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("flag"));
assert_eq!(m.value_of("flag").unwrap(), "some");
assert!(m.is_present("color"));
assert_eq!(m.value_of("color").unwrap(), "other");
}
#[test]
fn opts_using_mixed() {
let r = App::new("opts")
2018-01-25 04:05:05 +00:00
.args(&[
2018-04-21 18:59:19 +00:00
Arg::from("-f, --flag [flag] 'some flag'"),
Arg::from("-c, --color [color] 'some other flag'"),
2018-01-25 04:05:05 +00:00
])
.try_get_matches_from(vec!["", "-f", "some", "--color", "other"]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("flag"));
assert_eq!(m.value_of("flag").unwrap(), "some");
assert!(m.is_present("color"));
assert_eq!(m.value_of("color").unwrap(), "other");
}
#[test]
fn opts_using_mixed2() {
let r = App::new("opts")
2018-01-25 04:05:05 +00:00
.args(&[
2018-04-21 18:59:19 +00:00
Arg::from("-f, --flag [flag] 'some flag'"),
Arg::from("-c, --color [color] 'some other flag'"),
2018-01-25 04:05:05 +00:00
])
.try_get_matches_from(vec!["", "--flag=some", "-c", "other"]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("flag"));
assert_eq!(m.value_of("flag").unwrap(), "some");
assert!(m.is_present("color"));
assert_eq!(m.value_of("color").unwrap(), "other");
}
2016-02-09 14:05:19 +00:00
#[test]
fn default_values_user_value() {
let r = App::new("df")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("-o [opt] 'some opt'").default_value("default"))
.try_get_matches_from(vec!["", "-o", "value"]);
2016-02-09 14:05:19 +00:00
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("o"));
assert_eq!(m.value_of("o").unwrap(), "value");
}
#[test]
fn multiple_vals_pos_arg_equals() {
let r = App::new("mvae")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("-o [opt]... 'some opt'"))
.arg(Arg::from("[file] 'some file'"))
.try_get_matches_from(vec!["", "-o=1", "some"]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("o"));
assert_eq!(m.value_of("o").unwrap(), "1");
assert!(m.is_present("file"));
assert_eq!(m.value_of("file").unwrap(), "some");
}
#[test]
fn multiple_vals_pos_arg_delim() {
let r = App::new("mvae")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("-o [opt]... 'some opt'").setting(ArgSettings::UseValueDelimiter))
.arg(Arg::from("[file] 'some file'"))
.try_get_matches_from(vec!["", "-o", "1,2", "some"]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("o"));
assert_eq!(m.values_of("o").unwrap().collect::<Vec<_>>(), &["1", "2"]);
assert!(m.is_present("file"));
assert_eq!(m.value_of("file").unwrap(), "some");
}
2016-06-30 03:01:41 +00:00
#[test]
fn require_delims_no_delim() {
let r = App::new("mvae")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("-o [opt]... 'some opt'").setting(ArgSettings::RequireDelimiter))
.arg(Arg::from("[file] 'some file'"))
.try_get_matches_from(vec!["mvae", "-o", "1", "2", "some"]);
2016-06-30 03:01:41 +00:00
assert!(r.is_err());
let err = r.unwrap_err();
assert_eq!(err.kind, ErrorKind::UnknownArgument);
}
#[test]
fn require_delims() {
let r = App::new("mvae")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("-o [opt]... 'some opt'").setting(ArgSettings::RequireDelimiter))
.arg(Arg::from("[file] 'some file'"))
.try_get_matches_from(vec!["", "-o", "1,2", "some"]);
2016-06-30 03:01:41 +00:00
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("o"));
assert_eq!(m.values_of("o").unwrap().collect::<Vec<_>>(), &["1", "2"]);
assert!(m.is_present("file"));
assert_eq!(m.value_of("file").unwrap(), "some");
}
#[test]
fn leading_hyphen_pass() {
let r = App::new("mvae")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("-o [opt]... 'some opt'").setting(ArgSettings::AllowHyphenValues))
.try_get_matches_from(vec!["", "-o", "-2", "3"]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("o"));
assert_eq!(m.values_of("o").unwrap().collect::<Vec<_>>(), &["-2", "3"]);
}
#[test]
fn leading_hyphen_fail() {
let r = App::new("mvae")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("-o [opt] 'some opt'"))
.try_get_matches_from(vec!["", "-o", "-2"]);
assert!(r.is_err());
let m = r.unwrap_err();
assert_eq!(m.kind, ErrorKind::UnknownArgument);
}
#[test]
fn leading_hyphen_with_flag_after() {
let r = App::new("mvae")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("-o [opt]... 'some opt'").setting(ArgSettings::AllowHyphenValues))
.arg("-f 'some flag'")
.try_get_matches_from(vec!["", "-o", "-2", "-f"]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("o"));
assert_eq!(m.values_of("o").unwrap().collect::<Vec<_>>(), &["-2", "-f"]);
assert!(!m.is_present("f"));
}
#[test]
fn leading_hyphen_with_flag_before() {
let r = App::new("mvae")
2018-04-21 18:59:19 +00:00
.arg(Arg::from("-o [opt]... 'some opt'").setting(ArgSettings::AllowHyphenValues))
.arg("-f 'some flag'")
.try_get_matches_from(vec!["", "-f", "-o", "-2"]);
assert!(r.is_ok());
let m = r.unwrap();
assert!(m.is_present("o"));
assert_eq!(m.values_of("o").unwrap().collect::<Vec<_>>(), &["-2"]);
assert!(m.is_present("f"));
}
#[test]
fn leading_hyphen_with_only_pos_follows() {
let r = App::new("mvae")
2018-01-25 04:05:05 +00:00
.arg(
2018-04-21 18:59:19 +00:00
Arg::from("-o [opt]... 'some opt'")
2018-01-25 04:05:05 +00:00
.number_of_values(1)
.setting(ArgSettings::AllowHyphenValues),
2018-01-25 04:05:05 +00:00
)
.arg("[arg] 'some arg'")
.try_get_matches_from(vec!["", "-o", "-2", "--", "val"]);
assert!(r.is_ok(), "{:?}", r);
let m = r.unwrap();
assert!(m.is_present("o"));
assert_eq!(m.values_of("o").unwrap().collect::<Vec<_>>(), &["-2"]);
assert_eq!(m.value_of("arg"), Some("val"));
}
#[test]
2018-01-25 04:05:05 +00:00
#[cfg(feature = "suggestions")]
fn did_you_mean() {
2020-02-04 08:10:53 +00:00
assert!(utils::compare_output(
utils::complex_app(),
2018-01-25 04:05:05 +00:00
"clap-test --optio=foo",
DYM,
true
));
}
#[test]
fn issue_665() {
let res = App::new("tester")
.arg("-v, --reroll-count=[N] 'Mark the patch series as PATCH vN'")
2018-04-21 18:59:19 +00:00
.arg(Arg::from(
"--subject-prefix [Subject-Prefix] 'Use [Subject-Prefix] instead of the standard [PATCH] prefix'") )
.try_get_matches_from(vec!["test", "--subject-prefix", "-v", "2"]);
assert!(res.is_err());
assert_eq!(res.unwrap_err().kind, ErrorKind::EmptyValue);
}
#[test]
fn issue_1047_min_zero_vals_default_val() {
let m = App::new("foo")
.arg(
Arg::new("del")
.short('d')
.long("del")
.setting(ArgSettings::RequireEquals)
.min_values(0)
.default_missing_value("default"),
)
.get_matches_from(vec!["foo", "-d"]);
assert_eq!(m.occurrences_of("del"), 1);
assert_eq!(m.value_of("del"), Some("default"));
}
fn issue_1105_setup(argv: Vec<&'static str>) -> Result<ArgMatches, clap::Error> {
App::new("opts")
2018-08-02 03:13:51 +00:00
.arg(Arg::from("-o, --option [opt] 'some option'").setting(ArgSettings::AllowEmptyValues))
2018-04-21 18:59:19 +00:00
.arg(Arg::from("--flag 'some flag'"))
.try_get_matches_from(argv)
}
#[test]
fn issue_1105_empty_value_long_fail() {
2018-01-25 04:05:05 +00:00
let r = issue_1105_setup(vec!["app", "--option", "--flag"]);
assert!(r.is_err());
assert_eq!(r.unwrap_err().kind, ErrorKind::EmptyValue);
}
#[test]
fn issue_1105_empty_value_long_explicit() {
let r = issue_1105_setup(vec!["app", "--option", ""]);
assert!(r.is_ok());
let m = r.unwrap();
assert_eq!(m.value_of("option"), Some(""));
}
#[test]
fn issue_1105_empty_value_long_equals() {
2018-01-25 04:05:05 +00:00
let r = issue_1105_setup(vec!["app", "--option="]);
assert!(r.is_ok());
let m = r.unwrap();
assert_eq!(m.value_of("option"), Some(""));
}
#[test]
fn issue_1105_empty_value_short_fail() {
let r = issue_1105_setup(vec!["app", "-o", "--flag"]);
assert!(r.is_err());
assert_eq!(r.unwrap_err().kind, ErrorKind::EmptyValue);
}
#[test]
fn issue_1105_empty_value_short_explicit() {
let r = issue_1105_setup(vec!["app", "-o", ""]);
assert!(r.is_ok());
let m = r.unwrap();
assert_eq!(m.value_of("option"), Some(""));
}
#[test]
fn issue_1105_empty_value_short_equals() {
let r = issue_1105_setup(vec!["app", "-o="]);
assert!(r.is_ok());
let m = r.unwrap();
assert_eq!(m.value_of("option"), Some(""));
}
#[test]
fn issue_1105_empty_value_short_explicit_no_space() {
let r = issue_1105_setup(vec!["app", "-o", ""]);
assert!(r.is_ok());
let m = r.unwrap();
assert_eq!(m.value_of("option"), Some(""));
}
#[test]
#[cfg(feature = "suggestions")]
fn issue_1073_suboptimal_flag_suggestion() {
let app = App::new("ripgrep-616")
.arg(Arg::new("files-with-matches").long("files-with-matches"))
.arg(Arg::new("files-without-match").long("files-without-match"));
assert!(utils::compare_output(
app,
"ripgrep-616 --files-without-matches",
DYM_ISSUE_1073,
true
));
}
2020-04-20 15:29:29 +00:00
#[test]
fn short_non_ascii_no_space() {
let matches = App::new("app")
.arg("<opt> -磨 <opt>")
.get_matches_from(&["test", "-磨VALUE"]);
assert_eq!("VALUE", matches.value_of("opt").unwrap());
}
#[test]
fn short_eq_val_starts_with_eq() {
let matches = App::new("app")
.arg("<opt> -f <opt>")
.get_matches_from(&["test", "-f==value"]);
assert_eq!("=value", matches.value_of("opt").unwrap());
}
#[test]
fn long_eq_val_starts_with_eq() {
let matches = App::new("app")
.arg("<opt> --foo <opt>")
.get_matches_from(&["test", "--foo==value"]);
assert_eq!("=value", matches.value_of("opt").unwrap());
}
#[test]
fn issue_2022_get_flags_misuse() {
let app = App::new("test")
.help_heading("test")
.arg(Arg::new("a").long("a").default_value("32"));
let matches = app.get_matches_from(&[""]);
assert!(matches.value_of("a").is_some())
}