ISSUE #54

* Refactor `ApiGatewayConfig` and configuration file structure.

Author: Sergio García Prado

minos/api_gateway/rest/cli.py

@@ -34,9 +34,7 @@ def start(
         typer.echo(f"Error loading config: {exc!r}")
         raise typer.Exit(code=1)
 
-    services = (
-        ApiGatewayRestService(address=config.rest.connection.host, port=config.rest.connection.port, config=config),
-    )
+    services = (ApiGatewayRestService(address=config.rest.host, port=config.rest.port, config=config),)
     try:
         EntrypointLauncher(config=config, services=services).launch()
     except Exception as exc:

minos/api_gateway/rest/config.py

@@ -19,34 +19,24 @@
     ApiGatewayConfigException,
 )
 
-CONNECTION = collections.namedtuple("Connection", "host port")
-ENDPOINT = collections.namedtuple("Endpoint", "name route method controller action")
-REST = collections.namedtuple("Rest", "connection endpoints")
-DISCOVERY_CONNECTION = collections.namedtuple("DiscoveryConnection", "host port path")
-DATABASE = collections.namedtuple("Database", "host port password")
-DISCOVERY = collections.namedtuple("Discovery", "connection endpoints database")
+REST = collections.namedtuple("Rest", "host port cors")
+DISCOVERY = collections.namedtuple("Discovery", "host port")
 CORS = collections.namedtuple("Cors", "enabled")
 
 _ENVIRONMENT_MAPPER = {
     "rest.host": "API_GATEWAY_REST_HOST",
     "rest.port": "API_GATEWAY_REST_PORT",
-    "cors.enabled": "API_GATEWAY_CORS_ENABLED",
+    "rest.cors.enabled": "API_GATEWAY_REST_CORS_ENABLED",
     "discovery.host": "DISCOVERY_SERVICE_HOST",
     "discovery.port": "DISCOVERY_SERVICE_PORT",
-    "discovery.db.host": "DISCOVERY_SERVICE_DB_HOST",
-    "discovery.db.port": "DISCOVERY_SERVICE_DB_PORT",
-    "discovery.db.password": "DISCOVERY_SERVICE_DB_PASSWORD",
 }
 
 _PARAMETERIZED_MAPPER = {
     "rest.host": "api_gateway_rest_host",
     "rest.port": "api_gateway_rest_port",
-    "cors.enabled": "api_gateway_cors_enabled",
+    "rest.cors.enabled": "api_gateway_rest_cors_enabled",
     "discovery.host": "discovery_service_host",
     "discovery.port": "discovery_service_port",
-    "discovery.db.host": "discovery_service_db_host",
-    "discovery.db.port": "discovery_service_db_port",
-    "discovery.db.password": "discovery_service_db_password",
 }
 
 
@@ -103,78 +93,20 @@ def rest(self) -> REST:
 
         :return: A ``REST`` NamedTuple instance.
         """
-        connection = self._rest_connection
-        endpoints = self._rest_endpoints
-        return REST(connection=connection, endpoints=endpoints)
+        return REST(host=self._get("rest.host"), port=int(self._get("rest.port")), cors=self._cors)
 
     @property
-    def _rest_connection(self):
-        connection = CONNECTION(host=self._get("rest.host"), port=int(self._get("rest.port")))
-        return connection
-
-    @property
-    def _rest_endpoints(self) -> list[ENDPOINT]:
-        info = self._get("rest.endpoints")
-        endpoints = [self._rest_endpoints_entry(endpoint) for endpoint in info]
-        return endpoints
-
-    @staticmethod
-    def _rest_endpoints_entry(endpoint: dict[str, t.Any]) -> ENDPOINT:
-        return ENDPOINT(
-            name=endpoint["name"],
-            route=endpoint["route"],
-            method=endpoint["method"].upper(),
-            controller=endpoint["controller"],
-            action=endpoint["action"],
-        )
-
-    @property
-    def cors(self) -> CORS:
+    def _cors(self) -> CORS:
         """Get the cors config.
 
         :return: A ``CORS`` NamedTuple instance.
         """
-        return CORS(enabled=self._get("cors.enabled"))
+        return CORS(enabled=self._get("rest.cors.enabled"))
 
     @property
     def discovery(self) -> DISCOVERY:
         """Get the rest config.
 
         :return: A ``REST`` NamedTuple instance.
         """
-        connection = self._discovery_connection
-        endpoints = self._discovery_endpoints
-        database = self._discovery_database
-        return DISCOVERY(connection=connection, endpoints=endpoints, database=database)
-
-    @property
-    def _discovery_connection(self):
-        connection = DISCOVERY_CONNECTION(
-            host=self._get("discovery.host"), port=int(self._get("discovery.port")), path=self._get("discovery.path")
-        )
-        return connection
-
-    @property
-    def _discovery_database(self):
-        connection = DATABASE(
-            host=self._get("discovery.db.host"),
-            port=int(self._get("discovery.db.port")),
-            password=self._get("discovery.db.password"),
-        )
-        return connection
-
-    @property
-    def _discovery_endpoints(self) -> list[ENDPOINT]:
-        info = self._get("discovery.endpoints")
-        endpoints = [self._discovery_endpoints_entry(endpoint) for endpoint in info]
-        return endpoints
-
-    @staticmethod
-    def _discovery_endpoints_entry(endpoint: dict[str, t.Any]) -> ENDPOINT:
-        return ENDPOINT(
-            name=endpoint["name"],
-            route=endpoint["route"],
-            method=endpoint["method"].upper(),
-            controller=endpoint["controller"],
-            action=endpoint["action"],
-        )
+        return DISCOVERY(host=self._get("discovery.host"), port=int(self._get("discovery.port")))

minos/api_gateway/rest/handler.py

@@ -25,8 +25,8 @@
 
 async def orchestrate(request: web.Request) -> web.Response:
     """ Orchestrate discovery and microservice call """
-    discovery_host = request.app["config"].discovery.connection.host
-    discovery_port = request.app["config"].discovery.connection.port
+    discovery_host = request.app["config"].discovery.host
+    discovery_port = request.app["config"].discovery.port
 
     verb = request.method
     url = f"/{request.match_info['endpoint']}"

minos/api_gateway/rest/service.py

@@ -27,7 +27,7 @@ def __init__(self, address: str, port: int, config: ApiGatewayConfig):
 
     async def create_application(self) -> web.Application:
         middlewares = list()
-        if self.config.cors.enabled:
+        if self.config.rest.cors.enabled:
             middlewares = [cors_middleware(allow_all=True)]
 
         app = web.Application(middlewares=middlewares)

tests/config.yml

@@ -1,16 +1,9 @@
 rest:
     host: localhost
     port: 55909
-    endpoints: []
+    cors:
+      enabled: false
 discovery:
     host: localhost
     port: 5567
-    path: ""
-    endpoints: []
-    db:
-        host: localhost
-        port: 6379
-        password:
-cors:
-  enabled: false
 

tests/test_api_gateway/test_rest/test_authentication.py

@@ -26,13 +26,11 @@
 class TestApiGatewayAuthentication(AioHTTPTestCase):
     CONFIG_FILE_PATH = BASE_PATH / "config.yml"
 
-    @mock.patch.dict(os.environ, {"API_GATEWAY_CORS_ENABLED": "true"})
+    @mock.patch.dict(os.environ, {"API_GATEWAY_REST_CORS_ENABLED": "true"})
     def setUp(self) -> None:
         self.config = ApiGatewayConfig(self.CONFIG_FILE_PATH)
 
-        self.discovery = MockServer(
-            host=self.config.discovery.connection.host, port=self.config.discovery.connection.port,
-        )
+        self.discovery = MockServer(host=self.config.discovery.host, port=self.config.discovery.port,)
         self.discovery.add_json_response(
             "/microservices", {"address": "localhost", "port": "5568", "status": True},
         )
@@ -62,7 +60,7 @@ async def get_application(self):
         Override the get_app method to return your application.
         """
         rest_service = ApiGatewayRestService(
-            address=self.config.rest.connection.host, port=self.config.rest.connection.port, config=self.config
+            address=self.config.rest.host, port=self.config.rest.port, config=self.config
         )
 
         return await rest_service.create_application()
@@ -102,9 +100,7 @@ class TestAuthUnreachable(AioHTTPTestCase):
     def setUp(self) -> None:
         self.config = ApiGatewayConfig(self.CONFIG_FILE_PATH)
 
-        self.discovery = MockServer(
-            host=self.config.discovery.connection.host, port=self.config.discovery.connection.port,
-        )
+        self.discovery = MockServer(host=self.config.discovery.host, port=self.config.discovery.port,)
         self.discovery.add_json_response(
             "/microservices", {"address": "localhost", "port": "5568", "status": True},
         )
@@ -129,7 +125,7 @@ async def get_application(self):
         Override the get_app method to return your application.
         """
         rest_service = ApiGatewayRestService(
-            address=self.config.rest.connection.host, port=self.config.rest.connection.port, config=self.config
+            address=self.config.rest.host, port=self.config.rest.port, config=self.config
         )
 
         return await rest_service.create_application()

tests/test_api_gateway/test_rest/test_config.py

@@ -32,90 +32,61 @@ def test_config_rest(self):
         config = ApiGatewayConfig(path=self.config_file_path)
         rest = config.rest
 
-        broker = rest.connection
-        self.assertEqual("localhost", broker.host)
-        self.assertEqual(55909, broker.port)
+        self.assertEqual("localhost", rest.host)
+        self.assertEqual(55909, rest.port)
 
     def test_config_discovery(self):
         config = ApiGatewayConfig(path=self.config_file_path)
         discovery = config.discovery
 
-        conn = discovery.connection
-        self.assertEqual("localhost", conn.host)
-        self.assertEqual(5567, conn.port)
-
-        db = discovery.database
-        self.assertEqual("localhost", db.host)
-        self.assertEqual(6379, db.port)
-        self.assertEqual(None, db.password)
-
-        self.assertEqual("", discovery.connection.path)
+        self.assertEqual("localhost", discovery.host)
+        self.assertEqual(5567, discovery.port)
 
     def test_config_cors(self):
         config = ApiGatewayConfig(path=self.config_file_path)
-        cors = config.cors
+        cors = config.rest.cors
 
         self.assertIsInstance(cors.enabled, bool)
         self.assertFalse(cors.enabled)
 
     @mock.patch.dict(os.environ, {"DISCOVERY_SERVICE_HOST": "::1"})
     def test_overwrite_with_environment_discovery_host(self):
         config = ApiGatewayConfig(path=self.config_file_path)
-        conn = config.discovery.connection
-        self.assertEqual("::1", conn.host)
+        self.assertEqual("::1", config.discovery.host)
 
     @mock.patch.dict(os.environ, {"DISCOVERY_SERVICE_PORT": "4040"})
     def test_overwrite_with_environment_discovery_port(self):
         config = ApiGatewayConfig(path=self.config_file_path)
-        conn = config.discovery.connection
-        self.assertEqual(4040, conn.port)
-
-    @mock.patch.dict(os.environ, {"DISCOVERY_SERVICE_DB_HOST": "::1"})
-    def test_overwrite_with_environment_discovery_db_host(self):
-        config = ApiGatewayConfig(path=self.config_file_path)
-        conn = config.discovery.database
-        self.assertEqual("::1", conn.host)
-
-    @mock.patch.dict(os.environ, {"DISCOVERY_SERVICE_DB_PORT": "3030"})
-    def test_overwrite_with_environment_discovery_db_port(self):
-        config = ApiGatewayConfig(path=self.config_file_path)
-        conn = config.discovery.database
-        self.assertEqual(3030, conn.port)
-
-    @mock.patch.dict(os.environ, {"DISCOVERY_SERVICE_DB_PASSWORD": "1234"})
-    def test_overwrite_with_environment_discovery_db_password(self):
-        config = ApiGatewayConfig(path=self.config_file_path)
-        conn = config.discovery.database
-        self.assertEqual("1234", conn.password)
+        self.assertEqual(4040, config.discovery.port)
 
     @mock.patch.dict(os.environ, {"API_GATEWAY_REST_HOST": "::1"})
     def test_overwrite_with_environment(self):
         config = ApiGatewayConfig(path=self.config_file_path)
         rest = config.rest
-        self.assertEqual("::1", rest.connection.host)
+        self.assertEqual("::1", rest.host)
 
     @mock.patch.dict(os.environ, {"API_GATEWAY_REST_HOST": "::1"})
     def test_overwrite_with_environment_false(self):
         config = ApiGatewayConfig(path=self.config_file_path, with_environment=False)
         rest = config.rest
-        self.assertEqual("localhost", rest.connection.host)
+        self.assertEqual("localhost", rest.host)
 
-    @mock.patch.dict(os.environ, {"API_GATEWAY_CORS_ENABLED": "false"})
+    @mock.patch.dict(os.environ, {"API_GATEWAY_REST_CORS_ENABLED": "false"})
     def test_overwrite_with_environment_cors(self):
         config = ApiGatewayConfig(path=self.config_file_path)
-        cors = config.cors
+        cors = config.rest.cors
 
         self.assertIsInstance(cors.enabled, bool)
         self.assertFalse(cors.enabled)
 
     def test_overwrite_with_parameter(self):
         config = ApiGatewayConfig(path=self.config_file_path, api_gateway_rest_host="::1")
         rest = config.rest
-        self.assertEqual("::1", rest.connection.host)
+        self.assertEqual("::1", rest.host)
 
     def test_overwrite_with_parameter_cors(self):
-        config = ApiGatewayConfig(path=self.config_file_path, api_gateway_cors_enabled=False)
-        cors = config.cors
+        config = ApiGatewayConfig(path=self.config_file_path, api_gateway_rest_cors_enabled=False)
+        cors = config.rest.cors
 
         self.assertIsInstance(cors.enabled, bool)
         self.assertFalse(cors.enabled)

tests/test_api_gateway/test_rest/test_cors.py

@@ -33,13 +33,11 @@ class TestApiGatewayCORS(AioHTTPTestCase):
     TEST_DENIED_ORIGIN = "https://www.google.com"
     TEST_ORIGIN = "http://localhost:3000"
 
-    @mock.patch.dict(os.environ, {"API_GATEWAY_CORS_ENABLED": "true"})
+    @mock.patch.dict(os.environ, {"API_GATEWAY_REST_CORS_ENABLED": "true"})
     def setUp(self) -> None:
         self.config = ApiGatewayConfig(self.CONFIG_FILE_PATH)
 
-        self.discovery = MockServer(
-            host=self.config.discovery.connection.host, port=self.config.discovery.connection.port,
-        )
+        self.discovery = MockServer(host=self.config.discovery.host, port=self.config.discovery.port,)
         self.discovery.add_json_response(
             "/microservices", {"address": "localhost", "port": "5568", "status": True},
         )
@@ -64,7 +62,7 @@ async def get_application(self):
         Override the get_app method to return your application.
         """
         rest_service = ApiGatewayRestService(
-            address=self.config.rest.connection.host, port=self.config.rest.connection.port, config=self.config
+            address=self.config.rest.host, port=self.config.rest.port, config=self.config
         )
 
         return await rest_service.create_application()