mirror of
https://github.com/clap-rs/clap
synced 2024-12-15 07:12:32 +00:00
d840d5650e
Before #2005, `Clap` was a special trait that derived all clap traits it detected were relevant (including an enum getting both `ArgEnum`, `Clap`, and `Subcommand`). Now, we have elevated `Clap`, `Args`, `Subcommand`, and `ArgEnum` to be user facing but the name `Clap` isn't very descriptive. This also helps further clarify the relationships so a crate providing an item to be `#[clap(flatten)]` or `#[clap(subcommand)]` is more likely to choose the needed trait to derive. Also, my proposed fix fo #2785 includes making `App` attributes almost exclusively for `Clap`. Clarifying the names/roles will help communicate this. For prior discussion, see #2583
120 lines
3.5 KiB
Rust
120 lines
3.5 KiB
Rust
// Copyright 2018 Guillaume Pinot (@TeXitoi) <texitoi@texitoi.eu>,
|
|
// Kevin Knapp (@kbknapp) <kbknapp@gmail.com>, and
|
|
// Andrew Hobden (@hoverbear) <andrew@hoverbear.org>
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
// option. This file may not be copied, modified, or distributed
|
|
// except according to those terms.
|
|
//
|
|
// This work was derived from Structopt (https://github.com/TeXitoi/structopt)
|
|
// commit#ea76fa1b1b273e65e3b0b1046643715b49bec51f which is licensed under the
|
|
// MIT/Apache 2.0 license.
|
|
|
|
use clap::IntoApp;
|
|
use clap::Parser;
|
|
|
|
#[test]
|
|
fn required_argument() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
arg: i32,
|
|
}
|
|
assert_eq!(Opt { arg: 42 }, Opt::parse_from(&["test", "42"]));
|
|
assert!(Opt::try_parse_from(&["test"]).is_err());
|
|
assert!(Opt::try_parse_from(&["test", "42", "24"]).is_err());
|
|
}
|
|
|
|
#[test]
|
|
fn optional_argument() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
arg: Option<i32>,
|
|
}
|
|
assert_eq!(Opt { arg: Some(42) }, Opt::parse_from(&["test", "42"]));
|
|
assert_eq!(Opt { arg: None }, Opt::parse_from(&["test"]));
|
|
assert!(Opt::try_parse_from(&["test", "42", "24"]).is_err());
|
|
}
|
|
|
|
#[test]
|
|
fn argument_with_default() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(default_value = "42")]
|
|
arg: i32,
|
|
}
|
|
assert_eq!(Opt { arg: 24 }, Opt::parse_from(&["test", "24"]));
|
|
assert_eq!(Opt { arg: 42 }, Opt::parse_from(&["test"]));
|
|
assert!(Opt::try_parse_from(&["test", "42", "24"]).is_err());
|
|
}
|
|
|
|
#[test]
|
|
fn arguments() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
arg: Vec<i32>,
|
|
}
|
|
assert_eq!(Opt { arg: vec![24] }, Opt::parse_from(&["test", "24"]));
|
|
assert_eq!(Opt { arg: vec![] }, Opt::parse_from(&["test"]));
|
|
assert_eq!(
|
|
Opt { arg: vec![24, 42] },
|
|
Opt::parse_from(&["test", "24", "42"])
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn arguments_safe() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
arg: Vec<i32>,
|
|
}
|
|
assert_eq!(
|
|
Opt { arg: vec![24] },
|
|
Opt::try_parse_from(&["test", "24"]).unwrap()
|
|
);
|
|
assert_eq!(Opt { arg: vec![] }, Opt::try_parse_from(&["test"]).unwrap());
|
|
assert_eq!(
|
|
Opt { arg: vec![24, 42] },
|
|
Opt::try_parse_from(&["test", "24", "42"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
clap::ErrorKind::ValueValidation,
|
|
Opt::try_parse_from(&["test", "NOPE"]).err().unwrap().kind
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn auto_value_name() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
my_special_arg: i32,
|
|
}
|
|
|
|
let mut help = Vec::new();
|
|
Opt::into_app().write_help(&mut help).unwrap();
|
|
let help = String::from_utf8(help).unwrap();
|
|
|
|
assert!(help.contains("MY_SPECIAL_ARG"));
|
|
// Ensure the implicit `num_vals` is just 1
|
|
assert_eq!(Opt { my_special_arg: 10 }, Opt::parse_from(&["test", "10"]));
|
|
}
|
|
|
|
#[test]
|
|
fn explicit_value_name() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(value_name = "BROWNIE_POINTS")]
|
|
my_special_arg: i32,
|
|
}
|
|
|
|
let mut help = Vec::new();
|
|
Opt::into_app().write_help(&mut help).unwrap();
|
|
let help = String::from_utf8(help).unwrap();
|
|
|
|
assert!(help.contains("BROWNIE_POINTS"));
|
|
assert!(!help.contains("MY_SPECIAL_ARG"));
|
|
// Ensure the implicit `num_vals` is just 1
|
|
assert_eq!(Opt { my_special_arg: 10 }, Opt::parse_from(&["test", "10"]));
|
|
}
|