Newer
Older
__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.
"""
from urllib.parse import ParseResult, quote, urlparse
import unittest
from datetime import timedelta
import re
from django.utils.timezone import now
from djangosaml2.urls import urlpatterns as djsaml2_urlpatterns
from django.test import TestCase, override_settings, RequestFactory
from django.conf import settings
from django.core import mail
from django.contrib.auth import (
REDIRECT_FIELD_NAME, SESSION_KEY,
)
from django.contrib.auth.hashers import check_password
from django.http import QueryDict, HttpResponse, JsonResponse
from django.urls import NoReverseMatch, reverse
from django.conf.urls import url
from django.core.exceptions import PermissionDenied
from relate.urls import urlpatterns as base_urlpatterns, COURSE_ID_REGEX
EmailedTokenBackend, with_course_api_auth, APIError, APIBearerTokenBackend,
APIContext
from course.models import FlowPageVisit, ParticipationPermission, AuthenticationToken
CoursesTestMixinBase, SingleCoursePageTestMixin, MockAddMessageMixing,
APITestMixin
)
LocmemBackendTestsMixin, load_url_pattern_names, reload_urlconf, mock)
# 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.")
_TOKEN_AUTH_DATA_RE = re.compile(
r"[^0-9]+(?P<token_id>[0-9]+)_(?P<token_hash>[a-z0-9]+).+")
class ImpersonateTest(SingleCoursePageTestMixin, MockAddMessageMixing, TestCase):
def test_impersonate_by_not_authenticated(self):
with self.temporarily_switch_to_user(None):
self.assertEqual(resp.status_code, 403)
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):
self.assertEqual(resp.status_code, 403)
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
course=self.course,
status=constants.participation_status.active)
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):
self.assertEqual(resp.status_code, 200)
impersonatee=self.student_participation.user)
self.assertEqual(resp.status_code, 200)
self.assertEqual(self.c.session["impersonate_id"],
self.student_participation.user.pk)
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.assertIsNone(self.c.session.get("impersonate_id"))
self.assertAddMessageCalledWith(NO_LONGER_IMPERSONATING_MESSAGE)
# fail re-stop_impersonating
resp = self.post_stop_impersonate()
self.assertEqual(resp.status_code, 200)
self.assertAddMessageCalledWith(NOT_IMPERSONATING_MESSAGE)
# not allowed to impersonate instructor
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
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):
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):
self.assertEqual(resp.status_code, 200)
# first impersonate ta who has pperm
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
impersonatee=self.student_participation.user)
self.assertEqual(resp.status_code, 200)
self.assertAddMessageCalledWith(ALREADY_IMPERSONATING_SOMEONE_MESSAGE)
self.assertEqual(self.c.session["impersonate_id"],
self.ta_participation.user.pk)
# stop_impersonating
resp = self.post_stop_impersonate()
self.assertEqual(resp.status_code, 200)
self.assertAddMessageCalledWith(NO_LONGER_IMPERSONATING_MESSAGE)
# re-stop_impersonating
self.assertEqual(resp.status_code, 200)
self.assertAddMessageCalledWith(NOT_IMPERSONATING_MESSAGE)
def test_impersonate_error_none_user(self):
with self.temporarily_switch_to_user(self.ta_participation.user):
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.assertAddMessageCalledWith(ERROR_WHILE_IMPERSONATING_MESSAGE)
def test_impersonatee_error_none_existing_user(self):
with self.temporarily_switch_to_user(self.ta_participation.user):
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.assertAddMessageCalledWith(ERROR_WHILE_IMPERSONATING_MESSAGE)
def test_impersonate_error_no_impersonatable(self):
with self.temporarily_switch_to_user(self.ta_participation.user):
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.assertAddMessageCalledWith(ERROR_WHILE_IMPERSONATING_MESSAGE)
def test_impersonator_flow_page_visit(self):
session = factories.FlowSessionFactory(
course=self.course, participation=self.student_participation)
page_data = factories.FlowPageDataFactory(flow_session=session)
factories.FlowPageVisitFactory(page_data=page_data)
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_view(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)
290
291
292
293
294
295
296
297
298
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
def test_stop_impersonate_by_get_or_non_ajax_post_while_not_impersonating(self):
with self.temporarily_switch_to_user(self.instructor_participation.user):
# request by get
resp = self.get_stop_impersonate()
self.assertEqual(resp.status_code, 403)
# post not using ajax
resp = self.post_stop_impersonate(using_ajax=False)
self.assertEqual(resp.status_code, 403)
def test_stop_impersonate_by_get_or_non_ajax_post_while_impersonating(self):
with self.temporarily_switch_to_user(self.instructor_participation.user):
# first impersonate a user
self.post_impersonate_view(
impersonatee=self.student_participation.user)
# request by get
resp = self.get_stop_impersonate()
self.assertEqual(resp.status_code, 403)
self.assertIsNotNone(self.c.session.get("impersonate_id"))
# post not using ajax
resp = self.post_stop_impersonate(using_ajax=False)
self.assertEqual(resp.status_code, 403)
self.assertIsNotNone(self.c.session.get("impersonate_id"))
def test_stop_impersonate_suspicious_post(self):
with self.temporarily_switch_to_user(self.instructor_participation.user):
# first impersonate a user
self.post_impersonate_view(
impersonatee=self.student_participation.user)
resp = self.post_stop_impersonate(data={"foo": "bar"})
self.assertEqual(resp.status_code, 400)
self.assertIsNotNone(self.c.session.get("impersonate_id"))
# {{{ ImpersonateForm select2 result test
def test_impersonate_select2_user_search_widget_instructor(self):
p = factories.ParticipationFactory.create(course=self.course)
# make sure user have/don't have first_name and last_name get
# rendered in UserSearchWidget when requested.
if p.user.last_name:
p.user.last_name = ""
p.user.save()
user = self.instructor_participation.user
with self.temporarily_switch_to_user(user):
impersonatable = get_impersonable_user_qset(user)
343
344
345
346
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
field_id = self.get_select2_field_id_from_response(resp)
# With no search term, should display all impersonatable users
term = None
resp = self.select2_get_request(field_id=field_id, term=term)
self.assertEqual(resp.status_code, 200)
result = self.get_select2_response_data(resp)
self.assertEqual(len(result), impersonatable.count())
all_ids = [int(r['id']) for r in result]
# impersonator and superuser not in result
self.assertNotIn(user.pk, all_ids)
self.assertNotIn(self.superuser.pk, all_ids)
impersonatable_pks = list(impersonatable.values_list("pk", flat=True))
self.assertSetEqual(set(impersonatable_pks), set(all_ids))
all_text = [r['text'] for r in result]
for s in all_text:
for bad_string in ["(), None, none"]:
if bad_string in s:
self.fail("label_from_instance method in "
"course.auth.UserSearchWidget should not "
"return %s" % bad_string)
# Search ta by ta's last name
impersonatee = self.ta_participation.user
term = impersonatee.last_name
resp = self.select2_get_request(field_id=field_id, term=term)
self.assertEqual(resp.status_code, 200)
result = self.get_select2_response_data(resp)
self.assertEqual(len(result), 1)
self.assertEqual(impersonatee.pk, int(result[0]["id"]))
# Search student by his email
term = impersonatee.email
resp = self.select2_get_request(field_id=field_id, term=term)
result = self.get_select2_response_data(resp)
self.assertEqual(len(result), 1)
self.assertEqual(impersonatee.pk, int(result[0]["id"]))
def test_impersonate_select2_user_search_widget_ta(self):
user = self.ta_participation.user
with self.temporarily_switch_to_user(user):
impersonatable = get_impersonable_user_qset(user)
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
field_id = self.get_select2_field_id_from_response(resp)
# With no search term
term = None
resp = self.select2_get_request(field_id=field_id, term=term)
self.assertEqual(resp.status_code, 200)
result = self.get_select2_response_data(resp)
self.assertEqual(len(result), impersonatable.count())
all_ids = [int(r['id']) for r in result]
# impersonator and superuser not in result
self.assertNotIn(user.pk, all_ids)
self.assertNotIn(self.superuser.pk, all_ids)
impersonatable_pks = list(impersonatable.values_list("pk", flat=True))
self.assertSetEqual(set(impersonatable_pks), set(all_ids))
all_text = [r['text'] for r in result]
for s in all_text:
for bad_string in ["(), None, none"]:
if bad_string in s:
self.fail("label_from_instance method in "
"course.auth.UserSearchWidget should not "
"return %s" % bad_string)
# Search student by his email
impersonatee = self.student_participation.user
term = impersonatee.email
resp = self.select2_get_request(field_id=field_id, term=term)
self.assertEqual(resp.status_code, 200)
result = self.get_select2_response_data(resp)
self.assertEqual(len(result), 1)
self.assertEqual(impersonatee.pk, int(result[0]["id"]))
class CrossCourseImpersonateTest(CoursesTestMixinBase, TestCase):
@classmethod
def setUpTestData(cls): # noqa
super(CrossCourseImpersonateTest, cls).setUpTestData()
course1 = factories.CourseFactory()
course2 = factories.CourseFactory(identifier="another-course")
cls.ta = factories.UserFactory()
# create 2 ta with the same user in 2 courses
cls.course1_ta_participation = factories.ParticipationFactory.create(
user=cls.ta, course=course1, roles=["ta"])
cls.course1_ta_participation = factories.ParticipationFactory.create(
user=cls.ta, course=course2, roles=["ta"])
# create a student in each courses
factories.ParticipationFactory(course=course1)
factories.ParticipationFactory(course=course2)
def test_impersonate_across_courses(self):
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()
impersonatable = get_impersonable_user_qset(user)
self.assertEqual(impersonatable.count(), 0)
with self.temporarily_switch_to_user(user):
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()
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
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),
})
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
659
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
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)
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)
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
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,
AuthTestMixin, MockAddMessageMixing, TestCase):
@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, reverse("relate-home"),
fetch_redirect_response=False)
@override_settings(RELATE_SIGN_IN_BY_USERNAME_ENABLED=False)
def test_username_pw_not_enabled_sign_in_view_anonymous(self):
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.assertAddMessageCallCount(1)
self.assertAddMessageCalledWith(expected_msg)
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.assertAddMessageCallCount(1)
self.assertAddMessageCalledWith(expected_msg)
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
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, MockAddMessageMixing,
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
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):
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.assertAddMessageCallCount(1)
self.assertAddMessageCalledWith(expected_msg)
self.assertEqual(len(mail.outbox), 1)
@override_settings()
def test_email_login_not_enabled_sign_in_view_anonymous(self):
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.assertAddMessageCallCount(1)
self.assertAddMessageCalledWith(expected_msg)
self.assertEqual(len(mail.outbox), 0)
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.assertAddMessageCallCount(1)
self.assertAddMessageCalledWith(expected_msg)
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):
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.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):
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.assertEqual(resp.status_code, 403)
self.assertSessionHasNoUserLoggedIn()
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.assertEqual(resp.status_code, 403)
self.assertSessionHasNoUserLoggedIn()
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.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):
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.assertEqual(resp.status_code, 302)
self.assertRedirects(resp, reverse("relate-home"),
fetch_redirect_response=False)
self.assertSessionHasUserLoggedIn()
def test_stage2_login_non_existing_user(self):
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.assertEqual(resp.status_code, 403)
@override_settings(RELATE_REGISTRATION_ENABLED=True)
class SignUpTest(CoursesTestMixinBase, MockAddMessageMixing,
AuthTestMixin, LocmemBackendTestsMixin, 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)