Add Typer CLI #23

Author: vladyslav-fenchak

minos/api_gateway/rest/__init__.py

@@ -10,6 +10,9 @@
 from .coordinator import (
     MicroserviceCallCoordinator,
 )
+from .launchers import (
+    EntrypointLauncher,
+)
 from .service import (
     ApiGatewayRestService,
 )

minos/api_gateway/rest/cli.py

@@ -0,0 +1,68 @@
+"""
+Copyright (C) 2021 Clariteia SL
+
+This file is part of minos framework.
+
+Minos framework can not be copied and/or distributed without the express permission of Clariteia SL.
+"""
+from pathlib import (
+    Path,
+)
+from typing import (
+    Optional,
+)
+
+import typer
+
+from minos.api_gateway.common import (
+    MinosConfig,
+)
+from minos.api_gateway.rest.launchers import (
+    EntrypointLauncher,
+)
+from minos.api_gateway.rest.service import (
+    ApiGatewayRestService,
+)
+
+app = typer.Typer()
+
+
+@app.command("start")
+def start(
+    file_path: Optional[Path] = typer.Argument(
+        "config.yml", help="API Gateway configuration file.", envvar="MINOS_API_GATEWAY_CONFIG_FILE_PATH"
+    )
+):  # pragma: no cover
+    """Start Api Gateway services."""
+
+    try:
+        config = MinosConfig(file_path)
+    except Exception as exc:
+        typer.echo(f"Error loading config: {exc!r}")
+        raise typer.Exit(code=1)
+
+    services = (ApiGatewayRestService(config=config),)
+    try:
+        EntrypointLauncher(config=config, services=services).launch()
+    except Exception as exc:
+        typer.echo(f"Error launching Api Gateway: {exc!r}")
+        raise typer.Exit(code=1)
+
+    typer.echo("Api Gateway is up and running!\n")
+
+
+@app.command("status")
+def status():
+    """Get the Api Gateway status."""
+    raise NotImplementedError
+
+
+@app.command("stop")
+def stop():
+    """Stop the Api Gateway."""
+    raise NotImplementedError
+
+
+def main():  # pragma: no cover
+    """CLI's main function."""
+    app()

minos/api_gateway/rest/launchers.py

@@ -0,0 +1,55 @@
+"""
+Copyright (C) 2021 Clariteia SL
+
+This file is part of minos framework.
+
+Minos framework can not be copied and/or distributed without the express permission of Clariteia SL.
+"""
+
+import logging
+from typing import (
+    NoReturn,
+)
+
+from aiomisc import (
+    entrypoint,
+)
+from aiomisc.entrypoint import (
+    Entrypoint,
+)
+from cached_property import (
+    cached_property,
+)
+
+from minos.api_gateway.common import (
+    MinosConfig,
+)
+
+logger = logging.getLogger(__name__)
+
+
+class EntrypointLauncher:
+    """EntryPoint Launcher class."""
+
+    def __init__(self, config: MinosConfig, services: tuple, *args, **kwargs):
+        self.config = config
+        self.services = services
+
+    def launch(self) -> NoReturn:
+        """Launch a new execution and keeps running forever..
+
+        :return: This method does not return anything.
+        """
+        logger.info("Starting API Gateway...")
+        with self.entrypoint as loop:
+            logger.info("API Gateway is up and running!")
+            loop.run_forever()
+
+    @cached_property
+    def entrypoint(self) -> Entrypoint:
+        """Entrypoint instance.
+
+        :return: An ``Entrypoint`` instance.
+        """
+
+        return entrypoint(*self.services)  # pragma: no cover

poetry.lock

@@ -32,6 +32,8 @@ include = [
 [tool.poetry.dependencies]
 python = "^3.9"
 minos-apigateway-common = "^0.0.4"
+typer = "^0.3.2"
+cached-property = "^1.5.2"
 
 [tool.poetry.dev-dependencies]
 black = "^19.10b"
@@ -49,3 +51,6 @@ m2r2 = "^0.2.7"
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+api_gateway = "minos.api_gateway.rest.cli:main"

pyproject.toml

@@ -45,3 +45,7 @@ include_trailing_comma = True
 force_grid_wrap = 1
 use_parentheses = True
 line_length = 120
+
+[options.entry_points]
+console_scripts =
+    api_gateway = minos.api_gateway.rest.cli:main

setup.cfg

@@ -0,0 +1,52 @@
+import unittest
+from unittest.mock import (
+    PropertyMock,
+    patch,
+)
+
+from typer.testing import (
+    CliRunner,
+)
+
+from minos.api_gateway.common import (
+    MinosConfig,
+)
+from minos.api_gateway.rest.cli import (
+    app,
+)
+from minos.api_gateway.rest.launchers import (
+    EntrypointLauncher,
+)
+from tests.utils import (
+    BASE_PATH,
+    FakeEntrypoint,
+)
+
+runner = CliRunner()
+
+
+class Foo:
+    def __init__(self, **kwargs):
+        self.kwargs = kwargs
+
+
+class TestCli(unittest.TestCase):
+    CONFIG_FILE_PATH = BASE_PATH / "config.yml"
+
+    def setUp(self):
+        self.config = MinosConfig(self.CONFIG_FILE_PATH)
+        self.services = ["a", "b", Foo]
+        self.launcher = EntrypointLauncher(config=self.config, services=self.services)
+
+    def test_app_ko(self):
+        path = f"{BASE_PATH}/non_existing_config.yml"
+        result = runner.invoke(app, ["start", path])
+        self.assertEqual(result.exit_code, 1)
+        self.assertTrue("Error loading config" in result.stdout)
+
+    def test_launch(self):
+        entrypoint = FakeEntrypoint()
+        with patch("minos.api_gateway.rest.launchers.EntrypointLauncher.entrypoint", new_callable=PropertyMock) as mock:
+            mock.return_value = entrypoint
+            self.launcher.launch()
+        self.assertEqual(1, entrypoint.call_count)

tests/test_config.yml renamed to tests/config.yml

@@ -21,7 +21,7 @@
 
 
 class TestRestCoordinator(AioHTTPTestCase):
-    CONFIG_FILE_PATH = BASE_PATH / "test_config.yml"
+    CONFIG_FILE_PATH = BASE_PATH / "config.yml"
 
     async def get_application(self):
         """

tests/test_api_gateway/test_rest/test_cli.py

@@ -18,7 +18,7 @@
 
 
 class TestRestService(AioHTTPTestCase):
-    CONFIG_FILE_PATH = BASE_PATH / "test_config.yml"
+    CONFIG_FILE_PATH = BASE_PATH / "config.yml"
 
     async def get_application(self):
         """