Fix swagger openapi 3 (#100)

avara1986 · web-flow · commit 75b5a8b1524c · 2020-03-16T20:20:00.000+01:00
* Fix swagger path in openapi 3.0

* Fix pylint
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/pyms/flask/services/swagger.py b/pyms/flask/services/swagger.py
@@ -3,6 +3,7 @@
 import connexion
 from connexion.resolver import RestyResolver
 
+from pyms.exceptions import AttrDoesNotExistException
 from pyms.flask.services.driver import DriverService
 from pyms.utils import check_package_exists
 
@@ -31,6 +32,14 @@ class Service(DriverService):
         "project_dir": PROJECT_DIR
     }
 
+    @staticmethod
+    def _get_application_root(config):
+        try:
+            application_root = config.APPLICATION_ROOT
+        except AttrDoesNotExistException:
+            application_root = "/"
+        return application_root
+
     def init_app(self, config, path):
         """
         Initialize Connexion App. See more info in [Connexion Github](https://github.com/zalando/connexion)
@@ -57,6 +66,7 @@ def init_app(self, config, path):
         """
         check_package_exists("connexion")
         specification_dir = self.path
+        application_root = self._get_application_root(config)
         if not os.path.isabs(self.path):
             specification_dir = os.path.join(path, self.path)
 
@@ -67,11 +77,13 @@ def init_app(self, config, path):
         params = {
             "specification": self.file,
             "arguments": {'title': config.APP_NAME},
+            "base_path": application_root,
             "options": {"swagger_url": self.url},
         }
+
         # Fix Connexion issue https://github.com/zalando/connexion/issues/1135
-        if config.APPLICATION_ROOT and config.APPLICATION_ROOT != "/":
-            params["base_path"] = config.APPLICATION_ROOT
+        if application_root == "/":
+            params["base_path"] = ""
 
         app.add_api(**params)
         # Invert the objects, instead connexion with a Flask object, a Flask object with
diff --git a/tests/config-tests-flask-swagger.yml b/tests/config-tests-flask-swagger.yml
@@ -7,7 +7,6 @@ pyms:
     DEBUG: true
     TESTING: true
     APP_NAME: "Python Microservice With Flask in tests"
-    APPLICATION_ROOT: /
     test_var: general
     subservice1:
        test: input
diff --git a/tests/config-tests-flask.yml b/tests/config-tests-flask.yml
@@ -3,7 +3,6 @@ pyms:
     DEBUG: true
     TESTING: true
     APP_NAME: "Python Microservice With Flask"
-    APPLICATION_ROOT: /
     test_var: general
     subservice1:
        test: input
diff --git a/tests/config-tests-metrics.yml b/tests/config-tests-metrics.yml
@@ -9,4 +9,4 @@ pyms:
     DEBUG: true
     TESTING: true
     APP_NAME: "Python Microservice with Jaeger"
-    APPLICATION_ROOT: /
+    APPLICATION_ROOT: "/"
diff --git a/tests/config-tests-swagger_3.yml b/tests/config-tests-swagger_3.yml
@@ -0,0 +1,13 @@
+pyms:
+  services:
+    metrics:
+      enabled: false
+    swagger:
+      path: ""
+      file: "swagger3.yaml"
+      url: "/ws-doc/"
+  config:
+    DEBUG: true
+    TESTING: true
+    APP_NAME: "Python Microservice Swagger Openapi 3"
+    APPLICATION_ROOT: ""
diff --git a/tests/config-tests-swagger_3_no_abs_path.yml b/tests/config-tests-swagger_3_no_abs_path.yml
@@ -0,0 +1,13 @@
+pyms:
+  services:
+    metrics:
+      enabled: false
+    swagger:
+      path: ""
+      file: "swagger3.yaml"
+      url: "/ws-doc2/"
+  config:
+    DEBUG: true
+    TESTING: true
+    APP_NAME: "Python Microservice Swagger Openapi 3 No abspath"
+    APPLICATION_ROOT: "/test-api-path2"
diff --git a/tests/config-tests.yml b/tests/config-tests.yml
@@ -14,7 +14,6 @@ pyms:
     debug: true
     testing: true
     app_name: "Python Microservice"
-    application_root: /
     test_var: general
     subservice1:
        test: input
diff --git a/tests/swagger3.yaml b/tests/swagger3.yaml
@@ -0,0 +1,21 @@
+---
+openapi: 3.0.2
+info:
+  title: Testing
+  version: 1.0.0
+  description: Testing
+  termsOfService: http://swagger.io/terms/
+  contact:
+    name: Testing
+    email: test@test.com
+servers:
+- url: http://localhost:8080/test/path/
+  description: ""
+paths:
+  /test-url:
+    summary: get test
+    get:
+      responses:
+        "200":
+          description: OK
+      operationId: "tests.test_flask.home"
diff --git a/tests/test_metrics.py b/tests/test_metrics.py
@@ -4,15 +4,15 @@
 from prometheus_client import generate_latest
 
 from pyms.constants import CONFIGMAP_FILE_ENVIRONMENT
-from tests.common import MyMicroservice
+from tests.common import MyMicroserviceNoSingleton
 
 
 class TestMetricsFlask(unittest.TestCase):
     BASE_DIR = os.path.dirname(os.path.abspath(__file__))
 
     def setUp(self):
         os.environ[CONFIGMAP_FILE_ENVIRONMENT] = os.path.join(self.BASE_DIR, "config-tests-metrics.yml")
-        ms = MyMicroservice(path=__file__)
+        ms = MyMicroserviceNoSingleton(path=__file__)
         ms.reload_conf()
         self.app = ms.create_app()
         self.client = self.app.test_client()
diff --git a/tests/test_swagger.py b/tests/test_swagger.py
@@ -49,3 +49,47 @@ def test_default(self):
     def test_home(self):
         response = self.client.get('/test-api-path2/no-abs-path')
         self.assertEqual(200, response.status_code)
+
+
+class SwaggerOpenapi3Tests(unittest.TestCase):
+    """Test common rest operations wrapper.
+    """
+
+    BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+
+    def setUp(self):
+        os.environ[CONFIGMAP_FILE_ENVIRONMENT] = os.path.join(self.BASE_DIR, "config-tests-swagger_3.yml")
+        ms = MyMicroserviceNoSingleton(path=__file__)
+        self.app = ms.create_app()
+        self.client = self.app.test_client()
+        self.assertEqual("Python Microservice Swagger Openapi 3", self.app.config["APP_NAME"])
+
+    def test_default(self):
+        response = self.client.get('/ws-doc/')
+        self.assertEqual(200, response.status_code)
+
+    def test_home(self):
+        response = self.client.get('/test-url')
+        self.assertEqual(200, response.status_code)
+
+
+class SwaggerOpenapi3NoAbsPathTests(unittest.TestCase):
+    """Test common rest operations wrapper.
+    """
+
+    BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+
+    def setUp(self):
+        os.environ[CONFIGMAP_FILE_ENVIRONMENT] = os.path.join(self.BASE_DIR, "config-tests-swagger_3_no_abs_path.yml")
+        ms = MyMicroserviceNoSingleton(path=__file__)
+        self.app = ms.create_app()
+        self.client = self.app.test_client()
+        self.assertEqual("Python Microservice Swagger Openapi 3 No abspath", self.app.config["APP_NAME"])
+
+    def test_default(self):
+        response = self.client.get('/test-api-path2/ws-doc2/')
+        self.assertEqual(200, response.status_code)
+
+    def test_home(self):
+        response = self.client.get('/test-api-path2/test-url')
+        self.assertEqual(200, response.status_code)
