Rewrote the configuration options to make Diplonat modular: IGD and Firewall modules will only be enabled if correponding `DIPLONAT_*_ENABLE` is set. (Breaking changes!)

Also rearranged imports throughout the project, because I couldn't resist, sorry.

4 files changed, 150 insertions, 88 deletions

diff --git a/src/config/mod.rs b/src/config/mod.rs
index 14926bd..024e114 100644
--- a/src/config/mod.rs
+++ b/src/config/mod.rs
@@ -3,7 +3,7 @@ mod options;
 mod options_test;
 mod runtime;
 
-pub use options::{ConfigOpts, ConfigOptsAcme, ConfigOptsBase, ConfigOptsConsul};
+pub use options::{ConfigOpts, ConfigOptsConsul, ConfigOptsAcme, ConfigOptsFirewall, ConfigOptsIgd};
 pub use runtime::{RuntimeConfig, RuntimeConfigAcme, RuntimeConfigConsul, RuntimeConfigFirewall, RuntimeConfigIgd};
 
 pub const EXPIRATION_TIME: u16 = 300;
diff --git a/src/config/options.rs b/src/config/options.rs
index 36da475..b3a63b0 100644
--- a/src/config/options.rs
+++ b/src/config/options.rs
@@ -8,21 +8,27 @@ use crate::config::RuntimeConfig;
 // This file parses the options that can be declared in the environment.
 // runtime.rs applies business logic and builds RuntimeConfig structs.
 
-/// Base configuration options
+// - Note for the future -
+// There is no *need* to have a 'DIPLONAT_XXX_*' prefix for all config options.
+// If some config options are shared by several modules, a ConfigOptsBase could
+// contain them, and parse the 'DIPLONAT_*' prefix directly.
+// Only in runtime.rs would these options find their proper location in each 
+// module's struct.
+
+
+/// Consul configuration options
 #[derive(Clone, Default, Deserialize)]
-pub struct ConfigOptsBase {
-	/// This node's private IP address [default: None]
-	pub private_ip: Option<String>,
-	/// Expiration time for IGD rules [default: 60]
-	pub expiration_time: Option<u16>,
-	/// Refresh time for IGD and Firewall rules [default: 300]
-	pub refresh_time: Option<u16>,
+pub struct ConfigOptsConsul {
+	/// Consul's node name [default: None]
+	pub node_name: Option<String>,
+	/// Consul's REST URL [default: "http://127.0.0.1:8500"]
+	pub url: Option<String>,
 }
 
 /// ACME configuration options
 #[derive(Clone, Default, Deserialize)]
 pub struct ConfigOptsAcme {
-	/// Whether ACME is enabled [default: false]
+	/// Whether the ACME module is enabled [default: false]
 	#[serde(default)]
 	pub enable: bool,
 
@@ -30,32 +36,52 @@ pub struct ConfigOptsAcme {
 	pub email: Option<String>,
 }
 
-/// Consul configuration options
+/// Firewall configuration options
 #[derive(Clone, Default, Deserialize)]
-pub struct ConfigOptsConsul {
-	/// Consul's node name [default: None]
-	pub node_name: Option<String>,
-	/// Consul's REST URL [default: "http://127.0.0.1:8500"]
-	pub url: Option<String>,
+pub struct ConfigOptsFirewall {
+	/// Whether the firewall module is enabled [default: false]
+	#[serde(default)]
+	pub enable: bool,
+
+	/// Refresh time for firewall rules [default: 300]
+	pub refresh_time: Option<u16>,
+}
+
+/// IGD configuration options
+#[derive(Clone, Default, Deserialize)]
+pub struct ConfigOptsIgd {
+	/// Whether the IGD module is enabled [default: false]
+	#[serde(default)]
+	pub enable: bool,
+
+	/// This node's private IP address [default: None]
+	pub private_ip: Option<String>,
+	/// Expiration time for IGD rules [default: 60]
+	pub expiration_time: Option<u16>,
+	/// Refresh time for IGD rules [default: 300]
+	pub refresh_time: Option<u16>,
 }
 
 /// Model of all potential configuration options
 pub struct ConfigOpts {
-	pub base: ConfigOptsBase,
-	pub acme: ConfigOptsAcme,
 	pub consul: ConfigOptsConsul,
+	pub acme: ConfigOptsAcme,
+	pub firewall: ConfigOptsFirewall,
+	pub igd: ConfigOptsIgd,
 }
 
 impl ConfigOpts {
 	pub fn from_env() -> Result<RuntimeConfig> {
-		let base: ConfigOptsBase = envy::prefixed("DIPLONAT_").from_env()?;
 		let consul: ConfigOptsConsul = envy::prefixed("DIPLONAT_CONSUL_").from_env()?;
 		let acme: ConfigOptsAcme = envy::prefixed("DIPLONAT_ACME_").from_env()?;
+		let firewall: ConfigOptsFirewall = envy::prefixed("DIPLONAT_FIREWALL_").from_env()?;
+		let igd: ConfigOptsIgd = envy::prefixed("DIPLONAT_IGD_").from_env()?;
 
 		RuntimeConfig::new(Self {
-			base: base,
-			consul: consul,
-			acme: acme,
+			consul,
+			acme,
+			firewall,
+			igd,
 		})
 	}
 
@@ -63,14 +89,16 @@ impl ConfigOpts {
 	#[allow(dead_code)]
 	pub fn from_iter<Iter: Clone>(iter: Iter) -> Result<RuntimeConfig>
 	where Iter: IntoIterator<Item = (String, String)> {
-		let base: ConfigOptsBase = envy::prefixed("DIPLONAT_").from_iter(iter.clone())?;
 		let consul: ConfigOptsConsul = envy::prefixed("DIPLONAT_CONSUL_").from_iter(iter.clone())?;
 		let acme: ConfigOptsAcme = envy::prefixed("DIPLONAT_ACME_").from_iter(iter.clone())?;
+		let firewall: ConfigOptsFirewall = envy::prefixed("DIPLONAT_FIREWALL_").from_iter(iter.clone())?;
+		let igd: ConfigOptsIgd = envy::prefixed("DIPLONAT_IGD_").from_iter(iter.clone())?;
 
 		RuntimeConfig::new(Self {
-			base: base,
-			consul: consul,
-			acme: acme,
+			consul,
+			acme,
+			firewall,
+			igd,
 		})
 	}
 }
\ No newline at end of file
diff --git a/src/config/options_test.rs b/src/config/options_test.rs
index a6063fd..98fc625 100644
--- a/src/config/options_test.rs
+++ b/src/config/options_test.rs
@@ -11,35 +11,44 @@ use crate::config::*;
 
 fn minimal_valid_options() -> HashMap<String, String> {
 	let mut opts = HashMap::new();
-	opts.insert("DIPLONAT_PRIVATE_IP".to_string(), "172.123.43.555".to_string());
     opts.insert("DIPLONAT_CONSUL_NODE_NAME".to_string(), "consul_node".to_string());
     opts
 }
 
 fn all_valid_options() -> HashMap<String, String> {
 	let mut opts = minimal_valid_options();
-	opts.insert("DIPLONAT_EXPIRATION_TIME".to_string(), "30".to_string());
-	opts.insert("DIPLONAT_REFRESH_TIME".to_string(), "10".to_string());
     opts.insert("DIPLONAT_CONSUL_URL".to_string(), "http://127.0.0.1:9999".to_string());
 	opts.insert("DIPLONAT_ACME_ENABLE".to_string(), "true".to_string());
 	opts.insert("DIPLONAT_ACME_EMAIL".to_string(), "bozo@bozo.net".to_string());
+	opts.insert("DIPLONAT_FIREWALL_ENABLE".to_string(), "true".to_string());
+	opts.insert("DIPLONAT_FIREWALL_REFRESH_TIME".to_string(), "20".to_string());
+	opts.insert("DIPLONAT_IGD_ENABLE".to_string(), "true".to_string());
+	opts.insert("DIPLONAT_IGD_PRIVATE_IP".to_string(), "172.123.43.555".to_string());
+	opts.insert("DIPLONAT_IGD_EXPIRATION_TIME".to_string(), "60".to_string());
+	opts.insert("DIPLONAT_IGD_REFRESH_TIME".to_string(), "10".to_string());
     opts
 }
 
+// #[test]
+// #[should_panic]
+// fn err_empty_env() {
+// 	 std::env::remove_var("DIPLONAT_CONSUL_NODE_NAME");
+// 	 ConfigOpts::from_env().unwrap();
+// }
+
 #[test]
 #[should_panic]
 fn err_empty_env() {
-	std::env::remove_var("DIPLONAT_PRIVATE_IP");
 	std::env::remove_var("DIPLONAT_CONSUL_NODE_NAME");
-	ConfigOpts::from_env().unwrap();
+	let opts: HashMap<String, String> = HashMap::new();
+	ConfigOpts::from_iter(opts).unwrap();
 }
 
 #[test]
-fn ok_from_iter_minimal_valid_options() {
+fn ok_minimal_valid_options() {
 	let opts = minimal_valid_options();
 	let rt_config = ConfigOpts::from_iter(opts.clone()).unwrap();
 
-	assert!(rt_config.acme.is_none());
 	assert_eq!(
 		&rt_config.consul.node_name, 
 		opts.get(&"DIPLONAT_CONSUL_NODE_NAME".to_string()).unwrap()
@@ -48,7 +57,10 @@ fn ok_from_iter_minimal_valid_options() {
 		rt_config.consul.url, 
 		CONSUL_URL.to_string()
 	);
-	assert_eq!(
+	assert!(rt_config.acme.is_none());
+	assert!(rt_config.firewall.is_none());
+	assert!(rt_config.igd.is_none());
+	/*assert_eq!(
 		rt_config.firewall.refresh_time,
 		Duration::from_secs(REFRESH_TIME.into())
 	);
@@ -63,36 +75,37 @@ fn ok_from_iter_minimal_valid_options() {
 	assert_eq!(
 		rt_config.igd.refresh_time,
 		Duration::from_secs(REFRESH_TIME.into())
-	);
+	);*/
 }
 
 #[test]
 #[should_panic]
-fn err_from_iter_invalid_refresh_time() {
+fn err_invalid_igd_options() {
 	let mut opts = minimal_valid_options();
-	opts.insert("DIPLONAT_EXPIRATION_TIME".to_string(), "60".to_string());
-	opts.insert("DIPLONAT_REFRESH_TIME".to_string(), "60".to_string());
+	opts.insert("DIPLONAT_IGD_ENABLE".to_string(), "true".to_string());
+	opts.insert("DIPLONAT_IGD_EXPIRATION_TIME".to_string(), "60".to_string());
+	opts.insert("DIPLONAT_IGD_REFRESH_TIME".to_string(), "60".to_string());
 	ConfigOpts::from_iter(opts).unwrap();
 }
 
 #[test]
-fn ok_from_iter_all_valid_options() {
+fn ok_all_valid_options() {
 	let opts = all_valid_options();
 	let rt_config = ConfigOpts::from_iter(opts.clone()).unwrap();
 
-	let expiration_time = Duration::from_secs(
-		opts.get(&"DIPLONAT_EXPIRATION_TIME".to_string()).unwrap()
+	let firewall_refresh_time = Duration::from_secs(
+		opts.get(&"DIPLONAT_FIREWALL_REFRESH_TIME".to_string()).unwrap()
 			.parse::<u64>().unwrap()
 			.into());
-	let refresh_time = Duration::from_secs(
-		opts.get(&"DIPLONAT_REFRESH_TIME".to_string()).unwrap()
+	let igd_expiration_time = Duration::from_secs(
+		opts.get(&"DIPLONAT_IGD_EXPIRATION_TIME".to_string()).unwrap()
+			.parse::<u64>().unwrap()
+			.into());
+	let igd_refresh_time = Duration::from_secs(
+		opts.get(&"DIPLONAT_IGD_REFRESH_TIME".to_string()).unwrap()
 			.parse::<u64>().unwrap()
 			.into());
 
-	assert!(rt_config.acme.is_some());
-	assert_eq!(
-		&rt_config.acme.unwrap().email,
-		opts.get(&"DIPLONAT_ACME_EMAIL".to_string()).unwrap());
 	assert_eq!(
 		&rt_config.consul.node_name, 
 		opts.get(&"DIPLONAT_CONSUL_NODE_NAME".to_string()).unwrap()
@@ -101,20 +114,32 @@ fn ok_from_iter_all_valid_options() {
 		&rt_config.consul.url, 
 		opts.get(&"DIPLONAT_CONSUL_URL".to_string()).unwrap()
 	);
+
+	assert!(rt_config.acme.is_some());
+	let acme = rt_config.acme.unwrap();
 	assert_eq!(
-		rt_config.firewall.refresh_time,
-		refresh_time
+		&acme.email,
+		opts.get(&"DIPLONAT_ACME_EMAIL".to_string()).unwrap());
+
+	assert!(rt_config.firewall.is_some());
+	let firewall = rt_config.firewall.unwrap();
+	assert_eq!(
+		firewall.refresh_time,
+		firewall_refresh_time
 	);
+
+	assert!(rt_config.igd.is_some());
+	let igd = rt_config.igd.unwrap();
 	assert_eq!(
-		&rt_config.igd.private_ip,
-		opts.get(&"DIPLONAT_PRIVATE_IP".to_string()).unwrap()
+		&igd.private_ip,
+		opts.get(&"DIPLONAT_IGD_PRIVATE_IP".to_string()).unwrap()
 	);
 	assert_eq!(
-		rt_config.igd.expiration_time,
-		expiration_time
+		igd.expiration_time,
+		igd_expiration_time
 	);
 	assert_eq!(
-		rt_config.igd.refresh_time,
-		refresh_time
+		igd.refresh_time,
+		igd_refresh_time
 	);
 }
\ No newline at end of file
diff --git a/src/config/runtime.rs b/src/config/runtime.rs
index 58c86b9..f83a6b5 100644
--- a/src/config/runtime.rs
+++ b/src/config/runtime.rs
@@ -2,17 +2,14 @@ use std::time::Duration;
 
 use anyhow::{Result, anyhow};
 
-use crate::config::{ConfigOpts, ConfigOptsAcme, ConfigOptsBase, ConfigOptsConsul};
+use crate::config::{ConfigOpts, ConfigOptsConsul, ConfigOptsAcme, ConfigOptsFirewall, ConfigOptsIgd};
 
 // This code is inspired by the Trunk crate (https://github.com/thedodd/trunk)
 
 // In this file, we take ConfigOpts and transform them into ready-to-use RuntimeConfig.
 // We apply default values and business logic.
 
-#[derive(Debug)]
-pub struct RuntimeConfigAcme {
-	pub email: String,
-}
+// Consul config is mandatory, all the others are optional.
 
 #[derive(Debug)]
 pub struct RuntimeConfigConsul {
@@ -21,6 +18,11 @@ pub struct RuntimeConfigConsul {
 }
 
 #[derive(Debug)]
+pub struct RuntimeConfigAcme {
+	pub email: String,
+}
+
+#[derive(Debug)]
 pub struct RuntimeConfigFirewall {
 	pub refresh_time: Duration,
 }
@@ -34,18 +36,18 @@ pub struct RuntimeConfigIgd {
 
 #[derive(Debug)]
 pub struct RuntimeConfig {
-	pub acme: Option<RuntimeConfigAcme>,
 	pub consul: RuntimeConfigConsul,
-	pub firewall: RuntimeConfigFirewall,
-	pub igd: RuntimeConfigIgd,
+	pub acme: Option<RuntimeConfigAcme>,
+	pub firewall: Option<RuntimeConfigFirewall>,
+	pub igd: Option<RuntimeConfigIgd>,
 }
 
 impl RuntimeConfig {
 	pub fn new(opts: ConfigOpts) -> Result<Self> {
-		let acme = RuntimeConfigAcme::new(opts.acme.clone())?;
 		let consul = RuntimeConfigConsul::new(opts.consul.clone())?;
-		let firewall = RuntimeConfigFirewall::new(opts.base.clone())?;
-		let igd = RuntimeConfigIgd::new(opts.base.clone())?;
+		let acme = RuntimeConfigAcme::new(opts.acme.clone())?;
+		let firewall = RuntimeConfigFirewall::new(opts.firewall.clone())?;
+		let igd = RuntimeConfigIgd::new(opts.igd.clone())?;
 
 		Ok(Self {
 			acme,
@@ -56,6 +58,19 @@ impl RuntimeConfig {
 	}
 }
 
+impl RuntimeConfigConsul {
+	pub(super) fn new(opts: ConfigOptsConsul) -> Result<Self> {
+		let node_name = opts.node_name.expect(
+			"'DIPLONAT_CONSUL_NODE_NAME' is required");
+		let url = opts.url.unwrap_or(super::CONSUL_URL.to_string());
+
+		Ok(Self {
+			node_name,
+			url,
+		})
+	}
+}
+
 impl RuntimeConfigAcme {
 	pub fn new(opts: ConfigOptsAcme) -> Result<Option<Self>> {
 		if !opts.enable {
@@ -63,8 +78,7 @@ impl RuntimeConfigAcme {
 		}
 
 		let email = opts.email.expect(
-			"'DIPLONAT_ACME_EMAIL' environment variable is required \
-			if 'DIPLONAT_ACME_ENABLE' == 'true'");
+			"'DIPLONAT_ACME_EMAIL' is required if ACME is enabled");
 
 		Ok(Some(Self {
 			email,
@@ -72,34 +86,29 @@ impl RuntimeConfigAcme {
 	}
 }
 
-impl RuntimeConfigConsul {
-	pub(super) fn new(opts: ConfigOptsConsul) -> Result<Self> {
-		let node_name = opts.node_name.expect(
-			"'DIPLONAT_CONSUL_NODE_NAME' environment variable is required");
-		let url = opts.url.unwrap_or(super::CONSUL_URL.to_string());
-
-		Ok(Self {
-			node_name,
-			url,
-		})
-	}
-}
-
 impl RuntimeConfigFirewall {
-	pub(super) fn new(opts: ConfigOptsBase) -> Result<Self> {
+	pub(super) fn new(opts: ConfigOptsFirewall) -> Result<Option<Self>> {
+		if !opts.enable {
+			return Ok(None);
+		}
+
 		let refresh_time = Duration::from_secs(
 				opts.refresh_time.unwrap_or(super::REFRESH_TIME).into());
 
-		Ok(Self {
+		Ok(Some(Self {
 			refresh_time,
-		})
+		}))
 	}
 }
 
 impl RuntimeConfigIgd {
-	pub(super) fn new(opts: ConfigOptsBase) -> Result<Self> {
+	pub(super) fn new(opts: ConfigOptsIgd) -> Result<Option<Self>> {
+		if !opts.enable {
+			return Ok(None);
+		}
+
 		let private_ip = opts.private_ip.expect(
-			"'DIPLONAT_PRIVATE_IP' environment variable is required");
+			"'DIPLONAT_IGD_PRIVATE_IP' is required if IGD is enabled");
 		let expiration_time = Duration::from_secs(
 				opts.expiration_time.unwrap_or(super::EXPIRATION_TIME).into());
 		let refresh_time = Duration::from_secs(
@@ -112,10 +121,10 @@ impl RuntimeConfigIgd {
 	        refresh_time.as_secs()));
 	    }
 
-		Ok(Self {
+		Ok(Some(Self {
 			private_ip,
 			expiration_time,
 			refresh_time,
-		})
+		}))
 	}
 }
\ No newline at end of file