klauthed-core 0.4.0

Core primitives for klauthed: typed config, clock/time, request context, CQRS, domain, and validation.
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

//! Object-storage configuration (`StorageConfig`).

use std::path::PathBuf;

use serde::{Deserialize, Serialize};

/// Object/file storage configuration, tagged on `backend`.
///
/// ```toml
/// [storage]
/// backend = "s3"
/// bucket  = "uploads"
/// region  = "eu-central-1"
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "backend", rename_all = "snake_case")]
pub enum StorageConfig {
    /// Local filesystem storage.
    Local {
        /// Root directory under which files are stored.
        #[serde(default = "default_local_root")]
        root: PathBuf,
    },
    /// Amazon S3 (or S3-compatible endpoints such as MinIO).
    S3 {
        /// Bucket name.
        bucket: String,
        /// AWS region.
        #[serde(default = "default_s3_region")]
        region: String,
        /// Custom endpoint for S3-compatible stores (e.g. MinIO).
        #[serde(default)]
        endpoint: Option<String>,
        /// Access key ID. Prefer sourcing this from Vault in staging/prod.
        #[serde(default)]
        access_key_id: Option<String>,
        /// Secret key. Prefer sourcing this from Vault in staging/prod.
        #[serde(default)]
        secret_access_key: Option<String>,
        /// Use path-style addressing (required by some S3-compatible servers).
        #[serde(default)]
        path_style: bool,
    },
    /// Google Cloud Storage.
    Gcs {
        /// Bucket name.
        bucket: String,
        /// Path to a service-account credentials JSON file.
        #[serde(default)]
        credentials_path: Option<PathBuf>,
    },
    /// Azure Blob Storage.
    Azure {
        /// Storage account name.
        account: String,
        /// Blob container name.
        container: String,
        /// Access key. Prefer sourcing this from Vault in staging/prod.
        #[serde(default)]
        access_key: Option<String>,
    },
}

fn default_local_root() -> PathBuf {
    PathBuf::from("./data")
}
fn default_s3_region() -> String {
    "us-east-1".to_owned()
}

impl Default for StorageConfig {
    fn default() -> Self {
        StorageConfig::Local { root: default_local_root() }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn parses_local_backend_with_default_root() {
        let cfg: StorageConfig = serde_json::from_value(json!({ "backend": "local" })).unwrap();
        assert_eq!(cfg, StorageConfig::Local { root: PathBuf::from("./data") });
    }

    #[test]
    fn parses_s3_backend() {
        let cfg: StorageConfig = serde_json::from_value(json!({
            "backend": "s3",
            "bucket": "uploads",
            "region": "eu-central-1",
            "path_style": true
        }))
        .unwrap();

        assert_eq!(
            cfg,
            StorageConfig::S3 {
                bucket: "uploads".into(),
                region: "eu-central-1".into(),
                endpoint: None,
                access_key_id: None,
                secret_access_key: None,
                path_style: true,
            }
        );
    }
}