hoprd_cfg/
hoprd-cfg.rs

1//! Hoprd configuration utility `hoprd-cfg`
2//!
3//! This executable offers functionalities associated with configuration management
4//! of the HOPRd node configuration.
5//!
6//! ## Help
7//! ```shell
8//! ➜   hoprd-cfg --help
9//! Usage: hoprd-cfg [OPTIONS]
10//!
11//! Options:
12//!   -d, --default              Print the default YAML config for the hoprd
13//!   -v, --validate <VALIDATE>  Validate the config at this path
14//!   -h, --help                 Print help
15//!   -V, --version              Print version
16//! ```
17//!
18//! ## Dump a default configuration file
19//! ```shell
20//! ➜   hoprd-cfg -d     
21//! hopr:
22//! host:
23//!   address: !IPv4 0.0.0.0
24//!   port: 9091
25//!
26//! ... <snip>
27//!
28//! ```
29//!
30//! ## Validate an existing configuration YAML
31//!
32//! ```shell
33//! ➜   hoprd-cfg -v /tmp/bad-config.yaml
34//! Error: ValidationError("The specified network 'anvil-localhost' is not listed as supported ([\"debug-staging\", \"dufour\", \"rotsee\"])")
35//!
36//! ➜   echo $?
37//! 1
38//! ```
39
40use std::path::PathBuf;
41
42use clap::Parser;
43
44use hoprd::config::HoprdConfig;
45use validator::Validate;
46
47#[derive(Parser, Default)]
48#[clap(author, version, about, long_about = None)]
49struct CliArgs {
50    /// Print the default YAML config for the hoprd
51    #[clap(short = 'd', long, conflicts_with = "validate")]
52    default: bool,
53    /// Validate the config at this path
54    #[clap(short, long, conflicts_with = "default")]
55    validate: Option<PathBuf>,
56}
57
58fn main() -> Result<(), hoprd::errors::HoprdError> {
59    let args = CliArgs::parse();
60
61    if args.default {
62        println!(
63            "{}",
64            serde_yaml::to_string(&hoprd::config::HoprdConfig::default())
65                .map_err(|e| hoprd::errors::HoprdError::ConfigError(e.to_string()))?
66        );
67    } else if let Some(cfg_path) = args.validate {
68        let cfg_path = cfg_path
69            .into_os_string()
70            .into_string()
71            .map_err(|_| hoprd::errors::HoprdError::ConfigError("file path not convertible".into()))?;
72
73        let yaml_configuration = hopr_platform::file::native::read_to_string(&cfg_path)
74            .map_err(|e| hoprd::errors::HoprdError::ConfigError(e.to_string()))?;
75
76        let cfg: HoprdConfig = serde_yaml::from_str(&yaml_configuration)
77            .map_err(|e| hoprd::errors::HoprdError::SerializationError(e.to_string()))?;
78
79        if !cfg
80            .hopr
81            .chain
82            .protocols
83            .supported_networks(hopr_lib::constants::APP_VERSION_COERCED)
84            .iter()
85            .any(|network| network == &cfg.hopr.chain.network)
86        {
87            return Err(hoprd::errors::HoprdError::ValidationError(format!(
88                "The specified network '{}' is not listed as supported ({:?})",
89                cfg.hopr.chain.network,
90                cfg.hopr
91                    .chain
92                    .protocols
93                    .supported_networks(hopr_lib::constants::APP_VERSION_COERCED)
94            )));
95        };
96
97        if let Err(e) = cfg.validate() {
98            return Err(hoprd::errors::HoprdError::ValidationError(e.to_string()));
99        };
100    }
101
102    Ok(())
103}
hoprd_cfg/hoprd-cfg.rs

hoprd_cfg/
hoprd-cfg.rs
