Merge pull request #26 from python-microservices/feature/add-swagger-conf

avara1986 · web-flow · commit eb253708d69f · 2019-01-07T16:17:17.000+01:00
Extra configuration as a services
diff --git a/.coveragerc b/.coveragerc
@@ -3,6 +3,6 @@ include=
     *pyms/*
     *tests/*
 omit =
-    *example/*
+    *examples/*
     .tox/*
     venv/*
diff --git a/examples/microservice_requests/__init__.py b/examples/microservice_requests/__init__.py
@@ -0,0 +1,3 @@
+from pyms.flask.app import Microservice
+
+ms = Microservice(service="my-ms", path=__file__)
diff --git a/examples/microservice_requests/config.yml b/examples/microservice_requests/config.yml
@@ -0,0 +1,10 @@
+pyms:
+  requests: true
+  swagger:
+    path: ""
+    file: "swagger.yaml"
+my-ms:
+  DEBUG: true
+  TESTING: false
+  APP_NAME: "Python Microservice"
+  APPLICATION_ROOT: ""
diff --git a/examples/microservice_requests/main.py b/examples/microservice_requests/main.py
@@ -0,0 +1,5 @@
+from examples.microservice_requests import ms
+app = ms.create_app()
+
+if __name__ == '__main__':
+    app.run()
diff --git a/examples/microservice_requests/swagger.yaml b/examples/microservice_requests/swagger.yaml
@@ -0,0 +1,55 @@
+---
+swagger: "2.0"
+info:
+  description: "This is a sample server Test server"
+  version: "1.0.0"
+  title: "Swagger Test list"
+  termsOfService: "http://swagger.io/terms/"
+  contact:
+    email: "apiteam@swagger.io"
+  license:
+    name: "Apache 2.0"
+    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
+tags:
+- name: "colors"
+  description: "Everything about your colors"
+  externalDocs:
+    description: "Find out more"
+    url: "http://swagger.io"
+- name: "store"
+  description: "Example endpoint  list of colors"
+- name: "user"
+  description: "Operations about user"
+  externalDocs:
+    description: "Find out more about our store"
+    url: "http://swagger.io"
+schemes:
+- "http"
+paths:
+  /:
+    get:
+      tags:
+      - "test"
+      summary: "Example endpoint"
+      description: ""
+      operationId: "examples.microservice_requests.views.example"
+      consumes:
+      - "application/json"
+      produces:
+      - "application/json"
+      responses:
+        200:
+          description: "A list of colors (may be filtered by palette)"
+          schema:
+            $ref: '#/definitions/Example'
+        405:
+          description: "Invalid input"
+definitions:
+  Example:
+    type: "object"
+    properties:
+      main:
+        type: "string"
+externalDocs:
+  description: "Find out more about Swagger"
+  url: "http://swagger.io"
diff --git a/examples/microservice_requests/views.py b/examples/microservice_requests/views.py
@@ -0,0 +1,5 @@
+from examples.microservice_requests import ms
+
+
+def example():
+    return ms.requests.get_for_object("https://ghibliapi.herokuapp.com/films/2baf70d1-42bb-4437-b551-e5fed5a87abe")
diff --git a/examples/microservice_swagger/__init__.py b/examples/microservice_swagger/__init__.py
diff --git a/examples/microservice_swagger/config.yml b/examples/microservice_swagger/config.yml
@@ -0,0 +1,9 @@
+pyms:
+  swagger:
+    path: ""
+    file: "swagger.yaml"
+my-ms:
+  DEBUG: true
+  TESTING: false
+  APP_NAME: "Python Microservice"
+  APPLICATION_ROOT: ""
diff --git a/examples/microservice_swagger/main.py b/examples/microservice_swagger/main.py
@@ -0,0 +1,7 @@
+from pyms.flask.app import Microservice
+
+ms = Microservice(service="my-ms", path=__file__)
+app = ms.create_app()
+
+if __name__ == '__main__':
+    app.run()
diff --git a/examples/microservice_swagger/swagger.yaml b/examples/microservice_swagger/swagger.yaml
@@ -0,0 +1,55 @@
+---
+swagger: "2.0"
+info:
+  description: "This is a sample server Test server"
+  version: "1.0.0"
+  title: "Swagger Test list"
+  termsOfService: "http://swagger.io/terms/"
+  contact:
+    email: "apiteam@swagger.io"
+  license:
+    name: "Apache 2.0"
+    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
+tags:
+- name: "colors"
+  description: "Everything about your colors"
+  externalDocs:
+    description: "Find out more"
+    url: "http://swagger.io"
+- name: "store"
+  description: "Example endpoint  list of colors"
+- name: "user"
+  description: "Operations about user"
+  externalDocs:
+    description: "Find out more about our store"
+    url: "http://swagger.io"
+schemes:
+- "http"
+paths:
+  /:
+    get:
+      tags:
+      - "test"
+      summary: "Example endpoint"
+      description: ""
+      operationId: "examples.microservice_swagger.views.example"
+      consumes:
+      - "application/json"
+      produces:
+      - "application/json"
+      responses:
+        200:
+          description: "A list of colors (may be filtered by palette)"
+          schema:
+            $ref: '#/definitions/Example'
+        405:
+          description: "Invalid input"
+definitions:
+  Example:
+    type: "object"
+    properties:
+      main:
+        type: "string"
+externalDocs:
+  description: "Find out more about Swagger"
+  url: "http://swagger.io"
diff --git a/examples/microservice_swagger/views.py b/examples/microservice_swagger/views.py
@@ -0,0 +1,4 @@
+
+
+def example():
+    return {"main": "hello world"}
diff --git a/examples/mininum_microservice/__init__.py b/examples/mininum_microservice/__init__.py
diff --git a/examples/mininum_microservice/config.yml b/examples/mininum_microservice/config.yml
@@ -0,0 +1,2 @@
+my-minimal-microservice:
+  APP_NAME: "Python Microservice"
diff --git a/examples/mininum_microservice/main.py b/examples/mininum_microservice/main.py
@@ -0,0 +1,15 @@
+from flask import jsonify
+
+from pyms.flask.app import Microservice
+
+ms = Microservice(service="my-minimal-microservice", path=__file__)
+app = ms.create_app()
+
+
+@app.route("/")
+def example():
+    return jsonify({"main": "hello world"})
+
+
+if __name__ == '__main__':
+    app.run()
diff --git a/pyms/config/confile.py b/pyms/config/confile.py
@@ -13,6 +13,7 @@
 
 class ConfFile(dict):
     empty_init = False
+    default_file = "config.yml"
 
     def __init__(self, *args, **kwargs):
         """
@@ -63,9 +64,9 @@ def __getattr__(self, name, *args, **kwargs):
                 raise AttrDoesNotExistException("Variable {} not exist in the config file".format(name))
 
     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_file(os.environ.get(CONFIGMAP_FILE_ENVIRONMENT))
+        config_file = os.environ.get(CONFIGMAP_FILE_ENVIRONMENT, self.default_file)
+        logger.info("[CONF] Searching file in ENV[{}]: {}...".format(CONFIGMAP_FILE_ENVIRONMENT, config_file))
+        return self._get_conf_from_file(config_file)
 
     def _get_conf_from_file(self, path: Text) -> dict:
         if not path or not os.path.isfile(path):
diff --git a/pyms/constants.py b/pyms/constants.py
@@ -1,3 +1,5 @@
 CONFIGMAP_FILE_ENVIRONMENT = "CONFIGMAP_FILE"
 
-LOGGER_NAME = "pyms"
+LOGGER_NAME = "pyms"
+
+SERVICE_BASE = "pyms"
diff --git a/pyms/flask/app/__init__.py b/pyms/flask/app/__init__.py
@@ -3,10 +3,12 @@
 from typing import Text
 
 import connexion
+from flask import Flask
 from flask_opentracing import FlaskTracer
 
 from pyms.config.conf import get_conf
 from pyms.flask.healthcheck import healthcheck_blueprint
+from pyms.flask.services.driver import ServicesManager
 from pyms.logger import CustomJsonFormatter
 from pyms.tracer.main import init_jaeger_tracer
 
@@ -18,6 +20,13 @@ class Microservice:
     def __init__(self, service: Text, path=__file__):
         self.service = service
         self.path = os.path.dirname(path)
+        self.config = get_conf(service=self.service)
+        self.init_services()
+
+    def init_services(self):
+        service_manager = ServicesManager()
+        for service_name, service in service_manager.get_services():
+            setattr(self, service_name, service)
 
     def init_libs(self):
         return self.application
@@ -36,23 +45,31 @@ def init_logger(self):
         self.application.logger.propagate = False
         self.application.logger.setLevel(logging.INFO)
 
+    def init_app(self) -> Flask:
+        if getattr(self, "swagger", False):
+            app = connexion.App(__name__, specification_dir=os.path.join(self.path, self.swagger.path))
+            app.add_api(self.swagger.file,
+                        arguments={'title': self.config.APP_NAME},
+                        base_path=self.config.APPLICATION_ROOT
+                        )
+
+            # Invert the objects, instead connexion with a Flask object, a Flask object with
+            application = app.app
+            application._connexion_app = app
+        else:
+            application = Flask(__name__)
+
+        return application
+
     def create_app(self):
         """Initialize the Flask app, register blueprints and initialize
         all libraries like Swagger, database,
         the trace system...
         return the app and the database objects.
         :return:
         """
-        config = get_conf(service=self.service)
-        app = connexion.App(__name__, specification_dir=os.path.join(self.path, 'swagger'))
-        app.add_api('swagger.yaml',
-                    arguments={'title': config.APP_NAME},
-                    base_path=config.APPLICATION_ROOT
-                    )
-
-        self.application = app.app
-        self.application._connexion_app = app
-        self.application.config.from_object(config)
+        self.application = self.init_app()
+        self.application.config.from_object(self.config)
         self.application.tracer = None
 
         # Initialize Blueprints
diff --git a/pyms/flask/services/driver.py b/pyms/flask/services/driver.py
@@ -0,0 +1,36 @@
+import logging
+
+from pyms.config.conf import get_conf
+from pyms.constants import SERVICE_BASE, LOGGER_NAME
+from pyms.utils.utils import import_from
+
+logger = logging.getLogger(LOGGER_NAME)
+
+
+class DriverService:
+    service = ""
+
+    def __init__(self, service, *args, **kwargs):
+        self.service = ".".join([service, self.service])
+        self.config = get_conf(service=self.service, empty_init=True)
+
+    def __getattr__(self, attr, *args, **kwargs):
+        config_attribute = getattr(self.config, attr)
+        return config_attribute if config_attribute is "" or config_attribute != {} else self.default_values.get(attr,
+                                                                                                                 None)
+
+
+class ServicesManager:
+    service = SERVICE_BASE
+
+    def __init__(self, service=None):
+        self.service = (service if service else SERVICE_BASE)
+        self.config = get_conf(service=self.service, empty_init=True)
+
+    def get_services(self):
+        return ((k, self.get_service(k)) for k in self.config.__dict__.keys() if k not in ['empty_init', ])
+
+    def get_service(self, service, *args, **kwargs):
+        service_object = import_from("pyms.flask.services.{}".format(service), "Service")
+        logger.info("Init service {}".format(service))
+        return service_object(service=self.service, *args, **kwargs)
diff --git a/pyms/flask/services/requests.py b/pyms/flask/services/requests.py
diff --git a/pyms/flask/services/swagger.py b/pyms/flask/services/swagger.py
diff --git a/pyms/utils/utils.py b/pyms/utils/utils.py
diff --git a/tests/config-tests.yml b/tests/config-tests.yml
diff --git a/tests/swagger.yaml b/tests/swagger.yaml
diff --git a/tests/tests_requests.py b/tests/tests_requests.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from pyms.flask.app import Microservice`
	`2`	`+`
	`3`	`+ms = Microservice(service="my-ms", path=__file__)`