mirror of
https://github.com/clap-rs/clap
synced 2024-12-14 14:52:33 +00:00
4b7ed54d7e
`Parser::parse_from` will call `exit` on failure and we don't just lose
backtrace information but we don't even know which of the tests running
in parallel panicked. I ran into this when experimenting with
`clap_derive` and I couldn't tell what actually failed.
So let's switch to `Parse::try_parse_from`.
Errors went from:
```
test option_option ... ok
error: Found argument 'bar' which wasn't expected, or isn't valid in this context
USAGE:
clap_derive [OPTIONS]
For more information try --help
error: test failed, to rerun pass '--test arg_enum'
```
To:
```
test option_option ... ok
test variant_with_defined_casing ... ok
test skip_variant ... ok
test default_value ... ok
test vector ... FAILED
test option_vector ... ok
failures:
---- vector stdout ----
thread 'vector' panicked at 'called `Result::unwrap()` on an `Err` value: Error { message: Formatted(Colorizer { use_stderr: true, color_when: Auto
, pieces: [("error:", Some(Red)), (" ", None), ("Found argument '", None), ("bar", Some(Yellow)), ("' which wasn't expected, or isn't valid in this
context", None), ("\n\n", None), ("USAGE:\n clap_derive [OPTIONS]", None), ("\n\nFor more information try ", None), ("--help", Some(Green)), ("
\n", None)] }), kind: UnknownArgument, info: ["bar"], source: None, backtrace: Backtrace }', clap_derive/tests/arg_enum.rs:388:56
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
vector
test result: FAILED. 15 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
error: test failed, to rerun pass '--test arg_enum'
```
375 lines
9.1 KiB
Rust
375 lines
9.1 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.
|
|
|
|
#![allow(clippy::option_option)]
|
|
|
|
mod utils;
|
|
|
|
use clap::{Parser, Subcommand};
|
|
use utils::*;
|
|
|
|
#[test]
|
|
fn required_option() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(short, long)]
|
|
arg: i32,
|
|
}
|
|
assert_eq!(
|
|
Opt { arg: 42 },
|
|
Opt::try_parse_from(&["test", "-a42"]).unwrap()
|
|
);
|
|
assert_eq!(
|
|
Opt { arg: 42 },
|
|
Opt::try_parse_from(&["test", "-a", "42"]).unwrap()
|
|
);
|
|
assert_eq!(
|
|
Opt { arg: 42 },
|
|
Opt::try_parse_from(&["test", "--arg", "42"]).unwrap()
|
|
);
|
|
assert!(Opt::try_parse_from(&["test"]).is_err());
|
|
assert!(Opt::try_parse_from(&["test", "-a42", "-a24"]).is_err());
|
|
}
|
|
|
|
#[test]
|
|
fn optional_option() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(short)]
|
|
arg: Option<i32>,
|
|
}
|
|
assert_eq!(
|
|
Opt { arg: Some(42) },
|
|
Opt::try_parse_from(&["test", "-a42"]).unwrap()
|
|
);
|
|
assert_eq!(Opt { arg: None }, Opt::try_parse_from(&["test"]).unwrap());
|
|
assert!(Opt::try_parse_from(&["test", "-a42", "-a24"]).is_err());
|
|
}
|
|
|
|
#[test]
|
|
fn option_with_default() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(short, default_value = "42")]
|
|
arg: i32,
|
|
}
|
|
assert_eq!(
|
|
Opt { arg: 24 },
|
|
Opt::try_parse_from(&["test", "-a24"]).unwrap()
|
|
);
|
|
assert_eq!(Opt { arg: 42 }, Opt::try_parse_from(&["test"]).unwrap());
|
|
assert!(Opt::try_parse_from(&["test", "-a42", "-a24"]).is_err());
|
|
}
|
|
|
|
#[test]
|
|
fn option_with_raw_default() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(short, default_value = "42")]
|
|
arg: i32,
|
|
}
|
|
assert_eq!(
|
|
Opt { arg: 24 },
|
|
Opt::try_parse_from(&["test", "-a24"]).unwrap()
|
|
);
|
|
assert_eq!(Opt { arg: 42 }, Opt::try_parse_from(&["test"]).unwrap());
|
|
assert!(Opt::try_parse_from(&["test", "-a42", "-a24"]).is_err());
|
|
}
|
|
|
|
#[test]
|
|
fn options() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(short, long, multiple_occurrences(true))]
|
|
arg: Vec<i32>,
|
|
}
|
|
assert_eq!(
|
|
Opt { arg: vec![24] },
|
|
Opt::try_parse_from(&["test", "-a24"]).unwrap()
|
|
);
|
|
assert_eq!(Opt { arg: vec![] }, Opt::try_parse_from(&["test"]).unwrap());
|
|
assert_eq!(
|
|
Opt { arg: vec![24, 42] },
|
|
Opt::try_parse_from(&["test", "-a24", "--arg", "42"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn default_value() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(short, default_value = "test")]
|
|
arg: String,
|
|
}
|
|
assert_eq!(
|
|
Opt { arg: "test".into() },
|
|
Opt::try_parse_from(&["test"]).unwrap()
|
|
);
|
|
assert_eq!(
|
|
Opt { arg: "foo".into() },
|
|
Opt::try_parse_from(&["test", "-afoo"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn option_from_str() {
|
|
#[derive(Debug, PartialEq)]
|
|
struct A;
|
|
|
|
impl<'a> From<&'a str> for A {
|
|
fn from(_: &str) -> A {
|
|
A
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Parser, PartialEq)]
|
|
struct Opt {
|
|
#[clap(parse(from_str))]
|
|
a: Option<A>,
|
|
}
|
|
|
|
assert_eq!(Opt { a: None }, Opt::try_parse_from(&["test"]).unwrap());
|
|
assert_eq!(
|
|
Opt { a: Some(A) },
|
|
Opt::try_parse_from(&["test", "foo"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn optional_argument_for_optional_option() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(short, multiple_occurrences(true))]
|
|
#[allow(clippy::option_option)]
|
|
arg: Option<Option<i32>>,
|
|
}
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(Some(42))
|
|
},
|
|
Opt::try_parse_from(&["test", "-a42"]).unwrap()
|
|
);
|
|
assert_eq!(
|
|
Opt { arg: Some(None) },
|
|
Opt::try_parse_from(&["test", "-a"]).unwrap()
|
|
);
|
|
assert_eq!(Opt { arg: None }, Opt::try_parse_from(&["test"]).unwrap());
|
|
assert!(Opt::try_parse_from(&["test", "-a42", "-a24"]).is_err());
|
|
}
|
|
|
|
#[test]
|
|
fn option_option_help() {
|
|
#[derive(Parser, Debug)]
|
|
struct Opt {
|
|
#[clap(long, value_name = "val")]
|
|
arg: Option<Option<i32>>,
|
|
}
|
|
let help = get_help::<Opt>();
|
|
assert!(help.contains("--arg <val>"));
|
|
assert!(!help.contains("--arg <val>..."));
|
|
}
|
|
|
|
#[test]
|
|
fn two_option_options() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(short)]
|
|
arg: Option<Option<i32>>,
|
|
|
|
#[clap(long)]
|
|
field: Option<Option<String>>,
|
|
}
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(Some(42)),
|
|
field: Some(Some("f".into()))
|
|
},
|
|
Opt::try_parse_from(&["test", "-a42", "--field", "f"]).unwrap()
|
|
);
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(Some(42)),
|
|
field: Some(None)
|
|
},
|
|
Opt::try_parse_from(&["test", "-a42", "--field"]).unwrap()
|
|
);
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(None),
|
|
field: Some(None)
|
|
},
|
|
Opt::try_parse_from(&["test", "-a", "--field"]).unwrap()
|
|
);
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(None),
|
|
field: Some(Some("f".into()))
|
|
},
|
|
Opt::try_parse_from(&["test", "-a", "--field", "f"]).unwrap()
|
|
);
|
|
assert_eq!(
|
|
Opt {
|
|
arg: None,
|
|
field: Some(None)
|
|
},
|
|
Opt::try_parse_from(&["test", "--field"]).unwrap()
|
|
);
|
|
assert_eq!(
|
|
Opt {
|
|
arg: None,
|
|
field: None
|
|
},
|
|
Opt::try_parse_from(&["test"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn optional_vec() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(short, multiple_occurrences(true))]
|
|
arg: Option<Vec<i32>>,
|
|
}
|
|
assert_eq!(
|
|
Opt { arg: Some(vec![1]) },
|
|
Opt::try_parse_from(&["test", "-a", "1"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(vec![1, 2])
|
|
},
|
|
Opt::try_parse_from(&["test", "-a1", "-a2"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(vec![1, 2])
|
|
},
|
|
Opt::try_parse_from(&["test", "-a1", "-a2", "-a"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(vec![1, 2])
|
|
},
|
|
Opt::try_parse_from(&["test", "-a1", "-a", "-a2"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(vec![1, 2])
|
|
},
|
|
Opt::try_parse_from(&["test", "-a", "1", "2"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(vec![1, 2, 3])
|
|
},
|
|
Opt::try_parse_from(&["test", "-a", "1", "2", "-a", "3"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt { arg: Some(vec![]) },
|
|
Opt::try_parse_from(&["test", "-a"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt { arg: Some(vec![]) },
|
|
Opt::try_parse_from(&["test", "-a", "-a"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(Opt { arg: None }, Opt::try_parse_from(&["test"]).unwrap());
|
|
}
|
|
|
|
#[test]
|
|
fn two_optional_vecs() {
|
|
#[derive(Parser, PartialEq, Debug)]
|
|
struct Opt {
|
|
#[clap(short, multiple_occurrences(true))]
|
|
arg: Option<Vec<i32>>,
|
|
|
|
#[clap(short, multiple_occurrences(true))]
|
|
b: Option<Vec<i32>>,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(vec![1]),
|
|
b: Some(vec![])
|
|
},
|
|
Opt::try_parse_from(&["test", "-a", "1", "-b"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(vec![1]),
|
|
b: Some(vec![])
|
|
},
|
|
Opt::try_parse_from(&["test", "-a", "-b", "-a1"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
arg: Some(vec![1, 2]),
|
|
b: Some(vec![1, 2])
|
|
},
|
|
Opt::try_parse_from(&["test", "-a1", "-a2", "-b1", "-b2"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt { arg: None, b: None },
|
|
Opt::try_parse_from(&["test"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn required_option_type() {
|
|
#[derive(Debug, PartialEq, Eq, Parser)]
|
|
#[clap(setting(clap::AppSettings::SubcommandsNegateReqs))]
|
|
struct Opt {
|
|
#[clap(required = true)]
|
|
req_str: Option<String>,
|
|
|
|
#[clap(subcommand)]
|
|
cmd: Option<SubCommands>,
|
|
}
|
|
|
|
#[derive(Debug, PartialEq, Eq, Subcommand)]
|
|
enum SubCommands {
|
|
ExSub {
|
|
#[clap(short, long, parse(from_occurrences))]
|
|
verbose: u8,
|
|
},
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
req_str: Some(("arg").into()),
|
|
cmd: None,
|
|
},
|
|
Opt::try_parse_from(&["test", "arg"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
req_str: None,
|
|
cmd: Some(SubCommands::ExSub { verbose: 1 }),
|
|
},
|
|
Opt::try_parse_from(&["test", "ex-sub", "-v"]).unwrap()
|
|
);
|
|
|
|
assert!(Opt::try_parse_from(&["test"]).is_err());
|
|
}
|