clap/tests/builder/conflicts.rs

428 lines
12 KiB
Rust
Raw Normal View History

use crate::utils;
2021-11-19 20:33:11 +00:00
use clap::{arg, App, Arg, ArgGroup, ErrorKind};
static CONFLICT_ERR: &str = "error: The argument '--flag' cannot be used with '-F'
USAGE:
clap-test --flag --long-option-2 <option2> <positional> <positional2>
For more information try --help
";
static CONFLICT_ERR_REV: &str = "error: The argument '-F' cannot be used with '--flag'
USAGE:
clap-test -F --long-option-2 <option2> <positional> <positional2>
For more information try --help
";
static CONFLICT_ERR_THREE: &str = "error: The argument '--one' cannot be used with:
--two
--three
USAGE:
three_conflicting_arguments --one
For more information try --help
";
#[test]
fn flag_conflict() {
let result = App::new("flag_conflict")
2021-11-19 20:33:11 +00:00
.arg(arg!(-f --flag "some flag").conflicts_with("other"))
.arg(arg!(-o --other "some flag"))
.try_get_matches_from(vec!["myprog", "-f", "-o"]);
assert!(result.is_err());
2015-10-01 01:45:35 +00:00
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
}
#[test]
fn flag_conflict_2() {
let result = App::new("flag_conflict")
2021-11-19 20:33:11 +00:00
.arg(arg!(-f --flag "some flag").conflicts_with("other"))
.arg(arg!(-o --other "some flag"))
.try_get_matches_from(vec!["myprog", "-o", "-f"]);
assert!(result.is_err());
2015-10-01 01:45:35 +00:00
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
}
#[test]
fn flag_conflict_with_all() {
let result = App::new("flag_conflict")
2021-11-19 20:33:11 +00:00
.arg(arg!(-f --flag "some flag").conflicts_with_all(&["other"]))
.arg(arg!(-o --other "some flag"))
.try_get_matches_from(vec!["myprog", "-o", "-f"]);
assert!(result.is_err());
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
}
#[test]
fn flag_conflict_with_everything() {
let result = App::new("flag_conflict")
2021-11-19 20:33:11 +00:00
.arg(arg!(-f --flag "some flag").exclusive(true))
.arg(arg!(-o --other "some flag"))
.try_get_matches_from(vec!["myprog", "-o", "-f"]);
assert!(result.is_err());
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
}
#[test]
fn arg_conflicts_with_group() {
let mut app = App::new("group_conflict")
2021-11-19 20:33:11 +00:00
.arg(arg!(-f --flag "some flag").conflicts_with("gr"))
.group(ArgGroup::new("gr").arg("some").arg("other"))
2021-11-19 20:33:11 +00:00
.arg(arg!(--some "some arg"))
.arg(arg!(--other "other arg"));
let result = app.try_get_matches_from_mut(vec!["myprog", "--other", "-f"]);
assert!(result.is_err());
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
let result = app.try_get_matches_from_mut(vec!["myprog", "-f", "--some"]);
assert!(result.is_err());
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
let result = app.try_get_matches_from_mut(vec!["myprog", "--some"]);
if let Err(err) = result {
panic!("{}", err);
}
let result = app.try_get_matches_from_mut(vec!["myprog", "--other"]);
if let Err(err) = result {
panic!("{}", err);
}
let result = app.try_get_matches_from_mut(vec!["myprog", "--flag"]);
if let Err(err) = result {
panic!("{}", err);
}
}
#[test]
fn arg_conflicts_with_group_with_multiple_sources() {
let mut app = clap::App::new("group_conflict")
.arg(clap::arg!(-f --flag "some flag").conflicts_with("gr"))
.group(clap::ArgGroup::new("gr").multiple(true))
.arg(
clap::arg!(--some <name> "some arg")
.required(false)
.group("gr"),
)
.arg(
clap::arg!(--other <secs> "other arg")
.required(false)
.default_value("1000")
.group("gr"),
);
let result = app.try_get_matches_from_mut(vec!["myprog", "-f"]);
if let Err(err) = result {
panic!("{}", err);
}
let result = app.try_get_matches_from_mut(vec!["myprog", "--some", "usb1"]);
if let Err(err) = result {
panic!("{}", err);
}
let result = app.try_get_matches_from_mut(vec!["myprog", "--some", "usb1", "--other", "40"]);
if let Err(err) = result {
panic!("{}", err);
}
let result = app.try_get_matches_from_mut(vec!["myprog", "-f", "--some", "usb1"]);
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
}
#[test]
fn group_conflicts_with_arg() {
let mut app = App::new("group_conflict")
.arg(arg!(-f --flag "some flag"))
.group(
ArgGroup::new("gr")
.arg("some")
.arg("other")
.conflicts_with("flag"),
)
.arg(arg!(--some "some arg"))
.arg(arg!(--other "other arg"));
let result = app.try_get_matches_from_mut(vec!["myprog", "--other", "-f"]);
assert!(result.is_err());
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
let result = app.try_get_matches_from_mut(vec!["myprog", "-f", "--some"]);
assert!(result.is_err());
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
let result = app.try_get_matches_from_mut(vec!["myprog", "--some"]);
if let Err(err) = result {
panic!("{}", err);
}
let result = app.try_get_matches_from_mut(vec!["myprog", "--other"]);
if let Err(err) = result {
panic!("{}", err);
}
let result = app.try_get_matches_from_mut(vec!["myprog", "--flag"]);
if let Err(err) = result {
panic!("{}", err);
}
}
#[test]
fn arg_conflicts_with_required_group() {
let mut app = App::new("group_conflict")
2021-11-19 20:33:11 +00:00
.arg(arg!(-f --flag "some flag").conflicts_with("gr"))
.group(ArgGroup::new("gr").required(true).arg("some").arg("other"))
2021-11-19 20:33:11 +00:00
.arg(arg!(--some "some arg"))
.arg(arg!(--other "other arg"));
let result = app.try_get_matches_from_mut(vec!["myprog", "--other", "-f"]);
assert!(result.is_err());
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
let result = app.try_get_matches_from_mut(vec!["myprog", "-f", "--some"]);
assert!(result.is_err());
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
let result = app.try_get_matches_from_mut(vec!["myprog", "--some"]);
if let Err(err) = result {
panic!("{}", err);
}
let result = app.try_get_matches_from_mut(vec!["myprog", "--other"]);
if let Err(err) = result {
panic!("{}", err);
}
}
#[test]
fn required_group_conflicts_with_arg() {
let mut app = App::new("group_conflict")
.arg(arg!(-f --flag "some flag"))
.group(
ArgGroup::new("gr")
.required(true)
.arg("some")
.arg("other")
.conflicts_with("flag"),
)
.arg(arg!(--some "some arg"))
.arg(arg!(--other "other arg"));
let result = app.try_get_matches_from_mut(vec!["myprog", "--other", "-f"]);
assert!(result.is_err());
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
let result = app.try_get_matches_from_mut(vec!["myprog", "-f", "--some"]);
assert!(result.is_err());
let err = result.err().unwrap();
assert_eq!(err.kind, ErrorKind::ArgumentConflict);
let result = app.try_get_matches_from_mut(vec!["myprog", "--some"]);
if let Err(err) = result {
panic!("{}", err);
}
let result = app.try_get_matches_from_mut(vec!["myprog", "--other"]);
if let Err(err) = result {
panic!("{}", err);
}
}
#[test]
fn conflict_output() {
assert!(utils::compare_output(
2020-02-04 08:10:53 +00:00
utils::complex_app(),
"clap-test val1 fa --flag --long-option-2 val2 -F",
2018-01-25 04:05:05 +00:00
CONFLICT_ERR,
true,
));
}
#[test]
fn conflict_output_rev() {
assert!(utils::compare_output(
2020-02-04 08:10:53 +00:00
utils::complex_app(),
"clap-test val1 fa -F --long-option-2 val2 --flag",
2018-01-25 04:05:05 +00:00
CONFLICT_ERR_REV,
true,
));
}
#[test]
fn conflict_output_with_required() {
assert!(utils::compare_output(
utils::complex_app(),
"clap-test val1 --flag --long-option-2 val2 -F",
CONFLICT_ERR,
true,
));
}
#[test]
fn conflict_output_rev_with_required() {
assert!(utils::compare_output(
utils::complex_app(),
"clap-test val1 -F --long-option-2 val2 --flag",
CONFLICT_ERR_REV,
true,
));
}
#[test]
fn conflict_output_three_conflicting() {
let app = App::new("three_conflicting_arguments")
.arg(
Arg::new("one")
.long("one")
.conflicts_with_all(&["two", "three"]),
)
.arg(
Arg::new("two")
.long("two")
.conflicts_with_all(&["one", "three"]),
)
.arg(
Arg::new("three")
.long("three")
.conflicts_with_all(&["one", "two"]),
);
assert!(utils::compare_output(
app,
"three_conflicting_arguments --one --two --three",
CONFLICT_ERR_THREE,
true,
));
}
2020-04-09 10:20:46 +00:00
#[test]
fn two_conflicting_arguments() {
let a = App::new("two_conflicting_arguments")
.arg(
Arg::new("develop")
2020-04-09 10:20:46 +00:00
.long("develop")
.conflicts_with("production"),
)
.arg(
Arg::new("production")
2020-04-09 10:20:46 +00:00
.long("production")
.conflicts_with("develop"),
)
.try_get_matches_from(vec!["", "--develop", "--production"]);
assert!(a.is_err());
let a = a.unwrap_err();
2020-08-22 09:43:58 +00:00
assert!(
a.to_string()
.contains("The argument \'--develop\' cannot be used with \'--production\'"),
2020-08-22 09:43:58 +00:00
"{}",
a
2020-04-09 10:20:46 +00:00
);
}
#[test]
fn three_conflicting_arguments() {
let a = App::new("three_conflicting_arguments")
2020-04-09 10:20:46 +00:00
.arg(
Arg::new("one")
2020-04-09 10:20:46 +00:00
.long("one")
.conflicts_with_all(&["two", "three"]),
)
.arg(
Arg::new("two")
2020-04-09 10:20:46 +00:00
.long("two")
.conflicts_with_all(&["one", "three"]),
)
.arg(
Arg::new("three")
2020-04-09 10:20:46 +00:00
.long("three")
.conflicts_with_all(&["one", "two"]),
)
.try_get_matches_from(vec!["", "--one", "--two", "--three"]);
assert!(a.is_err());
let a = a.unwrap_err();
2020-08-22 09:43:58 +00:00
assert!(
a.to_string()
.contains("The argument \'--one\' cannot be used with:"),
2020-08-22 09:43:58 +00:00
"{}",
a
2020-04-09 10:20:46 +00:00
);
}
#[cfg(debug_assertions)]
#[test]
2020-04-09 22:33:16 +00:00
#[should_panic = "Argument 'config' cannot conflict with itself"]
2020-04-09 10:20:46 +00:00
fn self_conflicting_arg() {
let _ = App::new("prog")
.arg(Arg::new("config").long("config").conflicts_with("config"))
2020-04-09 10:20:46 +00:00
.try_get_matches_from(vec!["", "--config"]);
}
#[cfg(debug_assertions)]
#[test]
2020-04-24 19:34:23 +00:00
#[should_panic = "Argument or group 'extra' specified in 'conflicts_with*' for 'config' does not exist"]
2020-04-09 10:20:46 +00:00
fn conflicts_with_invalid_arg() {
let _ = App::new("prog")
.arg(Arg::new("config").long("config").conflicts_with("extra"))
2020-04-09 10:20:46 +00:00
.try_get_matches_from(vec!["", "--config"]);
}
2020-04-26 17:48:08 +00:00
#[test]
2021-10-25 17:36:01 +00:00
fn conflict_with_unused_default() {
let result = App::new("conflict")
2021-11-19 20:33:11 +00:00
.arg(
arg!(-o --opt <opt> "some opt")
.required(false)
.default_value("default"),
)
.arg(arg!(-f --flag "some flag").conflicts_with("opt"))
2021-10-25 17:36:01 +00:00
.try_get_matches_from(vec!["myprog", "-f"]);
2021-12-27 19:57:38 +00:00
assert!(result.is_ok(), "{}", result.unwrap_err());
2021-10-25 17:36:01 +00:00
let m = result.unwrap();
assert_eq!(m.value_of("opt"), Some("default"));
assert!(m.is_present("flag"));
}
#[test]
fn conflicts_with_alongside_default() {
2020-04-26 17:48:08 +00:00
let result = App::new("conflict")
.arg(
2021-11-19 20:33:11 +00:00
arg!(-o --opt <opt> "some opt")
2020-04-26 17:48:08 +00:00
.default_value("default")
2021-11-19 20:33:11 +00:00
.required(false)
2020-04-26 17:48:08 +00:00
.conflicts_with("flag"),
)
2021-11-19 20:33:11 +00:00
.arg(arg!(-f --flag "some flag"))
2020-04-26 17:48:08 +00:00
.try_get_matches_from(vec!["myprog", "-f"]);
assert!(
result.is_ok(),
"conflicts_with should ignore default_value: {:?}",
result.unwrap_err()
);
2020-04-26 17:48:08 +00:00
let m = result.unwrap();
assert_eq!(m.value_of("opt"), Some("default"));
assert!(m.is_present("flag"));
}