Merge pull request #4 from python-microservices/feature/agnostic-config-file

Feature/agnostic config file

Author: avara1986

pyms/config/confile.py

@@ -4,7 +4,7 @@
 
 from typing import Text
 
-import yaml
+import anyconfig
 
 from pyms.constants import CONFIGMAP_FILE_ENVIRONMENT, LOGGER_NAME
 from pyms.exceptions import AttrDoesNotExistException, ConfigDoesNotFoundException
@@ -19,7 +19,7 @@ def __init__(self, *args, **kwargs):
         environment with the constant `CONFIGMAP_FILE_ENVIRONMENT`
         """
 
-        config = kwargs.get("config") or self._get_conf_from_yaml_file(kwargs.get("path")) or self._get_conf_from_env()
+        config = kwargs.get("config") or self._get_conf_from_file(kwargs.get("path")) or self._get_conf_from_env()
 
         if not config:
             raise ConfigDoesNotFoundException("Configuration file not found")
@@ -56,19 +56,14 @@ def __getattr__(self, name, *args, **kwargs):
     def _get_conf_from_env(self):
         file = os.environ.get(CONFIGMAP_FILE_ENVIRONMENT)
         logger.info("[CONF] Searching file in ENV[{}]: {}...".format(CONFIGMAP_FILE_ENVIRONMENT, file))
-        return self._get_conf_from_yaml_file(os.environ.get(CONFIGMAP_FILE_ENVIRONMENT))
+        return self._get_conf_from_file(os.environ.get(CONFIGMAP_FILE_ENVIRONMENT))
 
-    def _get_conf_from_yaml_file(self, path: Text) -> dict:
+    def _get_conf_from_file(self, path: Text) -> dict:
         if not path or not os.path.isfile(path):
             return {}
         logger.info("[CONF] Configmap {} found".format(path))
-        f = open(path, "r")
-        conf = self._get_conf_from_yaml(f.read())
-        f.close()
+        conf = anyconfig.load(path)
         return conf
 
-    def _get_conf_from_yaml(self, config: Text) -> dict:
-        return yaml.safe_load(config)
-
     def __setattr__(self, name, value, *args, **kwargs):
         super(ConfFile, self).__setattr__(name, value)

requirements.txt

@@ -4,4 +4,5 @@ PyYAML==3.13
 # Optionals:
 connexion==2.0.0
 flask==1.0.2
-Flask-OpenTracing==0.2.0
+Flask-OpenTracing==0.2.0
+anyconfig==0.9.7

tests/config-tests.json

@@ -0,0 +1,15 @@
+{
+	"my-ms": {
+		"DEBUG": true,
+		"TESTING": true,
+		"APP_NAME": "Python Microservice",
+		"APPLICATION_ROOT": "/",
+		"test_var": "general",
+		"subservice1": {
+			"test": "input"
+		},
+		"subservice2": {
+			"test": "output"
+		}
+	}
+}

tests/tests_config.py

@@ -24,6 +24,7 @@ def test_example_test_file_from_env(self):
 
 
 class ConfTests(unittest.TestCase):
+    BASE_DIR = os.path.dirname(os.path.abspath(__file__))
 
     def test_dictionary_replace_key(self):
         config = ConfFile(config={"test-1": "a", "test_2": "b"})
@@ -57,3 +58,11 @@ def test_example_test_config_not_exixsts(self):
     def test_example_test_file_not_exists(self):
         with self.assertRaises(ConfigDoesNotFoundException):
             config = ConfFile(path="path/not/exist.yml")
+
+    def test_example_test_yaml_file(self):
+        config = ConfFile(path=os.path.join(self.BASE_DIR, "config-tests.yml"))
+        self.assertEqual(config.my_ms.test_var, "general")
+
+    def test_example_test_json_file(self):
+        config = ConfFile(path=os.path.join(self.BASE_DIR, "config-tests.json"))
+        self.assertEqual(config.my_ms.test_var, "general")

tests/tests_flask.py

@@ -31,4 +31,4 @@ def test_healthcheck(self):
 
     def test_error(self):
         response = self.client.get('/notexist')
-        self.assertEqual(404, response.status_code)
+        self.assertEqual(404, response.status_code)