Merge pull request #355 from Helene/conf_valid

Add validation for configuration empty values

Author: Helene

source/confParser.py

@@ -91,6 +91,15 @@ def checkCAsettings(args):
     return True, ''
 
 
+def checkForInvalidsettings(args):
+    if not all(args.values()):
+        for key, value in args.items():
+            if value is None or value == '':
+                return False, MSG['InvalidConfigParm'].format(key)
+    else:
+        return True, ''
+
+
 def getSettings(argv):
     settings = {}
     args, msg = parse_cmd_args(argv)
@@ -102,6 +111,9 @@ def getSettings(argv):
         settings = vars(args)
     else:
         return None, msg
+    valid, msg = checkForInvalidsettings(settings)
+    if not valid:
+        return None, msg
     # check application port
     valid, msg = checkApplicationPort(settings)
     if not valid:
@@ -127,7 +139,6 @@ def getSettings(argv):
 
 def merge_defaults_and_args(defaults, args):
     '''merge default config parameters with input parameters from the command line'''
-    brConfig = {}
     brConfig = dict(defaults)
     args = vars(args)
     brConfig.update({k: v for k, v in args.items() if v is not None and not (v == str(None))})
@@ -170,9 +181,9 @@ def readConfigFile(self, fileName):
                             value = int(value)
                         options[sect][name] = value
             except Exception as e:
-                print(f"cannot read config file {fileName} Exception {e}")
+                print(f"Error: Cannot read config file {fileName} Exception {e}")
         else:
-            print(f"cannot find config file {fileName}")
+            print(f"Error: Cannot find config file {fileName}")
         return options
 
     def get_template_path(self):

source/config.ini

@@ -65,7 +65,7 @@ username = scale_admin
 
 ##################### GPFS Server ###############################################
 [server]
-# The ip address to bind to, empty will bind to all interfaces
+# The host name or ip address of the pmcollector node
 server = localhost
 
 # The https port to use

source/messages.py

@@ -44,6 +44,7 @@
        'GroupByErr': 'In the current setup the group aggregation \'groupby\' is not possible.',
        'MetricErr': 'Metric {0} cannot be found. Please check if the corresponding sensor is configured',
        'InconsistentParams': 'Received parameters {} inconsistent with request parameters {}',
+       'InvalidConfigParm': 'Configuration Parameter "{}" has not allowed value, quitting',
        'SensorDisabled': 'Sensor for metric {} is disabled',
        'SensorForceRawData': 'Sensor {} includes metrics type counter, which need to be collected as raw data',
        'EndpointNotSupported': 'Endpoint {} you try to access is not supported',

tests/test_parser.py

@@ -4,12 +4,12 @@
 
 def test_case01():
     result = os.system('python ./source/zimonGrafanaIntf.py')
-    assert result == 0
+    assert result > 0
 
 
 def test_case02():
     result = os.system('python ./source/zimonGrafanaIntf.py -a 2')
-    assert result == 0
+    assert result > 0
 
 
 def test_case03():
@@ -19,7 +19,7 @@ def test_case03():
 
 def test_case04():
     result = os.system('python ./source/zimonGrafanaIntf.py -c 10 -m "/opt/registry/certs"')
-    assert result == 0
+    assert result > 0
 
 
 def test_case05():