provcfg 0.1.0

Configuration library that keeps track of the origin and history of all config values.
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

use super::fixtures::*;
use crate::*;

#[test]
fn build_with_no_sources_uses_defaults() {
    let config = Config::new();
    let db = config.build::<DatabaseConfigProv>().unwrap();

    assert_eq!(db.host.value(), "");
    assert_eq!(db.host.source().category(), Category::Default);
    assert_eq!(db.host.source().name(), "default");

    assert_eq!(db.port.value(), &0);
    assert_eq!(db.port.source().category(), Category::Default);
}

#[cfg(feature = "json")]
#[test]
fn unset_field_falls_back_to_default_category() {
    let host_only = r#"{ "host": "db.example" }"#;

    let config = Config::new().add_json_str("host.json", host_only);

    let db = config.build::<DatabaseConfigProv>().unwrap();

    assert_eq!(db.host.value(), "db.example");
    assert_eq!(db.host.source().category(), Category::File);

    assert_eq!(db.port.value(), &0);
    assert_eq!(db.port.source().category(), Category::Default);
}

#[cfg(feature = "json")]
#[test]
fn layered_sources_each_supply_subset_of_fields() {
    let host_only = r#"{ "host": "db.example" }"#;
    let port_only = r#"{ "port": 9000 }"#;

    let config = Config::new()
        .add_json_str("host.json", host_only)
        .add_json_str("port.json", port_only);

    let db = config.build::<DatabaseConfigProv>().unwrap();

    assert_eq!(db.host.value(), "db.example");
    assert_eq!(db.host.source().name(), "host.json");
    assert_eq!(db.port.value(), &9000);
    assert_eq!(db.port.source().name(), "port.json");
}

#[cfg(feature = "toml")]
#[test]
fn nested_struct_carries_provenance_per_leaf() {
    let toml = r#"
name = "my-app"
[database]
host = "db.example"
"#;

    let config = Config::new().add_toml_str("app.toml", toml);

    let app = config.build::<AppConfigProv>().unwrap();

    assert_eq!(app.name.value(), "my-app");
    assert_eq!(app.name.source().category(), Category::File);

    assert_eq!(app.database.host.value(), "db.example");
    assert_eq!(app.database.host.source().category(), Category::File);

    assert_eq!(app.database.port.value(), &0);
    assert_eq!(app.database.port.source().category(), Category::Default);
}

#[cfg(feature = "toml")]
#[test]
fn sources_map_flattens_provenance_to_dotted_paths() {
    let toml = r#"
name = "my-app"
[database]
host = "db.example"
"#;

    let config = Config::new().add_toml_str("k.toml", toml);
    let app = config.build::<AppConfigProv>().unwrap();

    let map = app.sources_map();
    assert_eq!(map.get("name"), Some(&Category::File));
    assert_eq!(map.get("database.host"), Some(&Category::File));
    assert_eq!(map.get("database.port"), Some(&Category::Default));
}

#[cfg(all(feature = "toml", feature = "env", feature = "cli"))]
#[test]
fn full_layered_stack_defaults_toml_env_cli() {
    let prefix = "PROVCFG_TEST_FULL_STACK";
    unsafe {
        std::env::set_var(format!("{prefix}_HOST"), "env.example");
    }

    let cli_partial = DatabaseConfigPartial {
        host: None,
        port: Some(3),
    };

    let config = Config::new()
        .add_toml_str("app.toml", "host = \"toml.example\"\nport = 1\n")
        .add_env(prefix)
        .add_cli(cli_partial);

    let db = config.build::<DatabaseConfigProv>().unwrap();

    assert_eq!(db.host.value(), "env.example");
    assert_eq!(db.host.source().category(), Category::Env);
    assert_eq!(db.port.value(), &3);
    assert_eq!(db.port.source().category(), Category::Cli);

    let map = db.sources_map();
    assert_eq!(map.get("host"), Some(&Category::Env));
    assert_eq!(map.get("port"), Some(&Category::Cli));

    unsafe {
        std::env::remove_var(format!("{prefix}_HOST"));
    }
}