mirror of
https://github.com/clap-rs/clap
synced 2024-12-13 14:22:34 +00:00
92919f5f67
* tests: adds tests for default values triggering conditional requirements * fix: fixes a bug where default values should have triggered a conditional requirement but didnt Closes #831 * tests: adds tests for missing conditional requirements in usage string of errors * fix: fixes a bug where conditionally required args werent appearing in errors * tests: adds tests for completion generators * tests: adds tests for completions with binaries names that have underscores * fix: fixes a bug where ZSH completions would panic if the binary name had an underscore in it Closes #581 * fix: fixes bash completions for commands that have an underscore in the name Closes #581 * chore: fix the category for crates.io * docs(Macros): adds a warning about changing values in Cargo.toml not triggering a rebuild automatically Closes #838 * fix(Completions): fixes a bug where global args weren't included in the generated completion scripts Closes #841 * fix: fixes a println->debugln typo * chore: increase version
371 lines
No EOL
12 KiB
Rust
371 lines
No EOL
12 KiB
Rust
extern crate clap;
|
|
extern crate regex;
|
|
|
|
include!("../clap-test.rs");
|
|
|
|
use clap::{App, Arg, ErrorKind};
|
|
|
|
#[test]
|
|
fn opts() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("-o [opt] 'some opt'")
|
|
.default_value("default"))
|
|
.get_matches_from_safe(vec![""]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("o"));
|
|
assert_eq!(m.value_of("o").unwrap(), "default");
|
|
}
|
|
|
|
#[test]
|
|
fn opt_user_override() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'")
|
|
.default_value("default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "value"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("opt"));
|
|
assert_eq!(m.value_of("opt").unwrap(), "value");
|
|
}
|
|
|
|
#[test]
|
|
fn positionals() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("[arg] 'some opt'")
|
|
.default_value("default"))
|
|
.get_matches_from_safe(vec![""]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "default");
|
|
}
|
|
|
|
#[test]
|
|
fn positional_user_override() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("default"))
|
|
.get_matches_from_safe(vec!["", "value"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "value");
|
|
}
|
|
|
|
// --- Default if arg is present
|
|
|
|
#[test]
|
|
fn default_if_arg_present_no_default() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value_if("opt", None, "default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "some"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "default");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_no_default_user_override() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value_if("opt", None, "default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "some", "other"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "other");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_no_arg_with_default() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_if("opt", None, "default"))
|
|
.get_matches_from_safe(vec![""]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "first");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_with_default() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_if("opt", None, "default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "some"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "default");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_with_default_user_override() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_if("opt", None, "default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "some", "other"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "other");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_no_arg_with_default_user_override() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_if("opt", None, "default"))
|
|
.get_matches_from_safe(vec!["", "other"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "other");
|
|
}
|
|
|
|
// Conditional Default Values
|
|
|
|
#[test]
|
|
fn default_if_arg_present_with_value_no_default() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value_if("opt", Some("value"), "default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "value"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "default");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_with_value_no_default_fail() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value_if("opt", Some("value"), "default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "other"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(!m.is_present("arg"));
|
|
//assert_eq!(m.value_of("arg").unwrap(), "default");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_with_value_no_default_user_override() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value_if("opt", Some("some"), "default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "some", "other"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "other");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_with_value_no_arg_with_default() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_if("opt", Some("some"), "default"))
|
|
.get_matches_from_safe(vec![""]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "first");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_with_value_no_arg_with_default_fail() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_if("opt", Some("some"), "default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "other"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "first");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_with_value_with_default() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_if("opt", Some("some"), "default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "some"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "default");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_with_value_with_default_user_override() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_if("opt", Some("some"), "default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "some", "other"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "other");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_no_arg_with_value_with_default_user_override() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_if("opt", Some("some"), "default"))
|
|
.get_matches_from_safe(vec!["", "other"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "other");
|
|
}
|
|
|
|
#[test]
|
|
fn default_if_arg_present_no_arg_with_value_with_default_user_override_fail() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_if("opt", Some("some"), "default"))
|
|
.get_matches_from_safe(vec!["", "--opt", "value", "other"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "other");
|
|
}
|
|
|
|
// Multiple conditions
|
|
|
|
#[test]
|
|
fn default_ifs_arg_present() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("--flag 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_ifs(&[
|
|
("opt", Some("some"), "default"),
|
|
("flag", None, "flg"),
|
|
]))
|
|
.get_matches_from_safe(vec!["", "--flag"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "flg");
|
|
}
|
|
|
|
#[test]
|
|
fn default_ifs_arg_present_user_override() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("--flag 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_ifs(&[
|
|
("opt", Some("some"), "default"),
|
|
("flag", None, "flg"),
|
|
]))
|
|
.get_matches_from_safe(vec!["", "--flag", "value"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "value");
|
|
}
|
|
|
|
#[test]
|
|
fn default_ifs_arg_present_order() {
|
|
let r = App::new("df")
|
|
.arg( Arg::from_usage("--opt [FILE] 'some arg'"))
|
|
.arg( Arg::from_usage("--flag 'some arg'"))
|
|
.arg( Arg::from_usage("[arg] 'some arg'")
|
|
.default_value("first")
|
|
.default_value_ifs(&[
|
|
("opt", Some("some"), "default"),
|
|
("flag", None, "flg"),
|
|
]))
|
|
.get_matches_from_safe(vec!["", "--opt=some", "--flag"]);
|
|
assert!(r.is_ok());
|
|
let m = r.unwrap();
|
|
assert!(m.is_present("arg"));
|
|
assert_eq!(m.value_of("arg").unwrap(), "default");
|
|
}
|
|
|
|
#[test]
|
|
fn conditional_reqs_fail() {
|
|
let m = App::new("Test app")
|
|
.version("1.0")
|
|
.author("F0x06")
|
|
.about("Arg test")
|
|
.arg(Arg::with_name("target")
|
|
.takes_value(true)
|
|
.default_value("file")
|
|
.possible_values(&["file", "stdout"])
|
|
.long("target"))
|
|
.arg(Arg::with_name("input")
|
|
.takes_value(true)
|
|
.required(true)
|
|
.long("input"))
|
|
.arg(Arg::with_name("output")
|
|
.takes_value(true)
|
|
.required_if("target", "file")
|
|
.long("output"))
|
|
.get_matches_from_safe(vec!["test", "--input", "some"]);
|
|
|
|
assert!(m.is_err());
|
|
assert_eq!(m.unwrap_err().kind, ErrorKind::MissingRequiredArgument);
|
|
}
|
|
|
|
#[test]
|
|
fn conditional_reqs_pass() {
|
|
let m = App::new("Test app")
|
|
.version("1.0")
|
|
.author("F0x06")
|
|
.about("Arg test")
|
|
.arg(Arg::with_name("target")
|
|
.takes_value(true)
|
|
.default_value("file")
|
|
.possible_values(&["file", "stdout"])
|
|
.long("target"))
|
|
.arg(Arg::with_name("input")
|
|
.takes_value(true)
|
|
.required(true)
|
|
.long("input"))
|
|
.arg(Arg::with_name("output")
|
|
.takes_value(true)
|
|
.required_if("target", "file")
|
|
.long("output"))
|
|
.get_matches_from_safe(vec!["test", "--input", "some", "--output", "other"]);
|
|
|
|
assert!(m.is_ok());
|
|
let m = m.unwrap();
|
|
assert_eq!(m.value_of("output"), Some("other"));
|
|
assert_eq!(m.value_of("input"), Some("some"));
|
|
} |