forked from maxcountryman/flask-login
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_login.py
1680 lines (1359 loc) · 63.6 KB
/
test_login.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
279
280
281
282
283
284
285
286
287
288
289
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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
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
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
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
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
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
794
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
845
846
847
848
849
850
851
852
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
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
try:
import unittest2 as unittest
except ImportError:
import unittest
import base64
import collections
from datetime import timedelta, datetime
from contextlib import contextmanager
from mock import ANY, patch, Mock
from semantic_version import Version
from werkzeug import __version__ as werkzeug_version
from flask import (
Flask,
Blueprint,
Response,
session,
get_flashed_messages,
)
from flask.views import MethodView
from flask_login import (LoginManager, UserMixin, AnonymousUserMixin,
current_user, login_user, logout_user, user_logged_in,
user_logged_out, user_loaded_from_cookie,
user_login_confirmed, user_loaded_from_header,
user_loaded_from_request, user_unauthorized,
user_needs_refresh, make_next_param, login_url,
login_fresh, login_required, session_protected,
fresh_login_required, confirm_login, encode_cookie,
decode_cookie, set_login_view, user_accessed)
from flask_login.__about__ import (__title__, __description__, __url__,
__version_info__, __version__, __author__,
__author_email__, __maintainer__,
__license__, __copyright__)
from flask_login.utils import _secret_key, _user_context_processor
# be compatible with py3k
if str is not bytes:
unicode = str
@contextmanager
def listen_to(signal):
''' Context Manager that listens to signals and records emissions
Example:
with listen_to(user_logged_in) as listener:
login_user(user)
# Assert that a single emittance of the specific args was seen.
listener.assert_heard_one(app, user=user))
# Of course, you can always just look at the list yourself
self.assertEqual(1, len(listener.heard))
'''
class _SignalsCaught(object):
def __init__(self):
self.heard = []
def add(self, *args, **kwargs):
''' The actual handler of the signal. '''
self.heard.append((args, kwargs))
def assert_heard_one(self, *args, **kwargs):
''' The signal fired once, and with the arguments given '''
if len(self.heard) == 0:
raise AssertionError('No signals were fired')
elif len(self.heard) > 1:
msg = '{0} signals were fired'.format(len(self.heard))
raise AssertionError(msg)
elif self.heard[0] != (args, kwargs):
msg = 'One signal was heard, but with incorrect arguments: '\
'Got ({0}) expected ({1}, {2})'
raise AssertionError(msg.format(self.heard[0], args, kwargs))
def assert_heard_none(self, *args, **kwargs):
''' The signal fired no times '''
if len(self.heard) >= 1:
msg = '{0} signals were fired'.format(len(self.heard))
raise AssertionError(msg)
results = _SignalsCaught()
signal.connect(results.add)
try:
yield results
finally:
signal.disconnect(results.add)
class User(UserMixin):
def __init__(self, name, id, active=True):
self.id = id
self.name = name
self.active = active
def get_id(self):
return self.id
@property
def is_active(self):
return self.active
notch = User(u'Notch', 1)
steve = User(u'Steve', 2)
creeper = User(u'Creeper', 3, False)
germanjapanese = User(u'Müller', u'佐藤') # Unicode user_id
USERS = {1: notch, 2: steve, 3: creeper, u'佐藤': germanjapanese}
class AboutTestCase(unittest.TestCase):
'''Make sure we can get version and other info.'''
def test_have_about_data(self):
self.assertTrue(__title__ is not None)
self.assertTrue(__description__ is not None)
self.assertTrue(__url__ is not None)
self.assertTrue(__version_info__ is not None)
self.assertTrue(__version__ is not None)
self.assertTrue(__author__ is not None)
self.assertTrue(__author_email__ is not None)
self.assertTrue(__maintainer__ is not None)
self.assertTrue(__license__ is not None)
self.assertTrue(__copyright__ is not None)
class StaticTestCase(unittest.TestCase):
def test_static_loads_anonymous(self):
app = Flask(__name__)
app.static_url_path = '/static'
app.secret_key = 'this is a temp key'
lm = LoginManager()
lm.init_app(app)
@lm.user_loader
def load_user(user_id):
return USERS[int(user_id)]
with app.test_client() as c:
c.get('/static/favicon.ico')
self.assertTrue(current_user.is_anonymous)
def test_static_loads_without_accessing_session(self):
app = Flask(__name__)
app.static_url_path = '/static'
app.secret_key = 'this is a temp key'
lm = LoginManager()
lm.init_app(app)
@lm.user_loader
def load_user(user_id):
return USERS[int(user_id)]
with app.test_client() as c:
with listen_to(user_accessed) as listener:
c.get('/static/favicon.ico')
listener.assert_heard_none(app)
class InitializationTestCase(unittest.TestCase):
''' Tests the two initialization methods '''
def setUp(self):
self.app = Flask(__name__)
self.app.config['SECRET_KEY'] = '1234'
def test_init_app(self):
login_manager = LoginManager()
login_manager.init_app(self.app, add_context_processor=True)
self.assertIsInstance(login_manager, LoginManager)
def test_class_init(self):
login_manager = LoginManager(self.app, add_context_processor=True)
self.assertIsInstance(login_manager, LoginManager)
def test_login_disabled_is_set(self):
login_manager = LoginManager(self.app, add_context_processor=True)
self.assertFalse(login_manager._login_disabled)
def test_no_user_loader_raises(self):
login_manager = LoginManager(self.app, add_context_processor=True)
with self.app.test_request_context():
session['user_id'] = '2'
with self.assertRaises(Exception) as cm:
login_manager._load_user()
expected_message = 'Missing user_loader or request_loader'
self.assertTrue(str(cm.exception).startswith(expected_message))
class MethodViewLoginTestCase(unittest.TestCase):
def setUp(self):
self.app = Flask(__name__)
self.login_manager = LoginManager()
self.login_manager.init_app(self.app)
self.login_manager._login_disabled = False
class SecretEndpoint(MethodView):
decorators = [
login_required,
fresh_login_required,
]
def options(self):
return u''
def get(self):
return u''
self.app.add_url_rule('/secret',
view_func=SecretEndpoint.as_view('secret'))
def test_options_call_exempt(self):
with self.app.test_client() as c:
result = c.open('/secret', method='OPTIONS')
self.assertEqual(result.status_code, 200)
class LoginTestCase(unittest.TestCase):
''' Tests for results of the login_user function '''
def setUp(self):
self.app = Flask(__name__)
self.app.config['SECRET_KEY'] = 'deterministic'
self.app.config['SESSION_PROTECTION'] = None
self.remember_cookie_name = 'remember'
self.app.config['REMEMBER_COOKIE_NAME'] = self.remember_cookie_name
self.login_manager = LoginManager()
self.login_manager.init_app(self.app)
self.login_manager._login_disabled = False
@self.app.route('/')
def index():
return u'Welcome!'
@self.app.route('/secret')
def secret():
return self.login_manager.unauthorized()
@self.app.route('/login-notch')
def login_notch():
return unicode(login_user(notch))
@self.app.route('/login-notch-remember')
def login_notch_remember():
return unicode(login_user(notch, remember=True))
@self.app.route('/login-notch-remember-custom')
def login_notch_remember_custom():
duration = timedelta(hours=7)
return unicode(login_user(notch, remember=True, duration=duration))
@self.app.route('/login-notch-permanent')
def login_notch_permanent():
session.permanent = True
return unicode(login_user(notch))
@self.app.route('/needs-refresh')
def needs_refresh():
return self.login_manager.needs_refresh()
@self.app.route('/confirm-login')
def _confirm_login():
confirm_login()
return u''
@self.app.route('/username')
def username():
if current_user.is_authenticated:
return current_user.name
return u'Anonymous'
@self.app.route('/is-fresh')
def is_fresh():
return unicode(login_fresh())
@self.app.route('/logout')
def logout():
return unicode(logout_user())
@self.login_manager.user_loader
def load_user(user_id):
return USERS[int(user_id)]
@self.login_manager.header_loader
def load_user_from_header(header_value):
if header_value.startswith('Basic '):
header_value = header_value.replace('Basic ', '', 1)
try:
user_id = base64.b64decode(header_value)
except TypeError:
pass
return USERS.get(int(user_id))
@self.login_manager.request_loader
def load_user_from_request(request):
user_id = request.args.get('user_id')
try:
user_id = int(float(user_id))
except TypeError:
pass
return USERS.get(user_id)
@self.app.route('/empty_session')
def empty_session():
return unicode(u'modified=%s' % session.modified)
# This will help us with the possibility of typoes in the tests. Now
# we shouldn't have to check each response to help us set up state
# (such as login pages) to make sure it worked: we will always
# get an exception raised (rather than return a 404 response)
@self.app.errorhandler(404)
def handle_404(e):
raise e
unittest.TestCase.setUp(self)
def _delete_session(self, c):
# Helper method to cause the session to be deleted
# as if the browser was closed. This will remove
# the session regardless of the permament flag
# on the session!
with c.session_transaction() as sess:
sess.clear()
#
# Login
#
def test_test_request_context_users_are_anonymous(self):
with self.app.test_request_context():
self.assertTrue(current_user.is_anonymous)
def test_defaults_anonymous(self):
with self.app.test_client() as c:
result = c.get('/username')
self.assertEqual(u'Anonymous', result.data.decode('utf-8'))
def test_login_user(self):
with self.app.test_request_context():
result = login_user(notch)
self.assertTrue(result)
self.assertEqual(current_user.name, u'Notch')
def test_login_user_not_fresh(self):
with self.app.test_request_context():
result = login_user(notch, fresh=False)
self.assertTrue(result)
self.assertEqual(current_user.name, u'Notch')
self.assertIs(login_fresh(), False)
def test_login_user_emits_signal(self):
with self.app.test_request_context():
with listen_to(user_logged_in) as listener:
login_user(notch)
listener.assert_heard_one(self.app, user=notch)
def test_login_inactive_user(self):
with self.app.test_request_context():
result = login_user(creeper)
self.assertTrue(current_user.is_anonymous)
self.assertFalse(result)
def test_login_inactive_user_forced(self):
with self.app.test_request_context():
login_user(creeper, force=True)
self.assertEqual(current_user.name, u'Creeper')
def test_login_user_with_header(self):
user_id = 2
user_name = USERS[user_id].name
self.login_manager._request_callback = None
with self.app.test_client() as c:
basic_fmt = 'Basic {0}'
decoded = bytes.decode(base64.b64encode(str.encode(str(user_id))))
headers = [('Authorization', basic_fmt.format(decoded))]
result = c.get('/username', headers=headers)
self.assertEqual(user_name, result.data.decode('utf-8'))
def test_login_invalid_user_with_header(self):
user_id = 9000
user_name = u'Anonymous'
self.login_manager._request_callback = None
with self.app.test_client() as c:
basic_fmt = 'Basic {0}'
decoded = bytes.decode(base64.b64encode(str.encode(str(user_id))))
headers = [('Authorization', basic_fmt.format(decoded))]
result = c.get('/username', headers=headers)
self.assertEqual(user_name, result.data.decode('utf-8'))
def test_login_user_with_request(self):
user_id = 2
user_name = USERS[user_id].name
with self.app.test_client() as c:
url = '/username?user_id={user_id}'.format(user_id=user_id)
result = c.get(url)
self.assertEqual(user_name, result.data.decode('utf-8'))
def test_login_invalid_user_with_request(self):
user_id = 9000
user_name = u'Anonymous'
with self.app.test_client() as c:
url = '/username?user_id={user_id}'.format(user_id=user_id)
result = c.get(url)
self.assertEqual(user_name, result.data.decode('utf-8'))
#
# Logout
#
def test_logout_logs_out_current_user(self):
with self.app.test_request_context():
login_user(notch)
logout_user()
self.assertTrue(current_user.is_anonymous)
def test_logout_emits_signal(self):
with self.app.test_request_context():
login_user(notch)
with listen_to(user_logged_out) as listener:
logout_user()
listener.assert_heard_one(self.app, user=notch)
def test_logout_without_current_user(self):
with self.app.test_request_context():
login_user(notch)
del session['user_id']
with listen_to(user_logged_out) as listener:
logout_user()
listener.assert_heard_one(self.app, user=ANY)
#
# Unauthorized
#
def test_unauthorized_fires_unauthorized_signal(self):
with self.app.test_client() as c:
with listen_to(user_unauthorized) as listener:
c.get('/secret')
listener.assert_heard_one(self.app)
def test_unauthorized_flashes_message_with_login_view(self):
self.login_manager.login_view = '/login'
expected_message = self.login_manager.login_message = u'Log in!'
expected_category = self.login_manager.login_message_category = 'login'
with self.app.test_client() as c:
c.get('/secret')
msgs = get_flashed_messages(category_filter=[expected_category])
self.assertEqual([expected_message], msgs)
def test_unauthorized_flash_message_localized(self):
def _gettext(msg):
if msg == u'Log in!':
return u'Einloggen'
self.login_manager.login_view = '/login'
self.login_manager.localize_callback = _gettext
self.login_manager.login_message = u'Log in!'
expected_message = u'Einloggen'
expected_category = self.login_manager.login_message_category = 'login'
with self.app.test_client() as c:
c.get('/secret')
msgs = get_flashed_messages(category_filter=[expected_category])
self.assertEqual([expected_message], msgs)
self.login_manager.localize_callback = None
def test_unauthorized_uses_authorized_handler(self):
@self.login_manager.unauthorized_handler
def _callback():
return Response('This is secret!', 401)
with self.app.test_client() as c:
result = c.get('/secret')
self.assertEqual(result.status_code, 401)
self.assertEqual(u'This is secret!', result.data.decode('utf-8'))
def test_unauthorized_aborts_with_401(self):
with self.app.test_client() as c:
result = c.get('/secret')
self.assertEqual(result.status_code, 401)
def test_unauthorized_redirects_to_login_view(self):
self.login_manager.login_view = 'login'
@self.app.route('/login')
def login():
return 'Login Form Goes Here!'
with self.app.test_client() as c:
result = c.get('/secret')
self.assertEqual(result.status_code, 302)
self.assertEqual(result.location,
'http://localhost/login?next=%2Fsecret')
def test_unauthorized_with_next_in_session(self):
self.login_manager.login_view = 'login'
self.app.config['USE_SESSION_FOR_NEXT'] = True
@self.app.route('/login')
def login():
return session.pop('next', '')
with self.app.test_client() as c:
result = c.get('/secret')
self.assertEqual(result.status_code, 302)
self.assertEqual(result.location,
'http://localhost/login')
self.assertEqual(c.get('/login').data.decode('utf-8'), '/secret')
def test_unauthorized_uses_blueprint_login_view(self):
with self.app.app_context():
first = Blueprint('first', 'first')
second = Blueprint('second', 'second')
@self.app.route('/app_login')
def app_login():
return 'Login Form Goes Here!'
@self.app.route('/first_login')
def first_login():
return 'Login Form Goes Here!'
@self.app.route('/second_login')
def second_login():
return 'Login Form Goes Here!'
@self.app.route('/protected')
@login_required
def protected():
return u'Access Granted'
@first.route('/protected')
@login_required
def first_protected():
return u'Access Granted'
@second.route('/protected')
@login_required
def second_protected():
return u'Access Granted'
self.app.register_blueprint(first, url_prefix='/first')
self.app.register_blueprint(second, url_prefix='/second')
set_login_view('app_login')
set_login_view('first_login', blueprint=first)
set_login_view('second_login', blueprint=second)
with self.app.test_client() as c:
result = c.get('/protected')
self.assertEqual(result.status_code, 302)
expected = ('http://localhost/'
'app_login?next=%2Fprotected')
self.assertEqual(result.location, expected)
result = c.get('/first/protected')
self.assertEqual(result.status_code, 302)
expected = ('http://localhost/'
'first_login?next=%2Ffirst%2Fprotected')
self.assertEqual(result.location, expected)
result = c.get('/second/protected')
self.assertEqual(result.status_code, 302)
expected = ('http://localhost/'
'second_login?next=%2Fsecond%2Fprotected')
self.assertEqual(result.location, expected)
def test_set_login_view_without_blueprints(self):
with self.app.app_context():
@self.app.route('/app_login')
def app_login():
return 'Login Form Goes Here!'
@self.app.route('/protected')
@login_required
def protected():
return u'Access Granted'
set_login_view('app_login')
with self.app.test_client() as c:
result = c.get('/protected')
self.assertEqual(result.status_code, 302)
expected = 'http://localhost/app_login?next=%2Fprotected'
self.assertEqual(result.location, expected)
#
# Session Persistence/Freshness
#
def test_login_persists(self):
with self.app.test_client() as c:
c.get('/login-notch')
result = c.get('/username')
self.assertEqual(u'Notch', result.data.decode('utf-8'))
def test_logout_persists(self):
with self.app.test_client() as c:
c.get('/login-notch')
c.get('/logout')
result = c.get('/username')
self.assertEqual(result.data.decode('utf-8'), u'Anonymous')
def test_incorrect_id_logs_out(self):
# Ensure that any attempt to reload the user by the ID
# will seem as if the user is no longer valid
@self.login_manager.user_loader
def new_user_loader(user_id):
return
with self.app.test_client() as c:
# Successfully logs in
c.get('/login-notch')
result = c.get('/username')
self.assertEqual(u'Anonymous', result.data.decode('utf-8'))
def test_authentication_is_fresh(self):
with self.app.test_client() as c:
c.get('/login-notch-remember')
result = c.get('/is-fresh')
self.assertEqual(u'True', result.data.decode('utf-8'))
def test_remember_me(self):
with self.app.test_client() as c:
c.get('/login-notch-remember')
self._delete_session(c)
result = c.get('/username')
self.assertEqual(u'Notch', result.data.decode('utf-8'))
def test_remember_me_custom_duration(self):
with self.app.test_client() as c:
c.get('/login-notch-remember-custom')
self._delete_session(c)
result = c.get('/username')
self.assertEqual(u'Notch', result.data.decode('utf-8'))
def test_remember_me_uses_custom_cookie_parameters(self):
name = self.app.config['REMEMBER_COOKIE_NAME'] = 'myname'
duration = self.app.config['REMEMBER_COOKIE_DURATION'] = \
timedelta(days=2)
path = self.app.config['REMEMBER_COOKIE_PATH'] = '/mypath'
domain = self.app.config['REMEMBER_COOKIE_DOMAIN'] = '.localhost.local'
with self.app.test_client() as c:
c.get('/login-notch-remember')
# TODO: Is there a better way to test this?
self.assertIn(domain, c.cookie_jar._cookies,
'Custom domain not found as cookie domain')
domain_cookie = c.cookie_jar._cookies[domain]
self.assertIn(path, domain_cookie,
'Custom path not found as cookie path')
path_cookie = domain_cookie[path]
self.assertIn(name, path_cookie,
'Custom name not found as cookie name')
cookie = path_cookie[name]
expiration_date = datetime.utcfromtimestamp(cookie.expires)
expected_date = datetime.utcnow() + duration
difference = expected_date - expiration_date
fail_msg = 'The expiration date {0} was far from the expected {1}'
fail_msg = fail_msg.format(expiration_date, expected_date)
self.assertLess(difference, timedelta(seconds=10), fail_msg)
self.assertGreater(difference, timedelta(seconds=-10), fail_msg)
def test_remember_me_custom_duration_uses_custom_cookie(self):
name = self.app.config['REMEMBER_COOKIE_NAME'] = 'myname'
self.app.config['REMEMBER_COOKIE_DURATION'] = 172800
duration = timedelta(hours=7)
path = self.app.config['REMEMBER_COOKIE_PATH'] = '/mypath'
domain = self.app.config['REMEMBER_COOKIE_DOMAIN'] = '.localhost.local'
with self.app.test_client() as c:
c.get('/login-notch-remember-custom')
# TODO: Is there a better way to test this?
self.assertIn(domain, c.cookie_jar._cookies,
'Custom domain not found as cookie domain')
domain_cookie = c.cookie_jar._cookies[domain]
self.assertIn(path, domain_cookie,
'Custom path not found as cookie path')
path_cookie = domain_cookie[path]
self.assertIn(name, path_cookie,
'Custom name not found as cookie name')
cookie = path_cookie[name]
expiration_date = datetime.utcfromtimestamp(cookie.expires)
expected_date = datetime.utcnow() + duration
difference = expected_date - expiration_date
fail_msg = 'The expiration date {0} was far from the expected {1}'
fail_msg = fail_msg.format(expiration_date, expected_date)
self.assertLess(difference, timedelta(seconds=10), fail_msg)
self.assertGreater(difference, timedelta(seconds=-10), fail_msg)
def test_remember_me_accepts_duration_as_int(self):
self.app.config['REMEMBER_COOKIE_DURATION'] = 172800
duration = timedelta(seconds=172800)
name = self.app.config['REMEMBER_COOKIE_NAME'] = 'myname'
domain = self.app.config['REMEMBER_COOKIE_DOMAIN'] = '.localhost.local'
with self.app.test_client() as c:
result = c.get('/login-notch-remember')
self.assertEqual(result.status_code, 200)
cookie = c.cookie_jar._cookies[domain]['/'][name]
expiration_date = datetime.utcfromtimestamp(cookie.expires)
expected_date = datetime.utcnow() + duration
difference = expected_date - expiration_date
fail_msg = 'The expiration date {0} was far from the expected {1}'
fail_msg = fail_msg.format(expiration_date, expected_date)
self.assertLess(difference, timedelta(seconds=10), fail_msg)
self.assertGreater(difference, timedelta(seconds=-10), fail_msg)
def test_remember_me_with_invalid_duration_returns_500_response(self):
self.app.config['REMEMBER_COOKIE_DURATION'] = '123'
with self.app.test_client() as c:
result = c.get('/login-notch-remember')
self.assertEqual(result.status_code, 500)
def test_remember_me_with_invalid_custom_duration_returns_500_resp(self):
@self.app.route('/login-notch-remember-custom-invalid')
def login_notch_remember_custom_invalid():
duration = '123'
return unicode(login_user(notch, remember=True, duration=duration))
with self.app.test_client() as c:
result = c.get('/login-notch-remember-custom-invalid')
self.assertEqual(result.status_code, 500)
def test_set_cookie_with_invalid_duration_raises_exception(self):
self.app.config['REMEMBER_COOKIE_DURATION'] = '123'
with self.assertRaises(Exception) as cm:
with self.app.test_request_context():
session['user_id'] = 2
self.login_manager._set_cookie(None)
expected_exception_message = 'REMEMBER_COOKIE_DURATION must be a ' \
'datetime.timedelta, instead got: 123'
self.assertIn(expected_exception_message, str(cm.exception))
def test_set_cookie_with_invalid_custom_duration_raises_exception(self):
with self.assertRaises(Exception) as cm:
with self.app.test_request_context():
login_user(notch, remember=True, duration='123')
expected_exception_message = 'duration must be a ' \
'datetime.timedelta, instead got: 123'
self.assertIn(expected_exception_message, str(cm.exception))
def test_remember_me_refresh_every_request(self):
domain = self.app.config['REMEMBER_COOKIE_DOMAIN'] = '.localhost.local'
path = self.app.config['REMEMBER_COOKIE_PATH'] = '/'
# No refresh
self.app.config['REMEMBER_COOKIE_REFRESH_EACH_REQUEST'] = False
with self.app.test_client() as c:
c.get('/login-notch-remember')
self.assertIn('remember', c.cookie_jar._cookies[domain][path])
expiration_date_1 = datetime.utcfromtimestamp(
c.cookie_jar._cookies[domain][path]['remember'].expires)
self._delete_session(c)
c.get('/username')
self.assertIn('remember', c.cookie_jar._cookies[domain][path])
expiration_date_2 = datetime.utcfromtimestamp(
c.cookie_jar._cookies[domain][path]['remember'].expires)
self.assertEqual(expiration_date_1, expiration_date_2)
# With refresh (mock datetime's `utcnow`)
with patch('flask_login.login_manager.datetime') as mock_dt:
self.app.config['REMEMBER_COOKIE_REFRESH_EACH_REQUEST'] = True
now = datetime.utcnow()
mock_dt.utcnow = Mock(return_value=now)
with self.app.test_client() as c:
c.get('/login-notch-remember')
self.assertIn('remember', c.cookie_jar._cookies[domain][path])
expiration_date_1 = datetime.utcfromtimestamp(
c.cookie_jar._cookies[domain][path]['remember'].expires)
self.assertIsNotNone(expiration_date_1)
self._delete_session(c)
mock_dt.utcnow = Mock(return_value=now + timedelta(seconds=1))
c.get('/username')
self.assertIn('remember', c.cookie_jar._cookies[domain][path])
expiration_date_2 = datetime.utcfromtimestamp(
c.cookie_jar._cookies[domain][path]['remember'].expires)
self.assertIsNotNone(expiration_date_2)
self.assertNotEqual(expiration_date_1, expiration_date_2)
def test_remember_me_is_unfresh(self):
with self.app.test_client() as c:
c.get('/login-notch-remember')
self._delete_session(c)
self.assertEqual(u'False', c.get('/is-fresh').data.decode('utf-8'))
def test_login_persists_with_signle_x_forwarded_for(self):
self.app.config['SESSION_PROTECTION'] = 'strong'
with self.app.test_client() as c:
c.get('/login-notch', headers=[('X-Forwarded-For', '10.1.1.1')])
result = c.get('/username',
headers=[('X-Forwarded-For', '10.1.1.1')])
self.assertEqual(u'Notch', result.data.decode('utf-8'))
result = c.get('/username',
headers=[('X-Forwarded-For', '10.1.1.1')])
self.assertEqual(u'Notch', result.data.decode('utf-8'))
def test_login_persists_with_many_x_forwarded_for(self):
self.app.config['SESSION_PROTECTION'] = 'strong'
with self.app.test_client() as c:
c.get('/login-notch',
headers=[('X-Forwarded-For', '10.1.1.1')])
result = c.get('/username',
headers=[('X-Forwarded-For', '10.1.1.1')])
self.assertEqual(u'Notch', result.data.decode('utf-8'))
result = c.get('/username',
headers=[('X-Forwarded-For', '10.1.1.1, 10.1.1.2')])
self.assertEqual(u'Notch', result.data.decode('utf-8'))
def test_user_loaded_from_cookie_fired(self):
with self.app.test_client() as c:
c.get('/login-notch-remember')
self._delete_session(c)
with listen_to(user_loaded_from_cookie) as listener:
c.get('/username')
listener.assert_heard_one(self.app, user=notch)
def test_user_loaded_from_header_fired(self):
user_id = 1
user_name = USERS[user_id].name
self.login_manager._request_callback = None
with self.app.test_client() as c:
with listen_to(user_loaded_from_header) as listener:
headers = [
(
'Authorization',
'Basic %s' % (
bytes.decode(
base64.b64encode(str.encode(str(user_id))))
),
)
]
result = c.get('/username', headers=headers)
self.assertEqual(user_name, result.data.decode('utf-8'))
listener.assert_heard_one(self.app, user=USERS[user_id])
def test_user_loaded_from_request_fired(self):
user_id = 1
user_name = USERS[user_id].name
with self.app.test_client() as c:
with listen_to(user_loaded_from_request) as listener:
url = '/username?user_id={user_id}'.format(user_id=user_id)
result = c.get(url)
self.assertEqual(user_name, result.data.decode('utf-8'))
listener.assert_heard_one(self.app, user=USERS[user_id])
def test_logout_stays_logged_out_with_remember_me(self):
with self.app.test_client() as c:
c.get('/login-notch-remember')
c.get('/logout')
result = c.get('/username')
self.assertEqual(result.data.decode('utf-8'), u'Anonymous')
def test_logout_stays_logged_out_with_remember_me_custom_duration(self):
with self.app.test_client() as c:
c.get('/login-notch-remember-custom')
c.get('/logout')
result = c.get('/username')
self.assertEqual(result.data.decode('utf-8'), u'Anonymous')
def test_needs_refresh_uses_handler(self):
@self.login_manager.needs_refresh_handler
def _on_refresh():
return u'Needs Refresh!'
with self.app.test_client() as c:
c.get('/login-notch-remember')
result = c.get('/needs-refresh')
self.assertEqual(u'Needs Refresh!', result.data.decode('utf-8'))
def test_needs_refresh_fires_needs_refresh_signal(self):
with self.app.test_client() as c:
c.get('/login-notch-remember')
with listen_to(user_needs_refresh) as listener:
c.get('/needs-refresh')
listener.assert_heard_one(self.app)
def test_needs_refresh_fires_flash_when_redirect_to_refresh_view(self):
self.login_manager.refresh_view = '/refresh_view'
self.login_manager.needs_refresh_message = u'Refresh'
self.login_manager.needs_refresh_message_category = 'refresh'
category_filter = [self.login_manager.needs_refresh_message_category]
with self.app.test_client() as c:
c.get('/login-notch-remember')
c.get('/needs-refresh')
msgs = get_flashed_messages(category_filter=category_filter)
self.assertIn(self.login_manager.needs_refresh_message, msgs)
def test_needs_refresh_flash_message_localized(self):
def _gettext(msg):
if msg == u'Refresh':
return u'Aktualisieren'
self.login_manager.refresh_view = '/refresh_view'
self.login_manager.localize_callback = _gettext
self.login_manager.needs_refresh_message = u'Refresh'
self.login_manager.needs_refresh_message_category = 'refresh'
category_filter = [self.login_manager.needs_refresh_message_category]
with self.app.test_client() as c:
c.get('/login-notch-remember')
c.get('/needs-refresh')
msgs = get_flashed_messages(category_filter=category_filter)
self.assertIn(u'Aktualisieren', msgs)
self.login_manager.localize_callback = None
def test_needs_refresh_aborts_401(self):
with self.app.test_client() as c:
c.get('/login-notch-remember')
result = c.get('/needs-refresh')
self.assertEqual(result.status_code, 401)
def test_redirects_to_refresh_view(self):
@self.app.route('/refresh-view')
def refresh_view():
return ''
self.login_manager.refresh_view = 'refresh_view'
with self.app.test_client() as c:
c.get('/login-notch-remember')
result = c.get('/needs-refresh')
self.assertEqual(result.status_code, 302)
expected = 'http://localhost/refresh-view?next=%2Fneeds-refresh'
self.assertEqual(result.location, expected)
def test_refresh_with_next_in_session(self):
@self.app.route('/refresh-view')
def refresh_view():
return session.pop('next', '')
self.login_manager.refresh_view = 'refresh_view'
self.app.config['USE_SESSION_FOR_NEXT'] = True
with self.app.test_client() as c:
c.get('/login-notch-remember')
result = c.get('/needs-refresh')
self.assertEqual(result.status_code, 302)
self.assertEqual(result.location, 'http://localhost/refresh-view')
result = c.get('/refresh-view')
self.assertEqual(result.data.decode('utf-8'), '/needs-refresh')
def test_confirm_login(self):
with self.app.test_client() as c:
c.get('/login-notch-remember')
self._delete_session(c)
self.assertEqual(u'False', c.get('/is-fresh').data.decode('utf-8'))
c.get('/confirm-login')
self.assertEqual(u'True', c.get('/is-fresh').data.decode('utf-8'))
def test_user_login_confirmed_signal_fired(self):
with self.app.test_client() as c:
with listen_to(user_login_confirmed) as listener:
c.get('/confirm-login')
listener.assert_heard_one(self.app)
def test_session_not_modified(self):
with self.app.test_client() as c:
# Within the request we think we didn't modify the session.
self.assertEquals(
u'modified=False',
c.get('/empty_session').data.decode('utf-8'))
# But after the request, the session could be modified by the
# "after_request" handlers that call _update_remember_cookie.