-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathtest_manage_permissions.py
More file actions
464 lines (327 loc) · 14.1 KB
/
test_manage_permissions.py
File metadata and controls
464 lines (327 loc) · 14.1 KB
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
import json
from unittest.mock import MagicMock, patch
import pytest
from manage_permissions import (
add_perm,
clear_perms,
list_apps,
list_orgs,
remove_perm,
show_perms,
)
from nrlf.core.constants import AccessControls, PointerTypes
MODULE = "manage_permissions"
APP_ID = "test-app-001"
ORG_ODS = "X26"
BUCKET = "nhsd-nrlf--dev-authorization-store"
SAMPLE_POINTER_TYPES = [
PointerTypes.MENTAL_HEALTH_PLAN.value,
PointerTypes.ADVANCE_CARE_PLAN.value,
]
SAMPLE_ACCESS_CONTROLS = [
AccessControls.ALLOW_ALL_TYPES.value,
AccessControls.ALLOW_OVERRIDE_CREATION_DATETIME.value,
]
_NoSuchKey = type("NoSuchKey", (Exception,), {})
def _make_s3_mock(
body: bytes | None = None, raise_no_such_key: bool = False
) -> MagicMock:
s3 = MagicMock()
s3.exceptions.NoSuchKey = _NoSuchKey
if raise_no_such_key:
s3.get_object.side_effect = _NoSuchKey("key not found")
elif body is not None:
import io
s3.get_object.return_value = {"Body": io.BytesIO(body)}
return s3
def _make_paginator(pages: list[dict]) -> MagicMock:
paginator = MagicMock()
paginator.paginate.return_value = pages
return paginator
# ---------------------------------------------------------------------------
# show_perms
# ---------------------------------------------------------------------------
@patch(f"{MODULE}._get_s3_client")
def test_show_perms_prints_all_permissions(mock_get_s3, capsys):
existing_perms = {
"types": SAMPLE_POINTER_TYPES,
"access_controls": SAMPLE_ACCESS_CONTROLS,
}
mock_get_s3.return_value = _make_s3_mock(body=json.dumps(existing_perms).encode())
show_perms("consumer", APP_ID, ORG_ODS)
output = capsys.readouterr().out
for pointer_type in SAMPLE_POINTER_TYPES:
assert pointer_type in output
for control in SAMPLE_ACCESS_CONTROLS:
assert control in output
@patch(f"{MODULE}._get_s3_client")
def test_show_perms_prints_no_file_message_when_missing(mock_get_s3, capsys):
s3 = _make_s3_mock(raise_no_such_key=True)
mock_get_s3.return_value = s3
show_perms("consumer", APP_ID, ORG_ODS)
assert "No permissions file found" in capsys.readouterr().out
@patch(f"{MODULE}._get_s3_client")
def test_show_perms_prints_no_perms_message_when_empty_json(mock_get_s3, capsys):
perms = {}
s3 = _make_s3_mock(body=json.dumps(perms).encode())
mock_get_s3.return_value = s3
show_perms("producer", APP_ID, ORG_ODS)
assert "No permissions found" in capsys.readouterr().out
# ---------------------------------------------------------------------------
# add_perm
# ---------------------------------------------------------------------------
@patch(f"{MODULE}._get_s3_client")
def test_add_perm_adds_new_type(mock_get_s3):
existing_perms = {"types": [SAMPLE_POINTER_TYPES[0]]}
s3 = _make_s3_mock(body=json.dumps(existing_perms).encode())
mock_get_s3.return_value = s3
add_perm("types", "producer", APP_ID, None, SAMPLE_POINTER_TYPES[1])
s3.put_object.assert_called_once_with(
Bucket=BUCKET,
Key=f"producer/{APP_ID}.json",
Body=json.dumps({"types": SAMPLE_POINTER_TYPES}, indent=4),
ContentType="application/json",
)
@patch(f"{MODULE}._get_s3_client")
def test_add_perm_all_keyword_adds_all_types(mock_get_s3):
existing_perms = {}
s3 = _make_s3_mock(body=json.dumps(existing_perms).encode())
mock_get_s3.return_value = s3
add_perm("types", "consumer", APP_ID, ORG_ODS, "all")
s3.put_object.assert_called_once_with(
Bucket=BUCKET,
Key=f"consumer/{APP_ID}/{ORG_ODS}.json",
Body=json.dumps({"types": PointerTypes.list()}, indent=4),
ContentType="application/json",
)
@patch(f"{MODULE}._get_s3_client")
@patch(f"{MODULE}.COMPARE_AND_CONFIRM", True)
@patch("builtins.input", return_value="yes")
def test_add_perm_adds_access_control(mock_input, mock_get_s3):
existing_perms = {}
s3 = _make_s3_mock(body=json.dumps(existing_perms).encode())
mock_get_s3.return_value = s3
add_perm(
"access_controls",
"producer",
APP_ID,
None,
AccessControls.ALLOW_ALL_TYPES.value,
)
s3.put_object.assert_called_once_with(
Bucket=BUCKET,
Key=f"producer/{APP_ID}.json",
Body=json.dumps(
{"access_controls": [AccessControls.ALLOW_ALL_TYPES.value]}, indent=4
),
ContentType="application/json",
)
@patch(f"{MODULE}._get_s3_client")
def test_add_perm_rejects_already_assigned_items(mock_get_s3, capsys):
existing_perms = {"types": SAMPLE_POINTER_TYPES}
mock_get_s3.return_value = _make_s3_mock(body=json.dumps(existing_perms).encode())
add_perm("types", "consumer", APP_ID, None, SAMPLE_POINTER_TYPES[0])
assert "already assigned" in capsys.readouterr().out
@patch(f"{MODULE}._get_s3_client")
@patch(f"{MODULE}.COMPARE_AND_CONFIRM", True)
@patch("builtins.input", return_value="no")
def test_add_perm_cancelled_by_user_does_not_save(mock_input, mock_get_s3):
existing_perms = {}
s3 = _make_s3_mock(body=json.dumps(existing_perms).encode())
mock_get_s3.return_value = s3
add_perm("types", "consumer", APP_ID, None, SAMPLE_POINTER_TYPES[0])
s3.put_object.assert_not_called()
def test_add_perm_rejects_invalid_permission_key(capsys):
add_perm("invalid_key", "consumer", APP_ID, None, SAMPLE_POINTER_TYPES[0])
assert "invalid permission" in capsys.readouterr().out.lower()
def test_add_perm_rejects_no_items(capsys):
add_perm("types", "producer", APP_ID, ORG_ODS)
assert "no pointer types provided" in capsys.readouterr().out
def test_add_perm_rejects_unknown_items(capsys):
add_perm("types", "consumer", APP_ID, None, "http://unknown.example.com|999")
assert "Unknown pointer types provided" in capsys.readouterr().out
# ---------------------------------------------------------------------------
# remove_perm
# ---------------------------------------------------------------------------
@patch(f"{MODULE}._get_s3_client")
def test_remove_perm_removes_type(mock_get_s3):
existing_perms = {"types": SAMPLE_POINTER_TYPES}
s3 = _make_s3_mock(body=json.dumps(existing_perms).encode())
mock_get_s3.return_value = s3
type_to_remove = SAMPLE_POINTER_TYPES[0]
remove_perm("types", "consumer", APP_ID, ORG_ODS, type_to_remove)
saved_perms = s3.put_object.call_args[1]["Body"]
assert type_to_remove not in saved_perms
assert SAMPLE_POINTER_TYPES[1] in saved_perms
@patch(f"{MODULE}._get_s3_client")
def test_remove_perm_removes_access_control(mock_get_s3):
existing_perms = {"access_controls": SAMPLE_ACCESS_CONTROLS}
s3 = _make_s3_mock(body=json.dumps(existing_perms).encode())
mock_get_s3.return_value = s3
control_to_remove = SAMPLE_ACCESS_CONTROLS[0]
remove_perm("access_controls", "producer", APP_ID, None, control_to_remove)
saved_perms = s3.put_object.call_args[1]["Body"]
assert control_to_remove not in saved_perms
assert SAMPLE_ACCESS_CONTROLS[1] in saved_perms
@patch(f"{MODULE}._get_s3_client")
def test_remove_perm_skips_update_if_all_items_not_currently_assigned(
mock_get_s3, capsys
):
existing_perms = {"types": [SAMPLE_POINTER_TYPES[0]]}
mock_get_s3.return_value = _make_s3_mock(body=json.dumps(existing_perms).encode())
remove_perm("types", "consumer", APP_ID, None, SAMPLE_POINTER_TYPES[1])
assert (
"Skipping: None of the requested pointer types are assigned"
in capsys.readouterr().out
)
mock_get_s3.put_object.assert_not_called()
@patch(f"{MODULE}._get_s3_client")
def test_remove_perm_skips_items_not_currently_assigned(mock_get_s3, capsys):
existing_perms = {"access_controls": [SAMPLE_ACCESS_CONTROLS[0]]}
s3 = _make_s3_mock(body=json.dumps(existing_perms).encode())
mock_get_s3.return_value = s3
remove_perm(
"access_controls",
"producer",
APP_ID,
ORG_ODS,
SAMPLE_ACCESS_CONTROLS[0],
SAMPLE_ACCESS_CONTROLS[1],
)
assert "Skipping access controls not already assigned" in capsys.readouterr().out
s3.put_object.assert_called_once_with(
Bucket=BUCKET,
Key=f"producer/{APP_ID}/{ORG_ODS}.json",
Body=json.dumps({"access_controls": []}, indent=4),
ContentType="application/json",
)
@patch(f"{MODULE}._get_s3_client")
def test_remove_perm_returns_early_if_no_perms_file(mock_get_s3, capsys):
mock_get_s3.return_value = _make_s3_mock(raise_no_such_key=True)
remove_perm("types", "consumer", APP_ID, ORG_ODS, SAMPLE_POINTER_TYPES[0])
assert "does not exist" in capsys.readouterr().out
@patch(f"{MODULE}._get_s3_client")
@patch(f"{MODULE}.COMPARE_AND_CONFIRM", True)
@patch("builtins.input", return_value="no")
def test_remove_perm_cancelled_by_user_does_not_save(mock_input, mock_get_s3):
existing_perms = {"types": SAMPLE_POINTER_TYPES}
s3 = _make_s3_mock(body=json.dumps(existing_perms).encode())
mock_get_s3.return_value = s3
remove_perm("types", "consumer", APP_ID, None, SAMPLE_POINTER_TYPES[0])
mock_get_s3.put_object.assert_not_called()
def test_remove_perm_rejects_invalid_permission_key(capsys):
remove_perm("invalid_key", "consumer", APP_ID, None, SAMPLE_POINTER_TYPES[0])
assert "invalid permission" in capsys.readouterr().out.lower()
def test_remove_perm_rejects_no_items(capsys):
remove_perm("types", "producer", APP_ID)
assert "No pointer types provided" in capsys.readouterr().out
def test_remove_perm_rejects_unknown_items(capsys):
remove_perm("types", "consumer", APP_ID, ORG_ODS, "http://unknown.example.com|999")
assert "Unknown pointer types provided" in capsys.readouterr().out
# ---------------------------------------------------------------------------
# clear_perms
# ---------------------------------------------------------------------------
@patch(f"{MODULE}._get_s3_client")
def test_clear_perms_saves_empty_dict(mock_get_s3):
existing_perms = {
"types": SAMPLE_POINTER_TYPES,
"access_controls": SAMPLE_ACCESS_CONTROLS,
}
s3 = _make_s3_mock(body=json.dumps(existing_perms).encode())
mock_get_s3.return_value = s3
clear_perms("consumer", APP_ID)
saved_perms = s3.put_object.call_args[1]["Body"]
assert saved_perms == "{}"
@patch(f"{MODULE}._get_s3_client")
@patch(f"{MODULE}.COMPARE_AND_CONFIRM", True)
@patch("builtins.input", return_value="no")
def test_clear_perms_cancelled_by_user_does_not_save(mock_input, mock_get_s3):
existing_perms = {"types": SAMPLE_POINTER_TYPES}
s3 = _make_s3_mock(body=json.dumps(existing_perms).encode())
mock_get_s3.return_value = s3
clear_perms("consumer", APP_ID)
s3.put_object.assert_not_called()
@patch(f"{MODULE}._get_s3_client")
def test_clear_perms_skips_when_no_perms_exist(mock_get_s3, capsys):
mock_get_s3.return_value = _make_s3_mock(raise_no_such_key=True)
clear_perms("consumer", APP_ID)
assert "no permissions" in capsys.readouterr().out.lower()
@patch(f"{MODULE}._get_s3_client")
def test_clear_perms_skips_when_perms_is_empty_json(mock_get_s3, capsys):
mock_get_s3.return_value = _make_s3_mock(body=json.dumps({}).encode())
clear_perms("producer", APP_ID, ORG_ODS)
assert "no permissions" in capsys.readouterr().out.lower()
# ---------------------------------------------------------------------------
# list_apps
# ---------------------------------------------------------------------------
@patch(f"{MODULE}._get_s3_client")
def test_list_apps_groups_app_level_and_org_level(mock_get_s3, capsys):
s3 = MagicMock()
mock_get_s3.return_value = s3
# Simulate: first key is the folder itself, then org-level and app-level perms
s3.get_paginator.return_value = _make_paginator(
[
{
"Contents": [
{"Key": "consumer/"},
{"Key": "consumer/app-with-org-perms/"},
{"Key": "consumer/app-with-only-app-perms.json"},
]
},
]
)
list_apps("consumer")
output = capsys.readouterr().out
assert "org-level permissions:\n- app-with-org-perms" in output
assert "app-level permissions:\n- app-with-only-app-perms" in output
@patch(f"{MODULE}._get_s3_client")
def test_list_apps_no_apps_found(mock_get_s3, capsys):
s3 = MagicMock()
mock_get_s3.return_value = s3
s3.get_paginator.return_value = _make_paginator([{}])
list_apps("consumer")
output = capsys.readouterr().out
assert "No applications found" in output
@patch(f"{MODULE}._get_s3_client")
def test_list_apps_invalid_supplier_type_prints_error(mock_get_s3, capsys):
list_apps("invalid")
mock_get_s3.assert_not_called()
assert "invalid supplier" in capsys.readouterr().out
# ---------------------------------------------------------------------------
# list_orgs
# ---------------------------------------------------------------------------
@patch(f"{MODULE}._get_s3_client")
def test_list_orgs_invalid_supplier_prints_error(mock_get_s3, capsys):
list_orgs("invalid", APP_ID)
mock_get_s3.assert_not_called()
assert "invalid supplier" in capsys.readouterr().out
@patch(f"{MODULE}._get_s3_client")
def test_list_orgs_no_orgs_found(mock_get_s3, capsys):
s3 = MagicMock()
mock_get_s3.return_value = s3
s3.get_paginator.return_value = _make_paginator([{}])
list_orgs("producer", APP_ID)
assert "No organizations found" in capsys.readouterr().out
@patch(f"{MODULE}._get_s3_client")
def test_list_orgs_lists_org_codes(mock_get_s3, capsys):
s3 = MagicMock()
mock_get_s3.return_value = s3
# Simulate: first key is the folder itself, then org-level and app-level perms
s3.get_paginator.return_value = _make_paginator(
[
{
"Contents": [
{"Key": "producer/"},
{
"Key": f"producer/{APP_ID}/X26.json",
},
{
"Key": f"producer/{APP_ID}/Y27.json",
},
]
},
]
)
list_orgs("producer", APP_ID)
output = capsys.readouterr().out
assert "There are 2 organizations for app test-app-001:\n- X26\n- Y27" in output