-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathadmin.py
More file actions
485 lines (388 loc) · 20.1 KB
/
admin.py
File metadata and controls
485 lines (388 loc) · 20.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
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
import os
import shutil
from datetime import datetime, timedelta
from uuid import uuid4
import pytest
from fastapi import status
from fastapi.testclient import TestClient
from mesh_sandbox.common import APP_V1_JSON
from mesh_sandbox.tests import _CANNED_MAILBOX1, _CANNED_MAILBOX2
from mesh_sandbox.tests.mesh_api_helpers import (
mesh_api_get_inbox_size,
mesh_api_send_message_and_return_message_id,
mesh_api_track_message_by_message_id,
mesh_api_track_message_by_message_id_status,
)
from ..common.constants import Headers
from ..models.message import MessageStatus, MessageType
from ..views.admin import AddMessageEventRequest, CreateReportRequest
from .helpers import generate_auth_token, temp_env_vars
def test_reset_canned_store_should_return_bad_request(app: TestClient):
with temp_env_vars(STORE_MODE="canned"):
res = app.delete("/messageexchange/admin/reset")
assert res.status_code == status.HTTP_405_METHOD_NOT_ALLOWED
def test_reset_canned_store_with_valid_mailbox_id_should_return_bad_request(app: TestClient):
with temp_env_vars(STORE_MODE="canned"):
res = app.delete(f"/messageexchange/admin/reset/{_CANNED_MAILBOX1}")
assert res.status_code == status.HTTP_405_METHOD_NOT_ALLOWED
def test_reset_memory_store_with_invalid_mailbox_id_should_return_bad_request(app: TestClient):
with temp_env_vars(STORE_MODE="memory"):
res = app.delete(f"/messageexchange/admin/reset/{uuid4().hex}")
assert res.status_code == status.HTTP_404_NOT_FOUND
def test_reset_file_store_with_invalid_mailbox_id_should_return_bad_request(app: TestClient):
with temp_env_vars(STORE_MODE="file"):
res = app.delete(f"/messageexchange/admin/reset/{uuid4().hex}")
assert res.status_code == status.HTTP_404_NOT_FOUND
def test_reset_memory_store_should_clear_all_mailboxes(app: TestClient):
with temp_env_vars(STORE_MODE="memory"):
msg_1to2_id = mesh_api_send_message_and_return_message_id(app, _CANNED_MAILBOX1, _CANNED_MAILBOX2)
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX2) == 1
msg_2to1_id = mesh_api_send_message_and_return_message_id(app, _CANNED_MAILBOX2, _CANNED_MAILBOX1)
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 1
res = app.delete("/messageexchange/admin/reset")
assert res.status_code == status.HTTP_200_OK
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 0
assert (
mesh_api_track_message_by_message_id_status(app, _CANNED_MAILBOX1, msg_2to1_id) == status.HTTP_404_NOT_FOUND
)
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX2) == 0
assert (
mesh_api_track_message_by_message_id_status(app, _CANNED_MAILBOX2, msg_1to2_id) == status.HTTP_404_NOT_FOUND
)
def test_reset_memory_store_should_clear_specified_mailbox_only(app: TestClient):
with temp_env_vars(STORE_MODE="memory"):
msg_1to2_id = mesh_api_send_message_and_return_message_id(app, _CANNED_MAILBOX1, _CANNED_MAILBOX2)
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX2) == 1
res = mesh_api_track_message_by_message_id(app, _CANNED_MAILBOX1, msg_1to2_id)
assert res.json()["messageId"] == msg_1to2_id
msg_2to1_id = mesh_api_send_message_and_return_message_id(app, _CANNED_MAILBOX2, _CANNED_MAILBOX1)
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 1
res = mesh_api_track_message_by_message_id(app, _CANNED_MAILBOX2, msg_2to1_id)
assert res.json()["messageId"] == msg_2to1_id
res = app.get(
f"/messageexchange/{_CANNED_MAILBOX1}/inbox/rich?max_results=10",
headers={Headers.Authorization: generate_auth_token(_CANNED_MAILBOX1), Headers.Accept: APP_V1_JSON},
)
assert res.status_code == status.HTTP_200_OK
response = res.json()
messages = [res["message_id"] for res in response.get("messages", [])]
assert len(messages) == 1
res = app.get(
f"/messageexchange/{_CANNED_MAILBOX2}/inbox/rich?max_results=10",
headers={Headers.Authorization: generate_auth_token(_CANNED_MAILBOX2), Headers.Accept: APP_V1_JSON},
)
assert res.status_code == status.HTTP_200_OK
response = res.json()
messages = [res["message_id"] for res in response.get("messages", [])]
assert len(messages) == 1
# RESET mailbox 2
res = app.delete(f"/messageexchange/admin/reset/{_CANNED_MAILBOX2}")
assert res.status_code == status.HTTP_200_OK
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 1
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX2) == 0
res = app.get(
f"/messageexchange/{_CANNED_MAILBOX1}/inbox/rich?max_results=10",
headers={Headers.Authorization: generate_auth_token(_CANNED_MAILBOX1), Headers.Accept: APP_V1_JSON},
)
assert res.status_code == status.HTTP_200_OK
response = res.json()
mb1_rich_inbox_messages = [res["message_id"] for res in response.get("messages", [])]
assert len(mb1_rich_inbox_messages) == 1
res = app.get(
f"/messageexchange/{_CANNED_MAILBOX2}/inbox/rich?max_results=10",
headers={Headers.Authorization: generate_auth_token(_CANNED_MAILBOX2), Headers.Accept: APP_V1_JSON},
)
assert res.status_code == status.HTTP_200_OK
response = res.json()
mb2_rich_inbox_messages = [res["message_id"] for res in response.get("messages", [])]
assert len(mb2_rich_inbox_messages) == 0
def test_reset_file_store_should_clear_all_mailboxes_and_maybe_files(app: TestClient, tmp_path: str):
with temp_env_vars(STORE_MODE="file", MAILBOXES_DATA_DIR=tmp_path):
msg_1to2_id = mesh_api_send_message_and_return_message_id(app, _CANNED_MAILBOX1, _CANNED_MAILBOX2)
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX2) == 1
msg_2to1_id = mesh_api_send_message_and_return_message_id(app, _CANNED_MAILBOX2, _CANNED_MAILBOX1)
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 1
inbox_folder1 = os.path.join(tmp_path, _CANNED_MAILBOX1, "in")
assert os.path.exists(inbox_folder1)
all_files = os.listdir(inbox_folder1)
messages = [msg for msg in all_files if not msg.endswith(".json")]
assert {msg[:-5] for msg in all_files if msg.endswith(".json")} == set(messages)
assert len(messages) == 1
assert messages[0] == msg_2to1_id
inbox_folder2 = os.path.join(tmp_path, _CANNED_MAILBOX2, "in")
assert os.path.exists(inbox_folder2)
all_files = os.listdir(inbox_folder2)
messages = [msg for msg in all_files if not msg.endswith(".json")]
assert {msg[:-5] for msg in all_files if msg.endswith(".json")} == set(messages)
assert len(messages) == 1
assert messages[0] == msg_1to2_id
shutil.rmtree(inbox_folder1)
shutil.rmtree(inbox_folder2)
res = app.delete("/messageexchange/admin/reset")
assert res.status_code == status.HTTP_200_OK
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 0
assert (
mesh_api_track_message_by_message_id_status(app, _CANNED_MAILBOX1, msg_1to2_id) == status.HTTP_404_NOT_FOUND
)
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX2) == 0
assert (
mesh_api_track_message_by_message_id_status(app, _CANNED_MAILBOX2, msg_2to1_id) == status.HTTP_404_NOT_FOUND
)
def test_reset_file_store_should_clear_specified_mailbox_only_and_maybe_files(app: TestClient, tmp_path: str):
with temp_env_vars(STORE_MODE="file", MAILBOXES_DATA_DIR=tmp_path):
msg_1to2_id = mesh_api_send_message_and_return_message_id(app, _CANNED_MAILBOX1, _CANNED_MAILBOX2)
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX2) == 1
msg_2to1_id = mesh_api_send_message_and_return_message_id(app, _CANNED_MAILBOX2, _CANNED_MAILBOX1)
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 1
inbox_folder1 = os.path.join(tmp_path, _CANNED_MAILBOX1, "in")
assert os.path.exists(inbox_folder1)
all_files = os.listdir(inbox_folder1)
messages = [msg for msg in all_files if not msg.endswith(".json")]
assert {msg[:-5] for msg in all_files if msg.endswith(".json")} == set(messages)
assert len(messages) == 1
assert messages[0] == msg_2to1_id
inbox_folder2 = os.path.join(tmp_path, _CANNED_MAILBOX2, "in")
assert os.path.exists(inbox_folder2)
all_files = os.listdir(inbox_folder2)
messages = [msg for msg in all_files if not msg.endswith(".json")]
assert {msg[:-5] for msg in all_files if msg.endswith(".json")} == set(messages)
assert len(messages) == 1
assert messages[0] == msg_1to2_id
res = app.delete(f"/messageexchange/admin/reset/{_CANNED_MAILBOX2}")
assert res.status_code == status.HTTP_200_OK
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX1) == 1
assert mesh_api_get_inbox_size(app, _CANNED_MAILBOX2) == 0
assert os.path.exists(inbox_folder1)
assert os.path.exists(inbox_folder2)
@pytest.mark.parametrize("clear_disk", ["tRue", "faLse", None])
def test_reset_file_store_should_not_error_if_folder_does_not_exist_yet(
app: TestClient, clear_disk: str, tmp_path: str
):
with temp_env_vars(STORE_MODE="file", MAILBOXES_DATA_DIR=tmp_path):
inbox_folder = os.path.join(tmp_path, _CANNED_MAILBOX1, "in")
assert not os.path.exists(inbox_folder)
clear_disk_param = "" if clear_disk is None else f"?clear_disk={clear_disk}"
res = app.delete(f"/messageexchange/admin/reset/{_CANNED_MAILBOX2}{clear_disk_param}")
assert res.status_code == status.HTTP_200_OK
def test_put_report_in_inbox(app: TestClient, tmp_path: str):
recipient = _CANNED_MAILBOX1
with temp_env_vars(STORE_MODE="file", MAILBOXES_DATA_DIR=tmp_path):
request = CreateReportRequest(
mailbox_id=recipient,
status=MessageStatus.ERROR,
workflow_id=uuid4().hex,
code="21",
description="my error",
subject=f"my subject {uuid4().hex}",
local_id=f"my local id {uuid4().hex}",
file_name=f"my filename {uuid4().hex}",
linked_message_id=uuid4().hex,
)
res = app.post("/messageexchange/admin/report", json=request.dict())
assert res.status_code == status.HTTP_200_OK
result = res.json()
assert result
message_id = result["message_id"]
assert message_id
res = app.get(
f"/messageexchange/{recipient}/inbox",
headers={Headers.Authorization: generate_auth_token(recipient)},
)
messages = res.json().get("messages", [])
assert messages
assert messages[0] == message_id
res = app.get(
f"/messageexchange/{recipient}/inbox/{message_id}",
headers={Headers.Authorization: generate_auth_token(recipient)},
)
assert res.status_code == status.HTTP_200_OK
assert res.text == ""
assert res.headers.get(Headers.Mex_To) == recipient
assert res.headers.get(Headers.Mex_WorkflowID) == request.workflow_id
assert res.headers.get(Headers.Mex_MessageType) == MessageType.REPORT
assert res.headers.get(Headers.Mex_StatusCode) == request.code
assert res.headers.get(Headers.Mex_StatusDescription) == request.description
assert res.headers.get(Headers.Mex_FileName) == request.file_name
assert res.headers.get(Headers.Mex_LinkedMsgId) == request.linked_message_id
assert res.headers.get(Headers.Mex_LocalID) == request.local_id
assert res.headers.get(Headers.Mex_StatusSuccess) == "ERROR"
assert res.headers.get(Headers.Content_Length) == "0"
res = app.put(
f"/messageexchange/{recipient}/inbox/{message_id}/status/acknowledged",
headers={Headers.Authorization: generate_auth_token(recipient)},
)
assert res.status_code == status.HTTP_200_OK
res = app.get(
f"/messageexchange/{recipient}/inbox",
headers={Headers.Authorization: generate_auth_token(recipient)},
)
messages = res.json().get("messages", [])
assert not messages
def test_add_message_event(app: TestClient, tmp_path: str):
recipient = _CANNED_MAILBOX1
with temp_env_vars(STORE_MODE="file", MAILBOXES_DATA_DIR=tmp_path):
create_report_request = CreateReportRequest(
mailbox_id=recipient,
status=MessageStatus.ERROR,
workflow_id=uuid4().hex,
code="21",
description="my error",
subject=f"my subject {uuid4().hex}",
local_id=f"my local id {uuid4().hex}",
file_name=f"my filename {uuid4().hex}",
linked_message_id=uuid4().hex,
)
res = app.post("/messageexchange/admin/report", json=create_report_request.dict())
assert res.status_code == status.HTTP_200_OK
result = res.json()
assert result
message_id = result["message_id"]
assert message_id
res = app.get(
f"/messageexchange/{recipient}/inbox",
headers={Headers.Authorization: generate_auth_token(recipient)},
)
messages = res.json().get("messages", [])
assert messages
assert messages[0] == message_id
res = app.put(
f"/messageexchange/{recipient}/inbox/{message_id}/status/acknowledged",
headers={Headers.Authorization: generate_auth_token(recipient)},
)
assert res.status_code == status.HTTP_200_OK
res = app.get(
f"/messageexchange/{recipient}/inbox",
headers={Headers.Authorization: generate_auth_token(recipient)},
)
messages = res.json().get("messages", [])
assert not messages
# move the message to accepted again
add_event_request = AddMessageEventRequest(status=MessageStatus.ACCEPTED)
res = app.post(f"/messageexchange/admin/message/{message_id}/event", json=add_event_request.dict())
assert res.status_code == status.HTTP_200_OK
res = app.get(
f"/messageexchange/{recipient}/inbox",
headers={Headers.Authorization: generate_auth_token(recipient)},
)
messages = res.json().get("messages", [])
assert messages == [message_id]
@pytest.mark.parametrize("root_path", ["/admin/mailbox", "/messageexchange/admin/mailbox", "/messageexchange/mailbox"])
def test_get_mailbox_invalid_mailbox_returns_404(app: TestClient, root_path: str):
with temp_env_vars(STORE_MODE="canned"):
res = app.get(f"{root_path}/NotAMailboxId")
assert res.status_code == status.HTTP_404_NOT_FOUND
@pytest.mark.parametrize("root_path", ["/admin/mailbox", "/messageexchange/admin/mailbox", "/messageexchange/mailbox"])
def test_get_mailbox_happy_path(app: TestClient, root_path: str):
with temp_env_vars(STORE_MODE="canned"):
res = app.get(f"{root_path}/{_CANNED_MAILBOX1}")
assert res.status_code == status.HTTP_200_OK
get_mailbox = res.json()
assert len(get_mailbox) == 7
assert get_mailbox["mailbox_id"] == _CANNED_MAILBOX1
assert get_mailbox["mailbox_name"] == "TESTMB1"
assert get_mailbox["billing_entity"] == "England"
assert get_mailbox["ods_code"] == "X26"
assert get_mailbox["org_code"] == "X26"
assert get_mailbox["org_name"] == ""
assert get_mailbox["active"] is True
@pytest.mark.parametrize("root_path", ["/admin/message", "/messageexchange/admin/message"])
def test_get_message(app: TestClient, root_path: str):
message_data = b"Hello World123!"
msg_id = mesh_api_send_message_and_return_message_id(
app, _CANNED_MAILBOX1, _CANNED_MAILBOX2, file_name="helloworld.dat", message_data=message_data
)
res = app.get(f"{root_path}/{msg_id}")
assert res.status_code == status.HTTP_200_OK
message = res.json()
upload_date = datetime.now()
expiry_date = upload_date + timedelta(days=5)
assert message["checksum"] == ""
assert message["chunk_count"] == 1
assert message["content_encoding"] == ""
assert message["expiry_time"].startswith(expiry_date.strftime("%Y-%m-%d"))
assert message["filename"] == "helloworld.dat"
assert message["file_size"] == 15
assert not message["is_compressed"]
assert not message["is_encrypted"]
assert message["local_id"] == ""
assert message["message_id"] == msg_id
assert message["message_type"] == "Data"
assert message["recipient"] == _CANNED_MAILBOX2
assert message["recipient_ods_code"] == "X26"
assert message["recipient_org_code"] == "X26"
assert message["sender"] == _CANNED_MAILBOX1
assert message["sender_ods_code"] == "X26"
assert message["sender_org_code"] == "X26"
assert message["status"] == "Accepted"
assert message["status_success"] == "SUCCESS"
assert message["subject"] == ""
assert message["upload_timestamp"].startswith(upload_date.strftime("%Y-%m-%d"))
assert message["workflow_id"] == "TEST_WORKFLOW"
@pytest.mark.parametrize("root_path", ["/admin/message", "/messageexchange/admin/message"])
def test_get_message_report_type(app: TestClient, root_path: str):
expected_response = {
"status": MessageStatus.ERROR,
"workflow_id": uuid4().hex,
"code": "21",
"description": "my error",
"subject": f"my subject {uuid4().hex}",
"local_id": f"my local id {uuid4().hex}",
"file_name": f"my filename {uuid4().hex}",
"linked_message_id": uuid4().hex,
}
request = CreateReportRequest(
mailbox_id=_CANNED_MAILBOX1,
status=expected_response["status"],
workflow_id=expected_response["workflow_id"],
code=expected_response["code"],
description=expected_response["description"],
subject=expected_response["subject"],
local_id=expected_response["local_id"],
file_name=expected_response["file_name"],
linked_message_id=expected_response["linked_message_id"],
)
res = app.post("/messageexchange/admin/report", json=request.dict())
assert res.status_code == status.HTTP_200_OK
msg_id = res.json()["message_id"]
res = app.get(f"{root_path}/{msg_id}")
message = res.json()
assert message["message_id"] == msg_id
assert message["linked_msg_id"] == expected_response["linked_message_id"]
assert message["message_type"] == "Report"
assert message["recipient"] == _CANNED_MAILBOX1
assert message["status_code"] == expected_response["code"]
assert message["status_success"] == "ERROR"
@pytest.mark.parametrize("root_path", ["/admin/message", "/messageexchange/admin/message", "/messageexchange/message"])
def test_get_message_not_found(app: TestClient, root_path: str):
res = app.get(f"{root_path}/notfound")
assert res.status_code == status.HTTP_404_NOT_FOUND
@pytest.mark.parametrize("root_path", ["/messageexchange/admin/message"])
def test_generate_ndr(app: TestClient, root_path: str):
expected_response = {
"status": MessageStatus.UNDELIVERABLE,
"workflow_id": uuid4().hex,
"code": "21",
"description": "non delivery reason",
"subject": f"my subject {uuid4().hex}",
"local_id": f"my local id {uuid4().hex}",
"file_name": f"my filename {uuid4().hex}",
"linked_message_id": uuid4().hex,
}
request = CreateReportRequest(
mailbox_id=_CANNED_MAILBOX1,
code=expected_response["code"],
description=expected_response["description"],
workflow_id=expected_response["workflow_id"],
subject=expected_response["subject"],
local_id=expected_response["local_id"],
status=expected_response["status"],
file_name=expected_response["file_name"],
linked_message_id=expected_response["linked_message_id"],
)
res = app.post("/messageexchange/admin/report", json=request.model_dump())
assert res.status_code == status.HTTP_200_OK
msg_id = res.json()["message_id"]
res = app.get(f"{root_path}/{msg_id}")
non_delivery_report = res.json()
assert non_delivery_report["status"] == "Accepted"
assert non_delivery_report["status_description"] == "Message not collected by recipient after 5 days"