Merge pull request #42 from python-ellar/django-commands-patch

Ellar Version Update

Author: eadwinCode

ellar_django/commands.py

@@ -4,12 +4,6 @@
 import ellar_cli.click as click
 from django.core.management import get_commands, load_command_class
 
-BLACKLISTED_COMMANDS: t.Final[t.Set[str]] = {
-    "runserver",
-    "startapp",
-    "startproject",
-}
-
 
 class _CommandItem(t.NamedTuple):
     name: str
@@ -23,18 +17,15 @@ def get_command_description(command_name: str) -> str:
     return CommandClass.help
 
 
-def generate_command_list() -> t.List[_CommandItem]:
+def _generate_command_list(
+    blacklist_commands: t.Set[str],
+) -> t.Generator[_CommandItem, None, None]:
     commands = get_commands()
-    command_list: t.List[_CommandItem] = []
     for command in commands:
-        if command in BLACKLISTED_COMMANDS:
+        if command in blacklist_commands:
             continue
         description = get_command_description(command)
-        command_list.append(_CommandItem(name=command, description=description))
-    return command_list
-
-
-_django_support_commands = generate_command_list()
+        yield _CommandItem(name=command, description=description)
 
 
 def version_callback(ctx: click.Context, _: click.Parameter, value: bool) -> None:
@@ -44,29 +35,14 @@ def version_callback(ctx: click.Context, _: click.Parameter, value: bool) -> Non
 
 
 def show_help_callback(ctx: click.Context, _: click.Parameter, value: bool) -> None:
-    command_args = ["manage.py", ctx.info_name, "--help"]
-    django.core.management.execute_from_command_line(command_args)
-
-
-@click.group(
-    name="django",
-    help="Ellar Django Commands",
-)
-@click.option(
-    "-v",
-    "--version",
-    callback=version_callback,
-    help="Show the version and exit.",
-    is_flag=True,
-    expose_value=False,
-    is_eager=True,
-)
-@click.pass_context
-def django_command(ctx: click.Context) -> None:
-    pass
-
-
-def _add_django_command(command_item: _CommandItem) -> None:
+    if value:
+        command_args = ["manage.py", ctx.info_name, "--help"]
+        django.core.management.execute_from_command_line(command_args)
+
+
+def _add_django_command(
+    django_command: click.Group, command_item: _CommandItem
+) -> None:
     @django_command.command(
         name=command_item.name,
         help=command_item.description,
@@ -90,4 +66,28 @@ def command(
         django.core.management.execute_from_command_line(command_args)
 
 
-list(map(_add_django_command, _django_support_commands))
+def get_django_command(blacklisted_commands: t.Set[str]) -> click.Group:
+    @click.group(
+        name="django",
+        help="Ellar Django Commands",
+    )
+    @click.option(
+        "-v",
+        "--version",
+        callback=version_callback,
+        help="Show the version and exit.",
+        is_flag=True,
+        expose_value=False,
+        is_eager=True,
+    )
+    @click.pass_context
+    def django_command(ctx: click.Context) -> None:
+        pass
+
+    for command_item in _generate_command_list(blacklisted_commands):
+        _add_django_command(
+            django_command=t.cast(click.Group, django_command),
+            command_item=command_item,
+        )
+
+    return t.cast(click.Group, django_command)

ellar_django/module.py

@@ -1,4 +1,5 @@
 import os
+import typing as t
 
 from django.core.asgi import get_asgi_application
 from ellar.common import IModuleSetup, Module, ModuleRouter
@@ -7,21 +8,36 @@
 from starlette.responses import RedirectResponse
 from starlette.routing import Mount
 
-from .commands import django_command
+from ellar_django.commands import get_django_command
+
 from .middleware import DjangoAdminRedirectMiddleware
 
 _router = ModuleRouter()
+_default_blacklisted_commands: t.Set[str] = {
+    "runserver",
+    "startapp",
+    "startproject",
+}
 
 
 @_router.get("/")
 async def _redirect_route(req: Request) -> RedirectResponse:
     return RedirectResponse(url=str(req.base_url))
 
 
-@Module(commands=[django_command])
+@Module()
 class DjangoModule(IModuleSetup):
     @classmethod
-    def setup(cls, settings_module: str, path_prefix: str = "/dj") -> "DynamicModule":
+    def setup(
+        cls,
+        settings_module: str,
+        path_prefix: str = "/dj",
+        command_blacklist: t.Optional[t.Set[str]] = None,
+    ) -> "DynamicModule":
+        blacklisted_commands = set(
+            list(_default_blacklisted_commands) + list(command_blacklist or set())
+        )
+
         assert path_prefix not in [
             "",
             "/",
@@ -42,4 +58,7 @@ def setup(cls, settings_module: str, path_prefix: str = "/dj") -> "DynamicModule
                 ),
             ],
         )
-        return DynamicModule(cls, routers=[mount])
+
+        return DynamicModule(
+            cls, routers=[mount], commands=[get_django_command(blacklisted_commands)]
+        )

pyproject.toml

@@ -47,7 +47,7 @@ classifiers = [
 ]
 
 dependencies = [
-    "ellar-cli >= 0.3.7",
+    "ellar-cli >= 0.4.1",
     "Django >= 3.1",
 ]
 

tests/conftest.py

@@ -1,3 +1,4 @@
+import click.testing
 import pytest
 from django.contrib.auth import get_user_model
 from ellar.testing import Test
@@ -22,3 +23,8 @@ def admin_user():
 def client():
     with test_module.get_test_client() as _client:
         yield _client
+
+
+@pytest.fixture
+def cli_runner():
+    return click.testing.CliRunner()

tests/test_django_commands.py

@@ -1,6 +1,21 @@
 import pytest
 from django.core.management import call_command
 from django.core.management.base import CommandError
+from ellar.common.constants import MODULE_METADATA
+from ellar.reflect import reflect
+
+from ellar_django.module import DjangoModule, _default_blacklisted_commands
+
+HELP_OUTPUT = """Usage: django [OPTIONS] COMMAND [ARGS]...
+
+  Ellar Django Commands
+
+Options:
+  -v, --version  Show the version and exit.
+  --help         Show this message and exit.
+
+Commands:
+"""
 
 
 def test_command_succeeds() -> None:
@@ -10,3 +25,77 @@ def test_command_succeeds() -> None:
 def test_nonexistent_command_fails() -> None:
     with pytest.raises(CommandError, match="Unknown command"):
         call_command("nonexistent_command")
+
+
+def test_command_help(cli_runner):
+    with reflect.context():
+        DjangoModule.setup(
+            settings_module="example_app.wsgi_django.settings"
+        ).apply_configuration()
+        django_command_group = reflect.get_metadata(
+            MODULE_METADATA.COMMANDS, DjangoModule
+        )[0]
+
+        res = cli_runner.invoke(django_command_group, ["--help"])
+        assert res.exit_code == 0
+        assert HELP_OUTPUT in res.stdout
+
+
+def test_check_help(cli_runner):
+    with reflect.context():
+        DjangoModule.setup(
+            settings_module="example_app.wsgi_django.settings"
+        ).apply_configuration()
+        django_command_group = reflect.get_metadata(
+            MODULE_METADATA.COMMANDS, DjangoModule
+        )[0]
+
+        res = cli_runner.invoke(django_command_group, ["check", "--help"])
+        assert res.exit_code == 0
+        assert (
+            "usage: manage.py check [-h] [--tag TAGS] [--list-tags] [--deploy]"
+            in res.stdout
+        )
+
+
+@pytest.mark.parametrize("command_name", list(_default_blacklisted_commands))
+def test_default_blacklist_command(cli_runner, command_name):
+    with reflect.context():
+        DjangoModule.setup(
+            settings_module="example_app.wsgi_django.settings"
+        ).apply_configuration()
+        django_command_group = reflect.get_metadata(
+            MODULE_METADATA.COMMANDS, DjangoModule
+        )[0]
+
+        res = cli_runner.invoke(django_command_group, [command_name])
+        assert res.exit_code == 2
+        assert f"Error: No such command '{command_name}'" in res.stdout
+
+
+def test_django_version(cli_runner):
+    with reflect.context():
+        DjangoModule.setup(
+            settings_module="example_app.wsgi_django.settings"
+        ).apply_configuration()
+        django_command_group = reflect.get_metadata(
+            MODULE_METADATA.COMMANDS, DjangoModule
+        )[0]
+
+        res = cli_runner.invoke(django_command_group, ["-v"])
+        assert res.exit_code == 0
+        assert "Django Version: " in res.stdout
+
+
+def test_collect_static_version(cli_runner):
+    with reflect.context():
+        DjangoModule.setup(
+            settings_module="example_app.wsgi_django.settings"
+        ).apply_configuration()
+        django_command_group = reflect.get_metadata(
+            MODULE_METADATA.COMMANDS, DjangoModule
+        )[0]
+
+        res = cli_runner.invoke(django_command_group, ["check", "db_models"])
+        assert res.exit_code == 0
+        assert res.stdout == "System check identified no issues (0 silenced).\n"