tryphon 0.2.0

Type-safe configuration loading from environment variables using derive macros
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

use std::env;
use tryphon::{Config, Secret};

mod common;
use common::TEST_MUTEX;

#[derive(Debug, Config)]
struct DbConfig {
    #[env("DB_HOST")]
    #[default("localhost")]
    host: String,

    #[env("DB_PASSWORD")]
    password: Secret<String>,

    #[env("DB_PORT")]
    #[default(5432)]
    port: u16,

    #[env("DB_NAME")]
    database: String,
}

#[derive(Debug, Config)]
struct AppConfig {
    #[env("APP_NAME")]
    #[default("test-app")]
    name: String,

    #[env("APP_PORT")]
    #[env("PORT")]
    #[default(8080)]
    port: u16,

    #[env("DEBUG_MODE")]
    #[default(false)]
    debug: bool,

    #[env("LOG_LEVEL")]
    log_level: Option<String>,

    #[config]
    database: DbConfig,
}

fn clear_test_env_vars() {
    unsafe {
        clear_test_env_vars!(
            "DB_HOST",
            "DB_PASSWORD",
            "DB_PORT",
            "DB_NAME",
            "APP_NAME",
            "APP_PORT",
            "PORT",
            "DEBUG_MODE",
            "LOG_LEVEL"
        );
    }
}

#[test]
fn test_successful_loading_with_all_values() {
    let _unused = TEST_MUTEX.lock().unwrap();

    clear_test_env_vars();

    unsafe {
        env::set_var("DB_PASSWORD", "secret123");
        env::set_var("DB_NAME", "test_db");
        env::set_var("APP_PORT", "3000");
        env::set_var("DEBUG_MODE", "true");
        env::set_var("LOG_LEVEL", "info");
    }

    let config = AppConfig::load().expect("Failed to load config");

    assert_eq!(config.name, "test-app"); // default value
    assert_eq!(config.port, 3000);
    assert!(config.debug);
    assert_eq!(config.log_level, Some("info".to_string()));
    assert_eq!(config.database.host, "localhost"); // default value
    assert_eq!(*config.database.password, "secret123");
    assert_eq!(config.database.port, 5432); // default value
    assert_eq!(config.database.database, "test_db");

    clear_test_env_vars();
}

#[test]
fn test_loading_with_custom_values_overriding_defaults() {
    let _unused = TEST_MUTEX.lock().unwrap();

    clear_test_env_vars();

    unsafe {
        env::set_var("APP_NAME", "custom-app");
        env::set_var("DB_HOST", "db.example.com");
        env::set_var("DB_PASSWORD", "pass456");
        env::set_var("DB_PORT", "3306");
        env::set_var("DB_NAME", "production_db");
    }

    let config = AppConfig::load().expect("Failed to load config");

    assert_eq!(config.name, "custom-app");
    assert_eq!(config.database.host, "db.example.com");
    assert_eq!(*config.database.password, "pass456");
    assert_eq!(config.database.port, 3306);
    assert_eq!(config.database.database, "production_db");

    clear_test_env_vars();
}

#[test]
fn test_default_values_used_when_no_env_set() {
    let _unused = TEST_MUTEX.lock().unwrap();

    clear_test_env_vars();

    unsafe {
        env::set_var("DB_PASSWORD", "pass");
        env::set_var("DB_NAME", "db");
    }
    // APP_NAME, APP_PORT, DEBUG_MODE, DB_HOST, DB_PORT all have defaults

    let config = AppConfig::load().expect("Failed to load config");

    assert_eq!(config.name, "test-app");
    assert_eq!(config.port, 8080);
    assert!(!config.debug);
    assert_eq!(config.database.host, "localhost");
    assert_eq!(config.database.port, 5432);

    clear_test_env_vars();
}