clap/clap_derive/tests/arguments.rs
Ed Page c485ae517b fix(derive): Follow value_name convention
I debated putting this fix inside of the Builder API but I figure this
makes it so you "pay for what you use", with the derive API giving it to
you "for free".

A potential next step is to improve the default value name.  I tend to
use value_name to hint at how to use an argument, which correlates with
types.  We could add a
`ValueName::value_name(fallback: &str) -> &str` with impls for common
types, so we get more of a usage-based result.

Fixes #2608
2021-07-26 10:01:32 -05:00

100 lines
2.8 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::Clap;
use clap::IntoApp;
#[test]
fn required_argument() {
#[derive(Clap, 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(Clap, 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(Clap, 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(Clap, 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(Clap, 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 value_name() {
#[derive(Clap, 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"));
}