cliconf 0.3.0

Dead-simple configuration for Rust CLI tools
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

use cliconf::Parse;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Parse, Default, Serialize, Deserialize)]
#[serde(default)]
struct Conf {
    #[cliconf(shorthand = 'b')]
    my_bool: bool,

    #[cliconf(shorthand = 's')]
    my_string: String,

    my_num: i32,

    #[cliconf(delimiter = ",", shorthand = 'v')]
    my_string_vec: Vec<String>,
}

fn assertions(c: &Conf) {
    assert_eq!(c.my_bool, true);
    assert_eq!(c.my_string, "1");
    assert_eq!(c.my_num, 1);
    assert_eq!(c.my_string_vec, ["1", "2"]);
}

#[test]
fn test_env() {
    let mut c = Conf::default();

    let mut vars: HashMap<&str, &str> = HashMap::new();
    vars.insert("MY_BOOL", "true");
    vars.insert("MY_STRING", "1");
    vars.insert("MY_NUM", "1");
    vars.insert("MY_STRING_VEC", "1,2");
    let vars: HashMap<String, String> = vars
        .iter()
        .map(|(key, val)| (key.to_string(), val.to_string()))
        .collect();

    c.parse_env(vars);

    assertions(&c);
}

#[test]
fn test_args() {
    let mut c = Conf::default();

    let args: Vec<String> = vec![
        "--my-bool",
        "--my-string",
        "1",
        "--my-num",
        "1",
        "--my-string-vec",
        "1",
        "--my-string-vec",
        "2",
    ]
    .iter()
    .map(|s| s.to_string())
    .collect();

    c.parse_args(args);

    assertions(&c);
}

#[test]
fn test_args_shorthand() {
    let mut c = Conf::default();

    let args: Vec<String> = vec!["-b", "-s", "1", "--my-num", "1", "-v", "1", "-v", "2"]
        .iter()
        .map(|s| s.to_string())
        .collect();

    c.parse_args(args);

    assertions(&c);
}

#[test]
fn test_json() {
    let data = r#"
        {
            "my_bool": true,
            "my_string": "1",
            "my_num": 1,
            "my_string_vec": ["1", "2"]
        }
    "#;

    let c: Conf = serde_json::from_str(data).unwrap();

    assertions(&c);
}