refacto: simplify macros

Author: sfauvel

internal/mithril-cli-helper/src/source_config.rs

@@ -1,27 +1,16 @@
 //! Utilities to register config parameters.
 
-/// Register a parameter in the config map.
-#[macro_export]
-macro_rules! register {
-    ( $map:ident, $namespace:expr, $command: ident, $value:expr ) => {{
-        $map.insert(
-            stringify!($command).to_string(),
-            config::Value::new(Some($namespace), $value),
-        );
-    }};
-}
-
 /// Register a optional parameter in the config map when it's not None.
 #[macro_export]
 macro_rules! register_config_value_option {
     ( $map:ident, $namespace:expr, $self:ident.$command:ident ) => {{
         if let Some(value) = $self.$command.clone() {
-            register!($map, $namespace, $command, value);
+            register_config_value!($map, $namespace, $command = value);
         }
     }};
     ( $map:ident, $namespace:expr, $self:ident.$command:ident, $mapping:expr ) => {{
         if let Some(value) = $self.$command.clone() {
-            register!($map, $namespace, $command, $mapping(value));
+            register_config_value!($map, $namespace, $command = $mapping(value));
         }
     }};
 }
@@ -31,19 +20,33 @@ macro_rules! register_config_value_option {
 macro_rules! register_config_value_bool {
     ( $map:ident, $namespace:expr, $self:ident.$command:ident ) => {{
         if $self.$command {
-            register!($map, $namespace, $command, true);
+            register_config_value!($map, $namespace, $command = true);
         }
     }};
 }
 
-/// Register a parameter in the config map.
+/// Register a parameter in the config map using the identifier as key.
+/// Example:
+///     register_config_value(map, namespace, self.identifier)
+///
+/// The same macro, with a different syntax, is used to insert the given value without transformation.
+/// Iit is designed to be used by other macros.
+/// Example:
+///     register_config_value!(map, namespace, identifier = value)
 #[macro_export]
 macro_rules! register_config_value {
     ( $map:ident, $namespace:expr, $self:ident.$command:ident ) => {{
-        register!($map, $namespace, $command, $self.$command);
+        register_config_value!($map, $namespace, $command = $self.$command);
     }};
     ( $map:ident, $namespace:expr, $self:ident.$command:ident, $mapping:expr ) => {{
-        register!($map, $namespace, $command, $mapping($self.$command));
+        register_config_value!($map, $namespace, $command = $mapping($self.$command));
+    }};
+
+    ( $map:ident, $namespace:expr, $command:ident = $value:expr ) => {{
+        $map.insert(
+            stringify!($command).to_string(),
+            config::Value::new(Some($namespace), $value),
+        );
     }};
 }
 
@@ -53,13 +56,12 @@ mod tests {
     use std::collections::HashMap;
 
     #[test]
-    fn test_register_macro() {
+    fn test_register_config_value_macro_with_the_value() {
         let mut map = HashMap::new();
-        register!(
+        register_config_value!(
             map,
             &"namespace".to_string(),
-            server_ip,
-            Some("value_server_ip".to_string())
+            server_ip = Some("value_server_ip".to_string())
         );
 
         let expected = HashMap::from([(

mithril-aggregator/src/commands/mod.rs

@@ -7,7 +7,7 @@ mod tools_command;
 use anyhow::anyhow;
 use clap::{CommandFactory, Parser, Subcommand};
 use config::{builder::DefaultState, ConfigBuilder, Map, Source, Value};
-use mithril_cli_helper::{register, register_config_value_option};
+use mithril_cli_helper::{register_config_value, register_config_value_option};
 use mithril_common::StdResult;
 use mithril_doc::{Documenter, DocumenterDefault, StructDoc};
 use slog::{debug, Level, Logger};

mithril-aggregator/src/commands/serve_command.rs

@@ -13,7 +13,9 @@ use config::{builder::DefaultState, ConfigBuilder, Map, Source, Value};
 use slog::{crit, debug, info, warn, Logger};
 use tokio::{sync::oneshot, task::JoinSet};
 
-use mithril_cli_helper::{register, register_config_value_bool, register_config_value_option};
+use mithril_cli_helper::{
+    register_config_value, register_config_value_bool, register_config_value_option,
+};
 use mithril_common::StdResult;
 use mithril_metric::MetricsServer;
 

mithril-aggregator/src/configuration.rs

@@ -5,7 +5,7 @@ use std::collections::{BTreeSet, HashMap};
 use std::path::PathBuf;
 use std::str::FromStr;
 
-use mithril_cli_helper::{register, register_config_value};
+use mithril_cli_helper::register_config_value;
 use mithril_common::chain_observer::ChainObserverType;
 use mithril_common::crypto_helper::ProtocolGenesisSigner;
 use mithril_common::entities::{

mithril-signer/src/configuration.rs

@@ -4,7 +4,7 @@ use mithril_doc::{Documenter, DocumenterDefault, StructDoc};
 use serde::{Deserialize, Serialize};
 use std::{path::PathBuf, sync::Arc};
 
-use mithril_cli_helper::{register, register_config_value};
+use mithril_cli_helper::register_config_value;
 use mithril_common::{
     chain_observer::ChainObserver,
     crypto_helper::tests_setup,