casper-node 0.6.3

//! Configuration file management.
//!
//! Configuration for the node is loaded from TOML files, but all configuration values have sensible
//! defaults.
//!
//! The binary offers an option to generate a configuration from defaults for editing. I.e. running
//! the following will dump a default configuration file to stdout:
//! ```
//! cargo run --release -- generate-config
//! ```
//!
//! # Adding a configuration section
//!
//! When adding a section to the configuration, ensure that
//!
//! * it has an entry in the root configuration [`Config`](struct.Config.html),
//! * `Default` is implemented (derived or manually) with sensible defaults,
//! * it is completely documented.
//! * it is annotated with `#[serde(deny_unknown_fields)]` to ensure config files and command-line
//!   overrides contain valid keys.

use std::path::Path;

use anyhow::Context;
use serde::{de::DeserializeOwned, Serialize};

use casper_node::utils::read_file;

/// Loads a TOML-formatted configuration from a given file.
pub fn load_from_file<P: AsRef<Path>, C: DeserializeOwned>(config_path: P) -> anyhow::Result<C> {
    let path_ref = config_path.as_ref();
    let config: C = toml::from_slice(
        &read_file(path_ref).with_context(|| "failed to read configuration file")?,
    )
    .with_context(|| format!("Failed to parse configuration file {}", path_ref.display()))?;
    Ok(config)
}

/// Creates a TOML-formatted string from a given configuration.
pub fn to_string<C: Serialize>(cfg: &C) -> anyhow::Result<String> {
    toml::to_string_pretty(cfg).with_context(|| "Failed to serialize default configuration")
}

#[cfg(test)]
mod tests {
    use casper_node::reactor::validator::Config;

    #[test]
    fn example_config_should_parse() {
        let config_path = format!(
            "{}/../resources/local/config.toml",
            env!("CARGO_MANIFEST_DIR")
        );
        let _config: Config = super::load_from_file(config_path).unwrap();
    }
}