Switch to explicit testing style (#199)

Author: florimondmanca

Makefile

@@ -1,7 +1,6 @@
 venv = venv
 bin = ${venv}/bin/
 pysources = src/ test_project/ tests/
-pysources_mypy = src/ test_project/ tests/conftest.py
 
 build:
 	${python} setup.py sdist bdist_wheel
@@ -11,7 +10,7 @@ build:
 check:
 	${bin}black --check --diff --target-version=py36 ${pysources}
 	${bin}flake8 ${pysources}
-	${bin}mypy ${pysources_mypy}
+	${bin}mypy ${pysources}
 	${bin}isort --check --diff ${pysources}
 	make migrations-check
 

tests/compat.py

@@ -1,17 +1,8 @@
-import typing
 from pathlib import Path
 
 import dj_database_url
 import dotenv
-import pytest
 from django.conf import settings
-from django.http import HttpRequest
-from django.test import override_settings
-
-from .compat import nullcontext
-
-if typing.TYPE_CHECKING:
-    from django.contrib.auth.base_user import AbstractBaseUser
 
 
 def pytest_configure() -> None:
@@ -58,85 +49,3 @@ def pytest_configure() -> None:
             },
         }
     )
-
-
-def _create_user() -> "AbstractBaseUser":
-    from django.contrib.auth import get_user_model
-
-    User = get_user_model()
-    return User.objects.create_user(username="foo", password="bar")
-
-
-@pytest.fixture(
-    name="key_header_config",
-    params=[
-        {"header": "HTTP_AUTHORIZATION", "default": "Api-Key {key}"},
-        {
-            "header": "HTTP_X_API_KEY",
-            "default": "{key}",
-            "set_custom_header_setting": True,
-        },
-    ],
-)
-def fixture_key_header_config(request: typing.Any) -> typing.Iterator[dict]:
-    config: dict = request.param
-
-    ctx: typing.ContextManager[None]
-    if config.get("set_custom_header_setting"):
-        ctx = override_settings(API_KEY_CUSTOM_HEADER=config["header"])  # type: ignore
-    else:
-        ctx = nullcontext()
-
-    with ctx:
-        yield config
-
-
-@pytest.fixture(name="build_create_request")
-def fixture_build_create_request(key_header_config: dict) -> typing.Callable:
-    from rest_framework.test import APIRequestFactory, force_authenticate
-
-    from rest_framework_api_key.models import AbstractAPIKey
-
-    def build_create_request(model: typing.Type[AbstractAPIKey]) -> typing.Callable:
-        request_factory = APIRequestFactory()
-
-        _MISSING = object()
-
-        def create_request(
-            authenticated: bool = False,
-            **kwargs: typing.Any,
-        ) -> HttpRequest:
-            headers = {}
-
-            authorization = kwargs.pop("authorization", _MISSING)
-
-            if authorization is not None:
-                kwargs.setdefault("name", "test")
-                _, key = model.objects.create_key(**kwargs)
-
-                if callable(authorization):
-                    authorization = authorization(key)
-
-                if authorization is _MISSING:
-                    authorization = key_header_config["default"]
-
-                headers[key_header_config["header"]] = authorization.format(key=key)
-
-            request = request_factory.get("/test/", **headers)
-
-            if authenticated:
-                user = _create_user()
-                force_authenticate(request, user)
-
-            return request
-
-        return create_request
-
-    return build_create_request
-
-
-@pytest.fixture(name="create_request")
-def fixture_create_request(build_create_request: typing.Callable) -> typing.Callable:
-    from rest_framework_api_key.models import APIKey
-
-    return build_create_request(APIKey)

tests/conftest.py

@@ -7,12 +7,12 @@
 @pytest.mark.skipif(
     django.VERSION < (3, 2), reason="app config is automatically defined by django"
 )
-def test_app_config_not_defined():
+def test_app_config_not_defined() -> None:
     assert hasattr(rest_framework_api_key, "default_app_config") is False
 
 
 @pytest.mark.skipif(
     django.VERSION >= (3, 2), reason="app config is not automatically defined by django"
 )
-def test_app_config_defined():
+def test_app_config_defined() -> None:
     assert hasattr(rest_framework_api_key, "default_app_config") is True

tests/test_compatibility.py

@@ -1,3 +1,4 @@
+import datetime as dt
 import string
 
 import pytest
@@ -12,7 +13,7 @@
 pytestmark = pytest.mark.django_db
 
 
-def test_key_generation():
+def test_key_generation() -> None:
     api_key, generated_key = APIKey.objects.create_key(name="test")
     prefix = api_key.prefix
     hashed_key = api_key.hashed_key
@@ -29,12 +30,12 @@ def test_key_generation():
     assert api_key.is_valid(hashed_key) is False
 
 
-def test_name_is_required():
+def test_name_is_required() -> None:
     with pytest.raises(IntegrityError):
         APIKey.objects.create()
 
 
-def test_cannot_unrevoke():
+def test_cannot_unrevoke() -> None:
     api_key, _ = APIKey.objects.create_key(name="test", revoked=True)
 
     # Try to unrevoke the API key programmatically.
@@ -51,12 +52,12 @@ def test_cannot_unrevoke():
     "expiry_date, has_expired",
     [(None, False), (NOW, True), (TOMORROW, False), (YESTERDAY, True)],
 )
-def test_has_expired(expiry_date, has_expired):
+def test_has_expired(expiry_date: dt.datetime, has_expired: bool) -> None:
     api_key, _ = APIKey.objects.create_key(name="test", expiry_date=expiry_date)
     assert api_key.has_expired is has_expired
 
 
-def test_custom_api_key_model():
+def test_custom_api_key_model() -> None:
     hero = Hero.objects.create()
     hero_api_key, generated_key = HeroAPIKey.objects.create_key(name="test", hero=hero)
     assert hero_api_key.is_valid(generated_key)
@@ -65,28 +66,28 @@ def test_custom_api_key_model():
 
 
 @pytest.mark.django_db
-def test_api_key_manager_get_from_key():
+def test_api_key_manager_get_from_key() -> None:
     api_key, generated_key = APIKey.objects.create_key(name="test")
     retrieved_key = APIKey.objects.get_from_key(generated_key)
     assert retrieved_key == api_key
 
 
 @pytest.mark.django_db
-def test_api_key_manager_get_from_key_missing_key():
+def test_api_key_manager_get_from_key_missing_key() -> None:
     with pytest.raises(APIKey.DoesNotExist):
         APIKey.objects.get_from_key("foobar")
 
 
 @pytest.mark.django_db
-def test_api_key_manager_get_from_key_invalid_key():
+def test_api_key_manager_get_from_key_invalid_key() -> None:
     api_key, generated_key = APIKey.objects.create_key(name="test")
     prefix, _, _ = generated_key.partition(".")
     invalid_key = f"{prefix}.foobar"
     with pytest.raises(APIKey.DoesNotExist):
         APIKey.objects.get_from_key(invalid_key)
 
 
-def test_api_key_str():
+def test_api_key_str() -> None:
     _, generated_key = APIKey.objects.create_key(name="test")
     retrieved_key = APIKey.objects.get_from_key(generated_key)
     assert str(retrieved_key) == "test"