expand list of the editable arguments

Author: Helene

source/confParser.py

@@ -27,20 +27,40 @@
 import configparser
 
 
-def findKeyFile(path):
-    for name in ["privkey.pem", "tls.key"]:
-        for root, dirs, files in os.walk(path):
-            if name in files:
-                return name
-    return None
-
-
-def findCertFile(path):
-    for name in ["cert.pem", "tls.crt"]:
-        for root, dirs, files in os.walk(path):
-            if name in files:
-                return name
-    return None
+def checkFileExists(path, filename):
+    for root, dirs, files in os.walk(path):
+        if filename in files:
+            return True
+    return False
+
+
+def checkTLSsettings(args):
+    if args.get('port') == 8443 and (not args.get('tlsKeyPath') or not args.get('tlsKeyFile') or not args.get('tlsCertFile')):
+        return False, MSG['MissingParm']
+    elif args.get('port') == 8443 and not os.path.exists(args.get('tlsKeyPath')):
+        return False, MSG['KeyPathError']
+    elif args.get('port') == 8443:
+        if (not checkFileExists(args.get('tlsKeyPath'), args.get('tlsCertFile'))) or (not checkFileExists(args.get('tlsKeyPath'), args.get('tlsKeyFile'))):
+            return False, MSG['CertError']
+    return True, ''
+
+
+def getSettings(argv):
+    settings = {}
+    msg = ''
+    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:
+        settings = args
+    else:
+        return None, msg
+    # check TLS settings
+    valid, msg = checkTLSsettings(settings)
+    if valid:
+        return settings, ''
+    return None, msg
 
 
 def merge_defaults_and_args(defaults, args):
@@ -76,21 +96,13 @@ def parse_cmd_args(argv):
                         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, default=9084, help='ZIMon collector port number (Default: 9084)')
-    parser.add_argument('-l', '--logFile', action="store", default="./logs/zserver.log", help='location of the log file (Default: ./logs/zserver.log')
+    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=logging.INFO, help='log level 10 (DEBUG), 20 (INFO), 30 (WARN), 40 (ERROR) (Default: 20)')
     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('-t', '--tlsKeyPath', action="store", 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", help='Name of TLS key file, f.e.: privkey.pem (Required only for HTTPS port 8443)')
+    parser.add_argument('-m', '--tlsCertFile', action="store", help='Name of TLS certificate file, f.e.: cert.pem (Required only for HTTPS port 8443)')
 
     args = parser.parse_args(argv)
-
-    if args.port == 8443 and not args.tlsKeyPath:
-        return None, MSG['MissingParm']
-    elif args.port == 8443 and not os.path.exists(args.tlsKeyPath):
-        return None, MSG['KeyPathError']
-    elif args.port == 8443:
-        certFile = findCertFile(args.tlsKeyPath)
-        keyFile = findKeyFile(args.tlsKeyPath)
-        if (not certFile) or (not keyFile):
-            return None, MSG['CertError']
-
     return args, ''

source/messages.py

@@ -52,5 +52,6 @@
        'TimerInfo': 'Processing {} took {} seconds',
        'Query2port': 'For better bridge performance multithreaded port {} will be used',
        'CollectorConnInfo': 'Connection to the collector server established successfully',
-       'BridgeVersionInfo': ' *** IBM Spectrum Scale bridge for Grafana - Version: {} ***'
+       'BridgeVersionInfo': ' *** IBM Spectrum Scale bridge for Grafana - Version: {} ***',
+       'FileNotFound': 'The file {} not found.'
        }

source/zimonGrafanaIntf.py

@@ -34,7 +34,7 @@
 from queryHandler import SensorConfig
 from __version__ import __version__
 from messages import ERR, MSG
-from confParser import parse_cmd_args, findCertFile, findKeyFile
+from confParser import getSettings
 from collections import defaultdict
 from timeit import default_timer as timer
 
@@ -534,11 +534,11 @@ def processFormJSON(entity):
         cherrypy.serving.request.json = json.loads('{}')
 
 
-def configureLogging(logfile, loglevel):
+def configureLogging(logPath, logfile, loglevel):
     # create the logfile path if needed
-    path, folder = os.path.split(logfile)
-    if not os.path.exists(path):
-        os.makedirs(path)
+    if not os.path.exists(logPath):
+        os.makedirs(logPath)
+    logfile = os.path.join(logPath, logfile)
 
     # prepare the logger
     logger = logging.getLogger('zimonGrafanaIntf')
@@ -556,32 +556,32 @@ def configureLogging(logfile, loglevel):
 
 def validateCollectorConf(args, logger):
 
-    if not (args.server == 'localhost') and not (args.server == '127.0.0.1'):
+    if not (args.get('server') == 'localhost') and not (args.get('server') == '127.0.0.1'):
         try:
             s = socket.socket()
-            s.connect((args.server, args.serverPort))
+            s.connect((args.get('server'), args.get('serverPort')))
             print(MSG['CollectorConnInfo'])
         finally:
             s.close()
     else:
         # get queryport
         foundPorts = SensorConfig.getCollectorPorts(logger)
-        if foundPorts and str(args.serverPort) not in foundPorts:
+        if foundPorts and str(args.get('serverPort')) not in foundPorts:
             raise Exception("Invalid serverPort specified. Try with: %s" % str(foundPorts))
-        elif foundPorts[1] and not (args.serverPort == int(foundPorts[1])):
-            args.serverPort = int(foundPorts[1])
-            logger.info(MSG['Query2port'].format(args.serverPort))
+        elif foundPorts[1] and not (args.get('serverPort') == int(foundPorts[1])):
+            args['serverPort'] = int(foundPorts[1])
+            logger.info(MSG['Query2port'].format(args['serverPort']))
 
 
 def updateCherrypyConf(args):
 
-    path, folder = os.path.split(args.logFile)
+    path = args.get('logPath')
     if not os.path.exists(path):
         os.makedirs(path)
     accesslog = os.path.join(path, 'cherrypy_access.log')
     errorlog = os.path.join(path, 'cherrypy_error.log')
 
-    globalConfig = {'global': {'server.socket_port': args.port,
+    globalConfig = {'global': {'server.socket_port': args.get('port'),
                                'log.access_file': accesslog,
                                'log.error_file': errorlog}}
 
@@ -593,8 +593,8 @@ def updateCherrypyConf(args):
 
 
 def updateCherrypySslConf(args):
-    certPath = os.path.join(args.tlsKeyPath, findCertFile(args.tlsKeyPath))
-    keyPath = os.path.join(args.tlsKeyPath, findKeyFile(args.tlsKeyPath))
+    certPath = os.path.join(args.get('tlsKeyPath'), args.get('tlsCertFile'))
+    keyPath = os.path.join(args.get('tlsKeyPath'), args.get('tlsKeyFile'))
     sslConfig = {'global': {'server.ssl_module': 'builtin',
                             'server.ssl_certificate': certPath,
                             'server.ssl_private_key': keyPath}}
@@ -604,25 +604,26 @@ def updateCherrypySslConf(args):
 def main(argv):
 
     # parse input arguments
-    args, msg = parse_cmd_args(argv)
+    args, msg = getSettings(argv)
     if not args:
         print(msg)
+        return
 
     # prepare the logger
-    logger = configureLogging(args.logFile, args.logLevel)
-    logger.info('zimonGrafanaItf invoked with parameters:%s', str(args))
+    logger = configureLogging(args.get('logPath'), args.get('logFile'), args.get('logLevel'))
 
     # prepare cherrypy server configuration
     updateCherrypyConf(args)
-    if args.port == 8443:
+    if args.get('port') == 8443:
         updateCherrypySslConf(args)
 
     # prepare metadata
     try:
         print("\n" + MSG['BridgeVersionInfo'].format(__version__))
         logger.info("%s", MSG['BridgeVersionInfo'].format(__version__))
+        logger.info('zimonGrafanaItf invoked with parameters:\n %s', "\n".join("{}={}".format(k, v) for k, v in args.items()))
         validateCollectorConf(args, logger)
-        mdHandler = MetadataHandler(logger, args.server, args.serverPort)
+        mdHandler = MetadataHandler(logger, args.get('server'), args.get('serverPort'))
         print(MSG['MetaSuccess'])
         print(MSG['ReceivAttrValues'].format('sensors', "\n\n" + "\t".join(mdHandler.metaData.sensorsSpec.keys())))
     except (AttributeError, ValueError, TypeError) as e:

tests/test_params.py

@@ -3,9 +3,10 @@
 
 
 def my_setup():
-    global a, b, c
+    global a, b, c, d, e
     a = parse_defaults_from_config_file()
     b, c = parse_cmd_args([])
+    d, e = parse_cmd_args(['-p', '8443', '-t', '/etc/my_tls'])
 
 
 def test_case01():
@@ -42,3 +43,11 @@ def test_case06():
     assert len(result.keys()) > 0
     assert 'port' in result.keys()
     assert 'serverPort' in result.keys()
+
+
+@with_setup(my_setup)
+def test_case07():
+    result = merge_defaults_and_args(a, d)
+    assert len(result.keys()) > 0
+    assert 'port' in result.keys()
+    assert result.get('port') == 8443