allow to pass a file path as apiKeyValue

Author: Helene

source/confParser.py

@@ -48,6 +48,8 @@ def checkTLSsettings(args):
 def checkAPIsettings(args):
     if not args.get('apiKeyName') or not args.get('apiKeyValue'):
         return False, MSG['MissingParm']
+    elif "/" in str(args.get('apiKeyValue')) and not os.path.isfile(args.get('apiKeyValue')):
+        return False, MSG['FileNotFound'].format(args.get('apiKeyValue'))
     return True, ''
 
 
@@ -159,8 +161,8 @@ class Password(argparse.Action):
     defaults = ConfigManager().defaults
 
     def __call__(self, parser, namespace, values, option_string):
-        if values is None and self.defaults.get('apiKeyValue', None) is None:
-            print('no valid apiKeyValue found in the config.ini')
+        if values is None:
+            print('Enter your apiKey value')
             values = getpass.getpass()
 
         setattr(namespace, self.dest, values)

source/zimonGrafanaIntf.py

@@ -569,6 +569,16 @@ def updateCherrypySslConf(args):
     cherrypy.config.update(sslConfig)
 
 
+def resolveAPIKeyValue(storedKey):
+    keyValue = None
+    if "/" in str(storedKey):
+        with open(storedKey) as file:
+            keyValue = file.read().rstrip()
+        return keyValue
+    else:
+        return storedKey
+
+
 def main(argv):
     # parse input arguments
     args, msg = getSettings(argv)
@@ -587,13 +597,21 @@ def main(argv):
     # prepare metadata
     try:
         logger.info("%s", MSG['BridgeVersionInfo'].format(__version__))
-        logger.details('zimonGrafanaItf invoked with parameters:\n %s', "\n".join("{}={}".format(k, v) for k, v in args.items()))
+        logger.details('zimonGrafanaItf invoked with parameters:\n %s', "\n".join("{}={}".format(k, v) for k, v in args.items() if not k =='apiKeyValue'))
         # logger.details('zimonGrafanaItf invoked with parameters:\n %s', "\n".join("{}={}".format(k, type(v)) for k, v in args.items()))
-        mdHandler = MetadataHandler(logger, args.get('server'), args.get('serverPort'), args.get('apiKeyName'), args.get('apiKeyValue'), args.get('includeDiskData'))
+        mdHandler = MetadataHandler(logger, args.get('server'), args.get('serverPort'), args.get('apiKeyName'), resolveAPIKeyValue(args.get('apiKeyValue')), args.get('includeDiskData'))
     except (AttributeError, TypeError, ValueError) as e:
         logger.details('%s', MSG['IntError'].format(str(e)))
         logger.error(MSG['MetaError'])
         return
+    except IOError as e:
+        if e.errno == errno.ENOENT:
+            # file does not exist'
+            logger.error(f'Error reading file, Reason: {e}')
+        elif e.errno == errno.EACCES:
+            # file cannot be read
+            logger.error(f'Error accessing file, Reason: {e}')
+        return
     except (PerfmonConnError, Exception) as e:
         logger.error('%s', MSG['CollectorErr'].format(str(e)))
         return

tests/test_configManager.py

@@ -78,3 +78,9 @@ def test_case11():
     result = cm.defaults
     assert 'includeDiskData' in result.keys()
     assert result['includeDiskData'] == 'no'
+
+
+def test_case12():
+    cm = ConfigManager()
+    result = cm.defaults
+    assert 'apiKeyValue' not in result.keys()

tests/test_params.py

@@ -3,12 +3,15 @@
 
 
 def my_setup():
-    global a, b, c, d, e, f, g, m, n
+    global a, b, c, d, e, f, g, m, n, o, p, y
     a = ConfigManager().defaults
+    y = ConfigManager().defaults.copy()
+    y['apiKeyValue'] = '/tmp/mykey'
     b, c = parse_cmd_args([])
     d, e = parse_cmd_args(['-p', '8443', '-t', '/etc/my_tls'])
     f, g = parse_cmd_args(['-p', '8443', '-t', None, '-k', 'None', '-m', "None"])
     m, n = parse_cmd_args(['-d', 'yes'])
+    o, p = parse_cmd_args(['-v', 'e40960c9-de0a-4c75-bc71-0bcae6db23b2'])
 
 
 @with_setup(my_setup)
@@ -17,6 +20,7 @@ def test_case01():
     assert len(result.keys()) > 0
     assert 'port' in result.keys()
     assert 'serverPort' in result.keys()
+    assert 'apiKeyValue' not in result.keys()
 
 
 @with_setup(my_setup)
@@ -43,6 +47,7 @@ def test_case04():
     assert 'tlsKeyPath' not in result.keys()
     assert 'tlsKeyFile' not in result.keys()
     assert 'tlsCertFile' not in result.keys()
+    assert 'apiKeyValue' not in result.keys()
     assert result.get('port') == 8443
 
 
@@ -60,3 +65,19 @@ def test_case06():
     assert len(result.keys()) > 0
     assert 'includeDiskData' in result.keys()
     assert result.get('includeDiskData') == True
+
+
+@with_setup(my_setup)
+def test_case07():
+    result = merge_defaults_and_args(y, m)
+    assert len(result.keys()) > 0
+    assert 'apiKeyValue' in result.keys()
+    assert '/' in str(result.get('apiKeyValue'))
+
+@with_setup(my_setup)
+def test_case08():
+    result = merge_defaults_and_args(y, o)
+    assert len(result.keys()) > 0
+    assert 'apiKeyValue' in result.keys()
+    assert '/' not in str(result.get('apiKeyValue'))
+    assert result.get('apiKeyValue') == 'e40960c9-de0a-4c75-bc71-0bcae6db23b2'