From 64998205402c11cd4ea126e71524ce712e5faba1 Mon Sep 17 00:00:00 2001
From: Sergi Delgado Segura <sergi.delgado.s@gmail.com>
Date: Fri, 20 Mar 2020 21:12:15 +0100
Subject: [PATCH] Adds ConfigLoader to handle loading configurations
 parameters. Switches from conf.py to .conf files

---
 common/config_loader.py | 101 ++++++++++++++++++++++++++++++++++++++++
 teos/template.conf      |  22 +++++++++
 2 files changed, 123 insertions(+)
 create mode 100644 common/config_loader.py
 create mode 100644 teos/template.conf

diff --git a/common/config_loader.py b/common/config_loader.py
new file mode 100644
index 0000000..e088a83
--- /dev/null
+++ b/common/config_loader.py
@@ -0,0 +1,101 @@
+import os
+import configparser
+
+from common.tools import extend_paths
+
+
+class ConfigLoader:
+    """
+     The :class:`ConfigLoader` class is in charge of loading all the configuration parameters to create a config dict
+     that can be used to set all configurable parameters of the system.
+
+    Args:
+        data_dir (:obj:`str`): the path to the data directory where the configuration file may be found.
+        default_conf (:obj:`dict`): a dictionary populated with the default configuration params and the expected types.
+            The format is as follows:
+
+            {"field0": {"value": value_from_conf_file, "type": expected_type, ...}}
+
+        command_line_conf (:obj:`dict`): a dictionary containing the command line parameters that may replace the
+            ones in default / config file.
+
+    Attributes:
+        data_dir (:obj:`str`): the path to the data directory where the configuration file may be found.
+        conf_file_path (:obj:`str`): the path to the config file (the file may not exist).
+        conf_fields (:obj:`dict`): a dictionary populated with the configuration params and the expected types.
+            follows the same format as default_conf.
+        command_line_conf (:obj:`dict`): a dictionary containing the command line parameters that may replace the
+            ones in default / config file.
+    """
+
+    def __init__(self, data_dir, default_conf, command_line_conf):
+        self.data_dir = data_dir
+        self.conf_file_path = self.data_dir + "teos.conf"
+        self.conf_fields = default_conf
+        self.command_line_conf = command_line_conf
+
+    def build_config(self):
+        """
+        Builds a config dictionary from command line, config file and default configuration parameters.
+
+        The priority if as follows:
+            - command line
+            - config file
+            - defaults
+
+        Returns:
+            obj:`dict`: a dictionary containing all the configuration parameters.
+
+        """
+
+        if os.path.exists(self.conf_file_path):
+            file_config = configparser.ConfigParser()
+            file_config.read(self.conf_file_path)
+
+            if file_config:
+                for sec in file_config.sections():
+                    for k, v in file_config.items(sec):
+                        k_upper = k.upper()
+                        if k_upper in self.conf_fields:
+                            if self.conf_fields[k_upper]["type"] == int:
+                                self.conf_fields[k_upper]["value"] = int(v)
+                            else:
+                                self.conf_fields[k_upper]["value"] = v
+
+        # Override the command line parameters to the defaults / conf file
+        for k, v in self.command_line_conf.items():
+            self.conf_fields[k]["value"] = v
+
+        # Extend relative paths
+        extend_paths(self.data_dir, self.conf_fields)
+
+        # Sanity check fields and build config dictionary
+        config = self.create_config_dict()
+
+        return config
+
+    def create_config_dict(self):
+        """
+        Checks that the configuration fields (self.conf_fields) have the right type and creates a config dict if so.
+
+        Returns:
+            :obj:`dict`: A dictionary with the same keys as the provided one, but containing only the "value" field as
+            value if the provided ``conf_fields`` where correct.
+
+        Raises:
+            ValueError: If any of the dictionary elements does not have the expected type
+        """
+
+        conf_dict = {}
+
+        for field in self.conf_fields:
+            value = self.conf_fields[field]["value"]
+            correct_type = self.conf_fields[field]["type"]
+
+            if (value is not None) and isinstance(value, correct_type):
+                conf_dict[field] = value
+            else:
+                err_msg = "{} variable in config is of the wrong type".format(field)
+                raise ValueError(err_msg)
+
+        return conf_dict
diff --git a/teos/template.conf b/teos/template.conf
new file mode 100644
index 0000000..e8f5b76
--- /dev/null
+++ b/teos/template.conf
@@ -0,0 +1,22 @@
+[bitcoind]
+btc_rpc_user = "user"
+btc_rpc_passwd = "passwd"
+btc_rpc_connect = "localhost"
+btc_rpc_port = 8332
+btc_network = "mainnet"
+
+# [zmq]
+feed_protocol = "tcp"
+feed_connect = "127.0.0.1"
+feed_port = 28332
+
+[teos]
+max_appointments = 100
+expiry_delta = 6
+min_to_self_delay = 20
+
+# [chain monitor]
+polling_delta = 60
+block_window_size = 10
+
+