Debian Codegraph @

tests/auth_tests/test_signals.py

raw
1 from django.apps import apps
2 from django.contrib.auth import authenticate, signals
3 from django.contrib.auth.models import User
4 from django.core.exceptions import FieldDoesNotExist
5 from django.test import TestCase, override_settings
6 from django.test.client import RequestFactory
7
8 from .models import MinimalUser, UserWithDisabledLastLoginField
9
10
11 @override_settings(ROOT_URLCONF="auth_tests.urls")
12 class SignalTestCase(TestCase):
13 @classmethod
14 def setUpTestData(cls):
15 cls.u1 = User.objects.create_user(username="testclient", password="password")
16 cls.u3 = User.objects.create_user(username="staff", password="password")
17
18 def listener_login(self, user, **kwargs):
19 self.logged_in.append(user)
20
21 def listener_logout(self, user, **kwargs):
22 self.logged_out.append(user)
23
24 def listener_login_failed(self, sender, **kwargs):
25 self.login_failed.append(kwargs)
26
27 def setUp(self):
28 """Set up the listeners and reset the logged in/logged out counters"""
29 self.logged_in = []
30 self.logged_out = []
31 self.login_failed = []
32 signals.user_logged_in.connect(self.listener_login)
33 self.addCleanup(signals.user_logged_in.disconnect, self.listener_login)
34 signals.user_logged_out.connect(self.listener_logout)
35 self.addCleanup(signals.user_logged_out.disconnect, self.listener_logout)
36 signals.user_login_failed.connect(self.listener_login_failed)
37 self.addCleanup(
38 signals.user_login_failed.disconnect, self.listener_login_failed
39 )
40
41 def test_login(self):
42 # Only a successful login will trigger the success signal.
43 self.client.login(username="testclient", password="bad")
44 self.assertEqual(len(self.logged_in), 0)
45 self.assertEqual(len(self.login_failed), 1)
46 self.assertEqual(self.login_failed[0]["credentials"]["username"], "testclient")
47 # verify the password is cleansed
48 self.assertIn("***", self.login_failed[0]["credentials"]["password"])
49 self.assertIn("request", self.login_failed[0])
50
51 # Like this:
52 self.client.login(username="testclient", password="password")
53 self.assertEqual(len(self.logged_in), 1)
54 self.assertEqual(self.logged_in[0].username, "testclient")
55
56 # Ensure there were no more failures.
57 self.assertEqual(len(self.login_failed), 1)
58
59 def test_logout_anonymous(self):
60 # The log_out function will still trigger the signal for anonymous
61 # users.
62 self.client.post("/logout/next_page/")
63 self.assertEqual(len(self.logged_out), 1)
64 self.assertIsNone(self.logged_out[0])
65
66 def test_logout(self):
67 self.client.login(username="testclient", password="password")
68 self.client.post("/logout/next_page/")
69 self.assertEqual(len(self.logged_out), 1)
70 self.assertEqual(self.logged_out[0].username, "testclient")
71
72 def test_update_last_login(self):
73 """Only `last_login` is updated in `update_last_login`"""
74 user = self.u3
75 old_last_login = user.last_login
76
77 user.username = "This username shouldn't get saved"
78 request = RequestFactory().get("/login")
79 signals.user_logged_in.send(sender=user.__class__, request=request, user=user)
80 user = User.objects.get(pk=user.pk)
81 self.assertEqual(user.username, "staff")
82 self.assertNotEqual(user.last_login, old_last_login)
83
84 def test_failed_login_without_request(self):
85 authenticate(username="testclient", password="bad")
86 self.assertIsNone(self.login_failed[0]["request"])
87
88 def test_login_with_custom_user_without_last_login_field(self):
89 """
90 The user_logged_in signal is only registered if the user model has a
91 last_login field.
92 """
93 last_login_receivers = signals.user_logged_in.receivers
94 try:
95 signals.user_logged_in.receivers = []
96 with self.assertRaises(FieldDoesNotExist):
97 MinimalUser._meta.get_field("last_login")
98 with self.settings(AUTH_USER_MODEL="auth_tests.MinimalUser"):
99 apps.get_app_config("auth").ready()
100 self.assertEqual(signals.user_logged_in.receivers, [])
101
102 # last_login is a property whose value is None.
103 self.assertIsNone(UserWithDisabledLastLoginField().last_login)
104 with self.settings(
105 AUTH_USER_MODEL="auth_tests.UserWithDisabledLastLoginField"
106 ):
107 apps.get_app_config("auth").ready()
108 self.assertEqual(signals.user_logged_in.receivers, [])
109
110 with self.settings(AUTH_USER_MODEL="auth.User"):
111 apps.get_app_config("auth").ready()
112 self.assertEqual(len(signals.user_logged_in.receivers), 1)
113 finally:
114 signals.user_logged_in.receivers = last_login_receivers