-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathtest_users.py
1936 lines (1651 loc) · 64.3 KB
/
test_users.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
import datetime
import json
import pytest
from py42.exceptions import Py42ActiveLegalHoldError
from py42.exceptions import Py42CloudAliasCharacterLimitExceededError
from py42.exceptions import Py42CloudAliasLimitExceededError
from py42.exceptions import Py42InvalidEmailError
from py42.exceptions import Py42InvalidPasswordError
from py42.exceptions import Py42InvalidUsernameError
from py42.exceptions import Py42NotFoundError
from py42.exceptions import Py42OrgNotFoundError
from py42.exceptions import Py42UserRiskProfileNotFound
from tests.conftest import create_mock_http_error
from tests.conftest import create_mock_response
from code42cli.main import cli
from code42cli.worker import WorkerStats
_NAMESPACE = "code42cli.cmds.users"
TEST_ROLE_RETURN_DATA = {
"data": [{"roleName": "Customer Cloud Admin", "roleId": "1234543"}]
}
TEST_USERS_RESPONSE = {
"users": [
{
"firstName": "test",
"lastName": "username",
"orgId": 4321,
"orgUid": "44444444",
"orgName": "ORG_NAME",
"status": "Active",
"notes": "This is a note.",
"active": True,
"blocked": False,
"creationDate": "2021-03-12T20:07:40.898Z",
"modificationDate": "2021-03-12T20:07:40.938Z",
"roles": ["Desktop User"],
"userId": 1234,
"username": "[email protected]",
"userUid": "911162111513111325",
"invited": False,
"quotaInBytes": 55555,
}
]
}
TEST_USER_RESPONSE = {
"tenantId": "SampleTenant1",
"userId": 12345,
"userName": "[email protected]",
"displayName": "Sample User1",
"notes": "This is an example of notes about Sample User1.",
"cloudAliases": ["[email protected]", "[email protected]"],
"managerUid": 12345,
"managerUsername": "[email protected]",
"managerDisplayName": "Manager Name",
"title": "Software Engineer",
"division": "Engineering",
"department": "Research and Development",
"employmentType": "Full-time",
"city": "Anytown",
"state": "MN",
"country": "US",
"riskFactors": ["FLIGHT_RISK", "HIGH_IMPACT_EMPLOYEE"],
}
TEST_PROFILE_RESPONSE = {
"userId": "12345-42",
"tenantId": "SampleTenant1",
"username": "[email protected]",
"displayName": "Foo Bar",
"notes": "",
"managerId": "123-42",
"managerUsername": "[email protected]",
"managerDisplayName": "",
"title": "Engineer",
"division": "Engineering",
"department": "RDO",
"employmentType": "Remote",
"country": "USA",
"region": "Minnesota",
"locality": "Minneapolis",
"active": True,
"deleted": False,
"supportUser": False,
"startDate": {"year": 2020, "month": 8, "day": 10},
"endDate": {"year": 2021, "month": 5, "day": 1},
"cloudAliases": ["[email protected]", "[email protected]"],
}
TEST_MATTER_RESPONSE = {
"legalHolds": [
{"legalHoldUid": "123456789", "name": "Legal Hold #1", "active": True},
{"legalHoldUid": "987654321", "name": "Legal Hold #2", "active": True},
]
}
TEST_CUSTODIANS_RESPONSE = {
"legalHoldMemberships": [
{
"legalHoldMembershipUid": "99999",
"active": True,
"creationDate": "2020-07-16T08:50:23.405Z",
"legalHold": {"legalHoldUid": "123456789", "name": "Legal Hold #1"},
"user": {
"userUid": "911162111513111325",
"username": "[email protected]",
"email": "[email protected]",
"userExtRef": None,
},
},
{
"legalHoldMembershipUid": "11111",
"active": True,
"creationDate": "2020-07-16T08:50:23.405Z",
"legalHold": {"legalHoldUid": "987654321", "name": "Legal Hold #2"},
"user": {
"userUid": "911162111513111325",
"username": "[email protected]",
"email": "[email protected]",
"userExtRef": None,
},
},
]
}
TEST_EMPTY_CUSTODIANS_RESPONSE = {"legalHoldMemberships": []}
TEST_EMPTY_MATTERS_RESPONSE = {"legalHolds": []}
TEST_EMPTY_USERS_RESPONSE = {"users": []}
TEST_USERNAME = TEST_USERS_RESPONSE["users"][0]["username"]
TEST_ALIAS = TEST_USER_RESPONSE["cloudAliases"][0]
TEST_USER_ID = TEST_USERS_RESPONSE["users"][0]["userId"]
TEST_USER_UID = TEST_USER_RESPONSE["userId"]
TEST_ROLE_NAME = TEST_ROLE_RETURN_DATA["data"][0]["roleName"]
TEST_GET_ORG_RESPONSE = {
"orgId": 9087,
"orgUid": "1007759454961904673",
"orgGuid": "a9578c3d-736b-4d96-80e5-71edd8a11ea3",
"orgName": "19may",
"orgExtRef": None,
"notes": None,
"status": "Active",
"active": True,
"blocked": False,
"parentOrgId": 2689,
"parentOrgUid": "890854247383106706",
"parentOrgGuid": "8c97h74umc2s8mmm",
"type": "ENTERPRISE",
"classification": "BASIC",
"externalId": "1007759454961904673",
"hierarchyCounts": {},
"configInheritanceCounts": {},
"creationDate": "2021-05-19T10:10:43.459Z",
"modificationDate": "2021-05-20T14:43:42.276Z",
"deactivationDate": None,
"settings": {"maxSeats": None, "maxBytes": None},
"settingsInherited": {"maxSeats": "", "maxBytes": ""},
"settingsSummary": {"maxSeats": "", "maxBytes": ""},
"registrationKey": "72RU-8P9S-M7KK-RHCC",
"reporting": {"orgManagers": []},
"customConfig": False,
}
TEST_EMPTY_ORGS_RESPONSE = {"totalCount": 0, "orgs": []}
TEST_GET_ALL_ORGS_RESPONSE = {"totalCount": 1, "orgs": [TEST_GET_ORG_RESPONSE]}
TEST_ORG_UID = "1007759454961904673"
@pytest.fixture
def update_user_response(mocker):
return create_mock_response(mocker)
@pytest.fixture
def get_available_roles_response(mocker):
return create_mock_response(mocker, data=TEST_ROLE_RETURN_DATA)
@pytest.fixture
def get_users_response(mocker):
return create_mock_response(mocker, data=TEST_USERS_RESPONSE)
@pytest.fixture
def get_user_response(mocker):
return create_mock_response(mocker, data=TEST_USER_RESPONSE)
@pytest.fixture
def get_user_failure(mocker):
return Py42UserRiskProfileNotFound(
create_mock_http_error(mocker, data=None, status=400),
"Failure in HTTP call 400 Client Error: Bad Request for url: https://ecm-east.us.code42.com/svc/api/v2/user/getbyusername.",
)
@pytest.fixture
def change_org_response(mocker):
return create_mock_response(mocker)
@pytest.fixture
def get_org_response(mocker):
return create_mock_response(mocker, data=TEST_GET_ORG_RESPONSE)
@pytest.fixture
def get_org_success(cli_state, get_org_response):
cli_state.sdk.orgs.get_by_uid.return_value = get_org_response
@pytest.fixture
def get_all_orgs_empty_success(mocker, cli_state):
def get_all_orgs_empty_generator():
yield create_mock_response(mocker, data=json.dumps(TEST_EMPTY_ORGS_RESPONSE))
cli_state.sdk.orgs.get_all.return_value = get_all_orgs_empty_generator()
@pytest.fixture
def get_all_orgs_success(mocker, cli_state):
def get_all_orgs_generator():
yield create_mock_response(mocker, data=json.dumps(TEST_GET_ALL_ORGS_RESPONSE))
cli_state.sdk.orgs.get_all.return_value = get_all_orgs_generator()
@pytest.fixture
def get_all_users_success(mocker, cli_state):
def get_all_users_generator():
yield create_mock_response(mocker, data=TEST_USERS_RESPONSE)
cli_state.sdk.users.get_all.return_value = get_all_users_generator()
@pytest.fixture
def get_user_id_success(cli_state, get_users_response):
"""Get by username returns a list of users"""
cli_state.sdk.users.get_by_username.return_value = get_users_response
@pytest.fixture
def get_user_uid_success(cli_state, get_user_response):
"""userriskprofile.get_by_username returns a single user"""
cli_state.sdk.userriskprofile.get_by_username.return_value = get_user_response
@pytest.fixture
def get_user_uid_failure(cli_state, get_user_failure):
cli_state.sdk.userriskprofile.get_by_username.side_effect = get_user_failure
@pytest.fixture
def get_user_id_failure(mocker, cli_state):
cli_state.sdk.users.get_by_username.return_value = create_mock_response(
mocker, data=TEST_EMPTY_USERS_RESPONSE
)
@pytest.fixture
def get_custodian_failure(mocker, cli_state):
def empty_custodian_list_generator():
yield create_mock_response(mocker, data=TEST_EMPTY_CUSTODIANS_RESPONSE)
cli_state.sdk.legalhold.get_all_matter_custodians.return_value = (
empty_custodian_list_generator()
)
@pytest.fixture
def get_matter_failure(mocker, cli_state):
def empty_matter_list_generator():
yield create_mock_response(mocker, data=TEST_EMPTY_MATTERS_RESPONSE)
cli_state.sdk.legalhold.get_all_matters.return_value = empty_matter_list_generator()
@pytest.fixture
def get_all_matter_success(mocker, cli_state):
def matter_list_generator():
yield create_mock_response(mocker, data=TEST_MATTER_RESPONSE)
cli_state.sdk.legalhold.get_all_matters.return_value = matter_list_generator()
@pytest.fixture
def get_all_custodian_success(mocker, cli_state):
def custodian_list_generator():
yield create_mock_response(mocker, data=TEST_CUSTODIANS_RESPONSE)
cli_state.sdk.legalhold.get_all_matter_custodians.return_value = (
custodian_list_generator()
)
@pytest.fixture
def get_available_roles_success(cli_state, get_available_roles_response):
cli_state.sdk.users.get_available_roles.return_value = get_available_roles_response
@pytest.fixture
def update_user_success(cli_state, update_user_response):
cli_state.sdk.users.update_user.return_value = update_user_response
@pytest.fixture
def deactivate_user_success(mocker, cli_state):
cli_state.sdk.users.deactivate.return_value = create_mock_response(mocker)
@pytest.fixture
def deactivate_user_legal_hold_failure(mocker, cli_state):
cli_state.sdk.users.deactivate.side_effect = Py42ActiveLegalHoldError(
create_mock_http_error(mocker, status=400), "user", TEST_USER_ID
)
@pytest.fixture
def reactivate_user_success(mocker, cli_state):
cli_state.sdk.users.deactivate.return_value = create_mock_response(mocker)
@pytest.fixture
def change_org_success(cli_state, change_org_response):
cli_state.sdk.users.change_org_assignment.return_value = change_org_response
@pytest.fixture
def add_alias_limit_failure(mocker, cli_state):
cli_state.sdk.userriskprofile.add_cloud_aliases.side_effect = (
Py42CloudAliasLimitExceededError(create_mock_http_error(mocker))
)
@pytest.fixture
def remove_alias_success(mocker, cli_state):
cli_state.sdk.userriskprofile.delete_cloud_aliases.return_value = (
create_mock_response(mocker)
)
@pytest.fixture
def worker_stats_factory(mocker):
return mocker.patch(f"{_NAMESPACE}.create_worker_stats")
@pytest.fixture
def worker_stats(mocker, worker_stats_factory):
stats = mocker.MagicMock(spec=WorkerStats)
worker_stats_factory.return_value = stats
return stats
def test_list_when_non_table_format_outputs_expected_columns(
runner, cli_state, get_all_users_success
):
result = runner.invoke(cli, ["users", "list", "-f", "CSV"], obj=cli_state)
assert "firstName" in result.output
assert "lastName" in result.output
assert "orgId" in result.output
assert "orgUid" in result.output
assert "orgName" in result.output
assert "status" in result.output
assert "notes" in result.output
assert "active" in result.output
assert "blocked" in result.output
assert "creationDate" in result.output
assert "modificationDate" in result.output
assert "userId" in result.output
assert "username" in result.output
assert "userUid" in result.output
assert "invited" in result.output
assert "quotaInBytes" in result.output
def test_list_when_table_format_outputs_expected_columns(
runner, cli_state, get_all_users_success
):
result = runner.invoke(cli, ["users", "list", "-f", "TABLE"], obj=cli_state)
assert "orgUid" in result.output
assert "status" in result.output
assert "username" in result.output
assert "userUid" in result.output
assert "firstName" not in result.output
assert "lastName" not in result.output
assert "orgId" not in result.output
assert "orgName" not in result.output
assert "notes" not in result.output
assert "active" not in result.output
assert "blocked" not in result.output
assert "creationDate" not in result.output
assert "modificationDate" not in result.output
assert "userId" not in result.output
assert "invited" not in result.output
assert "quotaInBytes" not in result.output
def test_list_users_calls_users_get_all_with_expected_role_id(
runner, cli_state, get_available_roles_success, get_all_users_success
):
role_name = "Customer Cloud Admin"
runner.invoke(cli, ["users", "list", "--role-name", role_name], obj=cli_state)
cli_state.sdk.users.get_all.assert_called_once_with(
active=None, org_uid=None, role_id="1234543", incRoles=False
)
def test_list_users_calls_get_all_users_with_correct_parameters(
runner, cli_state, get_all_users_success
):
org_uid = "TEST_ORG_UID"
runner.invoke(
cli,
["users", "list", "--org-uid", org_uid, "--active", "--include-roles"],
obj=cli_state,
)
cli_state.sdk.users.get_all.assert_called_once_with(
active=True, org_uid=org_uid, role_id=None, incRoles=True
)
def test_list_users_when_given_inactive_uses_active_equals_false(
runner, cli_state, get_available_roles_success, get_all_users_success
):
runner.invoke(cli, ["users", "list", "--inactive"], obj=cli_state)
cli_state.sdk.users.get_all.assert_called_once_with(
active=False, org_uid=None, role_id=None, incRoles=False
)
def test_list_users_when_given_active_and_inactive_raises_error(
runner, cli_state, get_available_roles_success, get_all_users_success
):
result = runner.invoke(
cli, ["users", "list", "--active", "--inactive"], obj=cli_state
)
assert "Error: --inactive can't be used with: --active" in result.output
def test_list_users_when_given_excluding_active_and_inactive_uses_active_equals_none(
runner, cli_state, get_available_roles_success, get_all_users_success
):
runner.invoke(cli, ["users", "list"], obj=cli_state)
cli_state.sdk.users.get_all.assert_called_once_with(
active=None, org_uid=None, role_id=None, incRoles=False
)
def test_list_users_when_given_invalid_org_uid_raises_error(
runner, cli_state, get_available_roles_success, custom_error
):
invalid_org_uid = "invalid_org_uid"
cli_state.sdk.users.get_all.side_effect = Py42OrgNotFoundError(
custom_error, invalid_org_uid
)
result = runner.invoke(
cli, ["users", "list", "--org-uid", invalid_org_uid], obj=cli_state
)
assert (
f"Error: The organization with UID '{invalid_org_uid}' was not found."
in result.output
)
def test_list_legal_hold_flag_reports_none_for_users_not_on_legal_hold(
runner,
cli_state,
get_all_users_success,
get_custodian_failure,
get_all_matter_success,
):
result = runner.invoke(
cli,
["users", "list", "--include-legal-hold-membership", "-f", "CSV"],
obj=cli_state,
)
assert "Legal Hold #1,Legal Hold #2" not in result.output
assert "123456789,987654321" not in result.output
assert "legalHoldUid" not in result.output
assert "[email protected]" in result.output
def test_list_legal_hold_flag_reports_none_if_no_matters_exist(
runner, cli_state, get_all_users_success, get_custodian_failure, get_matter_failure
):
result = runner.invoke(
cli, ["users", "list", "--include-legal-hold-membership"], obj=cli_state
)
assert "Legal Hold #1,Legal Hold #2" not in result.output
assert "123456789,987654321" not in result.output
assert "legalHoldUid" not in result.output
assert "[email protected]" in result.output
def test_list_legal_hold_values_not_included_for_legal_hold_user_if_legal_hold_flag_not_passed(
runner,
cli_state,
get_all_users_success,
get_all_custodian_success,
get_all_matter_success,
):
result = runner.invoke(cli, ["users", "list"], obj=cli_state)
assert "Legal Hold #1,Legal Hold #2" not in result.output
assert "123456789,987654321" not in result.output
assert "[email protected]" in result.output
def test_list_include_legal_hold_membership_merges_in_and_concats_legal_hold_info(
runner,
cli_state,
get_all_users_success,
get_all_custodian_success,
get_all_matter_success,
):
result = runner.invoke(
cli, ["users", "list", "--include-legal-hold-membership"], obj=cli_state
)
assert "Legal Hold #1,Legal Hold #2" in result.output
assert "123456789,987654321" in result.output
def test_list_prints_expected_data_if_include_roles(
runner, cli_state, get_all_users_success
):
result = runner.invoke(cli, ["users", "list", "--include-roles"], obj=cli_state)
assert "roles" in result.output
assert "Desktop User" in result.output
def test_show_calls_get_by_username_with_expected_params(runner, cli_state):
runner.invoke(
cli,
["users", "show", "[email protected]"],
obj=cli_state,
)
cli_state.sdk.users.get_by_username.assert_called_once_with(
"[email protected]", incRoles=True
)
def test_show_prints_expected_data(runner, cli_state, get_users_response):
cli_state.sdk.users.get_by_username.return_value = get_users_response
result = runner.invoke(
cli,
["users", "show", "[email protected]"],
obj=cli_state,
)
assert "[email protected]" in result.output
assert "911162111513111325" in result.output
assert "Active" in result.output
assert "44444444" in result.output
assert "Desktop User" in result.output
def test_show_legal_hold_flag_reports_none_for_users_not_on_legal_hold(
runner,
cli_state,
get_users_response,
get_custodian_failure,
get_all_matter_success,
):
cli_state.sdk.users.get_by_username.return_value = get_users_response
result = runner.invoke(
cli,
[
"users",
"show",
"--include-legal-hold-membership",
"-f",
"CSV",
],
obj=cli_state,
)
assert "Legal Hold #1,Legal Hold #2" not in result.output
assert "123456789,987654321" not in result.output
assert "legalHoldUid" not in result.output
assert "[email protected]" in result.output
def test_show_legal_hold_flag_reports_none_if_no_matters_exist(
runner, cli_state, get_users_response, get_custodian_failure, get_matter_failure
):
cli_state.sdk.users.get_by_username.return_value = get_users_response
result = runner.invoke(
cli,
[
"users",
"show",
"--include-legal-hold-membership",
],
obj=cli_state,
)
assert "Legal Hold #1,Legal Hold #2" not in result.output
assert "123456789,987654321" not in result.output
assert "legalHoldUid" not in result.output
assert "[email protected]" in result.output
def test_show_legal_hold_values_not_included_for_legal_hold_user_if_legal_hold_flag_not_passed(
runner,
cli_state,
get_users_response,
get_all_custodian_success,
get_all_matter_success,
):
cli_state.sdk.users.get_by_username.return_value = get_users_response
result = runner.invoke(
cli, ["users", "show", "[email protected]"], obj=cli_state
)
assert "Legal Hold #1,Legal Hold #2" not in result.output
assert "123456789,987654321" not in result.output
assert "[email protected]" in result.output
def test_show_include_legal_hold_membership_merges_in_and_concats_legal_hold_info(
runner,
cli_state,
get_users_response,
get_all_custodian_success,
get_all_matter_success,
):
cli_state.sdk.users.get_by_username.return_value = get_users_response
result = runner.invoke(
cli,
[
"users",
"show",
"--include-legal-hold-membership",
],
obj=cli_state,
)
assert "Legal Hold #1,Legal Hold #2" in result.output
assert "123456789,987654321" in result.output
def test_list_risk_profiles_calls_get_all_user_risk_profiles_with_default_parameters(
runner, cli_state
):
runner.invoke(
cli,
["users", "list-risk-profiles"],
obj=cli_state,
)
cli_state.sdk.userriskprofile.get_all.assert_called_once_with(
active=None, manager_id=None, department=None, employment_type=None, region=None
)
def test_list_risk_profiles_calls_get_all_user_risk_profiles_with_correct_parameters(
runner, cli_state
):
r = runner.invoke(
cli,
[
"users",
"list-risk-profiles",
"--active",
"--manager-id",
"123-42",
"--department",
"Engineering",
"--employment-type",
"Remote",
"--region",
"Minnesota",
],
obj=cli_state,
)
print(r.output)
cli_state.sdk.userriskprofile.get_all.assert_called_once_with(
active=True,
manager_id="123-42",
department="Engineering",
employment_type="Remote",
region="Minnesota",
)
def test_show_risk_profile_calls_user_risk_profile_get_by_username_with(
runner, cli_state, get_users_response
):
runner.invoke(
cli,
["users", "show-risk-profile", "[email protected]"],
obj=cli_state,
)
cli_state.sdk.userriskprofile.get_by_username.assert_called_once_with("[email protected]")
def test_add_user_role_adds(
runner, cli_state, get_user_id_success, get_available_roles_success
):
command = [
"users",
"add-role",
"--username",
"--role-name",
"Customer Cloud Admin",
]
runner.invoke(cli, command, obj=cli_state)
cli_state.sdk.users.add_role.assert_called_once_with(TEST_USER_ID, TEST_ROLE_NAME)
def test_add_user_role_raises_error_when_role_does_not_exist(
runner, cli_state, get_user_id_success, get_available_roles_success
):
command = [
"users",
"add-role",
"--username",
"--role-name",
"test",
]
result = runner.invoke(cli, command, obj=cli_state)
assert result.exit_code == 1
assert "Role with name 'test' not found." in result.output
def test_add_user_role_raises_error_when_username_does_not_exist(
runner, cli_state, get_user_id_failure, get_available_roles_success
):
command = [
"users",
"add-role",
"--username",
"--role-name",
"Desktop User",
]
result = runner.invoke(cli, command, obj=cli_state)
assert result.exit_code == 1
assert (
"User '[email protected]' does not exist or you do not have permission to view them."
in result.output
)
def test_remove_user_role_removes(
runner, cli_state, get_user_id_success, get_available_roles_success
):
command = [
"users",
"remove-role",
"--username",
"--role-name",
"Customer Cloud Admin",
]
runner.invoke(cli, command, obj=cli_state)
cli_state.sdk.users.remove_role.assert_called_once_with(
TEST_USER_ID, TEST_ROLE_NAME
)
def test_remove_user_role_raises_error_when_role_does_not_exist(
runner, cli_state, get_user_id_success, get_available_roles_success
):
command = [
"users",
"remove-role",
"--username",
"--role-name",
"test",
]
result = runner.invoke(cli, command, obj=cli_state)
assert result.exit_code == 1
assert "Role with name 'test' not found." in result.output
def test_remove_user_role_raises_error_when_username_does_not_exist(
runner, cli_state, get_user_id_failure, get_available_roles_success
):
command = [
"users",
"remove-role",
"--username",
"--role-name",
"Desktop User",
]
result = runner.invoke(cli, command, obj=cli_state)
assert result.exit_code == 1
assert (
"User '[email protected]' does not exist or you do not have permission to view them."
in result.output
)
def test_update_user_calls_update_user_with_correct_parameters_when_only_some_are_passed(
runner, cli_state, update_user_success
):
command = ["users", "update", "--user-id", "12345", "--email", "test_email"]
runner.invoke(cli, command, obj=cli_state)
cli_state.sdk.users.update_user.assert_called_once_with(
"12345",
username=None,
email="test_email",
password=None,
first_name=None,
last_name=None,
notes=None,
archive_size_quota_bytes=None,
)
def test_update_user_calls_update_user_with_correct_parameters_when_all_are_passed(
runner, cli_state, update_user_success
):
command = [
"users",
"update",
"--user-id",
"12345",
"--email",
"test_email",
"--username",
"test_username",
"--password",
"test_password",
"--first-name",
"test_fname",
"--last-name",
"test_lname",
"--notes",
"test notes",
"--archive-size-quota",
"123456",
]
runner.invoke(cli, command, obj=cli_state)
cli_state.sdk.users.update_user.assert_called_once_with(
"12345",
username="test_username",
email="test_email",
password="test_password",
first_name="test_fname",
last_name="test_lname",
notes="test notes",
archive_size_quota_bytes="123456",
)
def test_update_when_py42_raises_invalid_email_outputs_error_message(
mocker, runner, cli_state, update_user_success
):
test_email = "test_email"
mock_http_error = create_mock_http_error(mocker, status=500)
cli_state.sdk.users.update_user.side_effect = Py42InvalidEmailError(
test_email, mock_http_error
)
command = ["users", "update", "--user-id", "12345", "--email", test_email]
result = runner.invoke(cli, command, obj=cli_state)
assert "Error: 'test_email' is not a valid email." in result.output
def test_update_when_py42_raises_invalid_username_outputs_error_message(
mocker, runner, cli_state, update_user_success
):
mock_http_error = create_mock_http_error(mocker, status=500)
cli_state.sdk.users.update_user.side_effect = Py42InvalidUsernameError(
mock_http_error
)
command = ["users", "update", "--user-id", "12345", "--username", "test_username"]
result = runner.invoke(cli, command, obj=cli_state)
assert "Error: Invalid username." in result.output
def test_update_when_py42_raises_invalid_password_outputs_error_message(
mocker, runner, cli_state, update_user_success
):
mock_http_error = create_mock_http_error(mocker, status=500)
cli_state.sdk.users.update_user.side_effect = Py42InvalidPasswordError(
mock_http_error
)
command = ["users", "update", "--user-id", "12345", "--password", "test_password"]
result = runner.invoke(cli, command, obj=cli_state)
assert "Error: Invalid password." in result.output
def test_deactivate_calls_deactivate_with_correct_parameters(
runner, cli_state, get_user_id_success, deactivate_user_success
):
command = ["users", "deactivate", "[email protected]"]
runner.invoke(cli, command, obj=cli_state)
cli_state.sdk.users.deactivate.assert_called_once_with(TEST_USER_ID)
def test_deactivate_when_user_on_legal_hold_outputs_expected_error_text(
runner, cli_state, get_user_id_success, deactivate_user_legal_hold_failure
):
command = ["users", "deactivate", "[email protected]"]
result = runner.invoke(cli, command, obj=cli_state)
assert (
"Error: Cannot deactivate the user with ID 1234 as the user is involved in a legal hold matter."
in result.output
)
def test_reactivate_calls_reactivate_with_correct_parameters(
runner, cli_state, get_user_id_success, deactivate_user_success
):
command = ["users", "reactivate", "[email protected]"]
runner.invoke(cli, command, obj=cli_state)
cli_state.sdk.users.reactivate.assert_called_once_with(TEST_USER_ID)
def test_bulk_update_uses_expected_arguments_when_only_some_are_passed(
runner, mocker, cli_state
):
bulk_processor = mocker.patch(f"{_NAMESPACE}.run_bulk_process")
with runner.isolated_filesystem():
with open("test_bulk_update.csv", "w") as csv:
csv.writelines(
[
"user_id,username,email,password,first_name,last_name,notes,archive_size_quota\n",
"12345,,test_email,,,,,\n",
]
)
runner.invoke(
cli, ["users", "bulk", "update", "test_bulk_update.csv"], obj=cli_state
)
assert bulk_processor.call_args[0][1] == [
{
"user_id": "12345",
"username": "",
"email": "test_email",
"password": "",
"first_name": "",
"last_name": "",
"notes": "",
"archive_size_quota": "",
"updated": "False",
}
]
def test_bulk_update_uses_expected_arguments_when_all_are_passed(
runner, mocker, cli_state
):
bulk_processor = mocker.patch(f"{_NAMESPACE}.run_bulk_process")
with runner.isolated_filesystem():
with open("test_bulk_update.csv", "w") as csv:
csv.writelines(
[
"user_id,username,email,password,first_name,last_name,notes,archive_size_quota\n",
"12345,test_username,test_email,test_pword,test_fname,test_lname,test notes,4321\n",
]
)
runner.invoke(
cli, ["users", "bulk", "update", "test_bulk_update.csv"], obj=cli_state
)
assert bulk_processor.call_args[0][1] == [
{
"user_id": "12345",
"username": "test_username",
"email": "test_email",
"password": "test_pword",
"first_name": "test_fname",
"last_name": "test_lname",
"notes": "test notes",
"archive_size_quota": "4321",
"updated": "False",
}
]
def test_bulk_update_ignores_blank_lines(runner, mocker, cli_state):
bulk_processor = mocker.patch(f"{_NAMESPACE}.run_bulk_process")
with runner.isolated_filesystem():
with open("test_bulk_update.csv", "w") as csv:
csv.writelines(
[
"user_id,username,email,password,first_name,last_name,notes,archive_size_quota\n",
"\n",
"12345,test_username,test_email,test_pword,test_fname,test_lname,test notes,4321\n",
"\n",
]
)
runner.invoke(
cli, ["users", "bulk", "update", "test_bulk_update.csv"], obj=cli_state
)
assert bulk_processor.call_args[0][1] == [
{
"user_id": "12345",
"username": "test_username",
"email": "test_email",
"password": "test_pword",
"first_name": "test_fname",
"last_name": "test_lname",
"notes": "test notes",
"archive_size_quota": "4321",