initial commit

benchcoach/users/tests/factories.py

@@ -0,0 +1,32 @@
+from typing import Any, Sequence
+
+from django.contrib.auth import get_user_model
+from factory import Faker, post_generation
+from factory.django import DjangoModelFactory
+
+
+class UserFactory(DjangoModelFactory):
+
+    username = Faker("user_name")
+    email = Faker("email")
+    name = Faker("name")
+
+    @post_generation
+    def password(self, create: bool, extracted: Sequence[Any], **kwargs):
+        password = (
+            extracted
+            if extracted
+            else Faker(
+                "password",
+                length=42,
+                special_chars=True,
+                digits=True,
+                upper_case=True,
+                lower_case=True,
+            ).evaluate(None, None, extra={"locale": None})
+        )
+        self.set_password(password)
+
+    class Meta:
+        model = get_user_model()
+        django_get_or_create = ["username"]

benchcoach/users/tests/test_admin.py

@@ -0,0 +1,40 @@
+import pytest
+from django.urls import reverse
+
+from benchcoach.users.models import User
+
+pytestmark = pytest.mark.django_db
+
+
+class TestUserAdmin:
+    def test_changelist(self, admin_client):
+        url = reverse("admin:users_user_changelist")
+        response = admin_client.get(url)
+        assert response.status_code == 200
+
+    def test_search(self, admin_client):
+        url = reverse("admin:users_user_changelist")
+        response = admin_client.get(url, data={"q": "test"})
+        assert response.status_code == 200
+
+    def test_add(self, admin_client):
+        url = reverse("admin:users_user_add")
+        response = admin_client.get(url)
+        assert response.status_code == 200
+
+        response = admin_client.post(
+            url,
+            data={
+                "username": "test",
+                "password1": "My_R@ndom-P@ssw0rd",
+                "password2": "My_R@ndom-P@ssw0rd",
+            },
+        )
+        assert response.status_code == 302
+        assert User.objects.filter(username="test").exists()
+
+    def test_view_user(self, admin_client):
+        user = User.objects.get(username="admin")
+        url = reverse("admin:users_user_change", kwargs={"object_id": user.pk})
+        response = admin_client.get(url)
+        assert response.status_code == 200

benchcoach/users/tests/test_forms.py

@@ -0,0 +1,39 @@
+"""
+Module for all Form Tests.
+"""
+import pytest
+from django.utils.translation import gettext_lazy as _
+
+from benchcoach.users.forms import UserAdminCreationForm
+from benchcoach.users.models import User
+
+pytestmark = pytest.mark.django_db
+
+
+class TestUserAdminCreationForm:
+    """
+    Test class for all tests related to the UserAdminCreationForm
+    """
+
+    def test_username_validation_error_msg(self, user: User):
+        """
+        Tests UserAdminCreation Form's unique validator functions correctly by testing:
+            1) A new user with an existing username cannot be added.
+            2) Only 1 error is raised by the UserCreation Form
+            3) The desired error message is raised
+        """
+
+        # The user already exists,
+        # hence cannot be created.
+        form = UserAdminCreationForm(
+            {
+                "username": user.username,
+                "password1": user.password,
+                "password2": user.password,
+            }
+        )
+
+        assert not form.is_valid()
+        assert len(form.errors) == 1
+        assert "username" in form.errors
+        assert form.errors["username"][0] == _("This username has already been taken.")

benchcoach/users/tests/test_models.py

@@ -0,0 +1,9 @@
+import pytest
+
+from benchcoach.users.models import User
+
+pytestmark = pytest.mark.django_db
+
+
+def test_user_get_absolute_url(user: User):
+    assert user.get_absolute_url() == f"/users/{user.username}/"

benchcoach/users/tests/test_urls.py

@@ -0,0 +1,24 @@
+import pytest
+from django.urls import resolve, reverse
+
+from benchcoach.users.models import User
+
+pytestmark = pytest.mark.django_db
+
+
+def test_detail(user: User):
+    assert (
+        reverse("users:detail", kwargs={"username": user.username})
+        == f"/users/{user.username}/"
+    )
+    assert resolve(f"/users/{user.username}/").view_name == "users:detail"
+
+
+def test_update():
+    assert reverse("users:update") == "/users/~update/"
+    assert resolve("/users/~update/").view_name == "users:update"
+
+
+def test_redirect():
+    assert reverse("users:redirect") == "/users/~redirect/"
+    assert resolve("/users/~redirect/").view_name == "users:redirect"

benchcoach/users/tests/test_views.py

@@ -0,0 +1,98 @@
+import pytest
+from django.conf import settings
+from django.contrib import messages
+from django.contrib.auth.models import AnonymousUser
+from django.contrib.messages.middleware import MessageMiddleware
+from django.contrib.sessions.middleware import SessionMiddleware
+from django.http import HttpRequest, HttpResponseRedirect
+from django.test import RequestFactory
+from django.urls import reverse
+
+from benchcoach.users.forms import UserAdminChangeForm
+from benchcoach.users.models import User
+from benchcoach.users.tests.factories import UserFactory
+from benchcoach.users.views import UserRedirectView, UserUpdateView, user_detail_view
+
+pytestmark = pytest.mark.django_db
+
+
+class TestUserUpdateView:
+    """
+    TODO:
+        extracting view initialization code as class-scoped fixture
+        would be great if only pytest-django supported non-function-scoped
+        fixture db access -- this is a work-in-progress for now:
+        https://github.com/pytest-dev/pytest-django/pull/258
+    """
+
+    def dummy_get_response(self, request: HttpRequest):
+        return None
+
+    def test_get_success_url(self, user: User, rf: RequestFactory):
+        view = UserUpdateView()
+        request = rf.get("/fake-url/")
+        request.user = user
+
+        view.request = request
+
+        assert view.get_success_url() == f"/users/{user.username}/"
+
+    def test_get_object(self, user: User, rf: RequestFactory):
+        view = UserUpdateView()
+        request = rf.get("/fake-url/")
+        request.user = user
+
+        view.request = request
+
+        assert view.get_object() == user
+
+    def test_form_valid(self, user: User, rf: RequestFactory):
+        view = UserUpdateView()
+        request = rf.get("/fake-url/")
+
+        # Add the session/message middleware to the request
+        SessionMiddleware(self.dummy_get_response).process_request(request)
+        MessageMiddleware(self.dummy_get_response).process_request(request)
+        request.user = user
+
+        view.request = request
+
+        # Initialize the form
+        form = UserAdminChangeForm()
+        form.cleaned_data = []
+        view.form_valid(form)
+
+        messages_sent = [m.message for m in messages.get_messages(request)]
+        assert messages_sent == ["Information successfully updated"]
+
+
+class TestUserRedirectView:
+    def test_get_redirect_url(self, user: User, rf: RequestFactory):
+        view = UserRedirectView()
+        request = rf.get("/fake-url")
+        request.user = user
+
+        view.request = request
+
+        assert view.get_redirect_url() == f"/users/{user.username}/"
+
+
+class TestUserDetailView:
+    def test_authenticated(self, user: User, rf: RequestFactory):
+        request = rf.get("/fake-url/")
+        request.user = UserFactory()
+
+        response = user_detail_view(request, username=user.username)
+
+        assert response.status_code == 200
+
+    def test_not_authenticated(self, user: User, rf: RequestFactory):
+        request = rf.get("/fake-url/")
+        request.user = AnonymousUser()
+
+        response = user_detail_view(request, username=user.username)
+        login_url = reverse(settings.LOGIN_URL)
+
+        assert isinstance(response, HttpResponseRedirect)
+        assert response.status_code == 302
+        assert response.url == f"{login_url}?next=/fake-url/"