Merge branch 'feature/env_config' into development

* feature/env_config:
  Improve error messages on missing config
  Refactor Config into dhall module

bffhd/config/dhall.rs

@@ -1,6 +1,169 @@
-use crate::Config;
+use std::collections::HashMap;
+use std::default::Default;
+use std::error::Error;
+use std::fmt::{Debug, Display};
+use std::marker::PhantomData;
+use std::path::PathBuf;
+
+use serde::{Deserialize, Serialize};
+
+use crate::authorization::permissions::PrivilegesBuf;
+use crate::authorization::roles::Role;
+use crate::capnp::{Listen, TlsListen};
+use crate::logging::LogConfig;
+
+use miette::IntoDiagnostic;
 use std::path::Path;
 
+#[derive(Debug)]
+struct DhallConfig<'a> {
+    path: &'a Path,
+}
+
 pub fn read_config_file(path: impl AsRef<Path>) -> Result<Config, serde_dhall::Error> {
     serde_dhall::from_file(path).parse().map_err(Into::into)
 }
+
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(deny_unknown_fields)]
+/// A description of a machine
+///
+/// This is the struct that a machine is serialized to/from.
+/// Combining this with the actual state of the system will return a machine
+pub struct MachineDescription {
+    /// The name of the machine. Doesn't need to be unique but is what humans will be presented.
+    pub name: String,
+
+    /// An optional description of the Machine.
+    #[serde(
+        default,
+        skip_serializing_if = "Option::is_none",
+        deserialize_with = "deser_option"
+    )]
+    pub description: Option<String>,
+
+    #[serde(
+        default,
+        skip_serializing_if = "Option::is_none",
+        deserialize_with = "deser_option"
+    )]
+    pub wiki: Option<String>,
+
+    #[serde(
+        default,
+        skip_serializing_if = "Option::is_none",
+        deserialize_with = "deser_option"
+    )]
+    pub category: Option<String>,
+
+    /// The permission required
+    #[serde(flatten)]
+    pub privs: PrivilegesBuf,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct Config {
+    /// A list of address/port pairs to listen on.
+    pub listens: Vec<Listen>,
+
+    /// Machine descriptions to load
+    pub machines: HashMap<String, MachineDescription>,
+
+    /// Actors to load and their configuration options
+    pub actors: HashMap<String, ModuleConfig>,
+
+    /// Initiators to load and their configuration options
+    pub initiators: HashMap<String, ModuleConfig>,
+
+    pub mqtt_url: String,
+
+    pub actor_connections: Vec<(String, String)>,
+    pub init_connections: Vec<(String, String)>,
+
+    pub db_path: PathBuf,
+    pub auditlog_path: PathBuf,
+
+    pub roles: HashMap<String, Role>,
+
+    #[serde(flatten)]
+    pub tlsconfig: TlsListen,
+
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub tlskeylog: Option<PathBuf>,
+
+    #[serde(default, skip)]
+    pub verbosity: isize,
+
+    #[serde(default, skip)]
+    pub logging: LogConfig,
+}
+
+impl Config {
+    pub fn is_quiet(&self) -> bool {
+        self.verbosity < 0
+    }
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct ModuleConfig {
+    pub module: String,
+    pub params: HashMap<String, String>,
+}
+
+pub(crate) fn deser_option<'de, D, T>(d: D) -> std::result::Result<Option<T>, D::Error>
+where
+    D: serde::Deserializer<'de>,
+    T: serde::Deserialize<'de>,
+{
+    Ok(T::deserialize(d).ok())
+}
+
+impl Default for Config {
+    fn default() -> Self {
+        let mut actors: HashMap<String, ModuleConfig> = HashMap::new();
+        let mut initiators: HashMap<String, ModuleConfig> = HashMap::new();
+        let machines = HashMap::new();
+
+        actors.insert(
+            "Actor".to_string(),
+            ModuleConfig {
+                module: "Shelly".to_string(),
+                params: HashMap::new(),
+            },
+        );
+        initiators.insert(
+            "Initiator".to_string(),
+            ModuleConfig {
+                module: "TCP-Listen".to_string(),
+                params: HashMap::new(),
+            },
+        );
+
+        Config {
+            listens: vec![Listen {
+                address: "127.0.0.1".to_string(),
+                port: None,
+            }],
+            actors,
+            initiators,
+            machines,
+            mqtt_url: "tcp://localhost:1883".to_string(),
+            actor_connections: vec![("Testmachine".to_string(), "Actor".to_string())],
+            init_connections: vec![("Initiator".to_string(), "Testmachine".to_string())],
+
+            db_path: PathBuf::from("/run/bffh/database"),
+            auditlog_path: PathBuf::from("/var/log/bffh/audit.log"),
+            roles: HashMap::new(),
+
+            tlsconfig: TlsListen {
+                certfile: PathBuf::from("./bffh.crt"),
+                keyfile: PathBuf::from("./bffh.key"),
+                ..Default::default()
+            },
+
+            tlskeylog: None,
+            verbosity: 0,
+            logging: LogConfig::default(),
+        }
+    }
+}

bffhd/config/mod.rs

@@ -1,157 +1,50 @@
-use std::collections::HashMap;
+use std::path::Path;
-use std::default::Default;
-use std::path::PathBuf;
 
-use serde::{Deserialize, Serialize};
+use miette::Diagnostic;
+use thiserror::Error;
 
+pub(crate) use dhall::deser_option;
+pub use dhall::{Config, MachineDescription, ModuleConfig};
 mod dhall;
-pub use dhall::read_config_file as read;
 
-use crate::authorization::permissions::PrivilegesBuf;
+#[derive(Debug, Error, Diagnostic)]
-use crate::authorization::roles::Role;
+pub enum ConfigError {
-use crate::capnp::{Listen, TlsListen};
+    #[error("The config file '{0}' does not exist or is not readable")]
-use crate::logging::LogConfig;
+    #[diagnostic(
-
+        code(config::notfound),
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+        help("Make sure the config file and the directory it's in are readable by the user running bffh")
-#[serde(deny_unknown_fields)]
-/// A description of a machine
-///
-/// This is the struct that a machine is serialized to/from.
-/// Combining this with the actual state of the system will return a machine
-pub struct MachineDescription {
-    /// The name of the machine. Doesn't need to be unique but is what humans will be presented.
-    pub name: String,
-
-    /// An optional description of the Machine.
-    #[serde(
-        default,
-        skip_serializing_if = "Option::is_none",
-        deserialize_with = "deser_option"
     )]
-    pub description: Option<String>,
+    NotFound(String),
-
+    #[error("The path '{0}' does not point to a file")]
-    #[serde(
+    #[diagnostic(
-        default,
+        code(config::notafile),
-        skip_serializing_if = "Option::is_none",
+        help("The config must be a file in the dhall format")
-        deserialize_with = "deser_option"
     )]
-    pub wiki: Option<String>,
+    NotAFile(String),
-
+    #[error("failed to parse config: {0}")]
-    #[serde(
+    #[diagnostic(code(config::parse))]
-        default,
+    Parse(
-        skip_serializing_if = "Option::is_none",
+        #[from]
-        deserialize_with = "deser_option"
+        #[source]
-    )]
+        serde_dhall::Error,
-    pub category: Option<String>,
+    ),
-
-    /// The permission required
-    #[serde(flatten)]
-    pub privs: PrivilegesBuf,
 }
 
-#[derive(Debug, Clone, Serialize, Deserialize)]
+pub fn read(file: impl AsRef<Path>) -> Result<Config, ConfigError> {
-pub struct Config {
+    let path = file.as_ref();
-    /// A list of address/port pairs to listen on.
+    if !path.exists() {
-    pub listens: Vec<Listen>,
+        return Err(ConfigError::NotFound(path.to_string_lossy().to_string()));
-
-    /// Machine descriptions to load
-    pub machines: HashMap<String, MachineDescription>,
-
-    /// Actors to load and their configuration options
-    pub actors: HashMap<String, ModuleConfig>,
-
-    /// Initiators to load and their configuration options
-    pub initiators: HashMap<String, ModuleConfig>,
-
-    pub mqtt_url: String,
-
-    pub actor_connections: Vec<(String, String)>,
-    pub init_connections: Vec<(String, String)>,
-
-    pub db_path: PathBuf,
-    pub auditlog_path: PathBuf,
-
-    pub roles: HashMap<String, Role>,
-
-    #[serde(flatten)]
-    pub tlsconfig: TlsListen,
-
-    #[serde(default, skip_serializing_if = "Option::is_none")]
-    pub tlskeylog: Option<PathBuf>,
-
-    #[serde(default, skip)]
-    pub verbosity: isize,
-
-    #[serde(default, skip)]
-    pub logging: LogConfig,
     }
-
+    if !path.is_file() {
-impl Config {
+        return Err(ConfigError::NotAFile(path.to_string_lossy().to_string()));
-    pub fn is_quiet(&self) -> bool {
+    }
-        self.verbosity < 0
+    let mut config = dhall::read_config_file(file)?;
-    }
+    for (envvar, value) in std::env::vars() {
-}
+        match envvar.as_str() {
-
+            // Do things like this?
-#[derive(Debug, Clone, Serialize, Deserialize)]
+            // "BFFH_LOG" => config.logging.filter = Some(value),
-pub struct ModuleConfig {
+            _ => {}
-    pub module: String,
-    pub params: HashMap<String, String>,
-}
-
-pub(crate) fn deser_option<'de, D, T>(d: D) -> std::result::Result<Option<T>, D::Error>
-where
-    D: serde::Deserializer<'de>,
-    T: serde::Deserialize<'de>,
-{
-    Ok(T::deserialize(d).ok())
-}
-
-impl Default for Config {
-    fn default() -> Self {
-        let mut actors: HashMap<String, ModuleConfig> = HashMap::new();
-        let mut initiators: HashMap<String, ModuleConfig> = HashMap::new();
-        let machines = HashMap::new();
-
-        actors.insert(
-            "Actor".to_string(),
-            ModuleConfig {
-                module: "Shelly".to_string(),
-                params: HashMap::new(),
-            },
-        );
-        initiators.insert(
-            "Initiator".to_string(),
-            ModuleConfig {
-                module: "TCP-Listen".to_string(),
-                params: HashMap::new(),
-            },
-        );
-
-        Config {
-            listens: vec![Listen {
-                address: "127.0.0.1".to_string(),
-                port: None,
-            }],
-            actors,
-            initiators,
-            machines,
-            mqtt_url: "tcp://localhost:1883".to_string(),
-            actor_connections: vec![("Testmachine".to_string(), "Actor".to_string())],
-            init_connections: vec![("Initiator".to_string(), "Testmachine".to_string())],
-
-            db_path: PathBuf::from("/run/bffh/database"),
-            auditlog_path: PathBuf::from("/var/log/bffh/audit.log"),
-            roles: HashMap::new(),
-
-            tlsconfig: TlsListen {
-                certfile: PathBuf::from("./bffh.crt"),
-                keyfile: PathBuf::from("./bffh.key"),
-                ..Default::default()
-            },
-
-            tlskeylog: None,
-            verbosity: 0,
-            logging: LogConfig::default(),
         }
     }
+    Ok(config)
 }

bin/bffhd/main.rs

@@ -135,7 +135,7 @@ fn main() -> miette::Result<()> {
         }
     }
 
-    let mut config = config::read(&PathBuf::from_str(configpath).unwrap()).unwrap();
+    let mut config = config::read(&PathBuf::from_str(configpath).unwrap())?;
 
     if matches.is_present("dump") {
         return Err(miette::miette!("DB Dumping is currently not implemented, except for the users db, using `--dump-users`"));