-
Notifications
You must be signed in to change notification settings - Fork 214
/
test_client.py
1756 lines (1501 loc) · 60.1 KB
/
test_client.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
# pylint: disable=too-many-lines
import datetime
import json
from io import BytesIO
from unittest.mock import Mock, ANY
import pytest
import pytz
from boxsdk.auth.oauth2 import OAuth2, TokenScope
from boxsdk.client import Client, DeveloperTokenClient, DevelopmentClient, LoggingClient
from boxsdk.config import API
from boxsdk.network.default_network import DefaultNetworkResponse
from boxsdk.object.collaboration import Collaboration
from boxsdk.object.collaboration_allowlist import CollaborationAllowlist
from boxsdk.object.email_alias import EmailAlias
from boxsdk.object.collection import Collection
from boxsdk.object.comment import Comment
from boxsdk.object.device_pinner import DevicePinner
from boxsdk.object.enterprise import Enterprise
from boxsdk.object.events import Events
from boxsdk.object.file_request import FileRequest
from boxsdk.object.folder import Folder
from boxsdk.object.file import File
from boxsdk.object.file_version import FileVersion
from boxsdk.object.group import Group
from boxsdk.object.invite import Invite
from boxsdk.object.storage_policy import StoragePolicy
from boxsdk.object.storage_policy_assignment import StoragePolicyAssignment
from boxsdk.object.terms_of_service import TermsOfService
from boxsdk.object.user import User
from boxsdk.object.upload_session import UploadSession
from boxsdk.object.trash import Trash
from boxsdk.object.group_membership import GroupMembership
from boxsdk.object.metadata_template import MetadataTemplate, MetadataField, MetadataFieldType
from boxsdk.object.retention_policy import RetentionPolicy
from boxsdk.object.retention_policy_assignment import RetentionPolicyAssignment
from boxsdk.object.file_version_retention import FileVersionRetention
from boxsdk.object.legal_hold import LegalHold
from boxsdk.object.legal_hold_policy import LegalHoldPolicy
from boxsdk.object.legal_hold_policy_assignment import LegalHoldPolicyAssignment
from boxsdk.object.metadata_cascade_policy import MetadataCascadePolicy
from boxsdk.object.sign_request import SignRequest
from boxsdk.object.task import Task
from boxsdk.object.task_assignment import TaskAssignment
from boxsdk.object.webhook import Webhook
from boxsdk.object.web_link import WebLink
from boxsdk.pagination.marker_based_object_collection import MarkerBasedObjectCollection
from boxsdk.util.datetime_formatter import normalize_date_to_rfc3339_format
@pytest.fixture
def developer_token_input(monkeypatch):
monkeypatch.setattr('builtins.input', lambda prompt: 'developer_token')
@pytest.fixture(params=[Client, DeveloperTokenClient, DevelopmentClient, LoggingClient])
def mock_client(mock_box_session, developer_token_input, request):
# pylint:disable=redefined-outer-name, unused-argument
mock_oauth = Mock(OAuth2)
client = request.param(mock_oauth)
# pylint:disable=protected-access
client._session = mock_box_session
return client
@pytest.fixture(scope='module')
def user_id_1():
return 1
@pytest.fixture(scope='module')
def user_id_2():
return 1023
@pytest.fixture(scope='module')
def file_id():
return 100
@pytest.fixture(scope='module')
def folder_id():
return '1022'
@pytest.fixture()
def test_folder(mock_box_session, mock_object_id):
return Folder(mock_box_session, mock_object_id)
@pytest.fixture()
def test_webhook(mock_box_session, mock_object_id):
return Webhook(mock_box_session, mock_object_id)
@pytest.fixture(scope='function')
def mock_file_response(mock_object_id, make_mock_box_request):
# pylint:disable=redefined-outer-name
mock_box_response, _ = make_mock_box_request(
response={'type': 'file', 'id': mock_object_id},
)
return mock_box_response
@pytest.fixture(scope='function')
def mock_folder_response(mock_object_id, make_mock_box_request):
# pylint:disable=redefined-outer-name
mock_box_response, _ = make_mock_box_request(
response={'type': 'folder', 'id': mock_object_id},
)
return mock_box_response
@pytest.fixture(scope='function')
def mock_content_response(make_mock_box_request):
mock_box_response, mock_network_response = make_mock_box_request(content=b'Contents of a text file.')
mock_network_response.response_as_stream = raw = Mock()
raw.stream.return_value = (bytes((b,)) for b in mock_box_response.content)
return mock_box_response
@pytest.fixture(scope='module')
def marker_id():
return 'marker_1'
@pytest.fixture(scope='module')
def users_response(user_id_1, user_id_2):
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'entries': [
{'type': 'user', 'id': user_id_1},
{'type': 'user', 'id': user_id_2}
],
'limit': 100,
'offset': 0,
'total_count': 2
}
return mock_network_response
@pytest.fixture(scope='module')
def user_response(user_id_1):
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {'type': 'user', 'id': user_id_1}
return mock_network_response
@pytest.fixture(scope='module')
def group_id_1():
return 101
@pytest.fixture(scope='module')
def group_id_2():
return 202
@pytest.fixture()
def mock_user(mock_box_session, mock_user_id):
user = User(mock_box_session, mock_user_id)
return user
@pytest.fixture()
def mock_user_list(mock_box_session):
first_user = User(mock_box_session, '33333')
second_user = User(mock_box_session, '44444')
user_list = [first_user, second_user]
return user_list
@pytest.fixture()
def mock_file(mock_box_session):
test_file = File(mock_box_session, '11111')
return test_file
@pytest.fixture()
def mock_retention_policy(mock_box_session):
retention_policy = RetentionPolicy(mock_box_session, '22222')
return retention_policy
@pytest.fixture(scope='module')
def groups_response(group_id_1, group_id_2):
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'entries': [
{'type': 'group', 'id': group_id_1, 'name': str(group_id_1)},
{'type': 'group', 'id': group_id_2, 'name': str(group_id_2)},
],
'limit': 100,
'offset': 0,
'total_count': 2
}
return mock_network_response
@pytest.fixture(scope='module')
def legal_hold_policy_id_1():
return 101
@pytest.fixture(scope='module')
def legal_hold_policy_id_2():
return 202
@pytest.fixture(scope='module')
def legal_hold_policies_response(legal_hold_policy_id_1, legal_hold_policy_id_2):
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'entries': [
{'type': 'legal_hold_policy', 'id': legal_hold_policy_id_1, 'name': 'Test Policy 1'},
{'type': 'legal_hold_policy', 'id': legal_hold_policy_id_2, 'name': 'Test Policy 2'},
],
'limit': 5,
}
return mock_network_response
@pytest.fixture(scope='module')
def create_policy_response():
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'type': 'legal_hold_policy',
'id': 1234,
'policy_name': 'Test Policy'
}
return mock_network_response
@pytest.fixture(scope='module')
def create_group_response():
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'type': 'group',
'id': 1234,
'name': 'test_group_name',
}
return mock_network_response
@pytest.fixture(scope='module')
def tos_id_1():
return 101
@pytest.fixture(scope='module')
def tos_id_2():
return 202
@pytest.fixture(scope='module')
def terms_of_services_response(tos_id_1, tos_id_2):
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'entries': [
{'type': 'terms_of_service', 'id': tos_id_1},
{'type': 'terms_of_service', 'id': tos_id_2},
],
'total_count': 2,
}
return mock_network_response
@pytest.fixture(scope='module')
def create_user_response():
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'type': 'user',
'id': 1234,
'name': 'Ned Stark',
}
return mock_network_response
@pytest.fixture(scope='module')
def create_invite_response():
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'type': 'invite',
'id': 1234,
}
return mock_network_response
@pytest.fixture(params=('file', 'folder'))
def test_item_and_response(mock_file, test_folder, mock_file_response, mock_folder_response, request):
if request.param == 'file':
return mock_file, mock_file_response
return test_folder, mock_folder_response
@pytest.fixture()
def create_webhook_response(test_item_and_response, test_webhook):
# pylint:disable=redefined-outer-name
test_item, _ = test_item_and_response
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'type': test_webhook.object_type,
'id': test_webhook.object_id,
'target': {
'type': test_item.object_type,
'id': test_item.object_id,
},
'created_at': '2016-05-09T17:41:27-07:00',
'address': 'https://test.com',
'triggers': [
'FILE.UPLOADED',
'FOLDER.CREATED',
],
}
return mock_network_response
@pytest.fixture(scope='module', params=('file', 'folder'))
def shared_item_response(request):
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'type': request.param,
'id': 1234,
'name': 'shared_item',
}
return mock_network_response
@pytest.fixture(scope='module')
def search_response(file_id, folder_id):
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'entries': [
{'type': 'file', 'id': file_id},
{'type': 'folder', 'id': folder_id}
],
'limit': 100,
'offset': 0,
'total_count': 2
}
return mock_network_response
@pytest.fixture(scope='module')
def recent_items_response(file_id):
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'entries': [
{'type': 'recent_item', 'item': {'type': 'file', 'id': file_id}}
],
'next_marker': None,
'limit': 100,
}
return mock_network_response
@pytest.fixture(scope='module')
def device_pin_id_1():
return 101
@pytest.fixture(scope='module')
def device_pin_id_2():
return 202
@pytest.fixture(scope='module')
def device_pins_response(device_pin_id_1, device_pin_id_2):
# pylint:disable=redefined-outer-name
mock_network_response = Mock(DefaultNetworkResponse)
mock_network_response.json.return_value = {
'entries': [
{'type': 'device_pinner', 'id': device_pin_id_1},
{'type': 'device_pinner', 'id': device_pin_id_2},
],
'limit': 2,
}
return mock_network_response
@pytest.mark.parametrize('test_class, factory_method_name', [
(EmailAlias, 'email_alias'),
(Enterprise, 'enterprise'),
(Folder, 'folder'),
(File, 'file'),
(FileVersion, 'file_version'),
(Invite, 'invite'),
(User, 'user'),
(Group, 'group'),
(GroupMembership, 'group_membership'),
(Enterprise, 'enterprise'),
(Webhook, 'webhook'),
(MetadataCascadePolicy, 'metadata_cascade_policy'),
(UploadSession, 'upload_session'),
(StoragePolicy, 'storage_policy'),
(StoragePolicyAssignment, 'storage_policy_assignment'),
])
def test_factory_returns_the_correct_object(mock_client, test_class, factory_method_name):
""" Tests the various id-only factory methods in the Client class """
# pylint:disable=redefined-outer-name
fake_id = 'fake_id'
factory_method = getattr(mock_client, factory_method_name)
obj = factory_method(fake_id)
assert isinstance(obj, test_class)
assert obj.object_id == fake_id
def test_root_folder(mock_client):
folder = mock_client.root_folder()
assert isinstance(folder, Folder)
assert folder.object_id == '0'
@pytest.fixture(scope='module', params=(None, 'user1'))
def users_filter_term(request):
return request.param
@pytest.fixture(scope='module', params=(0, 10))
def users_offset(request):
return request.param
@pytest.fixture(scope='module', params=(0, 10))
def users_limit(request):
return request.param
@pytest.fixture(scope='module', params=(None, 'all', 'external', 'managed'))
def users_type(request):
return request.param
def test_users_return_the_correct_user_objects(
mock_client,
mock_box_session,
users_response,
user_id_1,
user_id_2,
users_filter_term,
users_type,
users_offset,
users_limit,
):
# pylint:disable=redefined-outer-name
mock_box_session.get.return_value = users_response
users = mock_client.users(limit=users_limit, offset=users_offset, filter_term=users_filter_term, user_type=users_type)
expected_params = {'offset': users_offset}
if users_limit is not None:
expected_params['limit'] = users_limit
if users_filter_term is not None:
expected_params['filter_term'] = users_filter_term
if users_type is not None:
expected_params['user_type'] = users_type
assert users.next().object_id == user_id_1
assert users.next().object_id == user_id_2
mock_box_session.get.assert_called_once_with(f'{API.BASE_API_URL}/users', params=expected_params)
def test_users_return_the_correct_user_objects_marker(
mock_client,
mock_box_session,
user_id_1,
user_id_2,
users_filter_term,
users_type,
marker_id,
users_limit,
):
# pylint:disable=redefined-outer-name
mock_box_session.get.return_value.json.return_value = {
'entries': [
{'type': 'user', 'id': user_id_1},
{'type': 'user', 'id': user_id_2}
],
'next_marker': 'JGWUGKNJFSAH123NDSA',
'total_count': 2
}
users = mock_client.users(limit=users_limit, marker=marker_id, use_marker=True, filter_term=users_filter_term, user_type=users_type)
expected_params = {'marker': marker_id, 'usemarker': True}
if users_limit is not None:
expected_params['limit'] = users_limit
if users_filter_term is not None:
expected_params['filter_term'] = users_filter_term
if users_type is not None:
expected_params['user_type'] = users_type
assert users.next().object_id == user_id_1
assert users.next().object_id == user_id_2
mock_box_session.get.assert_called_once_with(f'{API.BASE_API_URL}/users', params=expected_params)
def test_users_returns_correct_with_default_values(
mock_client,
mock_box_session,
):
expected_url = f'{API.BASE_API_URL}/users'
mock_box_session.get.return_value.json.return_value = {
'limit': 100,
'offset': 0,
'total_count': 1,
'entries': [
{
'type': 'user',
'id': '12345',
}
]
}
users = mock_client.users()
user = users.next()
mock_box_session.get.assert_called_once_with(expected_url, params={'offset': 0})
assert isinstance(user, User)
assert user.type == 'user'
assert user.id == '12345'
def test_search_instantiates_search_and_calls_search(
mock_client,
mock_box_session,
search_response,
file_id,
folder_id,
):
# pylint:disable=redefined-outer-name
mock_box_session.get.return_value = search_response
search_term = 'lolcatz'
search_result = mock_client.search().query(
search_term,
10,
0,
ancestor_folders=[Folder(mock_box_session, folder_id)],
file_extensions=['.jpg'],
)
assert search_result.next().object_id == file_id
assert search_result.next().object_id == folder_id
def test_events_returns_event_object(mock_client):
# pylint:disable=redefined-outer-name
assert isinstance(mock_client.events(), Events)
def test_collaboration_allowlist_initializer(mock_client):
collaboration_allowlist = mock_client.collaboration_allowlist()
assert isinstance(collaboration_allowlist, CollaborationAllowlist)
def test_get_groups_return_the_correct_group_objects(
mock_client,
mock_box_session,
groups_response,
group_id_1,
group_id_2,
):
# pylint:disable=redefined-outer-name
group_name = 'Employees'
expected_url = f'{API.BASE_API_URL}/groups'
mock_box_session.get.return_value = groups_response
groups = mock_client.get_groups(group_name)
for group, expected_id in zip(groups, [group_id_1, group_id_2]):
assert group.object_id == expected_id
assert group.name == str(expected_id)
# pylint:disable=protected-access
assert group._session == mock_box_session
mock_box_session.get.assert_called_once_with(expected_url, params={'offset': None, 'filter_term': group_name})
def test_create_group_returns_the_correct_group_object(mock_client, mock_box_session, create_group_response):
# pylint:disable=redefined-outer-name
expected_url = f'{API.BASE_API_URL}/groups'
test_group_name = 'test_group_name'
value = json.dumps({
'name': test_group_name,
'provenance': 'Example',
'external_sync_identifier': 'Example-User',
'description': 'Description of group',
'invitability_level': 'admins_and_members',
'member_viewability_level': 'admins_only',
})
mock_box_session.post.return_value = create_group_response
new_group = mock_client.create_group(
name=test_group_name,
provenance='Example',
external_sync_identifier='Example-User',
description='Description of group',
invitability_level='admins_and_members',
member_viewability_level='admins_only',
fields=['name,description'],
)
mock_box_session.post.assert_called_once_with(expected_url, data=value, params={'fields': 'name,description'})
assert isinstance(new_group, Group)
assert new_group.object_id == 1234
assert new_group.name == test_group_name
@pytest.mark.parametrize('description', ('My test policy',))
@pytest.mark.parametrize('filter_started_at', ('2016-01-01T00:00:00+00:00', datetime.datetime(2016, 1, 1, tzinfo=pytz.UTC)))
@pytest.mark.parametrize('filter_ended_at', ('2020-01-01T00:00:00+00:00', datetime.datetime(2020, 1, 1, tzinfo=pytz.UTC)))
@pytest.mark.parametrize('is_ongoing', ('True',))
def test_create_legal_hold_policy_returns_the_correct_policy_object(
mock_client,
mock_box_session,
create_policy_response,
description,
filter_started_at,
filter_ended_at,
is_ongoing
):
# pylint:disable=redefined-outer-name
params = {
'description': description,
'filter_started_at': filter_started_at,
'filter_ended_at': filter_ended_at,
'is_ongoing': is_ongoing
}
test_policy_name = 'Test Policy'
create_policy_response.json.return_value.update(params)
mock_box_session.post.return_value = create_policy_response
new_policy = mock_client.create_legal_hold_policy(test_policy_name, **params)
expected_url = f'{API.BASE_API_URL}/legal_hold_policies'
expected_body = {
'policy_name': test_policy_name,
'description': description,
'filter_started_at': normalize_date_to_rfc3339_format(filter_started_at),
'filter_ended_at': normalize_date_to_rfc3339_format(filter_ended_at),
'is_ongoing': is_ongoing
}
mock_box_session.post.assert_called_once_with(expected_url, data=ANY)
assert dict(json.loads(mock_box_session.post.call_args[1]['data'])) == expected_body
assert isinstance(new_policy, LegalHoldPolicy)
assert new_policy.policy_name == test_policy_name
for param, expected_value in params.items():
assert new_policy[param] == expected_value
def test_get_legal_hold_policies_return_the_correct_policy_objects(
mock_client,
mock_box_session,
legal_hold_policies_response,
legal_hold_policy_id_1,
legal_hold_policy_id_2,
):
# pylint:disable=redefined-outer-name
policy_name = 'Arbitration'
expected_url = f'{API.BASE_API_URL}/legal_hold_policies'
mock_box_session.get.return_value = legal_hold_policies_response
policies = mock_client.get_legal_hold_policies(policy_name)
for policy, expected_id in zip(policies, [legal_hold_policy_id_1, legal_hold_policy_id_2]):
assert policy.object_id == expected_id
# pylint:disable=protected-access
assert policy._session == mock_box_session
mock_box_session.get.assert_called_once_with(expected_url, params={'policy_name': policy_name})
def test_trash_initializer(mock_client):
trash = mock_client.trash()
assert isinstance(trash, Trash)
def test_get_recent_items_returns_the_correct_items(mock_client, mock_box_session, recent_items_response, file_id):
mock_box_session.get.return_value = recent_items_response
recent_items = mock_client.get_recent_items()
assert isinstance(recent_items, MarkerBasedObjectCollection)
recent_item = recent_items.next()
assert recent_item.item.object_id == file_id
next_pointer = recent_items.next_pointer()
assert next_pointer is None
def test_get_recent_items_sends_get_with_correct_params(mock_client, mock_box_session, recent_items_response, marker_id):
limit = 50
marker = marker_id
fields = ['modified_at', 'name']
expected_params = {
'limit': limit,
'marker': marker_id,
'fields': ','.join(fields),
}
mock_box_session.get.return_value = recent_items_response
object_collection = mock_client.get_recent_items(limit=limit, marker=marker, fields=fields)
object_collection.next()
mock_box_session.get.assert_called_once_with(f'{API.BASE_API_URL}/recent_items', params=expected_params)
@pytest.mark.parametrize('password', (None, 'p4ssw0rd'))
def test_get_shared_item_returns_the_correct_item(mock_client, mock_box_session, shared_item_response, password):
# pylint:disable=redefined-outer-name
shared_link = 'https://cloud.box.com/s/661wcw2iz6q5r7v5xxkm'
mock_box_session.request.return_value = shared_item_response
item = mock_client.get_shared_item(shared_link, password)
assert item.type == shared_item_response.json()['type']
mock_box_session.request.assert_called_once_with(
'GET',
f'{API.BASE_API_URL}/shared_items',
headers={
'BoxApi': f'shared_link={shared_link}{f"&shared_link_password={password}" if password is not None else ""}'
},
)
@pytest.mark.parametrize('test_method', [
'get',
'post',
'put',
'delete',
'options',
])
def test_make_request_passes_request_on_to_session(mock_client, mock_box_session, test_method):
# pylint:disable=redefined-outer-name
mock_client.make_request(test_method, 'url')
assert mock_box_session.request.call_args[0] == (test_method, 'url')
def test_create_app_user_returns_the_correct_user_object(mock_client, mock_box_session, create_user_response):
# pylint:disable=redefined-outer-name
test_user_name = 'Ned Stark'
value = json.dumps({'name': test_user_name, 'is_platform_access_only': True})
mock_box_session.post.return_value = create_user_response
new_user = mock_client.create_user(name=test_user_name)
assert len(mock_box_session.post.call_args_list) == 1
assert mock_box_session.post.call_args[0] == (f'{API.BASE_API_URL}/users',)
assert mock_box_session.post.call_args[1] == {'data': value}
assert isinstance(new_user, User)
assert new_user.object_id == 1234
assert new_user.name == test_user_name
def test_create_enterprise_user_returns_the_correct_user_object(mock_client, mock_box_session, create_user_response):
# pylint:disable=redefined-outer-name
test_user_name = 'Ned Stark'
test_user_login = 'eddard@box.com'
value = json.dumps({'name': test_user_name, 'login': test_user_login})
mock_box_session.post.return_value = create_user_response
new_user = mock_client.create_user(name=test_user_name, login=test_user_login)
assert len(mock_box_session.post.call_args_list) == 1
assert mock_box_session.post.call_args[0] == (f"{API.BASE_API_URL}/users",)
assert mock_box_session.post.call_args[1] == {'data': value}
assert isinstance(new_user, User)
assert new_user.object_id == 1234
assert new_user.name == test_user_name
def test_get_storage_policies(mock_client, mock_box_session):
expected_url = mock_box_session.get_url('storage_policies')
mock_policy = {
'type': 'storage_policy',
'id': '12345',
'name': 'Test Storage Policy'
}
mock_box_session.get.return_value.json.return_value = {
'limit': 100,
'entries': [mock_policy]
}
policies = mock_client.get_storage_policies()
policy = policies.next()
mock_box_session.get.assert_called_once_with(expected_url, params={})
assert isinstance(policy, StoragePolicy)
assert policy.type == 'storage_policy'
assert policy.id == '12345'
assert policy.name == 'Test Storage Policy'
def test_create_terms_of_service(mock_client, mock_box_session):
# pylint:disable=redefined-outer-name
expected_url = f'{API.BASE_API_URL}/terms_of_services'
test_text = 'This is a test text'
test_tos_type = 'external'
test_status = 'enabled'
value = json.dumps({
'status': 'enabled',
'tos_type': 'external',
'text': 'This is a test text',
})
mock_box_session.post.return_value.json.return_value = {
'type': 'terms_of_service',
'id': '12345',
'status': test_status,
'tos_type': test_tos_type,
'text': test_text,
}
new_terms_of_service = mock_client.create_terms_of_service('enabled', 'external', 'This is a test text')
mock_box_session.post.assert_called_once_with(expected_url, data=value)
assert isinstance(new_terms_of_service, TermsOfService)
assert new_terms_of_service.type == 'terms_of_service'
assert new_terms_of_service.id == '12345'
assert new_terms_of_service.status == test_status
assert new_terms_of_service.tos_type == test_tos_type
assert new_terms_of_service.text == test_text
def test_get_all_terms_of_services(mock_client, mock_box_session):
expected_url = f'{API.BASE_API_URL}/terms_of_services'
tos_body = {
'type': 'terms_of_service',
'id': '12345',
'status': 'enabled',
'tos_type': 'external',
}
mock_box_session.get.return_value.json.return_value = {
'total_count': 1,
'entries': [tos_body],
}
services = mock_client.get_terms_of_services(tos_type='external')
service = services.next()
mock_box_session.get.assert_called_once_with(expected_url, params={'tos_type': 'external'})
assert isinstance(service, TermsOfService)
assert service.type == 'terms_of_service'
assert service.id == '12345'
assert service.status == 'enabled'
assert service.tos_type == 'external'
def test_create_webhook_returns_the_correct_policy_object(
test_item_and_response,
test_webhook,
mock_client,
mock_box_session,
create_webhook_response,
):
# pylint:disable=redefined-outer-name
test_item, _ = test_item_and_response
expected_url = f'{API.BASE_API_URL}/webhooks'
expected_body = {
'target': {
'type': test_item.object_type,
'id': test_item.object_id,
},
'triggers': ['FILE.UPLOADED', 'FOLDER.CREATED'],
'address': 'https://test.com',
}
value = json.dumps(expected_body)
mock_box_session.post.return_value = create_webhook_response
new_webhook = mock_client.create_webhook(test_item, ['FILE.UPLOADED', 'FOLDER.CREATED'], 'https://test.com')
mock_box_session.post.assert_called_once_with(
expected_url,
data=value,
)
assert isinstance(new_webhook, Webhook)
assert new_webhook.id == test_webhook.object_id
assert new_webhook.type == test_webhook.object_type
assert new_webhook.target['type'] == test_item.object_type
assert new_webhook.target['id'] == test_item.object_id
assert new_webhook.triggers == ['FILE.UPLOADED', 'FOLDER.CREATED']
assert new_webhook.address == 'https://test.com'
def test_get_webhooks(mock_client, mock_box_session):
expected_url = f'{API.BASE_API_URL}/webhooks'
webhook_body = {
'type': 'webhook',
'id': '12345',
'target': {
'type': 'folder',
'id': '11111',
},
}
mock_box_session.get.return_value.json.return_value = {
'limit': 100,
'entries': [webhook_body],
}
webhooks = mock_client.get_webhooks()
webhook = webhooks.next()
mock_box_session.get.assert_called_once_with(expected_url, params={})
assert isinstance(webhook, Webhook)
assert webhook.object_id == webhook_body['id']
assert webhook.object_type == webhook_body['type']
assert webhook.target['id'] == webhook_body['target']['id']
assert webhook.target['type'] == webhook_body['target']['type']
def test_create_retention_policy(mock_client, mock_box_session, mock_user_list):
policy_name = 'Test Retention Policy'
policy_type = 'finite'
disposition_action = 'remove_retention'
policy_description = 'Test Retention Policy'
expected_url = f'{API.BASE_API_URL}/retention_policies'
expected_data = {
'policy_name': policy_name,
'disposition_action': disposition_action,
'policy_type': 'finite',
'retention_length': 5,
'can_owner_extend_retention': True,
'are_owners_notified': False,
'custom_notification_recipients': [
{
'type': mock_user_list[0].object_type,
'id': mock_user_list[0].object_id,
},
{
'type': mock_user_list[1].object_type,
'id': mock_user_list[1].object_id,
},
],
'retention_type': 'modifiable',
'description': policy_description,
}
mock_policy = {
'type': 'retention_policy',
'id': '1234',
'policy_name': policy_name,
'policy_type': policy_type,
'retention_length': 5,
'disposition_action': disposition_action,
'can_owner_extend_retention': False,
'are_owners_notified': False,
'custom_notification_recipients': [
{
'type': mock_user_list[0].object_type,
'id': mock_user_list[0].object_id,
},
{
'type': mock_user_list[1].object_type,
'id': mock_user_list[1].object_id,
},
],
'retention_type': 'modifiable',
'description': policy_description,
}
mock_box_session.post.return_value.json.return_value = mock_policy
policy = mock_client.create_retention_policy(
policy_name=policy_name,
disposition_action=disposition_action,
retention_length=5,
can_owner_extend_retention=True,
are_owners_notified=False,
custom_notification_recipients=mock_user_list,
retention_type='modifiable',
description=policy_description,
)
mock_box_session.post.assert_called_once_with(expected_url, data=json.dumps(expected_data))
assert policy.object_id == mock_policy['id']
assert policy.object_type == mock_policy['type']
assert policy.policy_name == mock_policy['policy_name']
assert policy.disposition_action == mock_policy['disposition_action']
assert policy.can_owner_extend_retention == mock_policy['can_owner_extend_retention']
assert policy.are_owners_notified == mock_policy['are_owners_notified']
assert policy.retention_type == mock_policy['retention_type']
assert policy.description == mock_policy['description']
assert isinstance(policy, RetentionPolicy)
def test_create_infinte_retention_policy(mock_client, mock_box_session):
policy_name = 'Test Retention Policy'
policy_type = 'indefinite'
disposition_action = 'remove_retention'
policy_description = 'Test Retention Policy'
expected_url = f'{API.BASE_API_URL}/retention_policies'
expected_data = {
'policy_name': policy_name,
'disposition_action': disposition_action,
'policy_type': policy_type,
'can_owner_extend_retention': False,
'are_owners_notified': False,
'retention_type': 'non_modifiable',
'description': policy_description,
}
mock_policy = {
'type': 'retention_policy',
'id': '1234',
'policy_name': policy_name,
'policy_type': policy_type,
'disposition_action': disposition_action,
'can_owner_extend_retention': False,
'are_owners_notified': False,
'retention_type': 'non_modifiable',
'description': policy_description,
}
mock_box_session.post.return_value.json.return_value = mock_policy
policy = mock_client.create_retention_policy(
policy_name=policy_name,
disposition_action=disposition_action,
retention_length=float('inf'),
can_owner_extend_retention=False,
are_owners_notified=False,
retention_type='non_modifiable',
description=policy_description,
)
mock_box_session.post.assert_called_once_with(expected_url, data=json.dumps(expected_data))