Merge pull request #21 from python-microservices/feature/add-app-more-reusable

Add app more reusable

Author: avara1986

pyms/config/conf.py

@@ -9,22 +9,21 @@ class Config:
     def __init__(self):
         pass
 
-    @property
-    def config(self):
+    def config(self, *args, **kwargs):
         """Set the configuration, if our yaml file is like:
         myservice:
           myservice1:
            myvar1
         and we want to get the configuration of service1, our self.service will be "myservice.myservice1"
         """
         if not self._config:
-            self._config = ConfFile()
+            self._config = ConfFile(*args, **kwargs)
         if not self.service:
             raise ServiceDoesNotExistException("Service not defined")
         return getattr(self._config, self.service)
 
 
-def get_conf(service=None):
+def get_conf(service=None, *args, **kwargs):
     config = Config()
     config.service = service
-    return config.config
+    return config.config(*args, **kwargs)

pyms/config/confile.py

@@ -1,7 +1,6 @@
 """Module to read yaml or json conf"""
 import logging
 import os
-
 from typing import Text
 
 import anyconfig
@@ -13,16 +12,23 @@
 
 
 class ConfFile(dict):
+    empty_init = False
+
     def __init__(self, *args, **kwargs):
         """
         Get configuration from a dictionary(variable `config`), from path (variable `path`) or from
         environment with the constant `CONFIGMAP_FILE_ENVIRONMENT`
         """
-
-        config = kwargs.get("config") or self._get_conf_from_file(kwargs.get("path")) or self._get_conf_from_env()
+        self.empty_init = kwargs.get("empty_init", False)
+        config = kwargs.get("config")
+        if config is None:
+            config = self._get_conf_from_file(kwargs.get("path")) or self._get_conf_from_env()
 
         if not config:
-            raise ConfigDoesNotFoundException("Configuration file not found")
+            if self.empty_init:
+                config = {}
+            else:
+                raise ConfigDoesNotFoundException("Configuration file not found")
 
         logger.debug("[CONF] INIT: Settings {kwargs}".format(
             kwargs=kwargs,
@@ -35,7 +41,7 @@ def __init__(self, *args, **kwargs):
     def normalize_config(self, config):
         for key, item in config.items():
             if isinstance(item, dict):
-                item = ConfFile(config=item)
+                item = ConfFile(config=item, empty_init=self.empty_init)
             yield self.normalize_keys(key), item
 
     def normalize_keys(self, key):
@@ -51,7 +57,10 @@ def __getattr__(self, name, *args, **kwargs):
                 aux_dict = aux_dict[k]
             return aux_dict
         except KeyError:
-            raise AttrDoesNotExistException("Variable {} not exist in the config file".format(name))
+            if self.empty_init:
+                return ConfFile(config={}, empty_init=self.empty_init)
+            else:
+                raise AttrDoesNotExistException("Variable {} not exist in the config file".format(name))
 
     def _get_conf_from_env(self):
         file = os.environ.get(CONFIGMAP_FILE_ENVIRONMENT)

pyms/flask/app/__init__.py

@@ -22,6 +22,20 @@ def __init__(self, service: Text, path=__file__):
     def init_libs(self):
         return self.application
 
+    def init_tracer(self):
+        self.application.tracer = FlaskTracer(init_jaeger_tracer(), True, self.application)
+
+    def init_logger(self):
+        formatter = CustomJsonFormatter('(timestamp) (level) (name) (module) (funcName) (lineno) (message)')
+        formatter.add_service_name(self.application.config["APP_NAME"])
+        if getattr(self.application, "tracer", False):
+            formatter.add_trace_span(self.application.tracer)
+        log_handler = logging.StreamHandler()
+        log_handler.setFormatter(formatter)
+        self.application.logger.addHandler(log_handler)
+        self.application.logger.propagate = False
+        self.application.logger.setLevel(logging.INFO)
+
     def create_app(self):
         """Initialize the Flask app, register blueprints and initialize
         all libraries like Swagger, database,
@@ -47,18 +61,10 @@ def create_app(self):
         self.init_libs()
         self.add_error_handlers()
 
-        # Inject Modules
-        formatter = CustomJsonFormatter('(timestamp) (level) (name) (module) (funcName) (lineno) (message)')
         if not self.application.config["TESTING"]:
-            log_handler = logging.StreamHandler()
+            self.init_tracer()
 
-            self.application.tracer = FlaskTracer(init_jaeger_tracer(), True, self.application)
-            formatter.add_service_name(self.application.config["APP_NAME"])
-            formatter.add_trace_span(self.application.tracer)
-            log_handler.setFormatter(formatter)
-            self.application.logger.addHandler(log_handler)
-            self.application.logger.propagate = False
-            self.application.logger.setLevel(logging.INFO)
+        self.init_logger()
 
         return self.application
 
@@ -74,5 +80,4 @@ def add_error_handler(self, code_or_exception, handler):
         :param code_or_exception: HTTP error code or exception
         :param handler: callback for error handler
         """
-
         self.application._connexion_app.add_error_handler(code_or_exception, handler)

tests/tests_config.py

@@ -1,10 +1,12 @@
 import logging
+import os
 import unittest
 
-import os
+from pyms.config.conf import Config
+
 from pyms.config.confile import ConfFile
-from pyms.exceptions import AttrDoesNotExistException, ConfigDoesNotFoundException
 from pyms.constants import CONFIGMAP_FILE_ENVIRONMENT, LOGGER_NAME
+from pyms.exceptions import AttrDoesNotExistException, ConfigDoesNotFoundException, ServiceDoesNotExistException
 
 logger = logging.getLogger(LOGGER_NAME)
 
@@ -66,3 +68,33 @@ def test_example_test_yaml_file(self):
     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")
+
+
+class ConfServiceTests(unittest.TestCase):
+
+    def test_config_with_service(self):
+        class MyService(Config):
+            service = "service"
+
+        config = MyService()
+        configuration = config.config(config={"service": {"service1": "a", "service2": "b"}})
+        self.assertEqual(configuration.service1, "a")
+
+    def test_config_with_service_not_exist(self):
+        config = Config()
+        with self.assertRaises(ServiceDoesNotExistException):
+            configuration = config.config(config={"service": {"service1": "a", "service2": "b"}})
+
+
+class ConfNotExistTests(unittest.TestCase):
+    def test_empty_conf(self):
+        config = ConfFile(empty_init=True)
+        self.assertEqual(config.my_ms, {})
+
+    def test_empty_conf_two_levels(self):
+        config = ConfFile(empty_init=True)
+        self.assertEqual(config.my_ms.level_two, {})
+
+    def test_empty_conf_three_levels(self):
+        config = ConfFile(empty_init=True)
+        self.assertEqual(config.my_ms.level_two.level_three, {})