Merge pull request #380 from Helene/setting_message

Improve warning messages for missing mandatory configuration settings.

Author: Helene

source/confParser.py

@@ -42,7 +42,7 @@ def checkTLSsettings(args):
                                             args.get('tlsKeyFile') or not
                                             args.get('tlsCertFile')
                                             ):
-        return False, MSG['MissingParm']
+        return False, MSG['MissingSSLCert']
     elif args.get('protocol') == "https" and not os.path.exists(args.get('tlsKeyPath')):
         return False, MSG['KeyPathError']
     elif args.get('protocol') == "https":
@@ -58,16 +58,16 @@ def checkBasicAuthsettings(args):
     if args.get('enabled') and (not args.get('username') or not
                                 args.get('password')
                                 ):
-        return False, MSG['MissingParm']
+        return False, MSG['MissingBasicAuthSettings']
     elif args.get('enabled') and ("/" in str(args.get('password')) and not
                                   os.path.isfile(args.get('password'))
                                   ):
-        return False, MSG['PathNotFound'].format("basic auth settings")
+        return False, MSG['PathNotFound'].format("basic authentication settings")
     elif args.get('enabled') and "/" not in str(args.get('password')):
         try:
             base64.b64decode(args.get('password'), validate=True)
         except binascii.Error:
-            return False, MSG['WrongFormat'].format("basic auth password")
+            return False, MSG['WrongFormat'].format("basic authentication settings")
     return True, ''
 
 
@@ -79,9 +79,9 @@ def checkApplicationPort(args):
 
 def checkAPIsettings(args):
     if not args.get('apiKeyName') or not args.get('apiKeyValue'):
-        return False, MSG['MissingParm']
+        return False, MSG['MissingApiKeySettings']
     elif "/" in str(args.get('apiKeyValue')) and not os.path.isfile(args.get('apiKeyValue')):
-        return False, MSG['PathNotFound'].format("api key settings")
+        return False, MSG['PathNotFound'].format("ApiKey settings")
     return True, ''
 
 

source/confgenerator.py

@@ -100,8 +100,8 @@ def generate_config(self):
                         self.attr.get('username', False)
                         and self.attr.get('password', False)
                     ):
-                        self.logger.error(MSG['MissingParm'])
-                        return MSG['MissingParm']
+                        self.logger.error(MSG['MissingBasicAuthSettings'])
+                        return MSG['MissingBasicAuthSettings']
                     basic_auth = {"username": self.attr.get('username')}
                     if os.path.isfile(self.attr.get('password')):
                         pw = {"password_file": self.attr.get('password')}

source/messages.py

@@ -28,8 +28,10 @@
 MSG = {'IntError': 'Server internal error occurred. Reason: {}',
        'sysStart': 'Initial cherryPy server engine start have been invoked. Python version: {}, cherryPy version: {}.',
        'MissingParm': 'Missing mandatory parameters, quitting',
+       'MissingApiKeySettings': 'Missing mandatory ApiKey settings, quitting',
        'MissingPortParam': 'Missing applications port configuration, quitting',
-       'MissingSSLCert': 'Missing ssl configuration, quitting',
+       'MissingSSLCert': 'Missing ssl configuration settings, quitting',
+       'MissingBasicAuthSettings': 'Missing basic authentication settings, quitting',
        'KeyPathError': 'KeyPath directory not found, quitting',
        'MissingFileFromPathError': 'Missing certificates in the specified keyPath directory, quitting',
        'CollectorErr': 'Failed to initialize connection to pmcollector: {}, quitting',
@@ -85,5 +87,5 @@
        'MetricNotInResults': 'Metric {} is not in Collector.metrcs',
        'ConnApplications': 'Registered applications: \n {}',
        'WrongFormat': 'The {} specified in wrong format.',
-       'AuthValidationError': 'Basic auth data not valid'
+       'AuthValidationError': 'Basic authentication data not valid'
        }

tests/test_params.py

@@ -2,7 +2,8 @@
                                parse_cmd_args, checkCAsettings,
                                checkApplicationPort,
                                checkBasicAuthsettings,
-                               checkForInvalidsettings)
+                               checkForInvalidsettings,
+                               checkAPIsettings)
 from source.__version__ import __version__ as version
 from nose2.tools.decorators import with_setup
 
@@ -225,3 +226,22 @@ def test_case18():
         assert not valid1
         assert msg == ''
         assert len(msg1) > 1
+
+
+@with_setup(my_setup)
+def test_case19():
+    z = a.copy()
+    del z['apiKeyName']
+    result = merge_defaults_and_args(a, b)
+    result1 = merge_defaults_and_args(z, b)
+    assert len(result.keys()) > 0
+    assert len(result1.keys()) > 0
+    assert 'apiKeyValue' not in result.keys()
+    assert 'apiKeyValue' not in result1.keys()
+    assert 'apiKeyName' not in result1.keys()
+    valid, msg = checkAPIsettings(result)
+    valid1, msg1 = checkAPIsettings(result1)
+    assert not valid
+    assert not valid1
+    assert msg == 'Missing mandatory ApiKey settings, quitting'
+    assert msg1 == 'Missing mandatory ApiKey settings, quitting'