Tests

Author: kalekseev

MANIFEST.in

@@ -3,6 +3,7 @@ graft .github
 
 
 include src/extra_checks/py.typed
+include conftest.py
 recursive-include tests *.py
 
 global-exclude __pycache__

conftest.py

@@ -0,0 +1,21 @@
+import pytest
+from extra_checks.checks.self_checks import CheckConfig
+from extra_checks.controller import Registry
+
+
+@pytest.fixture
+def registry() -> Registry:
+    registry = Registry()
+    registry._register(["extra_checks_selfcheck"], CheckConfig)
+    return registry
+
+
+@pytest.fixture
+def use_models(monkeypatch):
+    def f(*models):
+        monkeypatch.setattr(
+            "extra_checks.controller.ChecksController._get_models_to_check",
+            lambda *a: (m for m in models),
+        )
+
+    return f

pytest.ini

@@ -1,6 +1,6 @@
 [pytest]
 addopts = -p no:doctest
       --cov=extra_checks
-      --cov-fail-under 60
+      --cov-branch
       --ds=tests.settings
 django_find_project = false

src/extra_checks/ast.py

@@ -122,6 +122,8 @@ def verbose_name(self) -> Union[None, ast.Constant, ast.Call]:
             node = self.args[0]
             if isinstance(node, ast.Call) and hasattr(node.func, "id"):
                 return node
+            elif isinstance(node, (ast.Constant, ast.Str)):
+                return node
         return None
 
     @cached_property

src/extra_checks/checks/model_checks.py

@@ -13,15 +13,15 @@
 from .base_checks import BaseCheck
 
 
-class CheckAttrsForm(BaseCheckForm):
+class AttrsForm(BaseCheckForm):
     attrs = ListField(forms.CharField())
 
 
-class CheckMetaAttrsForm(BaseCheckForm):
+class MetaAttrsForm(BaseCheckForm):
     attrs = forms.MultipleChoiceField(choices=[(o, o) for o in META_ATTRS])
 
 
-class ModelCheck(BaseCheck):
+class CheckModel(BaseCheck):
     @abstractmethod
     def apply(
         self, model: Type[models.Model], model_ast: ModelAST
@@ -30,9 +30,9 @@ def apply(
 
 
 @register(django.core.checks.Tags.models)
-class CheckModelAttribute(ModelCheck):
+class CheckModelAttribute(CheckModel):
     Id = CheckId.X010
-    settings_form_class = CheckAttrsForm
+    settings_form_class = AttrsForm
 
     def __init__(self, attrs: List[str], **kwargs: Any) -> None:
         self.attrs = attrs
@@ -55,9 +55,9 @@ def apply(
 
 
 @register(django.core.checks.Tags.models)
-class CheckModelMetaAttribute(ModelCheck):
+class CheckModelMetaAttribute(CheckModel):
     Id = CheckId.X011
-    settings_form_class = CheckMetaAttrsForm
+    settings_form_class = MetaAttrsForm
 
     def __init__(self, attrs: List[str], **kwargs: Any) -> None:
         self.attrs = attrs

src/extra_checks/checks/model_field_checks.py

@@ -13,7 +13,7 @@
 from .base_checks import BaseCheck, BaseCheckMixin
 
 
-class ModelFieldCheck(BaseCheck):
+class CheckModelField(BaseCheck):
     @abstractmethod
     def apply(
         self,
@@ -25,12 +25,12 @@ def apply(
         raise NotImplementedError()
 
 
-class CheckGettTextFuncForm(BaseCheckForm):
+class GettTextFuncForm(BaseCheckForm):
     gettext_func = forms.CharField(required=False)
 
 
 class GetTextMixin(BaseCheckMixin):
-    settings_form_class = CheckGettTextFuncForm
+    settings_form_class = GettTextFuncForm
 
     def __init__(self, gettext_func: str, **kwargs: Any) -> None:
         self.gettext_func = gettext_func or "_"
@@ -44,7 +44,7 @@ def _is_gettext_node(self, node: ast.AST) -> bool:
 
 
 @register(django.core.checks.Tags.models)
-class CheckFieldVerboseName(ModelFieldCheck):
+class CheckFieldVerboseName(CheckModelField):
     Id = CheckId.X050
 
     def apply(
@@ -59,7 +59,7 @@ def apply(
 
 
 @register(django.core.checks.Tags.models)
-class CheckFieldVerboseNameGettext(GetTextMixin, ModelFieldCheck):
+class CheckFieldVerboseNameGettext(GetTextMixin, CheckModelField):
     Id = CheckId.X051
 
     def apply(
@@ -74,7 +74,7 @@ def apply(
 
 
 @register(django.core.checks.Tags.models)
-class CheckFieldVerboseNameGettextCase(GetTextMixin, ModelFieldCheck):
+class CheckFieldVerboseNameGettextCase(GetTextMixin, CheckModelField):
     Id = CheckId.X052
 
     def apply(
@@ -93,7 +93,7 @@ def apply(
 
 
 @register(django.core.checks.Tags.models)
-class CheckFieldHelpTextGettext(GetTextMixin, ModelFieldCheck):
+class CheckFieldHelpTextGettext(GetTextMixin, CheckModelField):
     Id = CheckId.X053
 
     def apply(
@@ -108,7 +108,7 @@ def apply(
 
 
 @register(django.core.checks.Tags.models)
-class CheckFieldFileUploadTo(ModelFieldCheck):
+class CheckFieldFileUploadTo(CheckModelField):
     Id = CheckId.X054
 
     def apply(
@@ -124,7 +124,7 @@ def apply(
 
 
 @register(django.core.checks.Tags.models)
-class CheckFieldTextNull(ModelFieldCheck):
+class CheckFieldTextNull(CheckModelField):
     Id = CheckId.X055
 
     def apply(
@@ -141,7 +141,7 @@ def apply(
 
 
 @register(django.core.checks.Tags.models)
-class CheckFieldNullBoolean(ModelFieldCheck):
+class CheckFieldNullBoolean(CheckModelField):
     Id = CheckId.X056
 
     def apply(
@@ -156,7 +156,7 @@ def apply(
 
 
 @register(django.core.checks.Tags.models)
-class CheckFieldNullFalse(ModelFieldCheck):
+class CheckFieldNullFalse(CheckModelField):
     Id = CheckId.X057
 
     def apply(
@@ -178,7 +178,7 @@ class CheckFieldForeignKeyIndexForm(BaseCheckForm):
 
 
 @register(django.core.checks.Tags.models)
-class CheckFieldForeignKeyIndex(ModelFieldCheck):
+class CheckFieldForeignKeyIndex(CheckModelField):
     Id = CheckId.X058
     settings_form_class = CheckFieldForeignKeyIndexForm
 

src/extra_checks/checks/self_checks.py

@@ -7,8 +7,23 @@
 from .base_checks import BaseCheck
 
 
+def dict_to_text(data: dict, indent_level: int = 0) -> str:
+    output = []
+    for field, errors in data.items():
+        if not errors:
+            continue
+        output.append(f"{' '*indent_level * 2}* {field}")
+        if isinstance(errors, dict):
+            output.append(dict_to_text(errors, indent_level + 1))
+        else:
+            output.append(
+                "\n".join(f"{' '*(indent_level * 2 + 2)}* {e}" for e in errors)
+            )
+    return "\n".join(output)
+
+
 @register("extra_checks_selfcheck")
-class CheckX001(BaseCheck):
+class CheckConfig(BaseCheck):
     Id = CheckId.X001
     level = django.core.checks.CRITICAL
 
@@ -19,5 +34,5 @@ def apply(
             yield self.message(
                 "Invalid EXTRA_CHECKS config.",
                 hint="Fix EXTRA_CHECKS in your settings. Errors:\n"
-                + (obj.errors.as_text() if obj.errors else "No details."),
+                + (dict_to_text(obj.errors) if obj.errors else "No details."),
             )

src/extra_checks/controller.py

@@ -1,4 +1,5 @@
 import site
+from functools import partial
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -35,17 +36,24 @@ class Registry:
     def __init__(self) -> None:
         self.checks: Dict["Type[BaseCheck]", Sequence[str]] = {}
 
-    def register(self, *tags: str) -> Callable[["Type[BaseCheck]"], "Type[BaseCheck]"]:
-        def inner(check_class: "Type[BaseCheck]") -> "Type[BaseCheck]":
-            self.checks[check_class] = tags
-            return check_class
+    def _register(
+        self, tags: List[str], check_class: "Type[BaseCheck]"
+    ) -> "Type[BaseCheck]":
+        self.checks[check_class] = tags
+        return check_class
 
-        return inner
+    def register(self, *tags: str) -> Callable[["Type[BaseCheck]"], "Type[BaseCheck]"]:
+        return partial(self._register, tags)
 
-    def finish(self) -> None:
+    def finish(self) -> "ChecksController":
         controller = ChecksController.create(self.checks)
 
         def f(callback: Callable) -> Callable:
+            """
+            Django does `check.tags = ...`, callback is a method of the controller
+            and setattr will fail on it so we wrap method with a function.
+            """
+
             def inner(*args: Any, **kwargs: Any) -> Any:
                 return callback(*args, **kwargs)
 
@@ -58,6 +66,8 @@ def inner(*args: Any, **kwargs: Any) -> Any:
             f(controller.check_models), django.core.checks.Tags.models
         )
 
+        return controller
+
 
 class ChecksController:
     def __init__(
@@ -100,7 +110,7 @@ def is_healthy(self) -> bool:
         return not self.errors
 
     def check_extra_checks_health(
-        self, app_configs: Optional[List[Any]], **kwargs: Any
+        self, app_configs: Optional[List[Any]] = None, **kwargs: Any
     ) -> Iterator[django.core.checks.CheckMessage]:
         for check in self.registered_checks.get("extra_checks_selfcheck", []):
             yield from check(self)
@@ -117,14 +127,14 @@ def _get_models_to_check(
                 yield from app.get_models()
 
     def check_models(
-        self, app_configs: Optional[List[Any]], **kwargs: Any
+        self, app_configs: Optional[List[Any]] = None, **kwargs: Any
     ) -> Iterator[Any]:
-        from .checks import ModelFieldCheck
+        from .checks import CheckModelField
 
         model_checks = []
         field_checks = []
         for check in self.registered_checks.get(django.core.checks.Tags.models, []):
-            if isinstance(check, ModelFieldCheck):
+            if isinstance(check, CheckModelField):
                 field_checks.append(check)
             else:
                 model_checks.append(check)

tests/example/models.py

@@ -1,5 +1,16 @@
+from django.contrib.sites.models import Site
 from django.db import models
 
 
-class CheckOne(models.Model):
-    title = models.CharField(max_length=100)
+class Article(models.Model):
+    site = models.ForeignKey(Site, verbose_name="site", on_delete=models.CASCADE)
+    title = models.CharField("article title", max_length=100)
+    text = models.TextField(verbose_name="article text")
+
+    class Meta:
+        verbose_name = "Site Article"
+
+
+class Author(models.Model):
+    first_name = models.CharField(max_length=100)
+    last_name = models.CharField(max_length=100)

tests/settings.py

@@ -2,7 +2,7 @@
 
 ALLOWED_HOSTS = ["*"]
 
-INSTALLED_APPS = ["tests.example"]
+INSTALLED_APPS = ["django.contrib.sites", "tests.example"]
 
 DATABASES = {"default": {"ENGINE": "django.db.backends.sqlite3"}}