clap/tests/builder/default_vals.rs

894 lines
26 KiB
Rust
Raw Normal View History

use super::utils;
2022-02-12 03:48:29 +00:00
use clap::{arg, error::ErrorKind, Arg, Command};
#[test]
fn opts() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(
arg!(o: -o <opt> "some opt")
.required(false)
.default_value("default"),
)
.try_get_matches_from(vec![""]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("o"));
assert_eq!(
m.get_one::<String>("o").map(|v| v.as_str()).unwrap(),
"default"
);
}
#[test]
fn default_has_index() {
let r = Command::new("df")
.arg(
arg!(o: -o <opt> "some opt")
.required(false)
.default_value("default"),
)
.try_get_matches_from(vec![""]);
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert_eq!(m.index_of("o"), Some(1));
}
#[test]
fn opt_without_value_fail() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
.arg(
2021-11-19 20:33:11 +00:00
arg!(o: -o <opt> "some opt")
.required(false)
.default_value("default")
2022-05-23 21:58:07 +00:00
.value_parser(clap::builder::NonEmptyStringValueParser::new()),
)
.try_get_matches_from(vec!["", "-o"]);
assert!(r.is_err());
let err = r.unwrap_err();
2022-01-25 22:19:28 +00:00
assert_eq!(err.kind(), ErrorKind::EmptyValue);
assert!(err
.to_string()
.contains("The argument '-o <opt>' requires a value but none was supplied"));
}
#[test]
fn opt_user_override() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(
arg!(--opt <FILE> "some arg")
.required(false)
.default_value("default"),
)
.try_get_matches_from(vec!["", "--opt", "value"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("opt"));
assert_eq!(
m.get_one::<String>("opt").map(|v| v.as_str()).unwrap(),
"value"
);
}
#[test]
fn positionals() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!([arg] "some opt").default_value("default"))
.try_get_matches_from(vec![""]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"default"
);
}
#[test]
fn positional_user_override() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!([arg] "some arg").default_value("default"))
.try_get_matches_from(vec!["", "value"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"value"
);
}
// OsStr Default Values
#[test]
fn osstr_opts() {
use std::ffi::OsStr;
let expected = OsStr::new("default");
2017-09-29 18:56:53 +00:00
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(
arg!(o: -o <opt> "some opt")
.required(false)
.default_value_os(expected),
)
.try_get_matches_from(vec![""]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("o"));
assert_eq!(
m.get_one::<String>("o").map(|v| v.as_str()).unwrap(),
expected
);
}
#[test]
fn osstr_opt_user_override() {
use std::ffi::OsStr;
let default = OsStr::new("default");
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(
arg!(--opt <FILE> "some arg")
.required(false)
.default_value_os(default),
)
.try_get_matches_from(vec!["", "--opt", "value"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("opt"));
assert_eq!(
m.get_one::<String>("opt").map(|v| v.as_str()).unwrap(),
"value"
);
}
#[test]
fn osstr_positionals() {
use std::ffi::OsStr;
let expected = OsStr::new("default");
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!([arg] "some opt").default_value_os(expected))
.try_get_matches_from(vec![""]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
expected
);
}
#[test]
fn osstr_positional_user_override() {
use std::ffi::OsStr;
let default = OsStr::new("default");
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!([arg] "some arg").default_value_os(default))
.try_get_matches_from(vec!["", "value"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"value"
);
}
2017-09-29 18:56:53 +00:00
// --- Default if arg is present
#[test]
fn default_if_arg_present_no_default() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(true))
.arg(arg!([arg] "some arg").default_value_if("opt", None, Some("default")))
.try_get_matches_from(vec!["", "--opt", "some"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"default"
);
}
#[test]
fn default_if_arg_present_no_default_user_override() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(arg!([arg] "some arg").default_value_if("opt", None, Some("default")))
.try_get_matches_from(vec!["", "--opt", "some", "other"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"other"
);
}
#[test]
fn default_if_arg_present_no_arg_with_default() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_if("opt", None, Some("default")),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec![""]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"first"
);
}
#[test]
fn default_if_arg_present_with_default() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_if("opt", None, Some("default")),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec!["", "--opt", "some"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"default"
);
}
#[test]
fn default_if_arg_present_with_default_user_override() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_if("opt", None, Some("default")),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec!["", "--opt", "some", "other"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"other"
);
}
#[test]
fn default_if_arg_present_no_arg_with_default_user_override() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_if("opt", None, Some("default")),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec!["", "other"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"other"
);
}
// Conditional Default Values
#[test]
fn default_if_arg_present_with_value_no_default() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(arg!([arg] "some arg").default_value_if("opt", Some("value"), Some("default")))
.try_get_matches_from(vec!["", "--opt", "value"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"default"
);
}
#[test]
fn default_if_arg_present_with_value_no_default_fail() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(arg!([arg] "some arg").default_value_if("opt", Some("value"), Some("default")))
.try_get_matches_from(vec!["", "--opt", "other"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(!m.is_present("arg"));
assert!(m.get_one::<String>("arg").map(|v| v.as_str()).is_none());
}
#[test]
fn default_if_arg_present_with_value_no_default_user_override() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(arg!([arg] "some arg").default_value_if("opt", Some("some"), Some("default")))
.try_get_matches_from(vec!["", "--opt", "some", "other"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"other"
);
}
#[test]
fn default_if_arg_present_with_value_no_arg_with_default() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_if("opt", Some("some"), Some("default")),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec![""]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"first"
);
}
#[test]
fn default_if_arg_present_with_value_no_arg_with_default_fail() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_if("opt", Some("some"), Some("default")),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec!["", "--opt", "other"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"first"
);
}
#[test]
fn default_if_arg_present_with_value_with_default() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_if("opt", Some("some"), Some("default")),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec!["", "--opt", "some"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"default"
);
}
#[test]
fn default_if_arg_present_with_value_with_default_user_override() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_if("opt", Some("some"), Some("default")),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec!["", "--opt", "some", "other"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"other"
);
}
#[test]
fn default_if_arg_present_no_arg_with_value_with_default_user_override() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_if("opt", Some("some"), Some("default")),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec!["", "other"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"other"
);
}
#[test]
fn default_if_arg_present_no_arg_with_value_with_default_user_override_fail() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_if("opt", Some("some"), Some("default")),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec!["", "--opt", "value", "other"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"other"
);
}
// Unsetting the default
#[test]
fn no_default_if_arg_present_with_value_no_default() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(arg!([arg] "some arg").default_value_if("opt", Some("value"), None))
.try_get_matches_from(vec!["", "--opt", "value"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(!m.is_present("arg"));
}
#[test]
fn no_default_if_arg_present_with_value_with_default() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
.default_value("default")
.default_value_if("opt", Some("value"), None),
)
.try_get_matches_from(vec!["", "--opt", "value"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(!m.is_present("arg"));
assert!(m.get_one::<String>("arg").map(|v| v.as_str()).is_none());
}
#[test]
fn no_default_if_arg_present_with_value_with_default_user_override() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
.default_value("default")
.default_value_if("opt", Some("value"), None),
)
.try_get_matches_from(vec!["", "--opt", "value", "other"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"other"
);
}
#[test]
fn no_default_if_arg_present_no_arg_with_value_with_default() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
.default_value("default")
.default_value_if("opt", Some("value"), None),
)
.try_get_matches_from(vec!["", "--opt", "other"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"default"
);
}
// Multiple conditions
#[test]
fn default_ifs_arg_present() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(arg!(--flag "some arg"))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_ifs(&[
("opt", Some("some"), Some("default")),
("flag", None, Some("flg")),
]),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec!["", "--flag"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"flg"
);
}
#[test]
fn no_default_ifs_arg_present() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(arg!(--flag "some arg"))
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
.default_value("first")
.default_value_ifs(&[("opt", Some("some"), Some("default")), ("flag", None, None)]),
)
.try_get_matches_from(vec!["", "--flag"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(!m.is_present("arg"));
assert!(m.get_one::<String>("arg").map(|v| v.as_str()).is_none());
}
#[test]
fn default_ifs_arg_present_user_override() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(arg!(--flag "some arg"))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_ifs(&[
("opt", Some("some"), Some("default")),
("flag", None, Some("flg")),
]),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec!["", "--flag", "value"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"value"
);
}
#[test]
fn default_ifs_arg_present_order() {
2022-02-12 03:48:29 +00:00
let r = Command::new("df")
2021-11-19 20:33:11 +00:00
.arg(arg!(--opt <FILE> "some arg").required(false))
.arg(arg!(--flag "some arg"))
2017-09-29 18:56:53 +00:00
.arg(
2021-11-19 20:33:11 +00:00
arg!([arg] "some arg")
2017-09-29 18:56:53 +00:00
.default_value("first")
2021-03-09 18:26:38 +00:00
.default_value_ifs(&[
("opt", Some("some"), Some("default")),
("flag", None, Some("flg")),
]),
2017-09-29 18:56:53 +00:00
)
.try_get_matches_from(vec!["", "--opt=some", "--flag"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("arg"));
assert_eq!(
m.get_one::<String>("arg").map(|v| v.as_str()).unwrap(),
"default"
);
}
2021-10-25 17:36:01 +00:00
// Interaction with requires
#[test]
fn conditional_reqs_pass() {
2022-02-14 21:47:20 +00:00
let m = Command::new("Test cmd")
2017-09-29 18:56:53 +00:00
.arg(
Arg::new("target")
2017-09-29 18:56:53 +00:00
.takes_value(true)
.default_value("file")
.long("target"),
)
.arg(
Arg::new("input")
2017-09-29 18:56:53 +00:00
.takes_value(true)
.required(true)
.long("input"),
)
.arg(
Arg::new("output")
2017-09-29 18:56:53 +00:00
.takes_value(true)
2020-05-23 14:02:03 +00:00
.required_if_eq("target", "file")
2017-09-29 18:56:53 +00:00
.long("output"),
)
.try_get_matches_from(vec!["test", "--input", "some", "--output", "other"]);
2021-12-27 19:57:38 +00:00
assert!(m.is_ok(), "{}", m.unwrap_err());
let m = m.unwrap();
assert_eq!(
m.get_one::<String>("output").map(|v| v.as_str()),
Some("other")
);
assert_eq!(
m.get_one::<String>("input").map(|v| v.as_str()),
Some("some")
);
}
#[test]
fn multiple_defaults() {
2022-02-12 03:48:29 +00:00
let r = Command::new("diff")
.arg(
Arg::new("files")
.long("files")
.number_of_values(2)
.default_values(&["old", "new"]),
)
.try_get_matches_from(vec![""]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("files"));
2022-05-23 12:23:16 +00:00
assert_eq!(
m.get_many::<String>("files").unwrap().collect::<Vec<_>>(),
vec!["old", "new"]
);
}
#[test]
fn multiple_defaults_override() {
2022-02-12 03:48:29 +00:00
let r = Command::new("diff")
.arg(
Arg::new("files")
.long("files")
.number_of_values(2)
.default_values(&["old", "new"]),
)
.try_get_matches_from(vec!["", "--files", "other", "mine"]);
2021-12-27 19:57:38 +00:00
assert!(r.is_ok(), "{}", r.unwrap_err());
let m = r.unwrap();
assert!(m.is_present("files"));
2022-05-23 12:23:16 +00:00
assert_eq!(
m.get_many::<String>("files").unwrap().collect::<Vec<_>>(),
vec!["other", "mine"]
);
}
2021-07-20 18:50:41 +00:00
#[test]
fn default_vals_donnot_show_in_smart_usage() {
2022-02-14 21:47:20 +00:00
let cmd = Command::new("bug")
2021-07-20 18:50:41 +00:00
.arg(
Arg::new("foo")
.long("config")
.takes_value(true)
.default_value("bar"),
)
.arg(Arg::new("input").required(true));
2021-10-25 17:36:01 +00:00
2022-04-29 20:32:25 +00:00
utils::assert_output(
2022-02-14 21:47:20 +00:00
cmd,
2021-07-20 18:50:41 +00:00
"bug",
"error: The following required arguments were not provided:
<input>
USAGE:
bug [OPTIONS] <input>
For more information try --help
",
2021-07-20 18:50:41 +00:00
true,
2022-04-29 20:32:25 +00:00
);
2021-07-20 18:50:41 +00:00
}
#[test]
fn issue_1050_num_vals_and_defaults() {
2022-02-12 03:48:29 +00:00
let res = Command::new("hello")
.arg(
Arg::new("exit-code")
.long("exit-code")
.takes_value(true)
.number_of_values(1)
.default_value("0"),
)
.try_get_matches_from(vec!["hello", "--exit-code=1"]);
2021-12-27 19:57:38 +00:00
assert!(res.is_ok(), "{}", res.unwrap_err());
let m = res.unwrap();
assert_eq!(
m.get_one::<String>("exit-code").map(|v| v.as_str()),
Some("1")
);
2018-01-25 04:05:05 +00:00
}
#[cfg(debug_assertions)]
#[test]
#[should_panic = "Argument group 'group' is required but all of it's arguments have a default value."]
fn required_groups_with_default_values() {
2022-02-12 03:48:29 +00:00
use clap::{Arg, ArgGroup, Command};
2022-02-12 03:48:29 +00:00
let _ = Command::new("test")
.arg(Arg::new("arg").default_value("value"))
.group(ArgGroup::new("group").args(&["arg"]).required(true))
.try_get_matches();
}
#[cfg(debug_assertions)]
#[test]
#[should_panic = "Argument 'arg' is required and can't have a default value"]
fn required_args_with_default_values() {
2022-02-12 03:48:29 +00:00
use clap::{Arg, Command};
2022-02-12 03:48:29 +00:00
let _ = Command::new("test")
.arg(Arg::new("arg").required(true).default_value("value"))
.try_get_matches();
}
#[cfg(debug_assertions)]
#[test]
2022-05-24 01:16:02 +00:00
#[should_panic = "Argument `arg`'s default_value=\"value\" failed validation: error: \"value\" isn't a valid value for '<arg>'"]
fn default_values_are_possible_values() {
2022-02-12 03:48:29 +00:00
use clap::{Arg, Command};
2022-02-12 03:48:29 +00:00
let _ = Command::new("test")
.arg(
Arg::new("arg")
2022-05-24 01:16:02 +00:00
.value_parser(["one", "two"])
.default_value("value"),
)
.try_get_matches();
}
#[cfg(debug_assertions)]
#[test]
#[should_panic = "Argument `arg`'s default_value=\"one\" failed validation: error: Invalid value \"one\" for '<arg>"]
fn invalid_default_values() {
2022-02-12 03:48:29 +00:00
use clap::{Arg, Command};
2022-02-12 03:48:29 +00:00
let _ = Command::new("test")
.arg(
Arg::new("arg")
.value_parser(clap::value_parser!(u32))
.default_value("one"),
)
.try_get_matches();
}
#[test]
fn valid_delimited_default_values() {
use clap::{Arg, Command};
let _ = Command::new("test")
.arg(
Arg::new("arg")
.value_parser(clap::value_parser!(u32))
.use_value_delimiter(true)
.require_value_delimiter(true)
.default_value("1,2,3"),
)
.try_get_matches();
}
#[cfg(debug_assertions)]
#[test]
#[should_panic = "Argument `arg`'s default_value=\"one\" failed validation: error: Invalid value \"one\" for '<arg>"]
fn invalid_delimited_default_values() {
use clap::{Arg, Command};
let _ = Command::new("test")
.arg(
Arg::new("arg")
.value_parser(clap::value_parser!(u32))
.use_value_delimiter(true)
.require_value_delimiter(true)
.default_value("one,two"),
)
.try_get_matches();
}
#[test]
fn with_value_delimiter() {
2022-02-14 21:47:20 +00:00
let cmd = Command::new("multiple_values").arg(
Arg::new("option")
.long("option")
.help("multiple options")
.value_delimiter(';')
.default_value("first;second"),
);
2022-02-14 21:47:20 +00:00
let matches = cmd.try_get_matches_from(vec![""]).unwrap();
assert_eq!(
matches
.get_many::<String>("option")
.unwrap()
.map(|v| v.as_str())
.collect::<Vec<_>>(),
["first", "second"]
);
}
#[test]
fn missing_with_value_delimiter() {
2022-02-14 21:47:20 +00:00
let cmd = Command::new("program").arg(
Arg::new("option")
.long("option")
.value_delimiter(';')
.default_missing_values(&["value1;value2;value3", "value4;value5"]),
);
2022-02-14 21:47:20 +00:00
let matches = cmd
.try_get_matches_from(vec!["program", "--option"])
.unwrap();
assert_eq!(
matches
.get_many::<String>("option")
.unwrap()
.map(|v| v.as_str())
.collect::<Vec<_>>(),
["value1", "value2", "value3", "value4", "value5"]
);
}
#[test]
fn default_independent_of_trailing() {
let cmd = Command::new("test")
.dont_delimit_trailing_values(true)
.arg(Arg::new("pos").required(true))
.arg(
Arg::new("flag")
.long("flag")
.default_value("one,two")
.value_delimiter(','),
);
// Baseline behavior
let m = cmd
.clone()
.try_get_matches_from(vec!["program", "here"])
.unwrap();
assert_eq!(
m.get_one::<String>("pos").map(|v| v.as_str()).unwrap(),
"here"
);
assert_eq!(
m.get_many::<String>("flag")
.unwrap()
.map(|v| v.as_str())
.collect::<Vec<_>>(),
["one", "two"]
);
// Trailing-values behavior should match the baseline
let m = cmd
.try_get_matches_from(vec!["program", "--", "here"])
.unwrap();
assert_eq!(
m.get_one::<String>("pos").map(|v| v.as_str()).unwrap(),
"here"
);
assert_eq!(
m.get_many::<String>("flag")
.unwrap()
.map(|v| v.as_str())
.collect::<Vec<_>>(),
["one", "two"]
);
}