tier 0.1.14

Rust configuration library for layered TOML, env, and CLI settings
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

#![cfg(feature = "clap")]

use clap::Parser;
#[cfg(feature = "schema")]
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

use tier::{
    ConfigLoader, ConfigMetadata, FieldMetadata, Secret, TierCli, TierCliCommand, TierMetadata,
};

#[derive(Debug, Parser)]
struct AppCli {
    #[command(flatten)]
    config: TierCli,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(JsonSchema))]
struct CliConfig {
    server: CliServer,
    db: CliDb,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(JsonSchema))]
struct CliServer {
    host: String,
    port: u16,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(JsonSchema))]
struct CliDb {
    password: Secret<String>,
}

impl TierMetadata for CliConfig {
    fn metadata() -> ConfigMetadata {
        ConfigMetadata::from_fields([
            FieldMetadata::new("server.host")
                .env("APP_SERVER_HOSTNAME")
                .doc("Address exposed by the CLI application"),
            FieldMetadata::new("db.password").secret(),
        ])
    }
}

impl Default for CliConfig {
    fn default() -> Self {
        Self {
            server: CliServer {
                host: "127.0.0.1".to_owned(),
                port: 3000,
            },
            db: CliDb {
                password: Secret::new("clap-secret".to_owned()),
            },
        }
    }
}

#[test]
fn clap_cli_parses_and_applies_loader_overrides() {
    let cli = AppCli::parse_from([
        "tier-app",
        "--profile",
        "prod",
        "--set",
        "server.port=9001",
        "--set",
        "server.host=\"0.0.0.0\"",
        "--print-config",
    ]);

    assert_eq!(cli.config.command(), TierCliCommand::PrintConfig);

    let loaded = cli
        .config
        .apply(ConfigLoader::new(CliConfig::default()).secret_path("db.password"))
        .load()
        .expect("config loads");

    assert_eq!(loaded.server.port, 9001);
    assert_eq!(loaded.server.host, "0.0.0.0");

    let output = cli
        .config
        .render(&loaded)
        .expect("render succeeds")
        .expect("print output");
    assert!(output.contains("***redacted***"));
    assert!(!output.contains("clap-secret"));
}

#[test]
fn clap_cli_can_render_explain_output() {
    let cli = AppCli::parse_from(["tier-app", "--explain-config", "server.port"]);
    assert_eq!(
        cli.config.command(),
        TierCliCommand::ExplainConfig {
            path: "server.port".to_owned()
        }
    );

    let loaded = cli
        .config
        .apply(ConfigLoader::new(CliConfig::default()).secret_path("db.password"))
        .load()
        .expect("config loads");

    let output = cli
        .config
        .render(&loaded)
        .expect("render succeeds")
        .expect("explain output");
    assert!(output.contains("server.port = 3000"));
}

#[cfg(feature = "schema")]
#[test]
fn clap_cli_can_render_schema_and_env_docs() {
    let schema_cli = AppCli::parse_from(["tier-app", "--print-config-schema"]);
    assert_eq!(
        schema_cli.config.command(),
        TierCliCommand::PrintConfigSchema
    );

    let env_cli = AppCli::parse_from(["tier-app", "--print-env-docs", "--env-prefix", "APP"]);
    assert_eq!(env_cli.config.command(), TierCliCommand::PrintEnvDocs);

    let example_cli = AppCli::parse_from(["tier-app", "--print-config-example"]);
    assert_eq!(
        example_cli.config.command(),
        TierCliCommand::PrintConfigExample
    );

    let loaded = ConfigLoader::new(CliConfig::default())
        .secret_path("db.password")
        .load()
        .expect("config loads");

    let schema_output = schema_cli
        .config
        .render_with_schema(&loaded)
        .expect("schema render succeeds")
        .expect("schema output");
    assert!(schema_output.contains("\"type\": \"object\""));
    assert!(schema_output.contains("\"x-tier-env\""));

    let env_output = env_cli
        .config
        .render_with_schema(&loaded)
        .expect("env doc render succeeds")
        .expect("env docs");
    assert!(env_output.contains("APP_SERVER_HOSTNAME"));
    assert!(env_output.contains("APP__DB__PASSWORD"));

    let example_output = example_cli
        .config
        .render_with_schema(&loaded)
        .expect("example render succeeds")
        .expect("example config");
    #[cfg(feature = "toml")]
    assert!(example_output.contains("[server]"));
    #[cfg(not(feature = "toml"))]
    assert!(example_output.contains("\"server\""));
    assert!(example_output.contains("<secret>"));
}