mirror of
https://github.com/clap-rs/clap
synced 2024-12-13 22:32: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'
```
339 lines
7.4 KiB
Rust
339 lines
7.4 KiB
Rust
use clap::Parser;
|
|
|
|
#[test]
|
|
fn test_single_word_enum_variant_is_default_renamed_into_kebab_case() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
enum Opt {
|
|
Command { foo: u32 },
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt::Command { foo: 0 },
|
|
Opt::try_parse_from(&["test", "command", "0"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_multi_word_enum_variant_is_renamed() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
enum Opt {
|
|
FirstCommand { foo: u32 },
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt::FirstCommand { foo: 0 },
|
|
Opt::try_parse_from(&["test", "first-command", "0"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_standalone_long_generates_kebab_case() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
#[allow(non_snake_case)]
|
|
struct Opt {
|
|
#[clap(long)]
|
|
FOO_OPTION: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { FOO_OPTION: true },
|
|
Opt::try_parse_from(&["test", "--foo-option"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_custom_long_overwrites_default_name() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Opt {
|
|
#[clap(long = "foo")]
|
|
foo_option: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { foo_option: true },
|
|
Opt::try_parse_from(&["test", "--foo"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_standalone_long_uses_previous_defined_custom_name() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Opt {
|
|
#[clap(name = "foo", long)]
|
|
foo_option: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { foo_option: true },
|
|
Opt::try_parse_from(&["test", "--foo"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_standalone_long_ignores_afterwards_defined_custom_name() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Opt {
|
|
#[clap(long, name = "foo")]
|
|
foo_option: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { foo_option: true },
|
|
Opt::try_parse_from(&["test", "--foo-option"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_standalone_short_generates_kebab_case() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
#[allow(non_snake_case)]
|
|
struct Opt {
|
|
#[clap(short)]
|
|
FOO_OPTION: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { FOO_OPTION: true },
|
|
Opt::try_parse_from(&["test", "-f"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_custom_short_overwrites_default_name() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Opt {
|
|
#[clap(short = 'o')]
|
|
foo_option: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { foo_option: true },
|
|
Opt::try_parse_from(&["test", "-o"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_standalone_short_uses_previous_defined_custom_name() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Opt {
|
|
#[clap(name = "option", short)]
|
|
foo_option: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { foo_option: true },
|
|
Opt::try_parse_from(&["test", "-o"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_standalone_short_ignores_afterwards_defined_custom_name() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Opt {
|
|
#[clap(short, name = "option")]
|
|
foo_option: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { foo_option: true },
|
|
Opt::try_parse_from(&["test", "-f"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_standalone_long_uses_previous_defined_casing() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Opt {
|
|
#[clap(rename_all = "screaming_snake", long)]
|
|
foo_option: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { foo_option: true },
|
|
Opt::try_parse_from(&["test", "--FOO_OPTION"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_standalone_short_uses_previous_defined_casing() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Opt {
|
|
#[clap(rename_all = "screaming_snake", short)]
|
|
foo_option: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { foo_option: true },
|
|
Opt::try_parse_from(&["test", "-F"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_standalone_long_works_with_verbatim_casing() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
#[allow(non_snake_case)]
|
|
struct Opt {
|
|
#[clap(rename_all = "verbatim", long)]
|
|
_fOO_oPtiON: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { _fOO_oPtiON: true },
|
|
Opt::try_parse_from(&["test", "--_fOO_oPtiON"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_standalone_short_works_with_verbatim_casing() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Opt {
|
|
#[clap(rename_all = "verbatim", short)]
|
|
_foo: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { _foo: true },
|
|
Opt::try_parse_from(&["test", "-_"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_rename_all_is_propagated_from_struct_to_fields() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
#[clap(rename_all = "screaming_snake")]
|
|
struct Opt {
|
|
#[clap(long)]
|
|
foo: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { foo: true },
|
|
Opt::try_parse_from(&["test", "--FOO"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_rename_all_is_not_propagated_from_struct_into_flattened() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
#[clap(rename_all = "screaming_snake")]
|
|
struct Opt {
|
|
#[clap(flatten)]
|
|
foo: Foo,
|
|
}
|
|
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Foo {
|
|
#[clap(long)]
|
|
foo: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
foo: Foo { foo: true }
|
|
},
|
|
Opt::try_parse_from(&["test", "--foo"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_rename_all_is_not_propagated_from_struct_into_subcommand() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
#[clap(rename_all = "screaming_snake")]
|
|
struct Opt {
|
|
#[clap(subcommand)]
|
|
foo: Foo,
|
|
}
|
|
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
enum Foo {
|
|
Command {
|
|
#[clap(long)]
|
|
foo: bool,
|
|
},
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt {
|
|
foo: Foo::Command { foo: true }
|
|
},
|
|
Opt::try_parse_from(&["test", "command", "--foo"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_rename_all_is_propagated_from_enum_to_variants_and_their_fields() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
#[clap(rename_all = "screaming_snake")]
|
|
enum Opt {
|
|
FirstVariant,
|
|
SecondVariant {
|
|
#[clap(long)]
|
|
foo: bool,
|
|
},
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt::FirstVariant,
|
|
Opt::try_parse_from(&["test", "FIRST_VARIANT"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt::SecondVariant { foo: true },
|
|
Opt::try_parse_from(&["test", "SECOND_VARIANT", "--FOO"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_rename_all_is_propagation_can_be_overridden() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
#[clap(rename_all = "screaming_snake")]
|
|
enum Opt {
|
|
#[clap(rename_all = "kebab_case")]
|
|
FirstVariant {
|
|
#[clap(long)]
|
|
foo_option: bool,
|
|
},
|
|
SecondVariant {
|
|
#[clap(rename_all = "kebab_case", long)]
|
|
foo_option: bool,
|
|
},
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt::FirstVariant { foo_option: true },
|
|
Opt::try_parse_from(&["test", "first-variant", "--foo-option"]).unwrap()
|
|
);
|
|
|
|
assert_eq!(
|
|
Opt::SecondVariant { foo_option: true },
|
|
Opt::try_parse_from(&["test", "SECOND_VARIANT", "--foo-option"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_lower_is_renamed() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Opt {
|
|
#[clap(rename_all = "lower", long)]
|
|
foo_option: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { foo_option: true },
|
|
Opt::try_parse_from(&["test", "--foooption"]).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_upper_is_renamed() {
|
|
#[derive(Parser, Debug, PartialEq)]
|
|
struct Opt {
|
|
#[clap(rename_all = "upper", long)]
|
|
foo_option: bool,
|
|
}
|
|
|
|
assert_eq!(
|
|
Opt { foo_option: true },
|
|
Opt::try_parse_from(&["test", "--FOOOPTION"]).unwrap()
|
|
);
|
|
}
|