envigil 0.3.0

Keep vigil over your environment — load, parse, and validate env vars with zero dependencies.
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
//! Loading environment variables into a typed container.
//!
//! [`EnvSource`] declares variables via [`VarBuilder`], reads from
//! an ordered list of [`Layer`](crate::layer::Layer)s, and produces
//! an [`Env`] — a typed, immutable map.
//!
//! # Examples
//!
//! ```rust,no_run
//! use envigil::{EnvSource, VarBuilder};
//! use envigil::layer;
//!
//! # fn main() -> Result<(), envigil::Error> {
//! let cfg = EnvSource::new()
//!     .prefix("APP_")
//!     .layer(layer::env())
//!     .declare(VarBuilder::new("PORT", |v| v.parse::<u16>().map_err(|e| e.to_string()))
//!         .default(8080))
//!     .declare(VarBuilder::new("NAME", |v| Ok(v.to_owned()))
//!         .required())
//!     .load()?;
//!
//! let port: &u16 = cfg.get("PORT")?;
//! let name: &String = cfg.get("NAME")?;
//! # Ok(())
//! # }
//! ```

use std::any::Any;
use std::collections::HashMap;
use std::fmt;

use crate::error::Error;
use crate::secret::Secret;
use crate::var::VarBuilder;

trait DynVar {
    fn name(&self) -> &str;
    fn resolve_raw(&self, raw: Option<&str>) -> Result<Option<Box<dyn Any>>, Error>;
}

impl<T: Clone + 'static> DynVar for VarBuilder<T> {
    fn name(&self) -> &str {
        self.name()
    }

    fn resolve_raw(&self, raw: Option<&str>) -> Result<Option<Box<dyn Any>>, Error> {
        let resolved = self.resolve(raw)?;

        match resolved {
            Some(v) if self.is_secret() => Ok(Some(Box::new(Secret::new(v)) as Box<dyn Any>)),
            Some(v) => Ok(Some(Box::new(v) as Box<dyn Any>)),
            None => Ok(None),
        }
    }
}

/// Builder that declares environment variables and loads them from
/// an ordered list of [`Layer`](crate::layer::Layer)s.
///
/// Layers are queried in the order they are added via
/// [`.layer()`](Self::layer). The first layer returning `Some(value)`
/// wins. When no layers are configured, [`load()`](Self::load) reads
/// from `std::env` automatically for backward compatibility.
///
/// # Examples
///
/// ```rust,no_run
/// use envigil::{EnvSource, VarBuilder};
/// use envigil::layer;
///
/// # fn main() -> Result<(), envigil::Error> {
/// let cfg = EnvSource::new()
///     .prefix("APP_")
///     .layer(layer::env())
///     .layer(layer::map([("PORT", "9090")]))
///     .declare(VarBuilder::new("PORT", |v| v.parse::<u16>().map_err(|e| e.to_string()))
///         .default(8080))
///     .load()?;
/// # Ok(())
/// # }
/// ```
pub struct EnvSource {
    prefix: String,
    vars: Vec<Box<dyn DynVar>>,
    layers: Vec<Box<dyn crate::layer::Layer>>,
}

impl EnvSource {
    /// Create an empty source with no prefix and no layers.
    pub fn new() -> Self {
        Self {
            prefix: String::new(),
            vars: Vec::new(),
            layers: Vec::new(),
        }
    }

    /// Set a prefix prepended to every variable name.
    ///
    /// ```rust,no_run
    /// use envigil::{EnvSource, VarBuilder};
    ///
    /// # fn main() -> Result<(), envigil::Error> {
    /// let cfg = EnvSource::new()
    ///     .prefix("APP_")
    ///     .declare(VarBuilder::new("PORT", |v| v.parse::<u16>().map_err(|e| e.to_string()))
    ///         .default(8080))
    ///     .load()?;
    /// // reads APP_PORT from the environment
    /// # Ok(())
    /// # }
    /// ```
    pub fn prefix(mut self, prefix: impl Into<String>) -> Self {
        self.prefix = prefix.into();
        self
    }

    /// Add a configuration layer.
    ///
    /// Layers are queried in the order they are added. The first
    /// layer returning `Some(value)` wins.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use envigil::{EnvSource, VarBuilder};
    /// use envigil::layer;
    ///
    /// # fn main() -> Result<(), envigil::Error> {
    /// let cfg = EnvSource::new()
    ///     .layer(layer::env())
    ///     .layer(layer::map([("PORT", "9090")]))
    ///     .declare(VarBuilder::new("PORT", |v| v.parse::<u16>().map_err(|e| e.to_string())))
    ///     .load()?;
    /// # Ok(())
    /// # }
    /// ```
    pub fn layer(mut self, layer: impl crate::layer::Layer + 'static) -> Self {
        self.layers.push(Box::new(layer));
        self
    }

    /// Register a variable declaration.
    pub fn declare<T: Clone + 'static>(mut self, var: VarBuilder<T>) -> Self {
        let var = var.prefixed(&self.prefix);
        self.vars.push(Box::new(var));
        self
    }

    /// Load entries from the `.env` file in the current working directory.
    ///
    /// Convenience wrapper around [`.layer(layer::dotenv())`](Self::layer).
    /// Missing files are silently ignored.
    #[cfg(feature = "dotenv")]
    pub fn dotenv(self) -> Self {
        self.layer(crate::layer::dotenv())
    }

    /// Load entries from a specific `.env` file path.
    ///
    /// Convenience wrapper around
    /// [`.layer(layer::dotenv_path(...))`](Self::layer). Missing or
    /// unreadable files are silently ignored.
    #[cfg(feature = "dotenv")]
    pub fn dotenv_path(self, path: impl AsRef<std::path::Path>) -> Self {
        self.layer(crate::layer::dotenv_path(path))
    }

    /// Create a source backed by an in-memory map.
    ///
    /// Adds [`layer::env()`](crate::layer::env) followed by
    /// [`layer::map(...)`](crate::layer::map), so real environment
    /// variables take precedence over map entries.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use envigil::{EnvSource, VarBuilder};
    ///
    /// # fn main() -> Result<(), envigil::Error> {
    /// let cfg = EnvSource::from_map([
    ///     ("PORT", "9090"),
    /// ])
    /// .declare(VarBuilder::new("PORT", |v| v.parse::<u16>().map_err(|e| e.to_string())))
    /// .load()?;
    ///
    /// assert_eq!(*cfg.get::<u16>("PORT")?, 9090);
    /// # Ok(())
    /// # }
    /// ```
    pub fn from_map(
        iter: impl IntoIterator<Item = (impl Into<String>, impl Into<String>)>,
    ) -> Self {
        Self::new()
            .layer(crate::layer::env())
            .layer(crate::layer::map(iter))
    }

    /// Read the environment and resolve every declared variable.
    ///
    /// Resolution order:
    /// 1. Layers in order added via [`.layer()`](Self::layer)
    /// 2. `std::env` (implicit fallback when no layers are configured)
    /// 3. Variable default / required / optional
    ///
    /// All errors are collected and returned together via
    /// [`Error::multiple`].
    pub fn load(self) -> Result<Env, Error> {
        let mut values: HashMap<String, Box<dyn Any>> = HashMap::new();
        let mut errors: Vec<Error> = Vec::new();

        for var in &self.vars {
            let raw = if !self.layers.is_empty() {
                self.lookup_in_layers(var.name())
            } else {
                std::env::var(var.name()).ok()
            };

            match var.resolve_raw(raw.as_deref()) {
                Ok(Some(v)) => {
                    values.insert(var.name().to_owned(), v);
                }
                Ok(None) => {}
                Err(e) => {
                    errors.push(e);
                }
            }
        }

        if errors.is_empty() {
            Ok(Env { values })
        } else if errors.len() == 1 {
            Err(errors.into_iter().next().expect("len == 1"))
        } else {
            Err(Error::multiple(errors))
        }
    }

    fn lookup_in_layers(&self, name: &str) -> Option<String> {
        for layer in &self.layers {
            if let Some(value) = layer.lookup(name) {
                return Some(value);
            }
        }
        None
    }
}

impl Default for EnvSource {
    fn default() -> Self {
        Self::new()
    }
}

/// An immutable, typed map of loaded environment variables.
pub struct Env {
    values: HashMap<String, Box<dyn Any>>,
}

impl Env {
    /// Retrieve a variable by name.
    ///
    /// The type parameter must match the parser's output type.
    /// Secret variables are stored as [`Secret<T>`].
    ///
    /// # Errors
    ///
    /// Returns [`Error::not_found`] if the name was not declared or
    /// the type does not match.
    pub fn get<T: 'static>(&self, name: &str) -> Result<&T, Error> {
        let value = self
            .values
            .get(name)
            .ok_or_else(|| Error::not_found(name))?;

        value
            .downcast_ref::<T>()
            .ok_or_else(|| Error::not_found(name))
    }

    /// Check whether a variable was loaded.
    pub fn contains(&self, name: &str) -> bool {
        self.values.contains_key(name)
    }
}

impl fmt::Debug for Env {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let keys: Vec<&String> = self.values.keys().collect();
        f.debug_struct("Env").field("keys", &keys).finish()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::validate;

    // Unique names to avoid collisions in parallel tests.

    #[test]
    fn loads_value_from_env() {
        unsafe {
            std::env::set_var("EVIGIL_T1_PORT", "9090");
        }

        let cfg = EnvSource::new()
            .declare(VarBuilder::new("EVIGIL_T1_PORT", |v| {
                v.parse::<u16>().map_err(|e| e.to_string())
            }))
            .load()
            .unwrap();

        assert_eq!(*cfg.get::<u16>("EVIGIL_T1_PORT").unwrap(), 9090);

        unsafe {
            std::env::remove_var("EVIGIL_T1_PORT");
        }
    }

    #[test]
    fn applies_prefix() {
        unsafe {
            std::env::set_var("MYAPP_PORT", "7070");
        }

        let cfg = EnvSource::new()
            .prefix("MYAPP_")
            .declare(VarBuilder::new("PORT", |v| {
                v.parse::<u16>().map_err(|e| e.to_string())
            }))
            .load()
            .unwrap();

        assert_eq!(*cfg.get::<u16>("MYAPP_PORT").unwrap(), 7070);

        unsafe {
            std::env::remove_var("MYAPP_PORT");
        }
    }

    #[test]
    fn default_when_absent() {
        let cfg = EnvSource::new()
            .declare(
                VarBuilder::new("EVIGIL_T3_MISSING", |v| {
                    v.parse::<u16>().map_err(|e| e.to_string())
                })
                .default(3000),
            )
            .load()
            .unwrap();

        assert_eq!(*cfg.get::<u16>("EVIGIL_T3_MISSING").unwrap(), 3000);
    }

    #[test]
    fn optional_absent_is_not_in_env() {
        let cfg = EnvSource::new()
            .declare(VarBuilder::new("EVIGIL_T4_NOPE", |v| Ok(v.to_owned())))
            .load()
            .unwrap();

        assert!(!cfg.contains("EVIGIL_T4_NOPE"));
        assert!(cfg.get::<String>("EVIGIL_T4_NOPE").is_err());
    }

    #[test]
    fn required_missing_is_error() {
        let err = EnvSource::new()
            .declare(VarBuilder::new("EVIGIL_T5_REQUIRED", |v| Ok(v.to_owned())).required())
            .load()
            .unwrap_err();

        let msg = err.to_string();
        assert!(msg.contains("EVIGIL_T5_REQUIRED"), "message: {msg}");
    }

    #[test]
    fn multiple_errors_collected() {
        let err = EnvSource::new()
            .declare(VarBuilder::new("EVIGIL_T6_A", |v| Ok(v.to_owned())).required())
            .declare(VarBuilder::new("EVIGIL_T6_B", |v| Ok(v.to_owned())).required())
            .load()
            .unwrap_err();

        let msg = err.to_string();
        assert!(msg.contains("2 errors"), "message: {msg}");
        assert!(msg.contains("EVIGIL_T6_A"), "message: {msg}");
        assert!(msg.contains("EVIGIL_T6_B"), "message: {msg}");
    }

    #[test]
    fn contains_returns_true_for_loaded() {
        let cfg = EnvSource::new()
            .declare(VarBuilder::new("EVIGIL_T9_X", |v| Ok(v.to_owned())).default("yes".to_owned()))
            .load()
            .unwrap();

        assert!(cfg.contains("EVIGIL_T9_X"));
        assert!(!cfg.contains("EVIGIL_T9_Y"));
    }

    #[test]
    fn from_map_loads_value() {
        let cfg = EnvSource::from_map([("EVIGIL_FM1_PORT", "9090")])
            .declare(VarBuilder::new("EVIGIL_FM1_PORT", |v| {
                v.parse::<u16>().map_err(|e| e.to_string())
            }))
            .load()
            .unwrap();
        assert_eq!(*cfg.get::<u16>("EVIGIL_FM1_PORT").unwrap(), 9090);
    }

    #[test]
    fn from_map_with_prefix() {
        let cfg = EnvSource::from_map([("MYAPP_PORT", "7070")])
            .prefix("MYAPP_")
            .declare(VarBuilder::new("PORT", |v| {
                v.parse::<u16>().map_err(|e| e.to_string())
            }))
            .load()
            .unwrap();
        assert_eq!(*cfg.get::<u16>("MYAPP_PORT").unwrap(), 7070);
    }

    #[test]
    fn from_map_env_wins_over_map() {
        unsafe {
            std::env::set_var("EVIGIL_FM3_PORT", "1111");
        }
        let cfg = EnvSource::from_map([("EVIGIL_FM3_PORT", "9090")])
            .declare(VarBuilder::new("EVIGIL_FM3_PORT", |v| {
                v.parse::<u16>().map_err(|e| e.to_string())
            }))
            .load()
            .unwrap();
        // Real env wins over map.
        assert_eq!(*cfg.get::<u16>("EVIGIL_FM3_PORT").unwrap(), 1111);
        unsafe {
            std::env::remove_var("EVIGIL_FM3_PORT");
        }
    }

    #[test]
    fn from_map_wins_over_default() {
        let cfg = EnvSource::from_map([("EVIGIL_FM4_PORT", "9090")])
            .declare(
                VarBuilder::new("EVIGIL_FM4_PORT", |v| {
                    v.parse::<u16>().map_err(|e| e.to_string())
                })
                .default(3000),
            )
            .load()
            .unwrap();
        // Map wins over default.
        assert_eq!(*cfg.get::<u16>("EVIGIL_FM4_PORT").unwrap(), 9090);
    }

    #[test]
    fn from_map_multiple_vars() {
        let cfg = EnvSource::from_map([("EVIGIL_FM5_A", "1"), ("EVIGIL_FM5_B", "two")])
            .declare(VarBuilder::new("EVIGIL_FM5_A", |v| {
                v.parse::<u32>().map_err(|e| e.to_string())
            }))
            .declare(VarBuilder::new("EVIGIL_FM5_B", |v| Ok(v.to_owned())))
            .load()
            .unwrap();

        assert_eq!(*cfg.get::<u32>("EVIGIL_FM5_A").unwrap(), 1);
        assert_eq!(cfg.get::<String>("EVIGIL_FM5_B").unwrap(), "two");
    }

    #[test]
    fn from_map_secret() {
        let cfg = EnvSource::from_map([("EVIGIL_FM6_TOKEN", "hunter2")])
            .declare(VarBuilder::new("EVIGIL_FM6_TOKEN", |v| Ok(v.to_owned())).secret())
            .load()
            .unwrap();

        let token = cfg.get::<Secret<String>>("EVIGIL_FM6_TOKEN").unwrap();
        assert_eq!(token.expose(), "hunter2");
        assert_eq!(format!("{token:?}"), "Secret([REDACTED])");
        // Plain String must NOT work:
        assert!(cfg.get::<String>("EVIGIL_FM6_TOKEN").is_err());
    }

    #[test]
    fn from_map_validation() {
        let err = EnvSource::from_map([("EVIGIL_FM7_PORT", "0")])
            .declare(
                VarBuilder::new("EVIGIL_FM7_PORT", |v| {
                    v.parse::<u16>().map_err(|e| e.to_string())
                })
                .validate(validate::range(1..=65535)),
            )
            .load()
            .unwrap_err();

        let msg = err.to_string();
        assert!(msg.contains("out of range"), "message: {msg}");
    }

    #[test]
    fn from_map_required_missing() {
        let err = EnvSource::from_map([("EVIGIL_FM8_OTHER", "x")])
            .declare(VarBuilder::new("EVIGIL_FM8_REQUIRED", |v| Ok(v.to_owned())).required())
            .load()
            .unwrap_err();

        let msg = err.to_string();
        assert!(msg.contains("EVIGIL_FM8_REQUIRED"), "message: {msg}");
    }
}