initial commit

Signed-off-by: hwassman <[email protected]>

Author: Helene

source/confParser.py

@@ -93,12 +93,13 @@ def checkCAsettings(args):
 
 def getSettings(argv):
     settings = {}
-    defaults = ConfigManager().defaults
     args, msg = parse_cmd_args(argv)
+    customFile = vars(args).get('configFile', None)
+    defaults = ConfigManager(customFile).defaults
     if args and defaults:
         settings = merge_defaults_and_args(defaults, args)
     elif args:
-        settings = args
+        settings = vars(args)
     else:
         return None, msg
     # check application port
@@ -143,41 +144,25 @@ def merge_defaults_and_args(defaults, args):
 class ConfigManager(object, metaclass=Singleton):
     ''' A singleton class managing the application configuration defaults '''
 
-    def __init__(self):
-        self.__sectOptions = {}
+    def __init__(self, custom_config_file=None):
         self.__defaults = {}
-        self.configFiles = ['config.ini']
-
-    @property
-    def options(self):
-        if not self.__sectOptions:
-            self.__sectOptions = self.reload()
-        return self.__sectOptions
+        self.customFile = custom_config_file
+        self.templateFile = self.get_template_path()
 
     @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):
+        if os.path.isfile(fileName):
             try:
                 config = configparser.ConfigParser()
                 config.optionxform = str
-                config.read(conf_file)
+                config.read(fileName)
                 for sect in config.sections():
                     options[sect] = {}
                     for name, value in config.items(sect):
@@ -187,20 +172,48 @@ def readConfigFile(self, fileName):
             except Exception as e:
                 print(f"cannot read config file {fileName} Exception {e}")
         else:
-            print(f"cannot find config file {fileName} in {dirname}")
+            print(f"cannot find config file {fileName}")
         return options
 
+    def get_template_path(self):
+        '''parse config.ini to a simple key:value dict'''
+        dirname, _ = os.path.split(os.path.abspath(__file__))
+        return os.path.join(dirname, 'config.ini')
+
+    def parse_file(self, file):
+        '''parse file to a simple key:value dict'''
+        settings = {}
+        section_names = set()
+        sections = self.readConfigFile(file)
+        if sections:
+            section_names = set(sections.keys())
+            for _, sect_values in sections.items():
+                for name, value in sect_values.items():
+                    settings[name] = value
+        return section_names, settings
+
     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
+        """Retuns a dictionary of parameter names and values parsed from config file
+
+        If no custom config file provided the values will be parsed from template
+        file (.config.ini)
+        """
+
+        default_sections, defaults = self.parse_file(self.templateFile)
+        if not self.customFile:
+            return defaults
+
+        custom_sections, customs = self.parse_file(self.customFile)
+        sect = default_sections.intersection(custom_sections)
+        if not sect:
+            return defaults
+
+        defaults.update(customs)
         return defaults
 
 
 class Password(argparse.Action):
-    defaults = ConfigManager().defaults
+    # defaults = ConfigManager().defaults
 
     def __call__(self, parser, namespace, values, option_string):
         if values is None:
@@ -226,6 +239,8 @@ def parse_cmd_args(argv):
     parser.add_argument('-f', '--logFile', action="store", default=None,
                         help='Name of the log file (Default from config.ini: zserver.log). If no log file name specified \
     all traces will be printed out directly on the command line')
+    parser.add_argument('-F', '--configFile', action="store", default=None,
+                        help='Absolute path to the custom config file that should be used instead of the default config.ini file (optional)')
     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('-e', '--prometheus', action="store", default=None,

tests/test_configManager.py

@@ -1,36 +1,59 @@
+import os
 from source.confParser import ConfigManager
 from source.__version__ import __version__ as version
+from nose2.tools.decorators import with_setup
+
+
+def my_setup():
+    global path, customConfigFile
+    path = os.getcwd()
+    customConfigFile = 'custom.ini'
 
 
 def test_case01():
     cm = ConfigManager()
     result = cm.readConfigFile('config.ini')
     assert isinstance(result, dict)
+    if version < "8.0.7":
+        assert len(result.keys()) > 0
+        assert 'tls' in result.keys()
+    else:
+        assert len(result) == 0
 
 
 def test_case02():
     cm = ConfigManager()
-    result = cm.readConfigFile('config.ini')
+    file = cm.get_template_path()
+    result = cm.readConfigFile(file)
+    assert isinstance(result, dict)
     assert len(result.keys()) > 0
+    assert 'tls' in result.keys()
 
 
 def test_case03():
     cm = ConfigManager()
-    result = cm.readConfigFile('config.ini')
-    assert 'tls' in result.keys()
-
-
+    if version < "8.0.7":
+        result = cm.readConfigFile('config.ini')
+        connection = result['connection']
+        assert len(connection) > 0
+        assert isinstance(connection, dict)
+        assert len(connection) > 0
+        if version < "8.0":
+            assert 'port' in connection.keys()
+        else:
+            assert 'port' not in connection.keys()
+
+
+@with_setup(my_setup)
 def test_case04():
+    customFile = os.path.join(path, "tests", "test_data", customConfigFile)
+    print(customFile)
     cm = ConfigManager()
-    result = cm.readConfigFile('config.ini')
-    connection = result['connection']
-    assert len(connection) > 0
-    assert isinstance(connection, dict)
-    assert len(connection) > 0
-    if version < "8.0":
-        assert 'port' in connection.keys()
-    else:
-        assert 'port' not in connection.keys()
+    cm.customFile = customFile
+    print(cm.__dict__)
+    assert (cm.customFile == customFile)
+    result = cm.readConfigFile(cm.customFile)
+    assert 'tls' in result.keys()
 
 
 def test_case05():

tests/test_data/custom.ini

@@ -0,0 +1,111 @@
+##################### OpenTSDB API Connection Defaults ########################
+[opentsdb_plugin]
+# Port number the bridge listening on for Grafana data requests over
+# OpentTSDB plugin
+# 
+# 4242 - for HTTP connections 
+# 8443 - for HTTPS connections 
+# (Default: 4242)
+# port = 4242
+
+##################### Prometheus Exporter API Connection Defaults #############
+[prometheues_exporter_plugin]
+# Port number the bridge listening on for Prometheus server requests;
+# prometheus = 9250
+
+# By default, the original values from the platform will be exported alongside 
+# the timestamps at which they were measured. This can slow down a ZIMON query
+# performance.
+# Set rawCounters to False to accelerate query execution time. Keep in mind that 
+# in this case the exposed timestamps will represent the time at which the values
+# were added to a bucket.
+# Sensors including  'increasing counters' metric types will still run in 
+# rawCounters mode.
+rawCounters = True
+
+##################### API Protocol scheme #####################################
+[connection]
+# Protocol (http, https)
+protocol = http
+
+##################### API Basic Authentication ################################
+[basic_auth]
+# Basic authentication is enabled by default.
+# It is recommended to leave Basic Authentication enabled, especially when 
+# connecting via HTTP. The bridge will validate the username and password 
+# from `Authorization` header of every incoming http request.
+enabled = True
+
+# user name used for bridge api http/s basic authentication
+username = scale_admin
+
+# Base64 encoded password string used for bridge api http/s basic authentication
+# Example string encoding via cli:
+#   $ echo "MyVeryStrongPassw0rd!" |base64
+#   TXlWZXJ5U3Ryb25nUGFzc3cwcmQhCg==
+#
+# password = TXlWZXJ5U3Ryb25nUGFzc3cwcmQhCg==
+#
+# alternatively you can store a Base64 encoded string in a file
+# and specify the file location as the basic authentication password, f.e:
+#   password = /etc/bridge_auth/basic_scale-21
+
+##################### API SSL OAuth ############################################
+[tls]
+# Directory path of tls key and cert file location
+# tlsKeyPath = /etc/bridge_ssl/certs
+
+# Name of tls private key file
+# tlsKeyFile = privkey.pem
+
+# Name of tls certificate file
+# tlsCertFile = cert.pem
+
+
+
+##################### GPFS Server ###############################################
+[server]
+# The ip address to bind to, empty will bind to all interfaces
+server = localhost
+
+# The https port to use
+serverPort = 9980
+
+# The sleep time in seconds before attempting to get metaData from the server again.
+# This most likely the case if the query was sent to server before it did finish the
+# initial startup (maximum 3 attempts)
+retryDelay = 60
+
+# The name of REST HTTPS API key name
+apiKeyName = scale_grafana
+
+# The REST HTTPS API key value, f.e:
+#   apiKeyValue = e40960c9-de0a-4c75-bc71-0bcae6db23b2
+#
+# alternatively you can store a string of 32 hexadecimal digits in a file
+# and specify the file location as the REST HTTPS API key value, f.e:
+#   apiKeyValue = /etc/bridge_ssl/apikey_scale-21
+
+# False or the path to the CA certificate to use. 
+# On many Linux systems, certs can be found in /etc/ssl/certs.
+# In CNSA the service-ca certifcate must be used:
+# caCertPath = "/etc/ssl/certs/service-ca.crt"
+caCertPath = False
+
+##################### GPFS Server data query settings ############################
+[query]
+# Use or not the historical data from disk (default: no)
+includeDiskData = no
+
+##################### Logging ####################################################
+[logging]
+# Directory where the bridge can store logs
+logPath = /var/log/ibm_bridge_for_grafana
+
+# log level 5 (TRACE) 10 (DEBUG), 15 (MOREINFO), 20 (INFO), 30 (WARN), 
+# 40 (ERROR) (Default: 15)
+logLevel = 15
+
+# Log file name (Default: zserver.log)
+# Comment out this setting, if you wish to print out the trace messages directly on the command line
+logFile = zserver.log