Merge pull request #24 from IBM/v6.1

add ConfigManager class

Author: Helene

source/confParser.py

@@ -47,8 +47,8 @@ def checkTLSsettings(args):
 def getSettings(argv):
     settings = {}
     msg = ''
+    defaults = ConfigManager().defaults
     args, msg = parse_cmd_args(argv)
-    defaults = parse_defaults_from_config_file()
     if args and defaults:
         settings = merge_defaults_and_args(defaults, args)
     elif args:
@@ -71,38 +71,91 @@ def merge_defaults_and_args(defaults, args):
     return brConfig
 
 
-def parse_defaults_from_config_file(fileName='config.ini'):
-    '''parse default parameters from a config file'''
-    defaults = {}
-    dirname, filename = os.path.split(os.path.abspath(__file__))
-    conf_file = os.path.join(dirname, fileName)
-    if os.path.isfile(conf_file):
-        config = configparser.ConfigParser()
-        config.optionxform = str
-        config.read(conf_file)
-        for sect in config.sections():
-            for name, value in config.items(sect):
+class Singleton(type):
+    _inst = {}
+
+    def __call__(clazz, *args, **kwargs):
+        if clazz not in clazz._inst:
+            clazz._inst[clazz] = super(Singleton, clazz).__call__(*args, **kwargs)
+        return clazz._inst[clazz]
+
+
+class ConfigManager(object, metaclass=Singleton):
+    ''' A singleton class managing the application configuration defaults '''
+
+    def __init__(self):
+        self.__sectOptions = {}
+        self.__defaults = {}
+        self.configFiles = ['config.ini']
+
+    @property
+    def options(self):
+        if not self.__sectOptions:
+            self.__sectOptions = self.reload()
+        return self.__sectOptions
+
+    @property
+    def defaults(self):
+        if not self.__defaults:
+            self.__defaults = self.parse_defaults()
+        return self.__defaults
+
+    def reload(self):
+        options = {}
+        self.__sectOptions = {}
+        if self.configFiles:
+            for config in self.configFiles:
+                options.update(self.readConfigFile(config))
+        return options
+
+    def readConfigFile(self, fileName):
+        '''parse config file and store values in a dict {section:{ key: value}}'''
+        options = {}
+        dirname, filename = os.path.split(os.path.abspath(__file__))
+        conf_file = os.path.join(dirname, fileName)
+        if os.path.isfile(conf_file):
+            try:
+                config = configparser.ConfigParser()
+                config.optionxform = str
+                config.read(conf_file)
+                for sect in config.sections():
+                    options[sect] = {}
+                    for name, value in config.items(sect):
+                        if value.isdigit():
+                            value = int(value)
+                        options[sect][name] = value
+            except Exception as e:
+                print(f"cannot read config file {fileName} Exception {e}")
+        else:
+            print(f"cannot find config file {fileName} in {dirname}")
+        return options
+
+    def parse_defaults(self):
+        '''parse all sections parameters to a simple key:value dict'''
+        defaults = {}
+        for sect_name, sect_values in self.options.items():
+            for name, value in sect_values.items():
                 defaults[name] = value
-    return defaults
+        return defaults
 
 
 def parse_cmd_args(argv):
     '''parse input parameters'''
 
     parser = argparse.ArgumentParser('python zimonGrafanaIntf.py')
-    parser.add_argument('-s', '--server', action="store", default='localhost',
-                        help='Host name or ip address of the ZIMon collector (Default: 127.0.0.1) \
+    parser.add_argument('-s', '--server', action="store", default=None,
+                        help='Host name or ip address of the ZIMon collector (Default from config.ini: 127.0.0.1) \
                         NOTE: Per default ZIMon does not accept queries from remote machines. \
                         To run the bridge from outside of the ZIMon collector, you need to modify ZIMon queryinterface settings (\'ZIMonCollector.cfg\')')
-    parser.add_argument('-P', '--serverPort', action="store", type=int, choices=[9084, 9094], default=9084,
-                        help='ZIMon collector port number (Default: 9084) \
+    parser.add_argument('-P', '--serverPort', action="store", type=int, choices=[9084, 9094], default=None,
+                        help='ZIMon collector port number (Default from config.ini: 9084) \
                         NOTE: In some environments, for better bridge performance the usage of the multi-threaded port 9094 could be helpful.\
                         In this case make sure the \'query2port = \"9094\"\' is enabled in the ZIMon queryinterface settings (\'ZIMonCollector.cfg\')')
-    parser.add_argument('-l', '--logPath', action="store", default="/var/log/ibm_bridge_for_grafana", help='location path of the log file (Default: /var/log/ibm_bridge_for_grafana')
-    parser.add_argument('-f', '--logFile', action="store", default="zserver.log", help='Name of the log file (Default: zserver.log')
-    parser.add_argument('-c', '--logLevel', action="store", type=int, default=15,
-                        help='log level. Available levels: 10 (DEBUG), 15 (MOREINFO), 20 (INFO), 30 (WARN), 40 (ERROR) (Default: 15)')
-    parser.add_argument('-p', '--port', action="store", type=int, choices=[4242, 8443], default=4242, help='port number listening on for HTTP(S) connections (Default: 4242)')
+    parser.add_argument('-l', '--logPath', action="store", default=None, help='location path of the log file (Default from config.ini: \'/var/log/ibm_bridge_for_grafana\')')
+    parser.add_argument('-f', '--logFile', action="store", default=None, help='Name of the log file (Default from config.ini: zserver.log')
+    parser.add_argument('-c', '--logLevel', action="store", type=int, default=None,
+                        help='log level. Available levels: 10 (DEBUG), 15 (MOREINFO), 20 (INFO), 30 (WARN), 40 (ERROR) (Default from config.ini: 15)')
+    parser.add_argument('-p', '--port', action="store", type=int, choices=[4242, 8443], default=None, help='port number listening on for HTTP(S) connections (Default from config.ini: 4242)')
     parser.add_argument('-t', '--tlsKeyPath', action="store", default=None, help='Directory path of tls privkey.pem and cert.pem file location (Required only for HTTPS port 8443)')
     parser.add_argument('-k', '--tlsKeyFile', action="store", default=None, help='Name of TLS key file, f.e.: privkey.pem (Required only for HTTPS port 8443)')
     parser.add_argument('-m', '--tlsCertFile', action="store", default=None, help='Name of TLS certificate file, f.e.: cert.pem (Required only for HTTPS port 8443)')

source/config.ini

@@ -30,8 +30,8 @@ serverPort = 9084
 # Directory where the bridge can store logs
 logPath = /var/log/ibm_bridge_for_grafana
 
-# log level 10 (DEBUG), 20 (INFO), 30 (WARN), 40 (ERROR) (Default: 20)
-logLevel = 20
+# log level 10 (DEBUG), 15 (MOREINFO), 20 (INFO), 30 (WARN), 40 (ERROR) (Default: 15)
+logLevel = 15
 
 # Log file name (Default: zserver.log)
 logFile = zserver.log

tests/test_cli_parser.py

@@ -4,13 +4,14 @@
 
 
 def my_setup():
-    global a, b, c, d, e, f
+    global a, b, c, d, e, f, g
     a = ['-p', '8443', '-t', '/etc/my_tls']
     b = ['-a']
     c = ['-a', 'abc']
     d = ['-c', '10', '-v', '/opt/registry/certs']
     e = ['-c', '10', '-t', '/opt/registry/certs']
     f = ['-c', '10', '-s', '9.155.108.199', '-p', '8443', '-t', '/opt/registry/certs', '--tlsKeyFile', 'privkey.pem', '--tlsCertFile', 'cert.pem']
+    g = ['-p', '4242', '-P', '9084']
 
 
 def test_case01():
@@ -34,17 +35,19 @@ def test_case03():
     assert all(item in elements for item in mandatoryItems)
 
 
+@with_setup(my_setup)
 def test_case04():
-    args, msg = parse_cmd_args([])
+    args, msg = parse_cmd_args(g)
     result = vars(args)
-    value = int(result['port'])
-    assert value == 4242
+    assert isinstance(result['port'], int)
+    assert result['port'] == 4242
 
 
+@with_setup(my_setup)
 def test_case05():
-    args, msg = parse_cmd_args([])
+    args, msg = parse_cmd_args(g)
     result = vars(args)
-    assert int(result['port']) == 4242 and int(result['serverPort']) == 9084
+    assert result['port'] == 4242 and result['serverPort'] == 9084
 
 
 @with_setup(my_setup)

tests/test_configManager.py

@@ -0,0 +1,69 @@
+from source.confParser import ConfigManager
+
+
+def test_case01():
+    cm = ConfigManager()
+    result = cm.readConfigFile('config.ini')
+    assert isinstance(result, dict)
+
+
+def test_case02():
+    cm = ConfigManager()
+    result = cm.readConfigFile('config.ini')
+    assert len(result.keys()) > 0
+
+
+def test_case03():
+    cm = ConfigManager()
+    result = cm.readConfigFile('config.ini')
+    assert 'tls' in result.keys()
+
+
+def test_case04():
+    cm = ConfigManager()
+    result = cm.readConfigFile('config.ini')
+    connection = result['connection']
+    assert len(connection) > 0
+    assert isinstance(connection, dict)
+    assert len(connection) > 0
+    assert 'port' in connection.keys()
+
+
+def test_case05():
+    cm = ConfigManager()
+    result = cm.parse_defaults()
+    assert isinstance(result, dict)
+
+
+def test_case06():
+    cm = ConfigManager()
+    result = cm.parse_defaults()
+    assert len(result.keys()) > 0
+
+
+def test_case07():
+    cm = ConfigManager()
+    result = cm.parse_defaults()
+    result1 = cm.defaults
+    assert len(result) == len(result1)
+
+
+def test_case08():
+    cm = ConfigManager()
+    result = cm.defaults
+    elements = list(result.keys())
+    mandatoryItems = ['port', 'serverPort']
+    assert all(item in elements for item in mandatoryItems)
+
+
+def test_case09():
+    cm = ConfigManager()
+    result = cm.defaults
+    value = int(result['port'])
+    assert value == 4242
+
+
+def test_case10():
+    cm = ConfigManager()
+    result = cm.defaults
+    assert int(result['port']) == 4242 and int(result['serverPort']) == 9084

tests/test_params.py

@@ -1,52 +1,33 @@
-from source.confParser import parse_defaults_from_config_file, merge_defaults_and_args, parse_cmd_args
+from source.confParser import ConfigManager, merge_defaults_and_args, parse_cmd_args
 from nose.tools import with_setup
 
 
 def my_setup():
     global a, b, c, d, e
-    a = parse_defaults_from_config_file()
+    a = ConfigManager().defaults
     b, c = parse_cmd_args([])
     d, e = parse_cmd_args(['-p', '8443', '-t', '/etc/my_tls'])
 
 
+@with_setup(my_setup)
 def test_case01():
-    result = parse_defaults_from_config_file()
-    assert isinstance(result, dict)
-
-
-def test_case02():
-    result = parse_defaults_from_config_file()
+    result = merge_defaults_and_args(a, b)
     assert len(result.keys()) > 0
-
-
-def test_case03():
-    result = parse_defaults_from_config_file()
-    elements = list(result.keys())
-    mandatoryItems = ['port', 'serverPort']
-    assert all(item in elements for item in mandatoryItems)
-
-
-def test_case04():
-    result = parse_defaults_from_config_file()
-    value = int(result['port'])
-    assert value == 4242
-
-
-def test_case05():
-    result = parse_defaults_from_config_file()
-    assert int(result['port']) == 4242 and int(result['serverPort']) == 9084
+    assert 'port' in result.keys()
+    assert 'serverPort' in result.keys()
 
 
 @with_setup(my_setup)
-def test_case06():
+def test_case02():
     result = merge_defaults_and_args(a, b)
     assert len(result.keys()) > 0
-    assert 'port' in result.keys()
-    assert 'serverPort' in result.keys()
+    assert 'logLevel' in result.keys()
+    assert isinstance(result.get('logLevel'), int)
+    assert result.get('logLevel') == 15
 
 
 @with_setup(my_setup)
-def test_case07():
+def test_case03():
     result = merge_defaults_and_args(a, d)
     assert len(result.keys()) > 0
     assert 'port' in result.keys()