apollo-configuration 0.4.0

A typed, friendly configuration system for Apollo products.
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

use apollo_configuration::configuration;
use apollo_configuration::parse_yaml;

#[test]
fn simple_struct() {
    #[configuration]
    #[derive(PartialEq, Eq)]
    struct Config {
        name: String,
        #[config(default = 10)]
        value: i32,
    }

    let default = Config::default();
    assert_eq!(default.name, "");
    assert_eq!(default.value, 10);

    let config: Config =
        parse_yaml(r#"{ name: "test", value: 42 }"#, &Default::default()).expect("should parse");
    assert_eq!(config.name, "test");
    assert_eq!(config.value, 42);
}

#[test]
fn struct_with_cfg_gated_fields() {
    #[configuration]
    #[derive(PartialEq, Eq)]
    struct Config {
        name: String,
        // cfg(test) is always true during tests
        #[cfg(test)]
        #[config(default = 42)]
        enabled_field: i32,
        // cfg(not(test)) is always false during tests
        #[cfg(not(test))]
        #[config(default = 99)]
        disabled_field: i32,
    }

    // Default includes enabled field, excludes disabled field
    let default = Config::default();
    assert_eq!(default.name, "");
    assert_eq!(default.enabled_field, 42);

    // Parsing works with enabled field
    let config: Config = parse_yaml(
        r#"{ name: "test", enabled_field: 100 }"#,
        &Default::default(),
    )
    .expect("should parse");
    assert_eq!(config.name, "test");
    assert_eq!(config.enabled_field, 100);

    // Providing the disabled field should fail (unknown field)
    let result: Result<Config, _> = parse_yaml(
        r#"{ name: "test", disabled_field: 100 }"#,
        &Default::default(),
    );
    assert!(result.is_err(), "cfg-disabled field should not be accepted");
}