Newer
Older
from __future__ import division
__copyright__ = "Copyright (C) 2018 Dong Zhuang"
__license__ = """
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""
import six
from six.moves.urllib.parse import ParseResult, quote, urlparse
from djangosaml2.urls import urlpatterns as djsaml2_urlpatterns
from django.test import TestCase, override_settings, RequestFactory
from django.contrib import messages
from django.conf import settings
from django.core import mail
from django.contrib.auth import (
REDIRECT_FIELD_NAME, SESSION_KEY,
)
from django.http import QueryDict, HttpResponse
from django.urls import NoReverseMatch, reverse
from unittest import skipIf
from course.auth import get_impersonable_user_qset, get_user_model
from course.models import FlowPageVisit, ParticipationPermission
CoursesTestMixinBase, SingleCoursePageTestMixin, TwoCourseTestMixin,
FallBackStorageMessageTestMixin, TWO_COURSE_SETUP_LIST,
NONE_PARTICIPATION_USER_CREATE_KWARG_LIST)
from tests.utils import (
LocmemBackendTestsMixin, load_url_pattern_names, reload_urlconf, mock)
from tests.factories import UserFactory, ParticipationFactory
# settings names
EDITABLE_INST_ID_BEFORE_VERI = "RELATE_EDITABLE_INST_ID_BEFORE_VERIFICATION"
SHOW_INST_ID_FORM = "RELATE_SHOW_INST_ID_FORM"
SHOW_EDITOR_FORM = "RELATE_SHOW_EDITOR_FORM"
NOT_IMPERSONATING_MESSAGE = "Not currently impersonating anyone."
NO_LONGER_IMPERSONATING_MESSAGE = "No longer impersonating anyone."
ALREADY_IMPERSONATING_SOMEONE_MESSAGE = "Already impersonating someone."
ERROR_WHILE_IMPERSONATING_MESSAGE = "Error while impersonating."
IMPERSONATE_FORM_ERROR_NOT_VALID_USER_MSG = (
"Select a valid choice. That choice is "
"not one of the available choices.")
ADD_MESSAGES_FUNC_PATH = "course.auth.messages.add_message"
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
class ImpersonateTest(SingleCoursePageTestMixin,
FallBackStorageMessageTestMixin, TestCase):
def test_impersonate_by_not_authenticated(self):
with self.temporarily_switch_to_user(None):
resp = self.get_impersonate()
self.assertEqual(resp.status_code, 403)
resp = self.post_impersonate(
impersonatee=self.student_participation.user)
self.assertEqual(resp.status_code, 403)
resp = self.get_stop_impersonate()
self.assertEqual(resp.status_code, 403)
resp = self.post_stop_impersonate()
self.assertEqual(resp.status_code, 403)
def test_impersonate_by_student(self):
user = self.student_participation.user
impersonatable = get_impersonable_user_qset(user)
self.assertEqual(impersonatable.count(), 0)
with self.temporarily_switch_to_user(user):
resp = self.get_impersonate()
self.assertEqual(resp.status_code, 403)
resp = self.post_impersonate(
impersonatee=self.student_participation.user)
self.assertEqual(resp.status_code, 403)
resp = self.get_stop_impersonate()
self.assertEqual(resp.status_code, 403)
self.assertIsNone(self.c.session.get("impersonate_id"))
resp = self.post_stop_impersonate()
self.assertEqual(resp.status_code, 403)
def test_impersonate_by_ta(self):
user = self.ta_participation.user
impersonatable = get_impersonable_user_qset(user)
self.assertEqual(impersonatable.count(), 1)
# create 2 participations, on is not active,
# impersonatable count should be 2, not 3
ParticipationFactory.create(
course=self.course,
status=constants.participation_status.active)
ParticipationFactory.create(
course=self.course,
status=constants.participation_status.requested)
impersonatable = get_impersonable_user_qset(user)
self.assertEqual(impersonatable.count(), 2)
self.assertNotIn(self.instructor_participation.user, impersonatable)
with self.temporarily_switch_to_user(user):
resp = self.get_impersonate()
self.assertEqual(resp.status_code, 200)
resp = self.post_impersonate(
impersonatee=self.student_participation.user)
self.assertEqual(resp.status_code, 200)
self.assertEqual(self.c.session["impersonate_id"],
self.student_participation.user.pk)
resp = self.post_impersonate(
impersonatee=self.student_participation.user)
# because the request.user is the impernatee (student)
# who has no pperm
self.assertEqual(resp.status_code, 403)
self.assertEqual(self.c.session["impersonate_id"],
self.student_participation.user.pk)
self.assertEqual(resp.status_code, 200)
# stop_impersonating
resp = self.post_stop_impersonate()
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
self.assertIsNone(self.c.session.get("impersonate_id"))
self.assertResponseMessageLevelsEqual(resp, [messages.INFO])
self.assertResponseMessagesEqual(resp, NO_LONGER_IMPERSONATING_MESSAGE)
# fail re-stop_impersonating
resp = self.post_stop_impersonate()
self.assertEqual(resp.status_code, 200)
self.assertResponseMessageLevelsEqual(resp, [messages.ERROR])
self.assertResponseMessagesEqual(resp, NOT_IMPERSONATING_MESSAGE)
# not allowed to impersonate instructor
resp = self.post_impersonate(
impersonatee=self.instructor_participation.user)
self.assertEqual(resp.status_code, 200)
self.assertFormError(resp, 'form', 'user',
IMPERSONATE_FORM_ERROR_NOT_VALID_USER_MSG)
self.assertIsNone(self.c.session.get("impersonate_id"))
# not allowed to impersonate self
resp = self.post_impersonate(
impersonatee=user)
self.assertEqual(resp.status_code, 200)
self.assertFormError(resp, 'form', 'user',
IMPERSONATE_FORM_ERROR_NOT_VALID_USER_MSG)
self.assertIsNone(self.c.session.get("impersonate_id"))
def test_impersonate_by_superuser(self):
user = self.superuser
impersonatable = get_impersonable_user_qset(user)
self.assertEqual(impersonatable.count(), 3)
with self.temporarily_switch_to_user(user):
resp = self.post_impersonate(
impersonatee=self.instructor_participation.user)
self.assertEqual(resp.status_code, 200)
self.assertEqual(self.c.session["impersonate_id"],
self.instructor_participation.user.pk)
def test_impersonate_by_instructor(self):
user = self.instructor_participation.user
impersonatable = get_impersonable_user_qset(user)
self.assertEqual(impersonatable.count(), 2)
with self.temporarily_switch_to_user(user):
resp = self.get_impersonate()
self.assertEqual(resp.status_code, 200)
# first impersonate ta who has pperm
resp = self.post_impersonate(
impersonatee=self.ta_participation.user)
self.assertEqual(resp.status_code, 200)
self.assertEqual(self.c.session["impersonate_id"],
self.ta_participation.user.pk)
# then impersonate student without stop_impersonating,
# this will fail
resp = self.post_impersonate(
impersonatee=self.student_participation.user)
self.assertEqual(resp.status_code, 200)
self.assertResponseMessageLevelsEqual(resp, [messages.ERROR])
self.assertResponseMessagesEqual(
resp, ALREADY_IMPERSONATING_SOMEONE_MESSAGE)
self.assertEqual(self.c.session["impersonate_id"],
self.ta_participation.user.pk)
self.assertEqual(resp.status_code, 200)
# stop_impersonating
resp = self.post_stop_impersonate()
self.assertEqual(resp.status_code, 200)
self.assertResponseMessageLevelsEqual(resp, [messages.INFO])
self.assertResponseMessagesEqual(resp, NO_LONGER_IMPERSONATING_MESSAGE)
# re-stop_impersonating
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
self.assertEqual(resp.status_code, 200)
self.assertResponseMessageLevelsEqual(resp, [messages.ERROR])
self.assertResponseMessagesEqual(resp, NOT_IMPERSONATING_MESSAGE)
def test_impersonate_error_none_user(self):
with self.temporarily_switch_to_user(self.ta_participation.user):
self.post_impersonate(
impersonatee=self.student_participation.user)
session = self.c.session
session["impersonate_id"] = None
session.save()
resp = self.c.get(self.get_course_page_url())
self.assertEqual(resp.status_code, 200)
self.assertResponseMessageLevelsEqual(resp, [messages.ERROR])
self.assertResponseMessagesEqual(resp,
ERROR_WHILE_IMPERSONATING_MESSAGE)
def test_impersonatee_error_none_existing_user(self):
with self.temporarily_switch_to_user(self.ta_participation.user):
self.post_impersonate(
impersonatee=self.student_participation.user)
session = self.c.session
session["impersonate_id"] = 100
session.save()
resp = self.c.get(self.get_course_page_url())
self.assertEqual(resp.status_code, 200)
self.assertResponseMessageLevelsEqual(resp, [messages.ERROR])
self.assertResponseMessagesEqual(resp,
ERROR_WHILE_IMPERSONATING_MESSAGE)
def test_impersonate_error_no_impersonatable(self):
with self.temporarily_switch_to_user(self.ta_participation.user):
self.post_impersonate(
impersonatee=self.student_participation.user)
# drop the only impersonatable participation
from course.constants import participation_status
self.student_participation.status = participation_status.dropped
self.student_participation.save()
resp = self.c.get(self.get_course_page_url())
self.assertEqual(resp.status_code, 200)
self.assertResponseMessageLevelsEqual(resp, [messages.ERROR])
self.assertResponseMessagesEqual(resp,
ERROR_WHILE_IMPERSONATING_MESSAGE)
def test_impersonator_flow_page_visit(self):
with self.temporarily_switch_to_user(self.student_participation.user):
self.start_flow("quiz-test")
self.c.get(self.get_page_url_by_ordinal(page_ordinal=0))
self.assertEqual(FlowPageVisit.objects.count(), 1)
first_visit = FlowPageVisit.objects.first()
self.assertFalse(first_visit.is_impersonated())
self.assertIsNone(first_visit.impersonated_by)
with self.temporarily_switch_to_user(self.ta_participation.user):
resp = self.c.get(self.get_page_url_by_ordinal(page_ordinal=0))
self.assertEqual(resp.status_code, 200)
self.assertEqual(FlowPageVisit.objects.count(), 2)
second_visit = FlowPageVisit.objects.all().order_by('-pk')[0]
# this visit is not impersonated
self.assertFalse(second_visit.is_impersonated())
self.assertIsNone(second_visit.impersonated_by)
# this visit is not impersonated
self.post_impersonate(impersonatee=self.student_participation.user)
resp = self.c.get(self.get_page_url_by_ordinal(page_ordinal=0))
self.assertEqual(resp.status_code, 200)
self.assertEqual(FlowPageVisit.objects.count(), 3)
second_visit = FlowPageVisit.objects.all().order_by('-pk')[0]
self.assertTrue(second_visit.is_impersonated())
self.assertEqual(second_visit.impersonated_by,
self.ta_participation.user)
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
def test_user_search_widget_works(self):
# make sure user have/don't have first_name and last_name get
# rendered in UserSearchWidget when requested.
p = ParticipationFactory.create(course=self.course)
if p.user.last_name:
p.user.last_name = ""
p.user.save()
import json
from django.core import signing
from course.auth import ImpersonateForm
user = self.instructor_participation.user
with self.temporarily_switch_to_user(user):
impersonatable = get_impersonable_user_qset(user)
form = ImpersonateForm(impersonable_qset=impersonatable)
assert form.as_p()
field_id = signing.dumps(id(form.fields['user'].widget))
url = reverse('django_select2-json')
impersonatee = self.student_participation.user
resp = self.c.get(url, {'field_id': field_id,
'term': impersonatee.last_name})
self.assertEqual(resp.status_code, 200)
data = json.loads(resp.content.decode('utf-8'))
self.assertEqual(len(data['results']), 1)
# no input, display all options
resp = self.c.get(url, {'field_id': field_id,
'term': ""})
self.assertEqual(resp.status_code, 200)
# This failed, because we can't dynamically filter with django-select2
# ref: https://github.com/applegrew/django-select2/issues/237
# i.e., it always return all objects.
# data = json.loads(resp.content.decode('utf-8'))
# self.assertEqual(len(data['results']), impersonatable.count())
# when searching None, there should be no result
for term in ["None", "none"]:
resp = self.c.get(url, {'field_id': field_id,
'term': term})
self.assertEqual(resp.status_code, 200)
data = json.loads(resp.content.decode('utf-8'))
self.assertEqual(len(data['results']), 0)
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
class CrossCourseImpersonateTest(TwoCourseTestMixin,
FallBackStorageMessageTestMixin, TestCase):
courses_setup_list = TWO_COURSE_SETUP_LIST
none_participation_user_create_kwarg_list = (
NONE_PARTICIPATION_USER_CREATE_KWARG_LIST)
@classmethod
def setUpTestData(cls): # noqa
super(CrossCourseImpersonateTest, cls).setUpTestData()
cls.extra_participation_user1 = cls.non_participation_users[0]
cls.create_participation(cls.course2, cls.extra_participation_user1)
def test_impersonate_across_courses(self):
user = self.course1_ta_participation.user
self.assertEqual(self.course1_ta_participation.user,
self.course2_ta_participation.user)
impersonatable = get_impersonable_user_qset(user)
# one is student_participation.user, another is extra_participation_user1
# in two courses
self.assertEqual(impersonatable.count(), 2)
def test_impersonate_across_courses_pperm_view_masked_profile_403(self):
"""
view_participant_masked_profile pperm will disable impersonating
site-wise
"""
from course.constants import participation_permission as pperm
pp = ParticipationPermission(
participation=self.course1_ta_participation,
permission=pperm.view_participant_masked_profile)
pp.save()
user = self.course1_ta_participation.user
self.assertEqual(self.course1_ta_participation.user,
self.course2_ta_participation.user)
impersonatable = get_impersonable_user_qset(user)
self.assertEqual(impersonatable.count(), 0)
with self.temporarily_switch_to_user(user):
resp = self.get_impersonate()
self.assertEqual(resp.status_code, 403)
class AuthTestMixin(object):
_user_create_kwargs = {
"username": "test_user", "password": "mypassword",
"email": "my_email@example.com"
}
@classmethod
def setUpTestData(cls): # noqa
super(AuthTestMixin, cls).setUpTestData()
cls.test_user = (
get_user_model().objects.create_user(**cls._user_create_kwargs))
cls.existing_user_count = get_user_model().objects.count()
def setUp(self):
super(AuthTestMixin, self).setUp()
self.test_user.refresh_from_db()
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
def get_sign_in_data(self):
return self._user_create_kwargs.copy()
def assertNewUserCreated(self, count=1): # noqa
self.assertEqual(get_user_model().objects.count(),
self.existing_user_count + count)
def assertNoNewUserCreated(self): # noqa
self.assertEqual(self.existing_user_count, get_user_model().objects.count())
def assertURLEqual(self, url, expected, parse_qs=False): # noqa
"""
Given two URLs, make sure all their components (the ones given by
urlparse) are equal, only comparing components that are present in both
URLs.
If `parse_qs` is True, then the querystrings are parsed with QueryDict.
This is useful if you don't want the order of parameters to matter.
Otherwise, the query strings are compared as-is.
"""
fields = ParseResult._fields
for attr, x, y in zip(fields, urlparse(url), urlparse(expected)):
if parse_qs and attr == 'query':
x, y = QueryDict(x), QueryDict(y)
if x and y and x != y:
self.fail("%r != %r (%s doesn't match)" % (url, expected, attr))
def do_test_security_check(self, url_name):
url = reverse(url_name)
with override_settings(ALLOWED_HOSTS=["testserver"]):
# These URLs should not pass the security check.
bad_urls = (
'http://example.com',
'http:///example.com',
'https://example.com',
'ftp://example.com',
'///example.com',
'//example.com',
'javascript:alert("XSS")',
)
for bad_url in bad_urls:
with self.temporarily_switch_to_user(None):
with self.subTest(bad_url=bad_url):
nasty_url = self.concatenate_redirect_url(url, bad_url)
response = self.c.post(nasty_url, self.get_sign_in_data())
self.assertEqual(response.status_code, 302)
self.assertNotIn(bad_url, response.url,
'%s should be blocked' % bad_url)
# These URLs should pass the security check.
good_urls = (
'/view/?param=http://example.com',
'/view/?param=https://example.com',
'/view?param=ftp://example.com',
'view/?param=//example.com',
'https://testserver/',
'HTTPS://testserver/',
'//testserver/',
'/url%20with%20spaces/',
)
for good_url in good_urls:
with self.temporarily_switch_to_user(None):
with self.subTest(good_url=good_url):
safe_url = self.concatenate_redirect_url(url, good_url)
response = self.c.post(safe_url, self.get_sign_in_data())
self.assertEqual(response.status_code, 302)
self.assertIn(good_url, response.url,
'%s should be allowed' % good_url)
def assertSessionHasUserLoggedIn(self): # noqa
self.assertIn(SESSION_KEY, self.c.session)
def assertSessionHasNoUserLoggedIn(self): # noqa
self.assertNotIn(SESSION_KEY, self.c.session)
def concatenate_redirect_url(self, url, redirect_to=None):
if not redirect_to:
return url
return ('%(url)s?%(next)s=%(bad_url)s' % {
'url': url,
'next': REDIRECT_FIELD_NAME,
'bad_url': quote(redirect_to),
})
def get_sign_up_view_url(self, redirect_to=None):
return self.concatenate_redirect_url(
reverse("relate-sign_up"), redirect_to
)
def get_sign_up(self, redirect_to=None, follow=False):
return self.c.get(self.get_sign_up_view_url(redirect_to),
follow=follow)
def post_sign_up(self, data, redirect_to=None, follow=False):
return self.c.post(self.get_sign_up_view_url(redirect_to), data,
follow=follow)
def get_sign_in_choice_url(self, redirect_to=None):
return self.concatenate_redirect_url(
reverse("relate-sign_in_choice"), redirect_to)
def get_sign_in_by_user_pw_url(self, redirect_to=None):
return self.concatenate_redirect_url(
reverse("relate-sign_in_by_user_pw"), redirect_to)
def get_sign_in_by_user_pw(self, redirect_to=None, follow=False):
return self.c.get(self.get_sign_in_by_user_pw_url(redirect_to),
follow=follow)
def post_sign_in_by_user_pw(self, data, redirect_to=None, follow=False):
return self.c.post(self.get_sign_in_by_user_pw_url(redirect_to), data,
follow=follow)
def get_sign_in_by_email_url(self, redirect_to=None):
return self.concatenate_redirect_url(
reverse("relate-sign_in_by_email"), redirect_to)
def get_sign_in_by_email(self, redirect_to=None, follow=False):
return self.c.get(self.get_sign_in_by_email_url(redirect_to),
follow=follow)
def post_sign_in_by_email(self, data, redirect_to=None, follow=False):
return self.c.post(self.get_sign_in_by_email_url(redirect_to), data,
follow=follow)
def get_sign_out_view_url(self, redirect_to=None):
return self.concatenate_redirect_url(
reverse("relate-logout"), redirect_to)
def get_sign_out(self, redirect_to=None, follow=False):
return self.c.get(self.get_sign_out_view_url(redirect_to),
follow=follow)
def post_sign_out(self, data, redirect_to=None, follow=False):
# Though RELATE and django are using GET to sign out
return self.c.post(self.get_sign_out_view_url(redirect_to), data,
follow=follow)
def get_sign_out_confirmation_view_url(self, redirect_to=None):
return self.concatenate_redirect_url(
reverse("relate-logout-confirmation"), redirect_to
)
def get_sign_out_confirmation(self, redirect_to=None, follow=False):
return self.c.get(self.get_sign_out_confirmation_view_url(redirect_to),
follow=follow)
def post_sign_out_confirmation(self, data, redirect_to=None, follow=False):
return self.c.post(self.get_sign_out_confirmation_view_url(redirect_to),
data,
follow=follow)
def get_user_profile_url(self, redirect_to=None):
return self.concatenate_redirect_url(
reverse("relate-user_profile"), redirect_to)
def get_user_profile(self, redirect_to=None, follow=False):
return self.c.get(self.get_user_profile_url(redirect_to),
follow=follow)
def post_user_profile(self, data, redirect_to=None, follow=False):
return self.c.post(self.get_user_profile_url(redirect_to),
data=data, follow=follow)
@skipIf(six.PY2, "PY2 doesn't support subTest")
class AuthViewNamedURLTests(AuthTestMixin, TestCase):
need_logout_confirmation_named_urls = [
('relate-sign_in_choice', [], {}),
('relate-sign_in_by_user_pw', [], {}),
('relate-sign_in_by_email', [], {}),
('relate-sign_up', [], {}),
('relate-reset_password', [], {}),
('relate-reset_password', [], {"field": "instid"}),
('relate-reset_password_stage2',
[], {"user_id": 0, "sign_in_key": "abcd"}),
('relate-sign_in_stage2_with_token',
[], {"user_id": 0, "sign_in_key": "abcd"})]
djsaml2_urls = [
(name, [], {})
for name in load_url_pattern_names(djsaml2_urlpatterns)
]
need_login_named_urls = [
('relate-logout', [], {}),
('relate-logout-confirmation', [], {}),
('relate-user_profile', [], {}),
('relate-manage_authentication_tokens', [],
{"course_identifier": "test-course"}),
]
@override_settings(RELATE_SIGN_IN_BY_SAML2_ENABLED=True)
def test_named_urls(self):
# Named URLs should be reversible
# Because RELATE_SIGN_IN_BY_SAML2_ENABLED is not enabled in test settings.
# djangosaml2 url patterns should be included in this way.
reload_urlconf()
all_expected_named_urls = (
self.need_logout_confirmation_named_urls
+ self.djsaml2_urls + self.need_login_named_urls)
for name, args, kwargs in all_expected_named_urls:
with self.subTest(name=name):
try:
reverse(name, args=args, kwargs=kwargs)
except NoReverseMatch:
self.fail(
"Reversal of url named '%s' failed with "
"NoReverseMatch" % name)
@override_settings(RELATE_SIGN_IN_BY_USERNAME_ENABLED=True,
RELATE_SIGN_IN_BY_EMAIL_ENABLED=True)
def test_need_logout_urls(self):
# These URLs should be redirected to relate-logout-confirmation when
# there're user sessions
for name, args, kwargs in self.need_logout_confirmation_named_urls:
self.client.force_login(get_user_model().objects.last())
with self.subTest(name=name):
url = reverse(name, args=args, kwargs=kwargs)
resp = self.client.get(url)
self.assertEqual(resp.status_code, 302,
"The response should be redirected to "
"'relate-logout-confirmation'")
expected_redirect_url = (
self.concatenate_redirect_url(
reverse("relate-logout-confirmation"), url))
self.assertRedirects(resp, expected_redirect_url,
fetch_redirect_response=False)
class SignInByPasswordTest(CoursesTestMixinBase, FallBackStorageMessageTestMixin,
AuthTestMixin, TestCase):
courses_setup_list = []
@override_settings(RELATE_SIGN_IN_BY_USERNAME_ENABLED=True)
def test_user_pw_enabled_sign_in_view_anonymous(self):
with self.temporarily_switch_to_user(None):
resp = self.get_sign_in_by_user_pw()
self.assertEqual(resp.status_code, 200)
self.assertSessionHasNoUserLoggedIn()
resp = self.post_sign_in_by_user_pw(data=self.get_sign_in_data())
self.assertSessionHasUserLoggedIn()
self.assertEqual(resp.status_code, 302)
self.assertRedirects(resp, settings.LOGIN_REDIRECT_URL,
fetch_redirect_response=False)
@override_settings(RELATE_SIGN_IN_BY_USERNAME_ENABLED=False)
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
def test_username_pw_not_enabled_sign_in_view_anonymous(self, mock_add_msg):
expected_msg = "Username-based sign-in is not being used"
with self.temporarily_switch_to_user(None):
resp = self.get_sign_in_by_user_pw(follow=True)
self.assertEqual(resp.status_code, 200)
self.assertSessionHasNoUserLoggedIn()
self.assertEqual(mock_add_msg.call_count, 1)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
mock_add_msg.reset_mock()
resp = self.post_sign_in_by_user_pw(data=self.get_sign_in_data(),
follow=False)
self.assertEqual(resp.status_code, 302)
self.assertRedirects(resp, self.get_sign_in_choice_url(),
fetch_redirect_response=False)
self.assertSessionHasNoUserLoggedIn()
self.assertEqual(mock_add_msg.call_count, 1)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
@skipIf(six.PY2, "PY2 doesn't support subTest")
def test_security_check(self):
self.do_test_security_check(url_name="relate-sign_in_by_user_pw")
def test_login_form_invalid(self):
with self.temporarily_switch_to_user(None):
invalid_data = self.get_sign_in_data()
invalid_data["password"] = "invalid_pw"
resp = self.post_sign_in_by_user_pw(data=invalid_data)
self.assertSessionHasNoUserLoggedIn()
self.assertEqual(resp.status_code, 200)
self.assertFormErrorLoose(resp,
"Please enter a correct username and "
"password. Note that both fields may "
"be case-sensitive.")
def test_login_form_invalid_with_redirect_url_remains(self):
with self.temporarily_switch_to_user(None):
invalid_data = self.get_sign_in_data()
invalid_data["password"] = "invalid_pw"
redirect_to = "http:\\somedomain"
resp = self.post_sign_in_by_user_pw(data=invalid_data,
redirect_to=redirect_to)
self.assertSessionHasNoUserLoggedIn()
self.assertEqual(resp.status_code, 200)
# We don't use assertIn(url, resp.url) because the response
# can be a TemplateResponse
self.assertResponseContextContains(
resp, REDIRECT_FIELD_NAME, redirect_to)
@override_settings(RELATE_SIGN_IN_BY_EMAIL_ENABLED=True)
class SignInByEmailTest(CoursesTestMixinBase, FallBackStorageMessageTestMixin,
AuthTestMixin, LocmemBackendTestsMixin, TestCase):
courses_setup_list = []
@classmethod
def setUpTestData(cls): # noqa
super(SignInByEmailTest, cls).setUpTestData()
new_email = "somebody@example.com"
data = {"email": new_email}
# first login attempt
resp = cls.c.post(reverse("relate-sign_in_by_email"), data=data)
first_request = resp.wsgi_request
assert resp.status_code == 302
assert get_user_model().objects.count() == cls.existing_user_count + 1
user = get_user_model().objects.get(email=new_email)
first_sign_in_key = user.sign_in_key
cls.first_sign_in_url = first_request.build_absolute_uri(
reverse(
"relate-sign_in_stage2_with_token",
args=(user.id, user.sign_in_key,)))
assert len(mail.outbox) == 1
assert cls.first_sign_in_url in mail.outbox[0].body
# second login attempt
resp = cls.c.post(reverse("relate-sign_in_by_email"), data=data)
second_request = resp.wsgi_request
assert resp.status_code == 302
assert get_user_model().objects.count() == cls.existing_user_count + 1
user = get_user_model().objects.get(email=new_email)
second_sign_in_key = user.sign_in_key
cls.second_sign_in_url = second_request.build_absolute_uri(
reverse(
"relate-sign_in_stage2_with_token",
args=(user.id, user.sign_in_key,)))
assert len(mail.outbox) == 2
assert cls.second_sign_in_url in mail.outbox[1].body
assert first_sign_in_key != second_sign_in_key
cls.user = user
def setUp(self):
super(SignInByEmailTest, self).setUp()
self.user.refresh_from_db()
self.flush_mailbox()
def test_email_login_enabled_sign_in_view_anonymous(self, mock_add_msg):
with self.temporarily_switch_to_user(None):
resp = self.get_sign_in_by_email()
self.assertEqual(resp.status_code, 200)
self.assertSessionHasNoUserLoggedIn()
self.assertEqual(len(mail.outbox), 0)
resp = self.post_sign_in_by_email(data=self.get_sign_in_data())
self.assertSessionHasNoUserLoggedIn()
self.assertEqual(resp.status_code, 302)
self.assertRedirects(resp, reverse("relate-home"),
fetch_redirect_response=False)
expected_msg = (
"Email sent. Please check your email and click the link.")
self.assertEqual(mock_add_msg.call_count, 1)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
self.assertEqual(len(mail.outbox), 1)
@override_settings()
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
def test_email_login_not_enabled_sign_in_view_anonymous(self, mock_add_msg):
expected_msg = "Email-based sign-in is not being used"
settings.RELATE_SIGN_IN_BY_EMAIL_ENABLED = False
with self.temporarily_switch_to_user(None):
resp = self.get_sign_in_by_email(follow=True)
self.assertEqual(resp.status_code, 200)
self.assertSessionHasNoUserLoggedIn()
self.assertEqual(mock_add_msg.call_count, 1)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
self.assertEqual(len(mail.outbox), 0)
mock_add_msg.reset_mock()
resp = self.post_sign_in_by_email(data=self.get_sign_in_data(),
follow=False)
self.assertEqual(resp.status_code, 302)
self.assertRedirects(resp, self.get_sign_in_choice_url(),
fetch_redirect_response=False)
self.assertSessionHasNoUserLoggedIn()
self.assertEqual(mock_add_msg.call_count, 1)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
self.assertEqual(len(mail.outbox), 0)
def test_email_login_form_invalid(self):
with self.temporarily_switch_to_user(None):
data = {"email": "not a email"}
resp = self.post_sign_in_by_email(data=data,
follow=False)
self.assertEqual(resp.status_code, 200)
self.assertFormErrorLoose(resp, 'Enter a valid email address.')
self.assertSessionHasNoUserLoggedIn()
self.assertEqual(len(mail.outbox), 0)
@override_settings()
def test_stage2_login_email_login_not_enabled(self, mock_add_msg):
settings.RELATE_SIGN_IN_BY_EMAIL_ENABLED = False
expected_msg = "Email-based sign-in is not being used"
with self.temporarily_switch_to_user(None):
resp = self.c.get(self.second_sign_in_url)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
self.assertEqual(resp.status_code, 302)
self.assertRedirects(resp, self.get_sign_in_choice_url(),
fetch_redirect_response=False)
self.assertSessionHasNoUserLoggedIn()
def test_stage2_login_with_staled_signing_key(self, mock_add_msg):
with self.temporarily_switch_to_user(None):
expected_msg = ("Invalid sign-in token. Perhaps you've used "
"an old token email?")
resp = self.c.get(self.first_sign_in_url)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
self.assertEqual(resp.status_code, 403)
self.assertSessionHasNoUserLoggedIn()
def test_stage2_login_user_inactive(self, mock_add_msg):
self.user.is_active = False
self.user.save()
self.user.refresh_from_db()
with self.temporarily_switch_to_user(None):
expected_msg = ("Account disabled.")
resp = self.c.get(self.second_sign_in_url)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
self.assertEqual(resp.status_code, 403)
self.assertSessionHasNoUserLoggedIn()
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
def login_stage2_without_profile(self, user, mock_add_msg):
with self.temporarily_switch_to_user(None):
expected_msg = (
"Successfully signed in. "
"Please complete your registration information below.")
resp = self.c.get(self.second_sign_in_url)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
self.assertEqual(resp.status_code, 302)
self.assertRedirects(resp, self.get_user_profile_url()+"?first_login=1",
fetch_redirect_response=False)
self.assertSessionHasUserLoggedIn()
def test_stage2_login_without_first_name_last_name(self):
self.login_stage2_without_profile(self.user)
def test_stage2_login_without_first_name(self):
self.user.first_name = "foo"
self.user.save()
self.login_stage2_without_profile(self.user)
def test_stage2_login_without_last_name(self):
self.user.last_name = "bar"
self.user.save()
self.login_stage2_without_profile(self.user)
def test_stage2_login_with_first_name_and_last_name(self, mock_add_msg):
self.user.first_name = "foo"
self.user.last_name = "bar"
self.user.save()
with self.temporarily_switch_to_user(None):
expected_msg = (
"Successfully signed in.")
resp = self.c.get(self.second_sign_in_url)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
self.assertEqual(resp.status_code, 302)
self.assertRedirects(resp, reverse("relate-home"),
fetch_redirect_response=False)
self.assertSessionHasUserLoggedIn()
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
def test_stage2_login_non_existing_user(self, mock_add_msg):
user = get_user_model().objects.get(pk=self.user.pk)
user.delete()
expected_msg = (
"Account does not exist.")
with self.temporarily_switch_to_user(None):
resp = self.c.get(self.second_sign_in_url)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
self.assertEqual(resp.status_code, 403)
@override_settings(RELATE_REGISTRATION_ENABLED=True)
class SignUpTest(CoursesTestMixinBase, AuthTestMixin, LocmemBackendTestsMixin,
FallBackStorageMessageTestMixin, TestCase):
sign_up_user_dict = {
"username": "test_sign_up_user", "password": "mypassword",
"email": "test_sign_up@example.com"
}
def setUp(self):
super(SignUpTest, self).setUp()
self.c.logout()
@override_settings()
def test_signup_registeration_not_enabled(self):
settings.RELATE_REGISTRATION_ENABLED = False
resp = self.get_sign_up()
self.assertEqual(resp.status_code, 400)
self.assertNoNewUserCreated()
self.assertEqual(len(mail.outbox), 1)
self.assertIn("self-registration is not enabled", mail.outbox[0].body)
self.flush_mailbox()
resp = self.post_sign_up({})
self.assertEqual(resp.status_code, 400)
self.assertNoNewUserCreated()
self.assertEqual(len(mail.outbox), 1)
self.assertIn("self-registration is not enabled", mail.outbox[0].body)
def get_sign_up_user_dict(self):
return self.sign_up_user_dict.copy()
def test_sign_up_form_invalid(self):
with self.temporarily_switch_to_user(None):
data = self.get_sign_up_user_dict()
data["email"] = "not a email"
resp = self.post_sign_up(data=data,
follow=False)
self.assertEqual(resp.status_code, 200)
self.assertFormErrorLoose(resp, 'Enter a valid email address.')
self.assertNoNewUserCreated()
self.assertEqual(len(mail.outbox), 0)
def test_signup_existing_user_name(self, mock_add_msg):
resp = self.get_sign_up()
self.assertEqual(resp.status_code, 200)
self.assertNoNewUserCreated()
expected_msg = "A user with that username already exists."
data = self.get_sign_up_user_dict()
data["username"] = self.test_user.username
resp = self.post_sign_up(data=data, follow=False)
self.assertEqual(resp.status_code, 200)
self.assertNoNewUserCreated()
self.assertEqual(len(mail.outbox), 0)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
def test_signup_existing_email(self, mock_add_msg):
expected_msg = (
"That email address is already in use. "
"Would you like to "
"<a href='%s'>reset your password</a> instead?"
% reverse("relate-reset_password"))
data = self.get_sign_up_user_dict()
data["email"] = self.test_user.email
resp = self.post_sign_up(data=data, follow=False)
self.assertEqual(resp.status_code, 200)
self.assertNoNewUserCreated()
self.assertEqual(len(mail.outbox), 0)
self.assertIn(expected_msg, mock_add_msg.call_args[0])
def test_signup_success(self, mock_add_msg):
expected_msg = (
"Email sent. Please check your email and click "
"the link.")
data = self.get_sign_up_user_dict()
resp = self.post_sign_up(data=data, follow=False)
self.assertRedirects(resp, reverse("relate-home"),
fetch_redirect_response=False)
sent_request = resp.wsgi_request
self.assertEqual(resp.status_code, 302)
self.assertNewUserCreated()
self.assertEqual(len(mail.outbox), 1)