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
//! A layered configuration loader with zero-boilerplate configuration management. //! //! 1. [About](#about) //! 2. [Features](#features) //! 3. [Placeholder](#placeholder) //! 4. [Key Convension](#key-convension) //! 5. [Cargo Features](#cargo-features) //! 1. [Default features](#default-features) //! 2. [Optional features](#optional-features) //! 6. [Quick Example](#quick-example) //! //! //! ## About //! `salak` is a rust version of layered configuration loader inspired by //! [spring-boot](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config). //! `salak` provide an [`Environment`] structure which load properties from various [`PropertySource`]s. //! Any structure which impmement [`FromEnvironment`] can get from [`Environment`] by a key. //! Feature `enable_derive` provide rust attributes for auto derive [`FromEnvironment`]. //! //! ## Features //! Below are a few of the features which `salak` supports. //! //! * Auto mapping properties into configuration struct. //! - `#[salak(default="value")]` set default value. //! - `#[salak(name="key")]` rename property key. //! - `#[salak(prefix="salak.database")]` set prefix. //! * ** Supports load properties from various sources ** //! - Support following random property key. //! - `random.u8` //! - `random.u16` //! - `random.u32` //! - `random.i8` //! - `random.i16` //! - `random.i32` //! - `random.i64` //! - Load properties from command line arguments. //! - Load properties from system environment. //! - Load properties from toml config file. //! - Load properties from yaml config file. //! - Easy to add a new property source. //! * Supports profile(develop/production) based configuration. //! * Supports placeholder resolve. //! * Supports reload configurations. //! * Supports factory builder. //! //! ## Placeholder //! //! * `${key:default}` means get value of `key`, if not exists then return `default`. //! * `${key}` means get value of `key`, if not exists then return `PropertyError::NotFound(_)`. //! * `\$\{key\}` means escape to `${key}`. //! //! ## Key Convension //! * `a.b.c` is a normal key separated by dot(`.`). //! * `a.b[0]`, `a.b[1]`, `a.b[2]`... is a group of keys with arrays. //! //! ## Cargo Features //! //! ### Default features //! 1. `enable_log`, enable log record if enabled. //! 2. `enable_toml`, enable toml support. //! 3. `enable_derive`, enable auto derive [`FromEnvironment`] for struts. //! //! ### Optional features //! 1. `enable_pico`, enable default command line arguments parsing by `pico-args`. //! 1. `enable_clap`, enable default command line arguments parsing by `clap`. //! 2. `enable_yaml`, enable yaml support. //! 3. `enable_rand`, enable random value support. //! //! ## Quick Example //! //! ``` //! use salak::*; //! //! #[derive(FromEnvironment, Debug)] //! pub struct SslConfig { //! key: String, //! pem: String, //! } //! //! #[derive(FromEnvironment, Debug)] //! #[salak(prefix = "database")] //! pub struct DatabaseConfig { //! url: String, //! #[salak(default = "salak")] //! username: String, //! password: Option<String>, //! description: String, //! #[salak(name="ssl")] //! ssl_config: Option<SslConfig>, //! } //! //! std::env::set_var("database.url", "localhost:5432"); //! std::env::set_var("database.description", "\\$\\{Hello\\}"); //! let env = Salak::new() //! .with_default_args(auto_read_sys_args_param!()) // This line need enable feature `enable_pico`. //! .add_default::<DatabaseConfig>() //! .add_default_source(inline_toml!("app.toml")) //! .build(); //! //! match env.load_config::<DatabaseConfig>() { //! Ok(val) => println!("{:?}", val), //! Err(e) => println!("{}", e), //! } //! //! // Output: DatabaseConfig { //! // url: "localhost:5432", //! // username: "salak", //! // password: None, //! // description: "${Hello}", //! // ssl_config: None, //! // } //! ``` //! #![cfg_attr(docsrs, feature(doc_cfg))] #![warn( anonymous_parameters, missing_copy_implementations, missing_debug_implementations, missing_docs, nonstandard_style, rust_2018_idioms, single_use_lifetimes, trivial_casts, trivial_numeric_casts, unreachable_pub, unused_extern_crates, unused_qualifications, variant_size_differences )] #[cfg(feature = "enable_log")] use log::*; use std::collections::HashSet; use std::hash::BuildHasher; use std::hash::Hash; #[cfg(test)] #[macro_use(quickcheck)] extern crate quickcheck_macros; #[cfg(feature = "enable_derive")] #[cfg_attr(docsrs, doc(cfg(feature = "enable_derive")))] mod derive; #[cfg(feature = "enable_derive")] #[cfg_attr(docsrs, doc(cfg(feature = "enable_derive")))] pub use crate::derive::{AutoDeriveFromEnvironment, DefaultSourceFromEnvironment}; /// Auto derive [`FromEnvironment`] for struct. #[cfg(feature = "enable_derive")] #[cfg_attr(docsrs, doc(cfg(feature = "enable_derive")))] pub use salak_derive::FromEnvironment; mod err; mod utils; pub use crate::err::PropertyError; pub use crate::utils::SalakStringUtil; mod env; pub(crate) use crate::env::factory::FactoryRegistry; pub use crate::env::{ factory::{FacRef, Factory, FactoryContext, FactoryScope, FromFactory}, placeholder::PlaceholderResolver, registry::SourceRegistry, salak::{Salak, SalakBuilder}, }; mod source; #[cfg(feature = "enable_toml")] #[cfg_attr(docsrs, doc(cfg(feature = "enable_toml")))] pub use crate::source::toml::Toml; #[cfg(feature = "enable_yaml")] #[cfg_attr(docsrs, doc(cfg(feature = "enable_yaml")))] pub use crate::source::yaml::Yaml; pub use crate::source::{args::*, env::SysEnvPropertySource, map::MapPropertySource}; #[allow(unused)] pub(crate) const NOT_POSSIBLE: &str = "Not possible"; /// Raw property. #[derive(Clone, Debug)] pub enum Property { /// String value. Str(String), /// Integer value. Int(i64), /// Float value. Float(f64), /// Bool value. Bool(bool), } /// Convert to [`Property`]. pub trait IntoProperty: Sized { /// Convert to property. fn into_property(self) -> Property; } /// Convert from [`Property`]. pub trait FromProperty: Sized { /// Convert from property. fn from_property(_: Property) -> Result<Self, PropertyError>; } /// An abstract source loader from various sources, /// such as command line arguments, system environment, files, etc. pub trait PropertySource: Sync + Send { /// [`PropertySource`] name. fn name(&self) -> String; /// Get property by name. fn get_property(&self, key: &str) -> Option<Property>; /// Check whether property exists. fn contains_property(&self, key: &str) -> bool { self.get_property(key).is_some() } /// Check whether the [`PropertySource`] is empty. /// Empty source will not be ignored when register to registry. fn is_empty(&self) -> bool; /// Find all next level keys with prefix. fn get_keys(&self, prefix: &str) -> Vec<String>; /// Reload [`PropertySource`], if this [`PropertySource`] not support reload, then just return `Ok(None)`. fn load(&self) -> Result<Option<Box<dyn PropertySource>>, PropertyError>; } /// An environment for getting properties with mutiple [`PropertySource`]s, placeholder resolve and other features. pub trait Environment: Sync + Send { /// Check whether property exists. fn contains(&self, key: &str) -> bool { self.require::<Property>(key).is_ok() } /// Get property with specific type. fn require<T: FromEnvironment>(&self, key: &str) -> Result<T, PropertyError>; /// Get property with specific type, if property not exists, then return default value. fn require_or<T: FromEnvironment>(&self, key: &str, default: T) -> Result<T, PropertyError> { match self.require::<Option<T>>(key) { Ok(Some(a)) => Ok(a), Ok(None) => Ok(default), Err(e) => Err(e), } } /// Get property with specific type, if error happens then return [`None`]. fn get<T: FromEnvironment>(&self, key: &str) -> Option<T> { self.require(key).ok() } /// Get property with specific type, if error happens then return default value. fn get_or<T: FromEnvironment>(&self, key: &str, default: T) -> T { self.get(key).unwrap_or(default) } /// Resolve placeholder value. fn resolve_placeholder(&self, value: String) -> Result<Option<Property>, PropertyError>; /// Load properties which has `#[salak(prefix="prefix")]` #[cfg(feature = "enable_derive")] #[cfg_attr(docsrs, doc(cfg(feature = "enable_derive")))] fn load_config<T: DefaultSourceFromEnvironment>(&self) -> Result<T, PropertyError> { self.require(T::prefix()) } /// Find all next level keys with prefix. fn find_keys(&self, prefix: &str) -> Vec<String>; /// Reload [`Environment`]. fn reload(&mut self) -> Result<(), PropertyError>; } /// Convert from [`Environment`]. pub trait FromEnvironment: Sized { /// Generate object from [`Environment`]. /// * `prefix` - Property prefix. /// * `property` - Property value with key is `prefix`. /// * `env` - Instance of [`Environment`] fn from_env( prefix: &str, property: Option<Property>, env: &impl Environment, ) -> Result<Self, PropertyError>; /// Empty check for some containers, such as [`Vec<T>`] or [`Option<T>`]. fn check_is_empty(&self) -> bool { false } #[doc(hidden)] /// Handle special case such as property not found. fn from_err(err: PropertyError) -> Result<Self, PropertyError> { Err(err) } #[doc(hidden)] #[cfg(feature = "enable_derive")] fn load_default() -> Vec<(String, Property)> { vec![] } } #[cfg(feature = "enable_toml")] #[cfg(feature = "enable_derive")] #[cfg(test)] mod tests { use crate::*; use std::collections::HashMap; #[derive(FromEnvironment, Debug)] struct DatabaseConfigObj { hello: String, world: Option<String>, } #[derive(FromEnvironment, Debug)] struct DatabaseConfigDetail { #[salak(default = "str")] option_str: String, #[salak(default = 1)] option_i64: i64, option_arr: Vec<i64>, option_multi_arr: Vec<Vec<i64>>, option_obj: Vec<DatabaseConfigObj>, } #[derive(FromEnvironment, Debug)] #[salak(prefix = "database")] struct DatabaseConfig { url: String, name: String, #[salak(default = "${database.name}")] username: String, password: Option<String>, description: String, detail: DatabaseConfigDetail, } #[test] fn integration_tests() { let env = Salak::new() .with_custom_args(vec![ ( "database.detail.option_arr[0]".to_owned(), "10".into_property(), ), ("database.url".to_owned(), "localhost:5432".into_property()), ("database.name".to_owned(), "salak".into_property()), ( "database.description".to_owned(), "\\$\\{Hello\\}".into_property(), ), ]) .build(); let ret = env.load_config::<DatabaseConfig>(); assert_eq!(true, ret.is_ok()); let ret = ret.unwrap(); assert_eq!("localhost:5432", ret.url); assert_eq!("salak", ret.name); assert_eq!("salak", ret.username); assert_eq!(None, ret.password); assert_eq!("${Hello}", ret.description); let ret = ret.detail; assert_eq!("str", ret.option_str); assert_eq!(1, ret.option_i64); assert_eq!(1, ret.option_arr.len()); assert_eq!(10, ret.option_arr[0]); assert_eq!(0, ret.option_multi_arr.len()); assert_eq!(0, ret.option_obj.len()); let ret = env.require::<HashMap<String, String>>("database"); assert_eq!(true, ret.is_ok()); let ret = ret.unwrap(); assert_eq!(3, ret.len()); } #[derive(FromEnvironment, Debug)] struct Options { #[salak(default = "cidr")] mode: String, #[salak(default = "\t")] sep: String, #[salak(default = "false")] count: bool, } #[test] fn placeholder_tests() { let env = Salak::new().build(); let ret = env.require::<Options>(""); assert_eq!(true, ret.is_ok()); let ret = ret.unwrap(); assert_eq!("cidr", ret.mode); assert_eq!("\t", ret.sep); assert_eq!(false, ret.count); } }