ortho_config 0.9.0

A configuration management library for Rust, inspired by esbuild.
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

//! Shared fixtures for discovery integration tests.

use std::io::Write as _;

use anyhow::{Context, Result, anyhow};
use camino::{Utf8Path, Utf8PathBuf};
use cap_std::{ambient_authority, fs_utf8::Dir as Utf8Dir};
use rstest::fixture;
use tempfile::TempDir;
use test_helpers::env::{self as test_env, EnvScope};

use super::super::ConfigDiscovery;

fn remove_common_env_vars(env_lock: &test_env::EnvVarLock) -> Vec<test_env::EnvVarGuard> {
    let mut guards = Vec::new();
    for key in [
        "HELLO_WORLD_CONFIG_PATH",
        "XDG_CONFIG_HOME",
        "XDG_CONFIG_DIRS",
        "APPDATA",
        "LOCALAPPDATA",
        "HOME",
        "USERPROFILE",
    ] {
        guards.push(env_lock.remove_var(key));
    }
    guards
}

#[fixture]
pub(super) fn env_guards() -> EnvScope {
    test_env::EnvScope::new_with(remove_common_env_vars)
}

#[fixture]
pub(super) fn env_override_discovery() -> Result<(
    ConfigDiscovery,
    Utf8PathBuf,
    EnvScope,
    test_env::EnvVarGuard,
)> {
    let scope = test_env::EnvScope::new_with(remove_common_env_vars);
    let temp_dir = std::env::temp_dir();
    let utf8_temp_dir = Utf8PathBuf::from_path_buf(temp_dir)
        .map_err(|path| anyhow!("temporary directory path is not valid UTF-8: {path:?}"))?;
    let path = utf8_temp_dir.join("explicit.toml");
    let env_guard = test_env::set_var("HELLO_WORLD_CONFIG_PATH", path.as_std_path());
    let discovery = ConfigDiscovery::builder("hello_world")
        .env_var("HELLO_WORLD_CONFIG_PATH")
        .build();

    Ok((discovery, path, scope, env_guard))
}

#[fixture]
pub(super) fn config_temp_dir() -> Result<TempDir> {
    TempDir::new().context("create config directory")
}

#[fixture]
pub(super) fn sample_config_file() -> Result<(TempDir, Utf8PathBuf)> {
    let temp_dir = config_temp_dir()?;
    let utf8_temp_dir = Utf8Path::from_path(temp_dir.path()).ok_or_else(|| {
        anyhow!(
            "temporary directory path is not valid UTF-8: {:?}",
            temp_dir.path()
        )
    })?;
    let cap_temp_dir = Utf8Dir::open_ambient_dir(utf8_temp_dir, ambient_authority())
        .context("open temporary directory with cap-std")?;
    cap_temp_dir
        .create_dir("hello_world")
        .context("create hello_world directory")?;
    let hello_world_dir = cap_temp_dir
        .open_dir("hello_world")
        .context("open hello_world directory")?;
    let mut config_file = hello_world_dir
        .create("config.toml")
        .context("create config file")?;
    config_file
        .write_all(b"is_enabled = true")
        .context("write config file")?;
    let file = utf8_temp_dir.join("hello_world/config.toml");
    Ok((temp_dir, file))
}