argust 0.0.3

Simple to use commandline parser for rust programs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201

use argust::*;

use std::ffi::OsString;

fn compare(lhs: &Vec<String>, rhs: &Vec<String>) -> bool {
    println!("{:?} || {:?}", lhs, rhs);
    if lhs.len() != rhs.len() {
        return false;
    }
    for i in 0..lhs.len() {
        if lhs[i] != rhs[i] {
            return false;
        }
    }
    return true;
}

#[test]
fn basic_test() {
    let args: Vec<&str> = vec![
        "Command1",
        "-h",
        "-q",
        "--Option1",
        "--Option2=test",
        "Command2",
    ];
    let command_set = parse_args(args.iter(), None);
    let expected_output = vec![String::from("Command1"), String::from("Command2")];
    assert!(compare(&command_set.args, &expected_output));

    assert_eq!(command_set.short_params.len(), 2);
    assert_eq!(command_set.short_params["h"], None);
    assert_eq!(command_set.short_params["q"], None);

    assert_eq!(command_set.long_params.len(), 2);
    assert_eq!(command_set.long_params["Option1"], None);
    assert_eq!(command_set.long_params["Option2"], Some("test".to_string()));
}

#[test]
fn with_string_test() {
    let args: Vec<String> = vec![
        String::from("Command1"),
        String::from("-h"),
        String::from("-q"),
        String::from("--Option1"),
        String::from("--Option2=test"),
        String::from("Command2"),
    ];
    let args = args.iter();
    let command_set = parse_args(args, None);
    let expected_output = vec![String::from("Command1"), String::from("Command2")];
    assert!(compare(&command_set.args, &expected_output));

    assert_eq!(command_set.short_params.len(), 2);
    assert_eq!(command_set.short_params["h"], None);
    assert_eq!(command_set.short_params["q"], None);

    assert_eq!(command_set.long_params.len(), 2);
    assert_eq!(command_set.long_params["Option1"], None);
    assert_eq!(command_set.long_params["Option2"], Some("test".to_string()));
}

#[test]
fn with_os_string_test() {
    let args: Vec<OsString> = vec![
        OsString::from("Command1"),
        OsString::from("-h"),
        OsString::from("-q"),
        OsString::from("--Option1"),
        OsString::from("--Option2=test"),
        OsString::from("Command2"),
    ];
    let command_set = parse_args(args.iter(), None);
    let expected_output = vec![String::from("Command1"), String::from("Command2")];
    assert!(compare(&command_set.args, &expected_output));

    assert_eq!(command_set.short_params.len(), 2);
    assert_eq!(command_set.short_params["h"], None);
    assert_eq!(command_set.short_params["q"], None);

    assert_eq!(command_set.long_params.len(), 2);
    assert_eq!(command_set.long_params["Option1"], None);
    assert_eq!(command_set.long_params["Option2"], Some("test".to_string()));
}

#[test]
fn parametrized_test() {
    let args: Vec<&str> = vec![
        "Command1",
        "-h",
        "param1",
        "-q",
        "--Option1",
        "--Option2",
        "Command2",
    ];
    let mut parse_config = ParserConfig::new();
    parse_config.parse_tokens = ParseTokens {
        long_token: String::from("--"),
        option_key: String::from(" "),
        short_token: String::from("-"),
    };
    let command_set = parse_args(args.iter(), Some(parse_config.clone()));
    let expected_output = vec![
        String::from("Command1"),
        String::from("param1"),
        String::from("Command2"),
    ];
    assert!(compare(&command_set.args, &expected_output));

    assert_eq!(command_set.short_params.len(), 2);
    assert_eq!(command_set.short_params["h"], None);
    assert_eq!(command_set.short_params["q"], None);

    assert_eq!(command_set.long_params.len(), 2);
    assert_eq!(command_set.long_params["Option1"], None);
    assert_eq!(command_set.long_params["Option2"], None);

    parse_config
        .parameterized_long_params
        .insert(String::from("Option2"));

    let command_set = parse_args(args.iter(), Some(parse_config.clone()));
    assert_eq!(command_set.short_params.len(), 2);
    assert_eq!(command_set.short_params["h"], None);
    assert_eq!(command_set.short_params["q"], None);

    assert_eq!(command_set.long_params.len(), 2);
    assert_eq!(command_set.long_params["Option1"], None);
    assert_eq!(
        command_set.long_params["Option2"],
        Some(String::from("Command2"))
    );

    parse_config
        .parameterized_short_params
        .insert(String::from("q"));

    let command_set = parse_args(args.iter(), Some(parse_config.clone()));

    assert_eq!(command_set.short_params.len(), 2);
    assert_eq!(command_set.short_params["h"], None);
    assert_eq!(
        command_set.short_params["q"],
        Some(String::from("--Option1"))
    );

    assert_eq!(command_set.long_params.len(), 1);
    assert_eq!(
        command_set.long_params["Option2"],
        Some(String::from("Command2"))
    );
}

#[test]
#[should_panic(expected = "Unexpected input - \"-test\"")]
fn invalid_input_short() {
    let args: Vec<&str> = vec!["Command1", "-test"];
    parse_args(args.iter(), None);
}

#[test]
fn valid_input_short() {
    let args: Vec<&str> = vec!["Command1", "-test"];
    let mut parse_config = ParserConfig::new();
    parse_config
        .parameterized_short_params
        .insert(String::from("t"));
    parse_args(args.iter(), Some(parse_config));
}

#[test]
fn valid_input() {
    //Undefined behaviour but should harmless i.e no panic, no incorrect entires only ignorable extra garbagw"
    let args: Vec<&str> = vec!["Command1", "-", "--"];
    let command_set = parse_args(args.iter(), None);
    let expected_output = vec![String::from("Command1"), String::from("-")];
    assert!(compare(&command_set.args, &expected_output));
    assert_eq!(command_set.short_params["-"], None);
}

#[test]
fn add_params() {
    let args: Vec<&str> = vec!["-tblah", "-sblah"];
    let mut parse_config = ParserConfig::new();
    parse_config.add_parameter('t', "test");
    parse_config.add_parameter('s', "short");
    let context = parse_args(args.iter(), Some(parse_config.clone()));
    assert!(parse_config.parameterized_long_params.contains("test"));
    assert!(parse_config.parameterized_long_params.contains("short"));
    assert!(parse_config.parameterized_short_params.contains("s"));
    assert!(parse_config.parameterized_short_params.contains("t"));
    assert!(context.contains(Some('t'), Some("test")).0);
    assert!(context.contains(Some('s'), Some("short")).0);
    assert!(context.contains_short('t').0);
    assert!(context.contains_short('s').0);
    assert!(context.contains_long("short").0 == false);
    assert!(context.contains_long("test").0 == false);
}