pytest: better single unit test

Author: freemindcore

manage.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python
+import os
+import sys
+from pathlib import Path
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.config.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError:
+        # The above import may fail for some other reason. Ensure that the
+        # issue is really that Django is missing to avoid masking other
+        # exceptions on Python 2.
+        try:
+            import django  # noqa
+        except ImportError:
+            raise ImportError(
+                "Couldn't import Django. Are you sure it's installed and "
+                "available on your PYTHONPATH environment variable? Did you "
+                "forget to activate a virtual environment?"
+            )
+
+        raise
+
+    # This allows easy placement of apps within the interior
+    # tests directory.
+    current_path = Path(__file__).parent.resolve()
+    sys.path.append(str(current_path) / "tests")
+
+    execute_from_command_line(sys.argv)

pyproject.toml

@@ -79,3 +79,11 @@ doc = [
     "mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0",
     "markdown-include"
 ]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "tests.config.settings"
+asyncio_mode = "auto"
+addopts = "--nomigrations"
+filterwarnings = [
+    "ignore::django.utils.deprecation.RemovedInDjango50Warning",
+]

pytest.ini

@@ -0,0 +1,101 @@
+"""
+With these settings, tests run faster.
+"""
+
+# Admin API auto-generation settings
+AUTO_ADMIN_ENABLED_ALL_APPS = True
+AUTO_ADMIN_INCLUDE_APPS = []
+AUTO_ADMIN_EXCLUDE_APPS = []
+
+# Django Settings
+INSTALLED_APPS = (
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.sites",
+    "django.contrib.staticfiles",
+    "ninja_extra",
+    "tests.demo_app",
+    "easy",
+)
+
+MIDDLEWARE = (
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+)
+
+USE_I18N = True
+USE_TZ = True
+LANGUAGE_CODE = "en-us"
+
+STATIC_URL = "/static/"
+ROOT_URLCONF = "tests.demo_app.urls"
+
+AUTHENTICATION_BACKENDS = ("django.contrib.auth.backends.ModelBackend",)
+
+# DB
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": ":memory:",
+        # "TEST": {
+        #     # this gets you in-memory sqlite for faster testing
+        #     "ENGINE": "django.db.backends.sqlite3",
+        # },
+    }
+}
+
+# https://docs.djangoproject.com/en/dev/ref/settings/#test-runner
+TEST_RUNNER = "django.test.runner.DiscoverRunner"
+
+# CACHES
+# ------------------------------------------------------------------------------
+# https://docs.djangoproject.com/en/dev/ref/settings/#caches
+CACHES = {
+    "default": {
+        "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
+        "LOCATION": "",
+    }
+}
+
+# PASSWORDS
+# ------------------------------------------------------------------------------
+# https://docs.djangoproject.com/en/dev/ref/settings/#password-hashers
+PASSWORD_HASHERS = ["django.contrib.auth.hashers.MD5PasswordHasher"]
+
+# TEMPLATES
+# ------------------------------------------------------------------------------
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+# EMAIL
+# ------------------------------------------------------------------------------
+# https://docs.djangoproject.com/en/dev/ref/settings/#email-backend
+EMAIL_BACKEND = "django.core.mail.backends.locmem.EmailBackend"
+
+
+# Security
+ALLOWED_HOSTS = ["*"]
+SECRET_KEY = "not very secret in tests"
+
+# Debug
+DEBUG_PROPAGATE_EXCEPTIONS = True

tests/config/__init__.py

@@ -1,62 +1,45 @@
-import django
-
-
-def pytest_configure(config):
-    from django.conf import settings
-
-    settings.configure(
-        ALLOWED_HOSTS=["*"],
-        DEBUG_PROPAGATE_EXCEPTIONS=True,
-        DATABASES={
-            "default": {"ENGINE": "django.db.backends.sqlite3", "NAME": ":memory:"}
-        },
-        SITE_ID=1,
-        SECRET_KEY="not very secret in tests",
-        USE_I18N=True,
-        STATIC_URL="/static/",
-        ROOT_URLCONF="tests.demo_app.urls",
-        TEMPLATES=[
-            {
-                "BACKEND": "django.template.backends.django.DjangoTemplates",
-                "DIRS": [],
-                "APP_DIRS": True,
-                "OPTIONS": {
-                    "context_processors": [
-                        "django.template.context_processors.debug",
-                        "django.template.context_processors.request",
-                        "django.contrib.auth.context_processors.auth",
-                        "django.contrib.messages.context_processors.messages",
-                    ],
-                },
-            },
-        ],
-        MIDDLEWARE=(
-            "django.middleware.security.SecurityMiddleware",
-            "django.contrib.sessions.middleware.SessionMiddleware",
-            "django.middleware.common.CommonMiddleware",
-            "django.middleware.csrf.CsrfViewMiddleware",
-            "django.contrib.auth.middleware.AuthenticationMiddleware",
-            "django.contrib.messages.middleware.MessageMiddleware",
-            "django.middleware.clickjacking.XFrameOptionsMiddleware",
-        ),
-        INSTALLED_APPS=(
-            "django.contrib.admin",
-            "django.contrib.auth",
-            "django.contrib.contenttypes",
-            "django.contrib.sessions",
-            "django.contrib.sites",
-            "django.contrib.staticfiles",
-            "ninja_extra",
-            "tests.demo_app",
-            "easy",
-        ),
-        PASSWORD_HASHERS=("django.contrib.auth.hashers.MD5PasswordHasher",),
-        AUTHENTICATION_BACKENDS=("django.contrib.auth.backends.ModelBackend",),
-        LANGUAGE_CODE="en-us",
-        TIME_ZONE="UTC",
-        AUTO_ADMIN_ENABLED_ALL_APPS=True,
-        AUTO_ADMIN_INCLUDE_APPS=[],
-        AUTO_ADMIN_EXCLUDE_APPS=[],
-    )
-
-    django.setup()
+import copy
+
+import pytest
+from django.contrib.auth import get_user_model
+
+from easy.controller.base import CrudAPIController
+from easy.testing import EasyTestClient
+from tests.demo_app.auth import JWTAuthAsync, jwt_auth_async
+from tests.demo_app.factories import UserFactory
+
+User = get_user_model()
+
+
+@pytest.fixture(autouse=True)
+def media_storage(settings, tmpdir):
+    settings.MEDIA_ROOT = tmpdir.strpath
+
+
+@pytest.fixture
+def user(db) -> User:
+    return UserFactory()
+
+
+@pytest.fixture
+def easy_api_client(user) -> EasyTestClient:
+    orig_func = copy.deepcopy(JWTAuthAsync.__call__)
+
+    async def mock_func(self, request):
+        setattr(request, "user", user)
+        return True
+
+    setattr(JWTAuthAsync, "__call__", mock_func)
+
+    def create_client(
+        api: CrudAPIController,
+        is_staff: bool = False,
+        is_superuser: bool = False,
+    ):
+        setattr(user, "is_staff", is_staff)
+        setattr(user, "is_superuser", is_superuser)
+        client = EasyTestClient(api, auth=jwt_auth_async)
+        return client
+
+    yield create_client
+    setattr(JWTAuthAsync, "__call__", orig_func)

tests/config/settings.py

@@ -10,7 +10,7 @@
     PermissionAPIController,
 )
 from tests.demo_app.models import Client, Event
-from tests.demo_app.test_async_other_apis import dummy_data
+from tests.test_async_other_apis import dummy_data
 
 
 @pytest.mark.skipif(django.VERSION < (3, 1), reason="requires django 3.1 or higher")