-
Notifications
You must be signed in to change notification settings - Fork 2
/
test_verify.py
1518 lines (1282 loc) · 56 KB
/
test_verify.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
"""Test the iam.verify module."""
import pytest
from time import time
from unittest.mock import patch, AsyncMock, MagicMock
from discord import NotFound
from iam.verify import (
State, proc_begin, proc_restart, state_await_name, state_await_unsw,
state_await_zid, state_await_email, proc_send_email, state_await_code,
proc_resend_email, state_await_id, proc_forward_id_admins,
proc_exec_approve, proc_exec_reject, proc_resend_id, proc_display_pending,
proc_verify_manual, proc_grant_rank
)
from iam.db import (
MemberKey, MemberNotFound, make_def_member_data, MAX_VER_EMAILS
)
from iam.hooks import CheckFailed
from iam.mail import MailError
from iam.config import PREFIX, VERIF_ROLE
import discord
VALID_NAMES = ["Sabine Lim", "Test User", "kek", "", "X Æ A-12"]
VALID_ZIDS = ["z5555555", "z1234567", "z0000000", "z5242579"]
INVALID_ZIDS = ["5555555", "z12345678", "z0", "5242579z"]
VALID_EMAILS = [
"thesabinelim@gmail.com", "arcdelegate@unswpcsoc.com",
"sabine.lim@unsw.edu.au", "z5242579@unsw.edu.au", "g@g.gg"
]
INVALID_EMAILS = ["a@a", "google.com", "email", "", "@gmail.com", "hi@"]
SAMPLE_CODES = ["cf137a", "000000", "hello_world"]
SAMPLE_REJECT_REASONS = ["photo unclear", "", "u suck", "invalid", "123456"]
def filter_dict(dict, except_keys):
return {k:v for k,v in dict.items() if k not in except_keys}
def new_mock_user(id):
user = AsyncMock()
user.id = id
user.mention = f"@User_{user.id}#0000"
user.typing = MagicMock()
return user
def new_mock_guild(id):
guild = AsyncMock()
guild.id = id
return guild
def new_mock_channel(id):
channel = AsyncMock()
channel.id = id
channel.typing = MagicMock()
return channel
def new_mock_message(id, attachments=[]):
message = AsyncMock()
message.id = id
message.attachments = attachments
return message
def new_mock_attachment(id):
attachment = AsyncMock()
attachment.to_file.return_value = id
return attachment
@pytest.mark.asyncio
async def test_proc_begin_standard():
"""User not undergoing verification can begin verification."""
# Setup
invoke_message = new_mock_message(0)
db = MagicMock()
ver_channel = new_mock_channel(0)
member = new_mock_user(0)
db.get_member_data = MagicMock(side_effect=MemberNotFound(member.id, ""))
before_time = time()
# Call
await proc_begin(invoke_message, db, None, None, member)
# Ensure user entry in DB initialised with default data.
db.set_member_data.assert_called_once()
call_args = db.set_member_data.call_args.args
assert call_args[0] == member.id
assert filter_dict(call_args[1], [MemberKey.VER_TIME]) == \
filter_dict(make_def_member_data(), [MemberKey.VER_TIME])
assert call_args[1][MemberKey.VER_TIME] >= before_time and \
call_args[1][MemberKey.VER_TIME] <= time()
# Ensure user was sent prompts.
invoke_message.reply.assert_awaited_once_with("Please check your DMs for a "
"message from me.")
member.send.assert_awaited_once_with("Arc - UNSW Student Life strongly recommends all student societies verify their members' identities before allowing them to interact with their online communities (Arc Clubs Handbook section 22.2)\n"
"\n"
"To send messages in our PCSoc Discord server, we require the following:\n"
"(1) Your full name\n"
"(2) Whether or not you're a student at UNSW\n"
" (2a) If yes, your UNSW-issued zID\n"
"\n"
" (2b) If not, your email address\n"
" (3b) Your government-issued photo ID (e.g. driver's license or photo card).\n"
"\n"
"The information you share with us is only accessible by our current executive team - we do not share this with any other parties. You may request to have your record deleted if you are no longer a member of PCSoc.\n"
"If you have questions or you're stuck, feel free to message any of our executives :)\n"
"-----\n"
"(1) What is your full name as it appears on your government-issued ID?\n"
"You can restart this verification process "
f"at any time by typing `{PREFIX}restart`.")
# Ensure user state updated to awaiting name.
db.update_member_data.assert_called_once_with(member.id,
{MemberKey.VER_STATE: State.AWAIT_NAME})
# Ensure no side effects occurred.
member.add_roles.assert_not_awaited()
@pytest.mark.asyncio
async def test_proc_begin_already_verifying():
"""User already undergoing verification sent error."""
for state in State:
# Setup
db = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
member_data[MemberKey.VER_STATE] = state
db.get_member_data.return_value = member_data
# Call
await proc_begin(db, None, None, None, None, member)
# Ensure correct user queried.
db.get_member_data.assert_called_once_with(member.id)
# Ensure user was sent error.
member.send.assert_awaited_once_with("You are already undergoing the "
f"verification process. To restart, type `{PREFIX}restart`.")
# Ensure no side effects occurred.
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
db.update_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_begin_already_verified():
"""User previously verified granted rank immediately."""
for state in State:
# Setup
db = MagicMock()
member = new_mock_user(0)
ver_role = AsyncMock()
admin_channel = new_mock_channel(1)
member_data = make_def_member_data()
member_data[MemberKey.ID_VER] = True
member_data[MemberKey.VER_STATE] = state
db.get_member_data.return_value = member_data
# Call
await proc_begin(db, ver_role, None, admin_channel, member)
# Ensure correct user queried.
db.get_member_data.assert_called_once_with(member.id)
# Ensure user was granted rank.
member.add_roles.assert_awaited_once_with(ver_role)
# Ensure user was sent confirmation.
member.send.assert_awaited_once_with("Our records show you were "
"verified in the past. You have been granted the rank once again. "
"Welcome back to the server!")
# Ensure admin channel was sent confirmation.
admin_channel.send.assert_awaited_once_with(f"{member.mention} was "
"previously verified, and has been given the verified rank again "
"through request.")
# Ensure no side effects occurred.
db.set_member_data.assert_not_called()
db.update_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_restart_standard():
"""User undergoing verification can restart verification."""
for state in State:
# Setup
db = MagicMock()
user = new_mock_user(0)
member_data = make_def_member_data()
member_data[MemberKey.VER_STATE] = state
db.get_member_data.return_value = member_data
before_time = time()
# Call
await proc_restart(db, user)
# Ensure correct user queried.
db.get_member_data.assert_called_once_with(user.id)
# Ensure user entry in database updated correctly.
call_args_list = db.update_member_data.call_args_list
assert len(call_args_list) == 2
call_args = call_args_list[0].args
assert call_args[0] == user.id
assert filter_dict(call_args[1], [MemberKey.VER_TIME]) == \
{MemberKey.VER_STATE: None}
assert call_args[1][MemberKey.VER_TIME] >= before_time and \
call_args[1][MemberKey.VER_TIME] < time()
# Ensure user was sent prompt.
user.send.assert_awaited_once_with("Arc - UNSW Student Life strongly recommends all student societies verify their members' identities before allowing them to interact with their online communities (Arc Clubs Handbook section 22.2)\n"
"\n"
"To send messages in our PCSoc Discord server, we require the following:\n"
"(1) Your full name\n"
"(2) Whether or not you're a student at UNSW\n"
" (2a) If yes, your UNSW-issued zID\n"
"\n"
" (2b) If not, your email address\n"
" (3b) Your government-issued photo ID (e.g. driver's license or photo card).\n"
"\n"
"The information you share with us is only accessible by our current executive team - we do not share this with any other parties. You may request to have your record deleted if you are no longer a member of PCSoc.\n"
"If you have questions or you're stuck, feel free to message any of our executives :)\n"
"-----\n"
"(1) What is your full name as it appears on your government-issued ID?\n"
"You can restart this verification process "
f"at any time by typing `{PREFIX}restart`.")
# Ensure user state updated to awaiting name.
db.update_member_data.assert_called_with(user.id,
{MemberKey.VER_STATE: State.AWAIT_NAME})
# Ensure no side effects occurred.
user.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_restart_never_verifying():
"""User never started verification sent error."""
# Setup
db = MagicMock()
user = new_mock_user(0)
db.get_member_data = MagicMock(side_effect=MemberNotFound(user.id, ""))
# Call
await proc_restart(db, user)
# Ensure correct user queried.
db.get_member_data.assert_called_once_with(user.id)
# Ensure user was sent error.
user.send.assert_awaited_once_with("You are not currently being verified.")
# Ensure no side effects occurred.
user.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
db.update_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_restart_not_verifying():
"""User not undergoing verification sent error."""
# Setup
db = MagicMock()
user = new_mock_user(0)
db.get_member_data.return_value = make_def_member_data()
# Call
await proc_restart(db, user)
# Ensure correct user queried.
db.get_member_data.assert_called_once_with(user.id)
# Ensure user was sent error.
user.send.assert_awaited_once_with("You are not currently being verified.")
# Ensure no side effects occurred.
user.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
db.update_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_restart_already_verified():
"""User already verified sent error."""
for state in State:
# Setup
db = MagicMock()
user = new_mock_user(0)
member_data = make_def_member_data()
member_data[MemberKey.ID_VER] = True
member_data[MemberKey.VER_STATE] = state
db.get_member_data.return_value = member_data
# Call
await proc_restart(db, user)
# Ensure correct user queried.
db.get_member_data.assert_called_once_with(user.id)
# Ensure user was sent error.
user.send.assert_awaited_once_with("You are already verified.")
# Ensure no side effects occurred.
user.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
db.update_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_name_standard():
"""User sending valid name moves on to UNSW student question."""
# Setup
db = MagicMock()
member = new_mock_user(0)
full_name = "Test User 0"
# Call
await state_await_name(db, member, full_name)
# Ensure user entry in database updated correctly.
call_args_list = db.update_member_data.call_args_list
assert len(call_args_list) == 2
call_args = call_args_list[0].args
assert call_args == (member.id, {MemberKey.NAME: full_name})
# Ensure user was sent prompt.
member.send.assert_awaited_once_with("(2) Are you a UNSW student? Please type `y` or `n`.")
# Ensure user state updated to awaiting is UNSW.
call_args = call_args_list[1].args
assert call_args == (member.id, {MemberKey.VER_STATE: State.AWAIT_UNSW})
# Ensure no side effects occurred.
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_name_too_long():
"""User sending name that is too long sent error."""
# Setup
db = MagicMock()
member = new_mock_user(0)
full_name = "a" * 501
# Call
await state_await_name(db, member, full_name)
# Ensure user was sent error.
member.send.assert_awaited_once_with(f"Name must be 500 characters or "
"fewer. Please try again.")
# Ensure no side effects occurred.
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
db.update_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_unsw_yes():
"""User answering yes moves on to zID question."""
for ans in ["y", "Y", "yes", "Yes", "YES"]:
# Setup
db = MagicMock()
member = new_mock_user(0)
# Call
await state_await_unsw(db, member, ans)
# Ensure user was sent prompt.
member.send.awaited_once_with("(2a) What is your zID?")
# Ensure user state updated to awaiting zID.
db.update_member_data.assert_called_once_with(member.id,
{MemberKey.VER_STATE: State.AWAIT_ZID})
# Ensure no side effects occurred.
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_unsw_no():
"""User answering no moves on to email question."""
for ans in ["n", "N", "no", "No", "NO"]:
# Setup
db = MagicMock()
member = new_mock_user(0)
# Call
await state_await_unsw(db, member, ans)
# Ensure user was sent prompt.
member.send.awaited_once_with("(2b) What is your email address?")
# Ensure user state updated to awaiting email.
db.update_member_data.assert_called_once_with(member.id,
{MemberKey.VER_STATE: State.AWAIT_EMAIL})
# Ensure no side effects occurred.
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_unsw_unrecognised():
"""User typing unrecognised response sent error."""
# Setup
db = MagicMock()
member = new_mock_user(0)
ans = "kek"
# Call
await state_await_unsw(db, member, ans)
# Ensure user was sent error.
member.send.assert_awaited_once_with("Please type `y` or `n`.")
# Ensure no side effects occurred.
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
db.update_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_zid_standard():
"""User sending valid zID moves on to proc_send_email."""
for zid in VALID_ZIDS:
# Setup
db = MagicMock()
mail = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
email = f"{zid}@unsw.edu.au"
# Call
with patch("iam.verify.proc_send_email") as mock_proc_send_email:
await state_await_zid(db, mail, member, member_data, zid)
# Ensure user entry in database updated accordingly.
db.update_member_data.assert_called_once_with(member.id, {
MemberKey.ZID: zid,
MemberKey.EMAIL: email
})
# Ensure proc_send_email called.
mock_proc_send_email.assert_awaited_once_with(db, mail, member,
member_data, email)
# Ensure no side effects occurred.
member.send.assert_not_awaited()
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_zid_invalid():
"""User sending invalid zID sent error."""
for zid in INVALID_ZIDS:
# Setup
db = MagicMock()
mail = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
email = f"{zid}@unsw.edu.au"
# Call
with patch("iam.verify.proc_send_email") as mock_proc_send_email:
await state_await_zid(db, mail, member, member_data, zid)
# Ensure user was sent error.
member.send.assert_awaited_once_with("Your zID must match the "
"following format: `zXXXXXXX`. Please try again")
# Ensure no side effects occurred.
mock_proc_send_email.assert_not_called()
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
db.update_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_email_standard():
"""User sending valid email moves on to proc_send_email."""
for email in VALID_EMAILS:
# Setup
db = MagicMock()
mail = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
# Call
with patch("iam.verify.proc_send_email") as mock_proc_send_email:
await state_await_email(db, mail, member, member_data, email)
# Ensure user entry in database updated accordingly.
db.update_member_data.assert_called_once_with(member.id, {
MemberKey.EMAIL: email
})
# Ensure proc_send_email called.
mock_proc_send_email.assert_awaited_once_with(db, mail, member,
member_data, email)
# Ensure no side effects occurred.
member.send.assert_not_awaited()
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_email_invalid():
"""User sending invalid email sent error."""
for email in INVALID_EMAILS:
# Setup
db = MagicMock()
mail = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
# Call
with patch("iam.verify.proc_send_email") as mock_proc_send_email:
await state_await_email(db, mail, member, member_data, email)
# Ensure user was sent error.
member.send.assert_awaited_once_with("That is not a valid email "
"address. Please try again.")
# Ensure no side effects occurred.
mock_proc_send_email.assert_not_called()
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
db.update_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_send_email_standard():
"""User sent email moves on to code question."""
for email in VALID_EMAILS:
# Setup
db = MagicMock()
mail = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
code = "cf137a"
# Call
with patch("iam.verify.get_code") as mock_get_code:
mock_get_code.return_value = code
await proc_send_email(db, mail, member, member_data, email)
# Ensure user was sent email.
mail.send_email.assert_called_once_with(email,
"PCSoc Discord Verification", f"Your code is {code}")
# Ensure user entry in database updated accordingly.
call_args_list = db.update_member_data.call_args_list
assert len(call_args_list) == 2
call_args = call_args_list[0].args
assert call_args == (member.id, {
MemberKey.EMAIL_ATTEMPTS: member_data[MemberKey.EMAIL_ATTEMPTS] + 1
})
# Ensure user was sent prompt.
member.send.assert_awaited_once_with("Please enter the code sent to "
"your email (check your spam folder if you don't see it).\n"
f"You can request another email by typing `{PREFIX}resend`.")
# Ensure user state updated to awaiting code.
call_args = call_args_list[1].args
assert call_args == (member.id, {
MemberKey.VER_STATE: State.AWAIT_CODE
})
# Ensure no side effects occurred.
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_send_email_out_of_attempts():
"""User who was sent too many emails previously sent error."""
for email in VALID_EMAILS:
# Setup
db = MagicMock()
mail = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
member_data[MemberKey.EMAIL_ATTEMPTS] = MAX_VER_EMAILS
# Call
await proc_send_email(db, mail, member, member_data, email)
# Ensure user was sent error.
member.send.assert_awaited_once_with("You have requested too many "
"emails. Please DM an exec to continue verification.")
# Ensure user not sent email.
mail.send_email.assert_not_called()
# Ensure no side effects occurred.
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
db.update_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_send_email_failed():
"""When email bounces, user sent error without using up an attempt."""
for email in VALID_EMAILS:
# Setup
db = MagicMock()
mail = MagicMock()
mail.send_email = MagicMock(side_effect=MailError(email))
member = new_mock_user(0)
member_data = make_def_member_data()
code = "cf137a"
# Call
with patch("iam.verify.get_code") as mock_get_code:
mock_get_code.return_value = code
await proc_send_email(db, mail, member, member_data, email)
# Ensure email sending attempted.
mail.send_email.assert_called_once_with(email,
"PCSoc Discord Verification", f"Your code is {code}")
# Ensure user was sent error.
member.send.assert_awaited_once_with("Oops! Something went wrong "
"while attempting to send you an email. Please ensure that your "
"details have been entered correctly.")
# Ensure no side effects occurred.
member.add_roles.assert_not_awaited()
db.set_member_data.assert_not_called()
db.update_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_code_unsw():
"""Student sending matching code verified."""
for zid in VALID_ZIDS:
for code in SAMPLE_CODES:
# Setup
db = MagicMock()
ver_role = AsyncMock()
member = new_mock_user(0)
admin_channel = new_mock_channel(1)
member_data = make_def_member_data()
member_data[MemberKey.ZID] = zid
before_time = time()
# Call
with patch("iam.verify.get_code") as mock_get_code:
mock_get_code.return_value = code
with patch("iam.verify.proc_grant_rank") as \
mock_proc_grant_rank:
await state_await_code(db, ver_role, admin_channel, member,
member_data, code)
# Ensure user entry in DB updated correctly.
call_args_list = db.update_member_data.call_args_list
assert len(call_args_list) == 2
call_args = call_args_list[0].args
assert call_args[0] == member.id
assert filter_dict(call_args[1], [MemberKey.VER_TIME]) == \
{MemberKey.EMAIL_VER: True}
assert call_args[1][MemberKey.VER_TIME] >= before_time and \
call_args[1][MemberKey.VER_TIME] <= time()
call_args = call_args_list[1].args
assert call_args == (member.id, {MemberKey.ID_VER: True})
# Ensure user granted rank.
mock_proc_grant_rank.assert_awaited_once()
# Ensure no side effects occurred.
member.send.assert_not_awaited()
member.add_roles.assert_not_called()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_code_non_unsw():
"""Non-student sending matching code moves on to ID question."""
"""Student sending matching code verified."""
for code in SAMPLE_CODES:
# Setup
db = MagicMock()
ver_role = AsyncMock()
member = new_mock_user(0)
admin_channel = new_mock_channel(1)
member_data = make_def_member_data()
before_time = time()
# Call
with patch("iam.verify.get_code") as mock_get_code:
mock_get_code.return_value = code
await state_await_code(db, ver_role, admin_channel, member,
member_data, code)
# Ensure user entry in DB updated correctly.
call_args_list = db.update_member_data.call_args_list
assert len(call_args_list) == 2
call_args = call_args_list[0].args
assert call_args[0] == member.id
assert filter_dict(call_args[1], [MemberKey.VER_TIME]) == \
{MemberKey.EMAIL_VER: True}
assert call_args[1][MemberKey.VER_TIME] >= before_time and \
call_args[1][MemberKey.VER_TIME] <= time()
# Ensure user was sent prompt.
assert member.send.awaited_once_with("(3b) Please send a message with "
"a photo of your government-issued ID attached.")
# Ensure user state updated to awaiting ID.
call_args = call_args_list[1].args
assert call_args == (member.id,
{MemberKey.VER_STATE: State.AWAIT_ID})
# Ensure no side effects occurred.
member.add_roles.assert_not_called()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_code_invalid_unsw():
"""Student sending non-matching code sent error."""
for zid in VALID_ZIDS:
for expected_code in SAMPLE_CODES:
for received_code in ["wowee", "", "1nv4l1d", "!"]:
# Setup
db = MagicMock()
ver_role = AsyncMock()
member = new_mock_user(0)
admin_channel = new_mock_channel(1)
member_data = make_def_member_data()
member_data[MemberKey.ZID] = zid
before_time = time()
# Call
with patch("iam.verify.get_code") as mock_get_code:
mock_get_code.return_value = expected_code
await state_await_code(db, ver_role, admin_channel, member,
member_data, received_code)
# Ensure user was sent error.
member.send.assert_awaited_once_with("That was not the "
"correct code. Please try again.\nYou can request another "
f"email by typing `{PREFIX}resend`.")
# Ensure no side effects occurred.
member.add_roles.assert_not_called()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_code_invalid_non_unsw():
"""Non-student sending non-matching code sent error."""
for expected_code in SAMPLE_CODES:
for received_code in ["wowee", "", "1nv4l1d", "!"]:
# Setup
db = MagicMock()
ver_role = AsyncMock()
member = new_mock_user(0)
admin_channel = new_mock_channel(1)
member_data = make_def_member_data()
before_time = time()
# Call
with patch("iam.verify.get_code") as mock_get_code:
mock_get_code.return_value = expected_code
await state_await_code(db, ver_role, admin_channel, member,
member_data, received_code)
# Ensure user was sent error.
member.send.assert_awaited_once_with("That was not the "
"correct code. Please try again.\nYou can request another "
f"email by typing `{PREFIX}resend`.")
# Ensure no side effects occurred.
member.add_roles.assert_not_called()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_resend_email_standard():
"""User requesting resend sent another email."""
for email in VALID_EMAILS:
# Setup
db = MagicMock()
mail = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
member_data[MemberKey.EMAIL] = email
member_data[MemberKey.VER_STATE] = State.AWAIT_CODE
# Call
with patch("iam.verify.proc_send_email") as mock_proc_send_email:
await proc_resend_email(db, mail, member, member_data)
# Ensure proc_send_email called.
mock_proc_send_email.assert_awaited_once_with(db, mail, member,
member_data, email)
# Ensure no side effects occurred.
member.send.assert_not_awaited()
member.add_roles.assert_not_called()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_resend_email_not_awaiting_code():
"""User not awaiting code ignored."""
for email in VALID_EMAILS:
for state in State:
if state == State.AWAIT_CODE:
pass
# Setup
db = MagicMock()
mail = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
member_data[MemberKey.EMAIL] = email
member_data[MemberKey.VER_STATE] = state
# Call
with patch("iam.verify.proc_send_email") as mock_proc_send_email:
await proc_resend_email(db, mail, member, member_data)
# Ensure proc_send_email not called.
mock_proc_send_email.assert_not_awaited()
# Ensure no side effects occurred.
member.send.assert_not_awaited()
member.add_roles.assert_not_called()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_id_standard():
"""User sending attachments forwarded to admin channel."""
for n_attach in range(1, 11):
# Setup
db = MagicMock()
member = new_mock_user(0)
admin_channel = new_mock_channel(1)
member_data = make_def_member_data()
attachments = [new_mock_attachment(i) for i in range(n_attach)]
# Call
with patch("iam.verify.proc_forward_id_admins") as \
mock_proc_forward_id_admins:
await state_await_id(db, admin_channel, member, member_data,
attachments)
# Ensure proc_forward_id_admins called.
mock_proc_forward_id_admins.assert_awaited_once_with(db, member,
admin_channel, member_data, attachments)
# Ensure no side effects occurred.
member.add_roles.assert_not_called()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_state_await_id_no_attachments():
"""User sending no attachments sent error."""
# Setup
db = MagicMock()
member = new_mock_user(0)
admin_channel = new_mock_channel(1)
member_data = make_def_member_data()
attachments = []
# Call
with patch("iam.verify.proc_forward_id_admins") as \
mock_proc_forward_id_admins:
await state_await_id(db, admin_channel, member, member_data,
attachments)
# Ensure proc_forward_id_admins not called.
mock_proc_forward_id_admins.assert_not_awaited()
# Ensure user was sent error.
member.send.assert_awaited_once_with("No attachments received. Please try "
"again.")
# Ensure no side effects occurred.
member.add_roles.assert_not_called()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_forward_id_admins_standard():
"""Message containing attachments sent to admin channel."""
for full_name in VALID_NAMES:
for n_attach in range(1, 11):
# Setup
db = MagicMock()
member = new_mock_user(0)
admin_channel = new_mock_channel(1)
admin_channel.send.return_value = new_mock_message(1337)
member_data = make_def_member_data()
member_data[MemberKey.NAME] = full_name
attachments = [new_mock_attachment(i) for i in range(n_attach)]
# Call
await proc_forward_id_admins(db, member, admin_channel,
member_data, attachments)
# Ensure attachments forwarded to admin channel.
admin_channel.send.assert_awaited_once_with("Received "
f"attachment(s) from {member.mention}. Please verify that "
f"name on ID is `{full_name}`, then type `{PREFIX}verify "
f"approve {member.id}` or `{PREFIX}verify reject {member.id} "
"\"reason\"`.", files=[await a.to_file() for a in attachments])
# Ensure user entry in database updated accordingly.
call_args_list = db.update_member_data.call_args_list
assert len(call_args_list) == 2
call_args = call_args_list[0].args
assert call_args == (member.id, {MemberKey.ID_MESSAGE: 1337})
# Ensure notification sent to user.
member.send.assert_awaited_once_with("Your attachment(s) have "
"been forwarded to the execs. Please wait.")
# Ensure user state updated to awaiting approval.
call_args = call_args_list[1].args
assert call_args == (member.id,
{MemberKey.VER_STATE: State.AWAIT_APPROVAL})
# Ensure no side effects occurred.
member.add_roles.assert_not_called()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_exec_approve_standard():
"""Exec approving verifying user grants rank to user."""
# Setup
db = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
member_data[MemberKey.VER_STATE] = State.AWAIT_APPROVAL
db.get_member_data.return_value = member_data
exec = new_mock_user(1)
channel = new_mock_channel(2)
join_announce_channel = new_mock_channel(3)
ver_role = AsyncMock()
# Call
with patch("iam.verify.proc_grant_rank") as mock_proc_grant_rank:
await proc_exec_approve(db, channel, member, join_announce_channel,
exec, ver_role)
# Ensure user entry in database updated accordingly.
db.update_member_data.assert_called_once_with(member.id, {
MemberKey.ID_VER: True,
MemberKey.VER_EXEC: exec.id
})
# Ensure user granted rank.
mock_proc_grant_rank.assert_awaited_once_with(ver_role, channel,
join_announce_channel, member)
# Ensure no side effects occurred.
member.send.assert_not_awaited()
member.add_roles.assert_not_called()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_exec_approve_not_awaiting():
"""Exec approving user not awaiting approval sends error."""
for state in State:
if state == State.AWAIT_APPROVAL:
continue
# Setup
db = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
member_data[MemberKey.VER_STATE] = state
db.get_member_data.return_value = member_data
exec = new_mock_user(1)
channel = new_mock_channel(2)
ver_role = AsyncMock()
# Call
with patch("iam.verify.proc_grant_rank") as mock_proc_grant_rank:
with pytest.raises(CheckFailed) as exc:
await proc_exec_approve(db, channel, member, None, exec,
ver_role)
await exc.value.notify()
# Ensure error sent to channel.
channel.send.assert_awaited_once_with("That user is not awaiting "
"approval.")
# Ensure no side effects occurred.
mock_proc_grant_rank.assert_not_awaited()
member.send.assert_not_awaited()
member.add_roles.assert_not_called()
db.update_member_data.assert_not_called()
db.set_member_data.assert_not_called()
@pytest.mark.asyncio
async def test_proc_exec_approve_already_verified():
"""Exec approving user already verified sends error."""
for state in State:
# Setup
db = MagicMock()
member = new_mock_user(0)
member_data = make_def_member_data()
member_data[MemberKey.ID_VER] = True
member_data[MemberKey.VER_STATE] = state
db.get_member_data.return_value = member_data
exec = new_mock_user(1)
channel = new_mock_channel(2)
ver_role = AsyncMock()
# Call
with patch("iam.verify.proc_grant_rank") as mock_proc_grant_rank:
with pytest.raises(CheckFailed) as exc:
await proc_exec_approve(db, channel, member, None, exec,
ver_role)
await exc.value.notify()
# Ensure error sent to channel.