Support for application context in cli commands: Added application context loading to ellar cli commands

Author: eadwinCode

ellar_cli/main.py

@@ -8,8 +8,8 @@
 from ellar.app import AppFactory
 from ellar.common.commands import EllarTyper
 from ellar.common.constants import CALLABLE_COMMAND_INFO, MODULE_METADATA
+from ellar.core import reflector
 from ellar.core.modules import ModuleSetup
-from ellar.core.services import Reflector
 from typer.models import CommandInfo
 
 import ellar_cli
@@ -59,6 +59,8 @@ def typer_callback(
 ) -> None:
     meta_: t.Optional[EllarCLIService] = EllarCLIService.import_project_meta(project)
     ctx.meta[ELLAR_META] = meta_
+    if meta_ and meta_.has_meta:
+        ctx.with_resource(meta_.get_application_context())
 
 
 def build_typers() -> t.Any:  # pragma: no cover
@@ -82,7 +84,6 @@ def build_typers() -> t.Any:  # pragma: no cover
         module_configs = AppFactory.get_all_modules(
             ModuleSetup(meta_.import_root_module())
         )
-        reflector = Reflector()
 
         for module_config in module_configs:
             typers_commands = (

ellar_cli/manage_commands/create_module.py

@@ -5,7 +5,7 @@
 from pathlib import Path
 
 import typer
-from ellar.common.helper.module_loading import module_dir
+from ellar.common.utils.module_loading import module_dir
 
 from ellar_cli import scaffolding
 from ellar_cli.schema import EllarScaffoldSchema

ellar_cli/manage_commands/create_project.py

@@ -5,7 +5,7 @@
 from pathlib import Path
 
 import typer
-from ellar.common.helper.module_loading import module_dir
+from ellar.common.utils.module_loading import module_dir
 
 from ellar_cli import scaffolding
 from ellar_cli.constants import ELLAR_META

ellar_cli/manage_commands/new.py

@@ -4,7 +4,7 @@
 import typing as t
 
 import typer
-from ellar.common.helper.module_loading import module_dir
+from ellar.common.utils.module_loading import module_dir
 
 from ellar_cli import scaffolding
 from ellar_cli.schema import EllarScaffoldSchema

ellar_cli/manage_commands/runserver.py

@@ -1,10 +1,13 @@
 import ssl
 import sys
 import typing as t
+from datetime import datetime
 from pathlib import Path
 
+import ellar
 import typer
-from ellar.common.helper.enums import create_enums_from_list
+from ellar.app import current_config
+from ellar.common.utils.enums import create_enums_from_list
 from h11._connection import DEFAULT_MAX_INCOMPLETE_EVENT_SIZE
 from uvicorn.config import (
     HTTP_PROTOCOLS,
@@ -245,12 +248,12 @@ def runserver(
             "No available project found. please create ellar project with `ellar create-project 'project-name'`"
         )
 
-    application = None if factory else ellar_project_meta.project_meta.application
+    application_import_string = (
+        None if factory else ellar_project_meta.project_meta.application
+    )
 
-    config = ellar_project_meta.get_application_config()
-
-    log_config = config.LOGGING_CONFIG
-    _log_level = config.LOG_LEVEL
+    log_config = current_config.LOGGING_CONFIG
+    _log_level = current_config.LOG_LEVEL
 
     _log_level = log_level if log_level else _log_level or LOG_LEVELS.info
 
@@ -304,4 +307,12 @@ def runserver(
             ws_per_message_deflate=ws_per_message_deflate,
         )
 
-    uvicorn_run(application, **init_kwargs)
+    now = datetime.now().strftime("%B %d, %Y - %X")
+    version = ellar.__version__
+    print(
+        f"\nStarting Uvicorn server...\n"
+        f"{now}\n"
+        f"Ellar version {version}, using settings {current_config.config_module!r}\n"
+    )
+
+    uvicorn_run(application_import_string, **init_kwargs)

ellar_cli/service.py

@@ -1,10 +1,12 @@
+import functools
 import os
 import typing as t
 
 from click import ClickException
 from ellar.app import App
+from ellar.app.context import ApplicationContext
 from ellar.common.constants import ELLAR_CONFIG_MODULE
-from ellar.common.helper.importer import import_from_string
+from ellar.common.utils.importer import import_from_string
 from ellar.core import Config, ModuleBase
 from tomlkit import dumps as tomlkit_dumps
 from tomlkit import parse as tomlkit_parse
@@ -19,6 +21,21 @@
 ELLAR_PROJECTS_KEY = "projects"
 
 
+def _export_ellar_config_module(func: t.Callable) -> t.Callable:
+    """Ensure Ellar Config Module is Exported"""
+
+    @functools.wraps(func)
+    def _wrap(self: "EllarCLIService", *args: t.Any, **kwargs: t.Any) -> t.Any:
+        if os.environ.get(ELLAR_CONFIG_MODULE) is None and self.has_meta:
+            # export ELLAR_CONFIG_MODULE module
+            os.environ.setdefault(
+                ELLAR_CONFIG_MODULE, self._meta.config  # type:ignore[union-attr]
+            )
+        return func(self, *args, **kwargs)
+
+    return _wrap
+
+
 class EllarCLIException(ClickException):
     pass
 
@@ -189,6 +206,7 @@ def write_py_project(path: str, content: Table) -> None:
         with open(path, mode="w") as fw:
             fw.writelines(tomlkit_dumps(content))
 
+    @_export_ellar_config_module
     def import_application(self) -> "App":
         assert self._meta
         application_module = t.cast("App", import_from_string(self._meta.application))
@@ -199,14 +217,21 @@ def import_configuration(self) -> t.Type["Config"]:
         config = t.cast(t.Type["Config"], import_from_string(self._meta.config))
         return config
 
+    @_export_ellar_config_module
     def get_application_config(self) -> "Config":
         assert self._meta
         config = Config(os.environ.get(ELLAR_CONFIG_MODULE, self._meta.config))
         return config
 
+    @_export_ellar_config_module
     def import_root_module(self) -> t.Type["ModuleBase"]:
         assert self._meta
         root_module = t.cast(
             t.Type["ModuleBase"], import_from_string(self._meta.root_module)
         )
         return root_module
+
+    @_export_ellar_config_module
+    def get_application_context(self) -> ApplicationContext:
+        app = t.cast(App, self.import_application())
+        return app.application_context()

tests/test_ellar_commands/test_create_module_command.py

@@ -14,7 +14,7 @@ def test_create_module_fails_for_invalid_module_name(
 
 def test_create_module_with_directory_case_1(process_runner, tmpdir):
     result = process_runner(["ellar", "create-module", "test_new_module", "app/"])
-    assert result.returncode == 0
+    assert result.returncode == 0, result.stderr
     assert result.stdout == b"test_new_module module completely scaffolded\n"
 
     module_path = os.path.join(tmpdir, "app", "test_new_module")
@@ -36,7 +36,7 @@ def test_create_module_with_directory_case_2(process_runner, tmpdir):
     result = process_runner(
         ["ellar", "create-module", "test_new_module", "."], cwd=tmpdir
     )
-    assert result.returncode == 0
+    assert result.returncode == 0, result.stderr
     assert result.stdout == b"test_new_module module completely scaffolded\n"
 
     files = os.listdir(tmpdir / "test_new_module")
@@ -101,7 +101,7 @@ def test_create_module_works(tmpdir, process_runner, write_empty_py_project):
             "test_new_module",
         ]
     )
-    assert result.returncode == 0
+    assert result.returncode == 0, result.stderr
     assert result.stdout == b"test_new_module module completely scaffolded\n"
 
     module_path = os.path.join(tmpdir, "test_new_module")

tests/test_ellar_commands/test_create_project_command.py

@@ -13,10 +13,15 @@ def test_create_project_fails_for_py_project_none(cli_runner):
 
 
 def test_create_project_fails_for_existing_project_name(
-    cli_runner, add_ellar_project_to_py_project
+    cli_runner, write_empty_py_project, tmpdir
 ):
-    add_ellar_project_to_py_project("testing_new_project")
-    result = cli_runner.invoke_ellar_command(["create-project", "testing_new_project"])
+    module_name = "testing_new_project"
+    os.makedirs(os.path.join(tmpdir, module_name), exist_ok=True)
+    # add_ellar_project_to_py_project("testing_new_project")
+    result = cli_runner.invoke_ellar_command(["create-project", module_name])
+    assert result.exit_code == 0
+    result = cli_runner.invoke_ellar_command(["create-project", module_name])
+
     assert result.exit_code == 1
     assert result.output == "Error: Ellar Project already exist.\n"
 
@@ -54,7 +59,7 @@ def test_create_project_works_for_existing_folder_with_same_project_name(
     os.makedirs(os.path.join(tmpdir, module_name), exist_ok=True)
 
     result = cli_runner.invoke_ellar_command(["create-project", module_name])
-    assert result.exit_code == 0
+    assert result.exit_code == 0, result.stderr
     assert result.output == (
         "`new_project_module_2` project scaffold completed. To start your server, run the command below\n"
         "ellar --project new_project_module_2 runserver --reload\n"
@@ -64,7 +69,7 @@ def test_create_project_works_for_existing_folder_with_same_project_name(
 
 def test_create_project_command_works(tmpdir, process_runner, write_empty_py_project):
     result = process_runner(["ellar", "create-project", "ellar_project"])
-    assert result.returncode == 0
+    assert result.returncode == 0, result.stderr
     assert result.stdout.decode("utf8") == (
         "`ellar_project` project scaffold completed. To start your server, run the command below\n"
         "ellar --project ellar_project runserver --reload\n"
@@ -86,7 +91,7 @@ def test_create_project_command_works_with_specific_directory(
     tmpdir, process_runner, write_empty_py_project
 ):
     result = process_runner(["ellar", "create-project", "ellar_project", "Another/me"])
-    assert result.returncode == 0
+    assert result.returncode == 0, result.stderr
     assert result.stdout.decode("utf8") == (
         "`ellar_project` project scaffold completed. To start your server, run the command below\n"
         "ellar --project ellar_project runserver --reload\n"

tests/test_ellar_commands/test_new_command.py

@@ -7,7 +7,7 @@
 
 def test_new_command_works(tmpdir, process_runner):
     result = process_runner(["ellar", "new", "ellar-project-new"])
-    assert result.returncode == 0
+    assert result.returncode == 0, result.stderr
     assert result.stdout.decode("utf8") == (
         "`ellar_project_new` project created successfully.\n"
         "- cd ellar-project-new\n"
@@ -27,7 +27,7 @@ def test_new_command_works(tmpdir, process_runner):
 
 def test_new_command_works_with_specific_directory_case_1(tmpdir, process_runner):
     result = process_runner(["ellar", "new", "ellar-project-new", "Another/me"])
-    assert result.returncode == 0
+    assert result.returncode == 0, result.stderr
     assert result.stdout.decode("utf8") == (
         "`ellar_project_new` project created successfully.\n"
         "- cd another/me\n"
@@ -49,7 +49,7 @@ def test_new_command_works_with_specific_directory_case_3(tmpdir, process_runner
     _path = tmpdir / "23-August-2023"
     os.makedirs(_path)
     result = process_runner(["ellar", "new", "ellar-project-new", str(_path)])
-    assert result.returncode == 0
+    assert result.returncode == 0, result.stderr
     assert (
         "ellar --project ellar_project_new runserver --reload"
         in result.stdout.decode("utf8")
@@ -58,15 +58,15 @@ def test_new_command_works_with_specific_directory_case_3(tmpdir, process_runner
 
 def test_new_command_fails_case_1(tmpdir, process_runner):
     result = process_runner(["ellar", "new", "ellar-project-new", "Another/me"])
-    assert result.returncode == 0
+    assert result.returncode == 0, result.stderr
     result = process_runner(["ellar", "new", "ellar-project-new", "Another/me"])
     assert result.returncode == 1
     assert "Scaffolding Project Directory is not empty." in result.stderr.decode("utf8")
 
 
 def test_new_command_works_with_specific_directory_case_2(tmpdir, process_runner):
     result = process_runner(["ellar", "new", "ellar-project-new", "."])
-    assert result.returncode == 0
+    assert result.returncode == 0, result.stderr
     assert result.stdout.decode("utf8") == (
         "`ellar_project_new` project created successfully.\n\n"
         "To start your server, run the command below\n"

tests/test_ellar_commands/test_runserver_command.py

@@ -29,7 +29,7 @@ def test_runserver_command_works(cli_runner, process_runner, write_empty_py_proj
     process_runner(["ellar", "create-project", "ellar_project_1_0"])
     with mock.patch.object(runserver, "uvicorn_run") as mock_run:
         result = cli_runner.invoke_ellar_command(["runserver"])
-    assert result.exit_code == 0
+    assert result.exit_code == 0, result.stderr
     mock_run.assert_called_once()
     ellar_cli_service = EllarCLIService.import_project_meta()
     assert mock_run.call_args[0] == (ellar_cli_service.project_meta.application,)
@@ -43,7 +43,7 @@ def test_cli_headers(
         result = cli_runner.invoke_ellar_command(["runserver", "--header", HEADERS])
 
     assert result.output == ""
-    assert result.exit_code == 0
+    assert result.exit_code == 0, result.stderr
     mock_run.assert_called_once()
     assert mock_run.call_args[1]["headers"] == [
         [
@@ -60,7 +60,7 @@ def test_cli_call_change_reload_run(
     with mock.patch.object(runserver, "uvicorn_run") as mock_run:
         result = cli_runner.invoke_ellar_command(["runserver", "--reload"])
 
-    assert result.exit_code == 0
+    assert result.exit_code == 0, result.stderr
     mock_run.assert_called_once()
     assert mock_run.call_args[1]["reload"] is True
 
@@ -72,7 +72,7 @@ def test_cli_call_multiprocess_run(
     with mock.patch.object(runserver, "uvicorn_run") as mock_run:
         result = cli_runner.invoke_ellar_command(["runserver", "--workers=2"])
 
-    assert result.exit_code == 0
+    assert result.exit_code == 0, result.stderr
     mock_run.assert_called_once()
     assert mock_run.call_args[1]["workers"] == 2
 
@@ -89,7 +89,7 @@ def test_cli_uds(
             ["runserver", "--workers=2", "--uds", str(uds_file)]
         )
 
-    assert result.exit_code == 0
+    assert result.exit_code == 0, result.stderr
     assert result.output == ""
     mock_run.assert_called_once()
     assert mock_run.call_args[1]["workers"] == 2
@@ -106,7 +106,7 @@ def test_cli_event_size(cli_runner, process_runner, write_empty_py_project) -> N
             ["runserver", "--h11-max-incomplete-event-size", str(32 * 1024)]
         )
     assert result.output == ""
-    assert result.exit_code == 0
+    assert result.exit_code == 0, result.stderr
     mock_run.assert_called_once()
     assert mock_run.call_args[1]["h11_max_incomplete_event_size"] == 32768
 
@@ -127,7 +127,7 @@ def test_env_variables(
     with mock.patch.object(runserver, "uvicorn_run") as mock_run:
         result = cli_runner.invoke_ellar_command(["runserver"], env=os.environ)
     assert result.output == ""
-    assert result.exit_code == 0
+    assert result.exit_code == 0, result.stderr
     _, kwargs = mock_run.call_args
     assert kwargs["http"] == "auto"
 
@@ -141,6 +141,6 @@ def test_mis_match_env_variables(
             ["runserver", "--http=httptools"], env=os.environ
         )
     assert result.output == ""
-    assert result.exit_code == 0
+    assert result.exit_code == 0, result.stderr
     _, kwargs = mock_run.call_args
     assert kwargs["http"] == "httptools"