| 1 |
from django.conf import settings |
| 2 |
from django.contrib.auth import REDIRECT_FIELD_NAME |
| 3 |
from django.contrib.auth.middleware import ( |
| 4 |
AuthenticationMiddleware, |
| 5 |
LoginRequiredMiddleware, |
| 6 |
) |
| 7 |
from django.contrib.auth.models import User |
| 8 |
from django.core.exceptions import ImproperlyConfigured |
| 9 |
from django.http import HttpRequest, HttpResponse |
| 10 |
from django.test import TestCase, modify_settings, override_settings |
| 11 |
from django.urls import reverse |
| 12 |
|
| 13 |
|
| 14 |
class TestAuthenticationMiddleware(TestCase): |
| 15 |
@classmethod |
| 16 |
def setUpTestData(cls): |
| 17 |
cls.user = User.objects.create_user( |
| 18 |
"test_user", "[email protected]", "test_password" |
| 19 |
) |
| 20 |
|
| 21 |
def setUp(self): |
| 22 |
self.middleware = AuthenticationMiddleware(lambda req: HttpResponse()) |
| 23 |
self.client.force_login(self.user) |
| 24 |
self.request = HttpRequest() |
| 25 |
self.request.session = self.client.session |
| 26 |
|
| 27 |
def test_no_password_change_doesnt_invalidate_session(self): |
| 28 |
self.request.session = self.client.session |
| 29 |
self.middleware(self.request) |
| 30 |
self.assertIsNotNone(self.request.user) |
| 31 |
self.assertFalse(self.request.user.is_anonymous) |
| 32 |
|
| 33 |
def test_changed_password_invalidates_session(self): |
| 34 |
# After password change, user should be anonymous |
| 35 |
self.user.set_password("new_password") |
| 36 |
self.user.save() |
| 37 |
self.middleware(self.request) |
| 38 |
self.assertIsNotNone(self.request.user) |
| 39 |
self.assertTrue(self.request.user.is_anonymous) |
| 40 |
# session should be flushed |
| 41 |
self.assertIsNone(self.request.session.session_key) |
| 42 |
|
| 43 |
def test_no_session(self): |
| 44 |
msg = ( |
| 45 |
"The Django authentication middleware requires session middleware " |
| 46 |
"to be installed. Edit your MIDDLEWARE setting to insert " |
| 47 |
"'django.contrib.sessions.middleware.SessionMiddleware' before " |
| 48 |
"'django.contrib.auth.middleware.AuthenticationMiddleware'." |
| 49 |
) |
| 50 |
with self.assertRaisesMessage(ImproperlyConfigured, msg): |
| 51 |
self.middleware(HttpRequest()) |
| 52 |
|
| 53 |
async def test_auser(self): |
| 54 |
self.middleware(self.request) |
| 55 |
auser = await self.request.auser() |
| 56 |
self.assertEqual(auser, self.user) |
| 57 |
auser_second = await self.request.auser() |
| 58 |
self.assertIs(auser, auser_second) |
| 59 |
|
| 60 |
|
| 61 |
@override_settings(ROOT_URLCONF="auth_tests.urls") |
| 62 |
@modify_settings( |
| 63 |
MIDDLEWARE={"append": "django.contrib.auth.middleware.LoginRequiredMiddleware"} |
| 64 |
) |
| 65 |
class TestLoginRequiredMiddleware(TestCase): |
| 66 |
@classmethod |
| 67 |
def setUpTestData(cls): |
| 68 |
cls.user = User.objects.create_user( |
| 69 |
"test_user", "[email protected]", "test_password" |
| 70 |
) |
| 71 |
|
| 72 |
def setUp(self): |
| 73 |
self.middleware = LoginRequiredMiddleware(lambda req: HttpResponse()) |
| 74 |
self.request = HttpRequest() |
| 75 |
|
| 76 |
def test_public_paths(self): |
| 77 |
paths = ["public_view", "public_function_view"] |
| 78 |
for path in paths: |
| 79 |
response = self.client.get(f"/{path}/") |
| 80 |
self.assertEqual(response.status_code, 200) |
| 81 |
|
| 82 |
def test_protected_paths(self): |
| 83 |
paths = ["protected_view", "protected_function_view"] |
| 84 |
for path in paths: |
| 85 |
response = self.client.get(f"/{path}/") |
| 86 |
self.assertRedirects( |
| 87 |
response, |
| 88 |
settings.LOGIN_URL + f"?next=/{path}/", |
| 89 |
fetch_redirect_response=False, |
| 90 |
) |
| 91 |
|
| 92 |
def test_login_required_paths(self): |
| 93 |
paths = ["login_required_cbv_view", "login_required_decorator_view"] |
| 94 |
for path in paths: |
| 95 |
response = self.client.get(f"/{path}/") |
| 96 |
self.assertRedirects( |
| 97 |
response, |
| 98 |
"/custom_login/" + f"?step=/{path}/", |
| 99 |
fetch_redirect_response=False, |
| 100 |
) |
| 101 |
|
| 102 |
def test_admin_path(self): |
| 103 |
admin_url = reverse("admin:index") |
| 104 |
response = self.client.get(admin_url) |
| 105 |
self.assertRedirects( |
| 106 |
response, |
| 107 |
reverse("admin:login") + f"?next={admin_url}", |
| 108 |
target_status_code=200, |
| 109 |
) |
| 110 |
|
| 111 |
def test_non_existent_path(self): |
| 112 |
response = self.client.get("/non_existent/") |
| 113 |
self.assertEqual(response.status_code, 404) |
| 114 |
|
| 115 |
def test_paths_with_logged_in_user(self): |
| 116 |
paths = [ |
| 117 |
"public_view", |
| 118 |
"public_function_view", |
| 119 |
"protected_view", |
| 120 |
"protected_function_view", |
| 121 |
"login_required_cbv_view", |
| 122 |
"login_required_decorator_view", |
| 123 |
] |
| 124 |
self.client.login(username="test_user", password="test_password") |
| 125 |
for path in paths: |
| 126 |
response = self.client.get(f"/{path}/") |
| 127 |
self.assertEqual(response.status_code, 200) |
| 128 |
|
| 129 |
def test_get_login_url_from_view_func(self): |
| 130 |
def view_func(request): |
| 131 |
return HttpResponse() |
| 132 |
|
| 133 |
view_func.login_url = "/custom_login/" |
| 134 |
login_url = self.middleware.get_login_url(view_func) |
| 135 |
self.assertEqual(login_url, "/custom_login/") |
| 136 |
|
| 137 |
@override_settings(LOGIN_URL="/settings_login/") |
| 138 |
def test_get_login_url_from_settings(self): |
| 139 |
login_url = self.middleware.get_login_url(lambda: None) |
| 140 |
self.assertEqual(login_url, "/settings_login/") |
| 141 |
|
| 142 |
@override_settings(LOGIN_URL=None) |
| 143 |
def test_get_login_url_no_login_url(self): |
| 144 |
with self.assertRaises(ImproperlyConfigured) as e: |
| 145 |
self.middleware.get_login_url(lambda: None) |
| 146 |
self.assertEqual( |
| 147 |
str(e.exception), |
| 148 |
"No login URL to redirect to. Define settings.LOGIN_URL or provide " |
| 149 |
"a login_url via the 'django.contrib.auth.decorators.login_required' " |
| 150 |
"decorator.", |
| 151 |
) |
| 152 |
|
| 153 |
def test_get_redirect_field_name_from_view_func(self): |
| 154 |
def view_func(request): |
| 155 |
return HttpResponse() |
| 156 |
|
| 157 |
view_func.redirect_field_name = "next_page" |
| 158 |
redirect_field_name = self.middleware.get_redirect_field_name(view_func) |
| 159 |
self.assertEqual(redirect_field_name, "next_page") |
| 160 |
|
| 161 |
@override_settings( |
| 162 |
MIDDLEWARE=[ |
| 163 |
"django.contrib.sessions.middleware.SessionMiddleware", |
| 164 |
"django.contrib.auth.middleware.AuthenticationMiddleware", |
| 165 |
"auth_tests.test_checks.LoginRequiredMiddlewareSubclass", |
| 166 |
], |
| 167 |
LOGIN_URL="/settings_login/", |
| 168 |
) |
| 169 |
def test_login_url_resolve_logic(self): |
| 170 |
paths = ["login_required_cbv_view", "login_required_decorator_view"] |
| 171 |
for path in paths: |
| 172 |
response = self.client.get(f"/{path}/") |
| 173 |
self.assertRedirects( |
| 174 |
response, |
| 175 |
"/custom_login/" + f"?step=/{path}/", |
| 176 |
fetch_redirect_response=False, |
| 177 |
) |
| 178 |
paths = ["protected_view", "protected_function_view"] |
| 179 |
for path in paths: |
| 180 |
response = self.client.get(f"/{path}/") |
| 181 |
self.assertRedirects( |
| 182 |
response, |
| 183 |
f"/settings_login/?redirect_to=/{path}/", |
| 184 |
fetch_redirect_response=False, |
| 185 |
) |
| 186 |
|
| 187 |
def test_get_redirect_field_name_default(self): |
| 188 |
redirect_field_name = self.middleware.get_redirect_field_name(lambda: None) |
| 189 |
self.assertEqual(redirect_field_name, REDIRECT_FIELD_NAME) |