-
Notifications
You must be signed in to change notification settings - Fork 237
/
base.py
278 lines (213 loc) · 8.52 KB
/
base.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
"""
Base classes for other test cases to inherit from.
"""
from contextlib import contextmanager
from django.contrib.auth import get_user_model
from django.core import mail
from django.http import HttpRequest
from django.test import TestCase, override_settings
from django.urls import reverse
from django_registration import signals
from django_registration.forms import RegistrationForm
class _AssertSignalSentContext:
"""
Context manager for asserting a signal was sent.
"""
def __init__(self, test_case, signal, required_kwargs=None):
self.test_case = test_case
self.signal = signal
self.required_kwargs = required_kwargs
def _listener(self, sender, **kwargs):
"""
Listener function which will capture the sent signal.
"""
# pylint: disable=attribute-defined-outside-init
self.signal_sent = True
self.received_kwargs = kwargs
self.sender = sender
def __enter__(self):
# pylint: disable=attribute-defined-outside-init
self.signal_sent = False
self.received_kwargs = {}
self.sender = None
self.signal.connect(self._listener)
return self
def __exit__(self, exc_type, exc_value, traceback):
self.signal.disconnect(self._listener)
if not self.signal_sent:
self.test_case.fail("Signal was not sent.")
return
if self.required_kwargs is not None:
missing_kwargs = []
for k in self.required_kwargs:
if k not in self.received_kwargs:
missing_kwargs.append(k)
if missing_kwargs:
self.test_case.fail(
f"Signal missing required arguments: {','.join(missing_kwargs)}"
)
class _AssertSignalNotSentContext(_AssertSignalSentContext):
"""
Context manager for asserting a signal was not sent.
"""
# pylint: disable=too-few-public-methods
def __exit__(self, exc_type, exc_value, traceback):
self.signal.disconnect(self._listener)
if self.signal_sent:
self.test_case.fail("Signal was unexpectedly sent.")
@override_settings(ACCOUNT_ACTIVATION_DAYS=7, REGISTRATION_OPEN=True)
class RegistrationTestCase(TestCase):
"""
Base class for test cases, defining valid data for registering a
user account and looking up the account after creation.
"""
# pylint: disable=invalid-name
@property
def valid_data(self):
"""
Return a set of valid data for user registration.
"""
User = get_user_model()
return {
User.USERNAME_FIELD: "alice",
"email": "alice@example.com",
"password1": "swordfish",
"password2": "swordfish",
}
@property
def user_lookup_kwargs(self):
"""
Return query arguments for querying the user registered by ``valid_data``.
"""
User = get_user_model()
return {User.USERNAME_FIELD: "alice"}
@contextmanager
def assertSignalSent(self, signal, required_kwargs=None):
"""
Assert a signal was sent.
"""
with _AssertSignalSentContext(self, signal, required_kwargs) as signal_context:
yield signal_context
@contextmanager
def assertSignalNotSent(self, signal):
"""
Assert a signal was not sent.
"""
with _AssertSignalNotSentContext(self, signal) as signal_context:
yield signal_context
class WorkflowTestCase(RegistrationTestCase):
"""
Base class for the test cases which exercise the built-in
workflows, including logic common to all of them (and which needs
to be tested for each one).
"""
def test_registration_open(self):
"""
``REGISTRATION_OPEN``, when ``True``, permits registration.
"""
resp = self.client.get(reverse("django_registration_register"))
assert resp.status_code == 200
@override_settings(REGISTRATION_OPEN=False)
def test_registration_closed(self):
"""
``REGISTRATION_OPEN``, when ``False``, disallows registration.
"""
resp = self.client.get(reverse("django_registration_register"))
self.assertRedirects(resp, reverse("django_registration_disallowed"))
resp = self.client.post(
reverse("django_registration_register"), data=self.valid_data
)
self.assertRedirects(resp, reverse("django_registration_disallowed"))
def test_registration_get(self):
"""
HTTP ``GET`` to the registration view uses the appropriate
template and populates a registration form into the context.
"""
resp = self.client.get(reverse("django_registration_register"))
assert resp.status_code == 200
self.assertTemplateUsed(resp, "django_registration/registration_form.html")
assert isinstance(resp.context["form"], RegistrationForm)
def test_registration(self):
"""
Registration creates a new account.
"""
with self.assertSignalSent(signals.user_registered):
resp = self.client.post(
reverse("django_registration_register"), data=self.valid_data
)
self.assertRedirects(resp, reverse("django_registration_complete"))
user_model = get_user_model()
new_user = user_model.objects.get(**self.user_lookup_kwargs)
assert new_user.check_password(self.valid_data["password1"])
assert new_user.email == self.valid_data["email"]
def test_registration_failure(self):
"""
Registering with invalid data fails.
"""
data = self.valid_data.copy()
data.update(password2="notsecret")
with self.assertSignalNotSent(signals.user_registered):
resp = self.client.post(reverse("django_registration_register"), data=data)
assert resp.status_code == 200
assert not resp.context["form"].is_valid()
assert resp.context["form"].has_error("password2")
def test_registration_signal(self):
"""
Registering a new user account sends the registration signal.
"""
# pylint: disable=invalid-name
User = get_user_model()
with self.assertSignalSent(signals.user_registered) as signal_context:
self.client.post(
reverse("django_registration_register"), data=self.valid_data
)
assert (
signal_context.received_kwargs["user"].get_username()
== self.valid_data[User.USERNAME_FIELD]
)
assert isinstance(signal_context.received_kwargs["request"], HttpRequest)
class ActivationTestCase(WorkflowTestCase):
"""
Base class for testing the built-in workflows which involve an
activation step.
"""
# First few methods repeat parent class, but with added checks for
# is_active status and sending of activation emails.
def test_registration(self):
"""
Registration creates a new inactive account and sends an
activation email.
"""
with self.assertSignalSent(signals.user_registered):
super().test_registration()
user_model = get_user_model()
new_user = user_model.objects.get(**self.user_lookup_kwargs)
# New user must not be active.
assert not new_user.is_active
# An activation email was sent.
assert len(mail.outbox) == 1
assert "http" in mail.outbox[0].subject
def test_registration_failure(self):
"""
Registering with invalid data fails.
"""
with self.assertSignalNotSent(signals.user_registered):
super().test_registration_failure()
# Activation email was not sent.
assert 0 == len(mail.outbox)
def test_registration_no_sites(self):
"""
Registration still functions properly when
``django.contrib.sites`` is not installed; the fallback will
be a ``RequestSite`` instance.
"""
with self.modify_settings(INSTALLED_APPS={"remove": ["django.contrib.sites"]}):
with self.assertSignalSent(signals.user_registered):
resp = self.client.post(
reverse("django_registration_register"), data=self.valid_data
)
assert 302 == resp.status_code
user_model = get_user_model()
new_user = user_model.objects.get(**self.user_lookup_kwargs)
assert new_user.check_password(self.valid_data["password1"])
assert new_user.email == self.valid_data["email"]