env-url 2.1.0

env composable service urls
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

//!
//! This crate provides env-composable service urls complete with key overrides as to facilitate flexibility and to simplify integration with kubernetes.
//!
//! ## Env mapping behaviors
//!
//! | ENV                     |                                                           |
//! | -----------------------:|:---------------------------------------------------------:|
//! | {PREFIX}_URL            | set service url, disregarding other overrides             |
//! | {PREFIX}_URL_ENV        | override `{PREFIX}_URL` env mapping                       |
//! | {PREFIX}_SCHEME         | set url scheme component                                  |
//! | {PREFIX}_SCHEME_ENV     | override `{PREFIX}_SCHEME` env mapping                    |
//! | {PREFIX}_PATH           | set url path component                                    |
//! | {PREFIX}_PATH_ENV       | override `{PREFIX}_PATH` env mapping                      |
//! | {PREFIX}_QUERY          | set url query component                                   |
//! | {PREFIX}_QUERY_ENV      | override `{PREFIX}_QUERY` env mapping                     |
//! | {PREFIX}_USERINFO       | set url userinfo component                                |
//! | {PREFIX}_USERINFO_ENV   | override `{PREFIX}_USERINFO` env mapping                  |
//!
//! ## Example
//!
//! ```
//! use env_url::*;
//!
//! #[derive(EnvURL)]
//! #[env_url(env_prefix = "REDIS", default = "redis://127.0.0.1:6379")]
//! pub struct RedisDB;
//!
//! let service_url = RedisDB::service_url();
//!
//! ```
//!
#[doc(hidden)]
pub extern crate url;

extern crate self as env_url;

pub use derive_env_url::*;
pub use url::{ParseError, Url};
pub trait ServiceURL {
  fn service_url() -> Result<Url, ParseError>;
}

#[cfg(test)]
#[ctor::ctor]
fn setup_test_env() {
  std::env::remove_var("REDIS_URL");
  std::env::remove_var("REDIS_URL_ENV");
  std::env::remove_var("REDIS_SCHEME");
  std::env::remove_var("REDIS_SCHEME_ENV");
  std::env::remove_var("REDIS_PATH");
  std::env::remove_var("REDIS_PATH_ENV");
  std::env::remove_var("REDIS_QUERY");
  std::env::remove_var("REDIS_QUERY_ENV");
  std::env::remove_var("REDIS_USERINFO");
  std::env::remove_var("REDIS_USERINFO_ENV");
}
#[cfg(test)]
mod tests {
  use env_url::*;

  #[derive(EnvURL)]
  #[env_url(env_prefix = "REDIS", default = "redis://127.0.0.1:6379")]
  struct RedisDB;

  #[test]
  fn it_creates_url() -> Result<(), ParseError> {
    let url = RedisDB::service_url()?;

    assert_eq!(url.as_str(), "redis://127.0.0.1:6379");

    Ok(())
  }
}