tests/require.rs

mod utils;

use clap::{App, Arg, ArgGroup, ErrorKind};

static REQUIRE_EQUALS: &str = "error: The following required arguments were not provided:
    --opt=<FILE>

USAGE:
    clap-test --opt=<FILE>

For more information try --help";

static MISSING_REQ: &str = "error: The following required arguments were not provided:
    <positional2>
    --long-option-2 <option2>

USAGE:
    clap-test <positional2> --long-option-2 <option2> -F

For more information try --help";

static COND_REQ_IN_USAGE: &str = "error: The following required arguments were not provided:
    --output <output>

USAGE:
    test --target <target> --input <input> --output <output>

For more information try --help";

#[test]
fn flag_required() {
    let result = App::new("flag_required")
        .arg(Arg::from("-f, --flag 'some flag'").requires("color"))
        .arg(Arg::from("-c, --color 'third flag'"))
        .try_get_matches_from(vec!["", "-f"]);
    assert!(result.is_err());
    let err = result.err().unwrap();
    assert_eq!(err.kind, ErrorKind::MissingRequiredArgument);
}

#[test]
fn flag_required_2() {
    let m = App::new("flag_required")
        .arg(Arg::from("-f, --flag 'some flag'").requires("color"))
        .arg(Arg::from("-c, --color 'third flag'"))
        .get_matches_from(vec!["", "-f", "-c"]);
    assert!(m.is_present("color"));
    assert!(m.is_present("flag"));
}

#[test]
fn option_required() {
    let result = App::new("option_required")
        .arg(Arg::from("-f [flag] 'some flag'").requires("c"))
        .arg(Arg::from("-c [color] 'third flag'"))
        .try_get_matches_from(vec!["", "-f", "val"]);
    assert!(result.is_err());
    let err = result.err().unwrap();
    assert_eq!(err.kind, ErrorKind::MissingRequiredArgument);
}

#[test]
fn option_required_2() {
    let m = App::new("option_required")
        .arg(Arg::from("-f [flag] 'some flag'").requires("c"))
        .arg(Arg::from("-c [color] 'third flag'"))
        .get_matches_from(vec!["", "-f", "val", "-c", "other_val"]);
    assert!(m.is_present("c"));
    assert_eq!(m.value_of("c").unwrap(), "other_val");
    assert!(m.is_present("f"));
    assert_eq!(m.value_of("f").unwrap(), "val");
}

#[test]
fn positional_required() {
    let result = App::new("positional_required")
        .arg(Arg::with_name("flag").index(1).required(true))
        .try_get_matches_from(vec![""]);
    assert!(result.is_err());
    let err = result.err().unwrap();
    assert_eq!(err.kind, ErrorKind::MissingRequiredArgument);
}

#[test]
fn positional_required_2() {
    let m = App::new("positional_required")
        .arg(Arg::with_name("flag").index(1).required(true))
        .get_matches_from(vec!["", "someval"]);
    assert!(m.is_present("flag"));
    assert_eq!(m.value_of("flag").unwrap(), "someval");
}

#[test]
fn group_required() {
    let result = App::new("group_required")
        .arg(Arg::from("-f, --flag 'some flag'"))
        .group(
            ArgGroup::with_name("gr")
                .required(true)
                .arg("some")
                .arg("other"),
        )
        .arg(Arg::from("--some 'some arg'"))
        .arg(Arg::from("--other 'other arg'"))
        .try_get_matches_from(vec!["", "-f"]);
    assert!(result.is_err());
    let err = result.err().unwrap();
    assert_eq!(err.kind, ErrorKind::MissingRequiredArgument);
}

#[test]
fn group_required_2() {
    let m = App::new("group_required")
        .arg(Arg::from("-f, --flag 'some flag'"))
        .group(
            ArgGroup::with_name("gr")
                .required(true)
                .arg("some")
                .arg("other"),
        )
        .arg(Arg::from("--some 'some arg'"))
        .arg(Arg::from("--other 'other arg'"))
        .get_matches_from(vec!["", "-f", "--some"]);
    assert!(m.is_present("some"));
    assert!(!m.is_present("other"));
    assert!(m.is_present("flag"));
}

#[test]
fn group_required_3() {
    let m = App::new("group_required")
        .arg(Arg::from("-f, --flag 'some flag'"))
        .group(
            ArgGroup::with_name("gr")
                .required(true)
                .arg("some")
                .arg("other"),
        )
        .arg(Arg::from("--some 'some arg'"))
        .arg(Arg::from("--other 'other arg'"))
        .get_matches_from(vec!["", "-f", "--other"]);
    assert!(!m.is_present("some"));
    assert!(m.is_present("other"));
    assert!(m.is_present("flag"));
}

#[test]
fn arg_require_group() {
    let result = App::new("arg_require_group")
        .arg(Arg::from("-f, --flag 'some flag'").requires("gr"))
        .group(ArgGroup::with_name("gr").arg("some").arg("other"))
        .arg(Arg::from("--some 'some arg'"))
        .arg(Arg::from("--other 'other arg'"))
        .try_get_matches_from(vec!["", "-f"]);
    assert!(result.is_err());
    let err = result.err().unwrap();
    assert_eq!(err.kind, ErrorKind::MissingRequiredArgument);
}

#[test]
fn arg_require_group_2() {
    let res = App::new("arg_require_group")
        .arg(Arg::from("-f, --flag 'some flag'").requires("gr"))
        .group(ArgGroup::with_name("gr").arg("some").arg("other"))
        .arg(Arg::from("--some 'some arg'"))
        .arg(Arg::from("--other 'other arg'"))
        .try_get_matches_from(vec!["", "-f", "--some"]);
    assert!(res.is_ok());
    let m = res.unwrap();
    assert!(m.is_present("some"));
    assert!(!m.is_present("other"));
    assert!(m.is_present("flag"));
}

#[test]
fn arg_require_group_3() {
    let res = App::new("arg_require_group")
        .arg(Arg::from("-f, --flag 'some flag'").requires("gr"))
        .group(ArgGroup::with_name("gr").arg("some").arg("other"))
        .arg(Arg::from("--some 'some arg'"))
        .arg(Arg::from("--other 'other arg'"))
        .try_get_matches_from(vec!["", "-f", "--other"]);
    assert!(res.is_ok());
    let m = res.unwrap();
    assert!(!m.is_present("some"));
    assert!(m.is_present("other"));
    assert!(m.is_present("flag"));
}

// REQUIRED_UNLESS

#[test]
fn issue_753() {
    let m = App::new("test")
        .arg(Arg::from(
            "-l, --list 'List available interfaces (and stop there)'",
        ))
        .arg(
            Arg::from("-i, --iface=[INTERFACE] 'Ethernet interface for fetching NTP packets'")
                .required_unless("list"),
        )
        .arg(
            Arg::from("-f, --file=[TESTFILE] 'Fetch NTP packets from pcap file'")
                .conflicts_with("iface")
                .required_unless("list"),
        )
        .arg(Arg::from("-s, --server=[SERVER_IP] 'NTP server IP address'").required_unless("list"))
        .arg(Arg::from("-p, --port=[SERVER_PORT] 'NTP server port'").default_value("123"))
        .try_get_matches_from(vec!["test", "--list"]);
    assert!(m.is_ok());
}

#[test]
fn required_unless() {
    let res = App::new("unlesstest")
        .arg(
            Arg::with_name("cfg")
                .required_unless("dbg")
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("dbg").long("debug"))
        .try_get_matches_from(vec!["unlesstest", "--debug"]);

    assert!(res.is_ok());
    let m = res.unwrap();
    assert!(m.is_present("dbg"));
    assert!(!m.is_present("cfg"));
}

#[test]
fn required_unless_err() {
    let res = App::new("unlesstest")
        .arg(
            Arg::with_name("cfg")
                .required_unless("dbg")
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("dbg").long("debug"))
        .try_get_matches_from(vec!["unlesstest"]);

    assert!(res.is_err());
    assert_eq!(res.unwrap_err().kind, ErrorKind::MissingRequiredArgument);
}

// REQUIRED_UNLESS_ALL

#[test]
fn required_unless_all() {
    let res = App::new("unlessall")
        .arg(
            Arg::with_name("cfg")
                .required_unless_all(&["dbg", "infile"])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("dbg").long("debug"))
        .arg(Arg::with_name("infile").short('i').takes_value(true))
        .try_get_matches_from(vec!["unlessall", "--debug", "-i", "file"]);

    assert!(res.is_ok());
    let m = res.unwrap();
    assert!(m.is_present("dbg"));
    assert!(m.is_present("infile"));
    assert!(!m.is_present("cfg"));
}

#[test]
fn required_unless_all_err() {
    let res = App::new("unlessall")
        .arg(
            Arg::with_name("cfg")
                .required_unless_all(&["dbg", "infile"])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("dbg").long("debug"))
        .arg(Arg::with_name("infile").short('i').takes_value(true))
        .try_get_matches_from(vec!["unlessall", "--debug"]);

    assert!(res.is_err());
    assert_eq!(res.unwrap_err().kind, ErrorKind::MissingRequiredArgument);
}

// REQUIRED_UNLESS_ONE

#[test]
fn required_unless_one() {
    let res = App::new("unlessone")
        .arg(
            Arg::with_name("cfg")
                .required_unless_one(&["dbg", "infile"])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("dbg").long("debug"))
        .arg(Arg::with_name("infile").short('i').takes_value(true))
        .try_get_matches_from(vec!["unlessone", "--debug"]);

    assert!(res.is_ok());
    let m = res.unwrap();
    assert!(m.is_present("dbg"));
    assert!(!m.is_present("cfg"));
}

#[test]
fn required_unless_one_2() {
    // This tests that the required_unless_one works when the second arg in the array is used
    // instead of the first.
    let res = App::new("unlessone")
        .arg(
            Arg::with_name("cfg")
                .required_unless_one(&["dbg", "infile"])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("dbg").long("debug"))
        .arg(Arg::with_name("infile").short('i').takes_value(true))
        .try_get_matches_from(vec!["unlessone", "-i", "file"]);

    assert!(res.is_ok());
    let m = res.unwrap();
    assert!(m.is_present("infile"));
    assert!(!m.is_present("cfg"));
}

#[test]
fn required_unless_one_works_with_short() {
    // GitHub issue: https://github.com/kbknapp/clap-rs/issues/1135
    let res = App::new("unlessone")
        .arg(Arg::with_name("a").conflicts_with("b").short('a'))
        .arg(Arg::with_name("b").short('b'))
        .arg(
            Arg::with_name("x")
                .short('x')
                .required_unless_one(&["a", "b"]),
        )
        .try_get_matches_from(vec!["unlessone", "-a"]);

    assert!(res.is_ok());
}

#[test]
fn required_unless_one_works_with_short_err() {
    let res = App::new("unlessone")
        .arg(Arg::with_name("a").conflicts_with("b").short('a'))
        .arg(Arg::with_name("b").short('b'))
        .arg(
            Arg::with_name("x")
                .short('x')
                .required_unless_one(&["a", "b"]),
        )
        .try_get_matches_from(vec!["unlessone"]);

    assert!(!res.is_ok());
}

#[test]
fn required_unless_one_works_without() {
    let res = App::new("unlessone")
        .arg(Arg::with_name("a").conflicts_with("b").short('a'))
        .arg(Arg::with_name("b").short('b'))
        .arg(Arg::with_name("x").required_unless_one(&["a", "b"]))
        .try_get_matches_from(vec!["unlessone", "-a"]);

    assert!(res.is_ok());
}

#[test]
fn required_unless_one_works_with_long() {
    let res = App::new("unlessone")
        .arg(Arg::with_name("a").conflicts_with("b").short('a'))
        .arg(Arg::with_name("b").short('b'))
        .arg(
            Arg::with_name("x")
                .long("x_is_the_option")
                .required_unless_one(&["a", "b"]),
        )
        .try_get_matches_from(vec!["unlessone", "-a"]);

    assert!(res.is_ok());
}

#[test]
fn required_unless_one_1() {
    let res = App::new("unlessone")
        .arg(
            Arg::with_name("cfg")
                .required_unless_one(&["dbg", "infile"])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("dbg").long("debug"))
        .arg(Arg::with_name("infile").short('i').takes_value(true))
        .try_get_matches_from(vec!["unlessone", "--debug"]);

    assert!(res.is_ok());
    let m = res.unwrap();
    assert!(!m.is_present("infile"));
    assert!(!m.is_present("cfg"));
    assert!(m.is_present("dbg"));
}

#[test]
fn required_unless_one_err() {
    let res = App::new("unlessone")
        .arg(
            Arg::with_name("cfg")
                .required_unless_one(&["dbg", "infile"])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("dbg").long("debug"))
        .arg(Arg::with_name("infile").short('i').takes_value(true))
        .try_get_matches_from(vec!["unlessone"]);

    assert!(res.is_err());
    assert_eq!(res.unwrap_err().kind, ErrorKind::MissingRequiredArgument);
}

#[test]
fn missing_required_output() {
    assert!(utils::compare_output(
        utils::complex_app(),
        "clap-test -F",
        MISSING_REQ,
        true
    ));
}

// Conditional external requirements

#[test]
fn requires_if_present_val() {
    let res = App::new("unlessone")
        .arg(
            Arg::with_name("cfg")
                .requires_if("my.cfg", "extra")
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("extra").long("extra"))
        .try_get_matches_from(vec!["unlessone", "--config=my.cfg"]);

    assert!(res.is_err());
    assert_eq!(res.unwrap_err().kind, ErrorKind::MissingRequiredArgument);
}

#[test]
fn requires_if_present_mult() {
    let res = App::new("unlessone")
        .arg(
            Arg::with_name("cfg")
                .requires_ifs(&[("my.cfg", "extra"), ("other.cfg", "other")])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("extra").long("extra"))
        .arg(Arg::with_name("other").long("other"))
        .try_get_matches_from(vec!["unlessone", "--config=other.cfg"]);

    assert!(res.is_err());
    assert_eq!(res.unwrap_err().kind, ErrorKind::MissingRequiredArgument);
}

#[test]
fn requires_if_present_mult_pass() {
    let res = App::new("unlessone")
        .arg(
            Arg::with_name("cfg")
                .requires_ifs(&[("my.cfg", "extra"), ("other.cfg", "other")])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("extra").long("extra"))
        .arg(Arg::with_name("other").long("other"))
        .try_get_matches_from(vec!["unlessone", "--config=some.cfg"]);

    assert!(res.is_ok());
}

#[test]
fn requires_if_present_val_no_present_pass() {
    let res = App::new("unlessone")
        .arg(
            Arg::with_name("cfg")
                .requires_if("my.cfg", "extra")
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("extra").long("extra"))
        .try_get_matches_from(vec!["unlessone"]);

    assert!(res.is_ok());
}

// Conditionally required

#[test]
fn required_if_val_present_pass() {
    let res = App::new("ri")
        .arg(
            Arg::with_name("cfg")
                .required_if("extra", "val")
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("extra").takes_value(true).long("extra"))
        .try_get_matches_from(vec!["ri", "--extra", "val", "--config", "my.cfg"]);

    assert!(res.is_ok());
}

#[test]
fn required_if_val_present_fail() {
    let res = App::new("ri")
        .arg(
            Arg::with_name("cfg")
                .required_if("extra", "val")
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("extra").takes_value(true).long("extra"))
        .try_get_matches_from(vec!["ri", "--extra", "val"]);

    assert!(res.is_err());
    assert_eq!(res.unwrap_err().kind, ErrorKind::MissingRequiredArgument);
}

#[test]
fn required_if_val_present_fail_error_output() {
    let app = App::new("Test app")
        .version("1.0")
        .author("F0x06")
        .about("Arg test")
        .arg(
            Arg::with_name("target")
                .takes_value(true)
                .required(true)
                .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"),
        );

    assert!(utils::compare_output(
        app,
        "test --input somepath --target file",
        COND_REQ_IN_USAGE,
        true
    ));
}

#[test]
fn required_if_wrong_val() {
    let res = App::new("ri")
        .arg(
            Arg::with_name("cfg")
                .required_if("extra", "val")
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("extra").takes_value(true).long("extra"))
        .try_get_matches_from(vec!["ri", "--extra", "other"]);

    assert!(res.is_ok());
}

#[test]
fn required_ifs_val_present_pass() {
    let res = App::new("ri")
        .arg(
            Arg::with_name("cfg")
                .required_ifs(&[("extra", "val"), ("option", "spec")])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("option").takes_value(true).long("option"))
        .arg(Arg::with_name("extra").takes_value(true).long("extra"))
        .try_get_matches_from(vec!["ri", "--option", "spec", "--config", "my.cfg"]);

    assert!(res.is_ok());
}

#[test]
fn required_ifs_val_present_fail() {
    let res = App::new("ri")
        .arg(
            Arg::with_name("cfg")
                .required_ifs(&[("extra", "val"), ("option", "spec")])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("extra").takes_value(true).long("extra"))
        .arg(Arg::with_name("option").takes_value(true).long("option"))
        .try_get_matches_from(vec!["ri", "--option", "spec"]);

    assert!(res.is_err());
    assert_eq!(res.unwrap_err().kind, ErrorKind::MissingRequiredArgument);
}

#[test]
fn required_ifs_wrong_val() {
    let res = App::new("ri")
        .arg(
            Arg::with_name("cfg")
                .required_ifs(&[("extra", "val"), ("option", "spec")])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("extra").takes_value(true).long("extra"))
        .arg(Arg::with_name("option").takes_value(true).long("option"))
        .try_get_matches_from(vec!["ri", "--option", "other"]);

    assert!(res.is_ok());
}

#[test]
fn required_ifs_wrong_val_mult_fail() {
    let res = App::new("ri")
        .arg(
            Arg::with_name("cfg")
                .required_ifs(&[("extra", "val"), ("option", "spec")])
                .takes_value(true)
                .long("config"),
        )
        .arg(Arg::with_name("extra").takes_value(true).long("extra"))
        .arg(Arg::with_name("option").takes_value(true).long("option"))
        .try_get_matches_from(vec!["ri", "--extra", "other", "--option", "spec"]);

    assert!(res.is_err());
    assert_eq!(res.unwrap_err().kind, ErrorKind::MissingRequiredArgument);
}

#[test]
fn require_eq() {
    let app = App::new("clap-test").version("v1.4.8").arg(
        Arg::with_name("opt")
            .long("opt")
            .short('o')
            .required(true)
            .require_equals(true)
            .value_name("FILE")
            .help("some"),
    );
    assert!(utils::compare_output(
        app,
        "clap-test",
        REQUIRE_EQUALS,
        true
    ));
}

static ISSUE_1158: &str = "error: The following required arguments were not provided:
    -x <X>
    -y <Y>
    -z <Z>

USAGE:
    example <ID> -x <X> -y <Y> -z <Z>

For more information try --help";

fn issue_1158_app() -> App<'static> {
    App::new("example")
        .arg(
            Arg::from("-c, --config [FILE] 'Custom config file.'")
                .required_unless("ID")
                .conflicts_with("ID"),
        )
        .arg(
            Arg::from("[ID] 'ID'")
                .required_unless("config")
                .conflicts_with("config")
                .requires_all(&["x", "y", "z"]),
        )
        .arg(Arg::from("-x [X] 'X'"))
        .arg(Arg::from("-y [Y] 'Y'"))
        .arg(Arg::from("-z [Z] 'Z'"))
}

#[test]
fn issue_1158_conflicting_requirements() {
    let app = issue_1158_app();

    assert!(utils::compare_output(app, "example id", ISSUE_1158, true));
}

#[test]
fn issue_1158_conflicting_requirements_rev() {
    let res = issue_1158_app().try_get_matches_from(&["", "--config", "some.conf"]);

    assert!(res.is_ok());
}