Merge remote-tracking branch 'origin/master' into task/updated-documentation

Author: avara1986

AUTHORS

@@ -1,5 +1,6 @@
 Alberto Vara <a.vara.1986@gmail.com>
+Àlex Pérez <alexperezpujol@disroot.org>
 Hugo Camino <hugo.camino.villacorta@gmail.com>
-José Manuel <jmrivas86@gmail.com>
 Javier Luna molina <javierlunamolina@gmail.com>
-pilamb <perikopalotes@gmail.com>
+José Manuel <jmrivas86@gmail.com>
+Mike Rubin <miguelgr1988@gmail.com>

Pipfile

@@ -10,11 +10,12 @@ pyyaml = ">=5.1.2"
 anyconfig = ">=0.9.8"
 swagger-ui-bundle = ">=0.0.2"
 connexion = {extras = ["swagger-ui"],version = "==2.4.0"}
-jaeger-client = "==4.2.0"
+jaeger-client = "==4.3.0"
 flask-opentracing = "*"
 opentracing = ">=2.1"
 opentracing-instrumentation = "==3.2.1"
 prometheus_client = ">=0.7.1"
+
 [dev-packages]
 requests-mock = "*"
 coverage = "==4.5.4"

Pipfile.lock

@@ -6,35 +6,37 @@
 [![Requirements Status](https://requires.io/github/python-microservices/pyms/requirements.svg?branch=master)](https://requires.io/github/python-microservices/pyms/requirements/?branch=master)
 [![Total alerts](https://img.shields.io/lgtm/alerts/g/python-microservices/pyms.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/python-microservices/pyms/alerts/)
 [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/python-microservices/pyms.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/python-microservices/pyms/context:python)
+[![Gitter](https://img.shields.io/gitter/room/DAVFoundation/DAV-Contributors.svg)](https://gitter.im/python-microservices/pyms)
 
-PyMS, Python MicroService, is a collections of libraries, best practices and recommended ways to build 
-microservices with Python.
+
+PyMS, Python MicroService, is a collections of libraries, best practices and recommended ways to build  microservices with Python.
 
 ## Documentation
 
-To know how use, install or build a project see the docs: https://py-ms.readthedocs.io/en/latest/
+To know how use, install or build a project see the [docs](https://py-ms.readthedocs.io/en/latest/).
 
 ## Motivation
 
 When we started to create microservice with no idea, we were looking for tutorials, guides, best practices, but we found
 nothing to create professional projects. Most articles say:
+
 - "Install flask"
 - "Create routes"
 - (Sometimes) "Create a swagger specs"
 - "TA-DA! you have a microservice"
 
-But... what happens with our configuration out of code like Kubernetes configmap? what happens with transactionality? 
+But... what happens with our configuration out of code like Kubernetes configmap? what happens with transactionality?
 If we have many microservices, what happens with traces?.
 
 There are many problems around Python and microservices and we can`t find anyone to give a solution.
 
-We start creating these projects to try to solve all the problems we have found in our professional lives about 
+We start creating these projects to try to solve all the problems we have found in our professional lives about
 microservices architecture.
 
-Nowadays, is not perfect and we have a looong roadmap, but we hope this library could help other felas and friends ;) 
+Nowadays, is not perfect and we have a looong roadmap, but we hope this library could help other felas and friends ;)
 
+## Installation
 
-## Installation 
 ```bash
 pip install py-ms
 ```
@@ -43,7 +45,8 @@ pip install py-ms
 
 You need to create 2 files: main.py and config.yml:
 
-main.py
+- **main.py**
+
 ```python
 from flask import jsonify
 
@@ -62,9 +65,10 @@ if __name__ == '__main__':
     app.run()
 ```
 
-config.yml
+- **config.yml**
+
 ```yaml
-pyms: 
+pyms:
   services: # 1.2
     requests:
       data: {}
@@ -77,19 +81,22 @@ pyms:
 
 ### So what did that code do?
 
-1. Create a instance of PyMS Microservice class (#1.1). This initialization inject the configuration defined in the 
-1.3 block and could be accessed through current_app.config like typical 
-[Flask config](https://flask.palletsprojects.com/en/1.1.x/config/). 
+1. Create a instance of PyMS Microservice class (#1.1). This initialization inject the configuration defined in the
+1.3 block and could be accessed through current_app.config like typical
+[Flask config](https://flask.palletsprojects.com/en/1.1.x/config/).
 Then, initialize the service defined in the 1.2 block. See [Services](services.md) for more details.
-2. Initialize [Flask](https://flask.palletsprojects.com/en/1.1.x/) instance, [Connexion](https://github.com/zalando/connexion) 
-if it was defined in the pyms configuration block, create a tracer, add health-check blueprint, initialize libs and set 
-the PyMS Microservice in
-`ms` attribute and you can access to it with `current_app.ms`. This steps has their each functions and you can easy 
+
+2. Initialize [Flask](https://flask.palletsprojects.com/en/1.1.x/) instance, [Connexion](https://github.com/zalando/connexion)
+if it was defined in the pyms configuration block, create a tracer, add health-check blueprint, initialize libs and set
+the PyMS Microservice in `ms` attribute and you can access to it with `current_app.ms`.  
+This steps has their each functions and you can easy
 override it.
+
 3. `create_app` return the flask instance and you can interact with it as a typical flask app
 
-See Documentation https://py-ms.readthedocs.io/en/latest/ to learn more.
+See [Documentation](https://py-ms.readthedocs.io/en/latest/) to learn more.
 
 ## How To Contrib
-We appreciate opening issues and pull requests to make PyMS even more stable & useful! See [This doc](COONTRIBUTING.md)
-for more details
+
+We appreciate opening issues and pull requests to make PyMS even more stable & useful! See [This doc](CONTRIBUTING.md)
+for more details.

README.md

@@ -7,7 +7,7 @@ microservices with Python which handles cross-cutting concerns:
 - Externalized configuration
 - Logging
 - Health checks
-- Metrics (TODO)
+- Metrics
 - Distributed tracing
 
 PyMS is powered by [Flask](https://flask.palletsprojects.com/en/1.1.x/), [Connexion](https://github.com/zalando/connexion) and [Opentracing](https://opentracing.io/).

docs/index.md

@@ -37,19 +37,19 @@ Each keyword in our configuration block, can be accessed in our Microservice obj
 ```yaml
 # Config.yml
 pyms:
-	config:
-		app_name: "Python Microservice"
-		foo: "var"
-		multiplevars:
-			config1: "test1"
-			config2: "test2"
+  config:
+    app_name: "Python Microservice"
+      foo: "var"
+        multiplevars:
+          config1: "test1"
+          config2: "test2"
   
 ```
 ```python
 #app.py
 from pyms.flask.app import Microservice
 
-ms = Microservice(service="example-config", path=__file__)
+ms = Microservice(path=__file__)
 print(ms.config.APP_NAME) 
 # >> "Python Microservice"
 print(ms.config.app_name) 

docs/ms_class.md

@@ -26,14 +26,14 @@ if __name__ == '__main__':
 config.yml
 ```yaml
 pyms: 
-	services: # 1.2
-		requests:
-			data: {}
-	config: # 1.3
-		DEBUG: true
-		APP_NAME: business-glossary
-		APPLICATION_ROOT : ""
-		SECRET_KEY: "gjr39dkjn344_!67#"
+  services: # 1.2
+    requests:
+      data: {}
+  config: # 1.3
+    DEBUG: true
+    APP_NAME: business-glossary
+    APPLICATION_ROOT : ""
+    SECRET_KEY: "gjr39dkjn344_!67#"
 ```
 
 ## So what did that code do?

docs/quickstart.md

@@ -2,4 +2,4 @@
 
 __email__ = "a.vara.1986@gmail.com"
 
-__version__ = "2.0.0rc1"
+__version__ = "2.1.0"

pyms/__init__.py

@@ -1,8 +1,6 @@
 from pyms.config.confile import ConfFile
-from pyms.exceptions import ServiceDoesNotExistException
-
-
-__service_configs = {}
+from pyms.constants import PYMS_CONFIG_WHITELIST_KEYWORDS
+from pyms.exceptions import ServiceDoesNotExistException, ConfigErrorException, AttrDoesNotExistException
 
 
 def get_conf(*args, **kwargs):
@@ -11,34 +9,98 @@ def get_conf(*args, **kwargs):
     parent and this name, in example of the next yaml, tracer will be `pyms.tracer`. If we have got his config file:
     ```
     pyms:
-      metrics: true
-      requests:
-        data: data
-      swagger:
-        path: ""
-        file: "swagger.yaml"
-      tracer:
-        client: "jaeger"
-        host: "localhost"
-        component_name: "Python Microservice"
-    my-ms:
-      DEBUG: true
-      TESTING: true
+      services:
+        metrics: true
+        requests:
+          data: data
+        swagger:
+          path: ""
+          file: "swagger.yaml"
+        tracer:
+          client: "jaeger"
+          host: "localhost"
+          component_name: "Python Microservice"
+      config:
+        DEBUG: true
+        TESTING: true
     ```
-    * `pyms` block is the default key to load in the pyms.flask.app.create_app.Microservice class.
+    * `pyms.services`: block is the default key to load in the pyms.flask.app.create_app.Microservice class.
         * `metrics`: is set as the service `pyms.metrics`
         * `swagger`: is set as the service `pyms.swagger`
         * `tracer`: is set as the service `pyms.tracer`
-    * `my-ms` block is defined by the env var `CONFIGMAP_SERVICE`. By default is `ms`. This block is the default flask
-    block config
+    * `pyms.config`: This block is the default flask block config
     :param args:
     :param kwargs:
+
     :return:
     """
     service = kwargs.pop('service', None)
-    memoize = kwargs.pop('memoize', True)
     if not service:
         raise ServiceDoesNotExistException("Service not defined")
-    if not memoize or service not in __service_configs:
-        __service_configs[service] = ConfFile(*args, **kwargs)
-    return getattr(__service_configs[service], service)
+    config = ConfFile(*args, **kwargs)
+    return getattr(config, service)
+
+
+def validate_conf(*args, **kwargs):
+    config = ConfFile(*args, **kwargs)
+    is_config_ok = True
+    try:
+        config.pyms
+    except AttrDoesNotExistException:
+        is_config_ok = False
+    if not is_config_ok:
+        raise ConfigErrorException("""Config file must start with `pyms` keyword, for example:
+    pyms:
+      services:
+        metrics: true
+        requests:
+          data: data
+        swagger:
+          path: ""
+          file: "swagger.yaml"
+        tracer:
+          client: "jaeger"
+          host: "localhost"
+          component_name: "Python Microservice"
+      config:
+        DEBUG: true
+        TESTING: true""")
+    try:
+        config.pyms.config
+    except AttrDoesNotExistException:
+        is_config_ok = False
+    if not is_config_ok:
+        raise ConfigErrorException("""`pyms` block must contain a `config` keyword in your Config file, for example:
+    pyms:
+      services:
+        metrics: true
+        requests:
+          data: data
+        swagger:
+          path: ""
+          file: "swagger.yaml"
+        tracer:
+          client: "jaeger"
+          host: "localhost"
+          component_name: "Python Microservice"
+      config:
+        DEBUG: true
+        TESTING: true""")
+    wrong_keywords = [i for i in config.pyms if i not in PYMS_CONFIG_WHITELIST_KEYWORDS]
+    if len(wrong_keywords) > 0:
+        raise ConfigErrorException("""{} isn`t a valid keyword for pyms block, for example:
+        pyms:
+          services:
+            metrics: true
+            requests:
+              data: data
+            swagger:
+              path: ""
+              file: "swagger.yaml"
+            tracer:
+              client: "jaeger"
+              host: "localhost"
+              component_name: "Python Microservice"
+          config:
+            DEBUG: true
+            TESTING: true""".format(wrong_keywords))