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
//! Profile and environment support
//!
//! Provides Django-style environment profiles (development, staging, production)
//! with cascading configuration support.
use serde::{Deserialize, Serialize};
use std::env;
use std::fmt;
/// Application profile/environment
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
#[derive(Default)]
pub enum Profile {
/// Development environment (default)
#[default]
Development,
/// Staging/testing environment
Staging,
/// Production environment
Production,
/// Custom profile
Custom,
}
impl Profile {
/// Get the profile from environment variable
///
/// Checks REINHARDT_ENV, REINHARDT_SETTINGS_MODULE, and ENVIRONMENT variables
///
/// # Examples
///
/// ```
/// use reinhardt_conf::settings::profile::Profile;
///
/// // Returns the profile from environment variables
/// if let Some(profile) = Profile::from_env() {
/// println!("Running in {:?} mode", profile);
/// }
/// ```
pub fn from_env() -> Option<Self> {
// Try REINHARDT_ENV first
if let Ok(env_val) = env::var("REINHARDT_ENV") {
return Some(Self::parse(&env_val));
}
// Try ENVIRONMENT
if let Ok(env_val) = env::var("ENVIRONMENT") {
return Some(Self::parse(&env_val));
}
// Try to detect from REINHARDT_SETTINGS_MODULE
if let Ok(settings_module) = env::var("REINHARDT_SETTINGS_MODULE") {
if settings_module.contains("production") {
return Some(Profile::Production);
} else if settings_module.contains("staging") {
return Some(Profile::Staging);
} else if settings_module.contains("development") || settings_module.contains("dev") {
return Some(Profile::Development);
}
}
None
}
/// Parse profile from string
///
/// Returns Custom for unknown profile names.
///
/// # Examples
///
/// ```
/// use reinhardt_conf::settings::profile::Profile;
///
/// assert_eq!(Profile::parse("production"), Profile::Production);
/// assert_eq!(Profile::parse("dev"), Profile::Development);
/// assert_eq!(Profile::parse("staging"), Profile::Staging);
/// assert_eq!(Profile::parse("unknown"), Profile::Custom);
/// ```
pub fn parse(s: &str) -> Self {
match s.to_lowercase().as_str() {
"development" | "dev" | "develop" => Profile::Development,
"staging" | "stage" | "test" => Profile::Staging,
"production" | "prod" => Profile::Production,
_ => Profile::Custom,
}
}
/// Get the profile name as a string
///
/// # Examples
///
/// ```
/// use reinhardt_conf::settings::profile::Profile;
///
/// assert_eq!(Profile::Development.as_str(), "development");
/// assert_eq!(Profile::Production.as_str(), "production");
/// ```
pub fn as_str(&self) -> &'static str {
match self {
Profile::Development => "development",
Profile::Staging => "staging",
Profile::Production => "production",
Profile::Custom => "custom",
}
}
/// Check if this is a production environment
///
/// # Examples
///
/// ```
/// use reinhardt_conf::settings::profile::Profile;
///
/// assert!(Profile::Production.is_production());
/// assert!(!Profile::Development.is_production());
/// ```
pub fn is_production(&self) -> bool {
matches!(self, Profile::Production)
}
/// Check if this is a development environment
///
/// # Examples
///
/// ```
/// use reinhardt_conf::settings::profile::Profile;
///
/// assert!(Profile::Development.is_development());
/// assert!(!Profile::Production.is_development());
/// ```
pub fn is_development(&self) -> bool {
matches!(self, Profile::Development)
}
/// Check if debug mode should be enabled by default
///
/// # Examples
///
/// ```
/// use reinhardt_conf::settings::profile::Profile;
///
/// assert!(Profile::Development.default_debug());
/// assert!(!Profile::Production.default_debug());
/// ```
pub fn default_debug(&self) -> bool {
!self.is_production()
}
/// Get the .env file name for this profile
///
/// # Examples
///
/// ```
/// use reinhardt_conf::settings::profile::Profile;
///
/// let profile = Profile::Development;
/// assert_eq!(profile.env_file_name(), ".env.development");
/// ```
pub fn env_file_name(&self) -> String {
match self {
Profile::Custom => ".env".to_string(),
_ => format!(".env.{}", self.as_str()),
}
}
}
impl fmt::Display for Profile {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.as_str())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_profile_parse() {
assert_eq!(Profile::parse("development"), Profile::Development);
assert_eq!(Profile::parse("dev"), Profile::Development);
assert_eq!(Profile::parse("staging"), Profile::Staging);
assert_eq!(Profile::parse("stage"), Profile::Staging);
assert_eq!(Profile::parse("production"), Profile::Production);
assert_eq!(Profile::parse("prod"), Profile::Production);
assert_eq!(Profile::parse("unknown"), Profile::Custom);
}
#[test]
fn test_profile_as_str() {
assert_eq!(Profile::Development.as_str(), "development");
assert_eq!(Profile::Staging.as_str(), "staging");
assert_eq!(Profile::Production.as_str(), "production");
}
#[test]
fn test_profile_checks() {
assert!(Profile::Production.is_production());
assert!(!Profile::Development.is_production());
assert!(Profile::Development.is_development());
assert!(!Profile::Production.is_development());
}
#[test]
fn test_default_debug() {
assert!(Profile::Development.default_debug());
assert!(Profile::Staging.default_debug());
assert!(!Profile::Production.default_debug());
}
#[test]
fn test_env_file_name() {
assert_eq!(Profile::Development.env_file_name(), ".env.development");
assert_eq!(Profile::Staging.env_file_name(), ".env.staging");
assert_eq!(Profile::Production.env_file_name(), ".env.production");
assert_eq!(Profile::Custom.env_file_name(), ".env");
}
#[test]
fn test_settings_profile_from_env() {
// SAFETY: Setting environment variables is unsafe in multi-threaded programs.
// This test uses #[serial] to ensure exclusive access to environment variables.
unsafe {
env::set_var("REINHARDT_ENV", "production");
}
assert_eq!(Profile::from_env().unwrap(), Profile::Production);
// SAFETY: Removing environment variables is unsafe in multi-threaded programs.
// This test uses #[serial] to ensure exclusive access to environment variables.
unsafe {
env::remove_var("REINHARDT_ENV");
}
// SAFETY: Setting environment variables is unsafe in multi-threaded programs.
// This test uses #[serial] to ensure exclusive access to environment variables.
unsafe {
env::set_var("ENVIRONMENT", "development");
}
assert_eq!(Profile::from_env().unwrap(), Profile::Development);
// SAFETY: Removing environment variables is unsafe in multi-threaded programs.
// This test uses #[serial] to ensure exclusive access to environment variables.
unsafe {
env::remove_var("ENVIRONMENT");
}
}
}