mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-11 15:52:21 -05:00
5eebcf6452
At the moment, if a service callback fails, it will get put on the retry queue. This causes a potential problem though: If a service's callback server goes down, we may generate a lot of retries and this may then put a lot of items on the retry queue. The retry queue is also responsible for other important parts of Notify such as retrying message delivery and we don't want a service's callback server going down to have an impact on the rest of Notify. Putting the retries on a different queue means that tasks get processed faster than if they were put back on the same 'service-callbacks' queue.
202 lines
9.0 KiB
Python
202 lines
9.0 KiB
Python
import json
|
|
from datetime import datetime
|
|
|
|
import pytest
|
|
import requests_mock
|
|
from freezegun import freeze_time
|
|
|
|
from app import encryption
|
|
from app.celery.service_callback_tasks import send_delivery_status_to_service, send_complaint_to_service
|
|
from app.utils import DATETIME_FORMAT
|
|
from tests.app.db import (
|
|
create_complaint,
|
|
create_notification,
|
|
create_service_callback_api,
|
|
create_service,
|
|
create_template
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize("notification_type",
|
|
["email", "letter", "sms"])
|
|
def test_send_delivery_status_to_service_post_https_request_to_service_with_encrypted_data(
|
|
notify_db_session, notification_type):
|
|
|
|
callback_api, template = _set_up_test_data(notification_type, "delivery_status")
|
|
datestr = datetime(2017, 6, 20)
|
|
|
|
notification = create_notification(template=template,
|
|
created_at=datestr,
|
|
updated_at=datestr,
|
|
sent_at=datestr,
|
|
status='sent'
|
|
)
|
|
encrypted_status_update = _set_up_data_for_status_update(callback_api, notification)
|
|
with requests_mock.Mocker() as request_mock:
|
|
request_mock.post(callback_api.url,
|
|
json={},
|
|
status_code=200)
|
|
send_delivery_status_to_service(notification.id, encrypted_status_update=encrypted_status_update)
|
|
|
|
mock_data = {
|
|
"id": str(notification.id),
|
|
"reference": notification.client_reference,
|
|
"to": notification.to,
|
|
"status": notification.status,
|
|
"created_at": datestr.strftime(DATETIME_FORMAT),
|
|
"completed_at": datestr.strftime(DATETIME_FORMAT),
|
|
"sent_at": datestr.strftime(DATETIME_FORMAT),
|
|
"notification_type": notification_type
|
|
}
|
|
|
|
assert request_mock.call_count == 1
|
|
assert request_mock.request_history[0].url == callback_api.url
|
|
assert request_mock.request_history[0].method == 'POST'
|
|
assert request_mock.request_history[0].text == json.dumps(mock_data)
|
|
assert request_mock.request_history[0].headers["Content-type"] == "application/json"
|
|
assert request_mock.request_history[0].headers["Authorization"] == "Bearer {}".format(callback_api.bearer_token)
|
|
|
|
|
|
def test_send_complaint_to_service_posts_https_request_to_service_with_encrypted_data(notify_db_session):
|
|
with freeze_time('2001-01-01T12:00:00'):
|
|
callback_api, template = _set_up_test_data('email', "complaint")
|
|
|
|
notification = create_notification(template=template)
|
|
complaint = create_complaint(service=template.service, notification=notification)
|
|
complaint_data = _set_up_data_for_complaint(callback_api, complaint, notification)
|
|
with requests_mock.Mocker() as request_mock:
|
|
request_mock.post(callback_api.url,
|
|
json={},
|
|
status_code=200)
|
|
send_complaint_to_service(complaint_data)
|
|
|
|
mock_data = {
|
|
"notification_id": str(notification.id),
|
|
"complaint_id": str(complaint.id),
|
|
"reference": notification.client_reference,
|
|
"to": notification.to,
|
|
"complaint_date": datetime.utcnow().strftime(
|
|
DATETIME_FORMAT),
|
|
}
|
|
|
|
assert request_mock.call_count == 1
|
|
assert request_mock.request_history[0].url == callback_api.url
|
|
assert request_mock.request_history[0].method == 'POST'
|
|
assert request_mock.request_history[0].text == json.dumps(mock_data)
|
|
assert request_mock.request_history[0].headers["Content-type"] == "application/json"
|
|
assert request_mock.request_history[0].headers["Authorization"] == "Bearer {}".format(callback_api.bearer_token)
|
|
|
|
|
|
@pytest.mark.parametrize("notification_type",
|
|
["email", "letter", "sms"])
|
|
def test__send_data_to_service_callback_api_retries_if_request_returns_500_with_encrypted_data(
|
|
notify_db_session, mocker, notification_type
|
|
):
|
|
callback_api, template = _set_up_test_data(notification_type, "delivery_status")
|
|
datestr = datetime(2017, 6, 20)
|
|
notification = create_notification(template=template,
|
|
created_at=datestr,
|
|
updated_at=datestr,
|
|
sent_at=datestr,
|
|
status='sent'
|
|
)
|
|
encrypted_data = _set_up_data_for_status_update(callback_api, notification)
|
|
mocked = mocker.patch('app.celery.service_callback_tasks.send_delivery_status_to_service.retry')
|
|
with requests_mock.Mocker() as request_mock:
|
|
request_mock.post(callback_api.url,
|
|
json={},
|
|
status_code=500)
|
|
send_delivery_status_to_service(notification.id, encrypted_status_update=encrypted_data)
|
|
|
|
assert mocked.call_count == 1
|
|
assert mocked.call_args[1]['queue'] == 'service-callbacks-retry'
|
|
|
|
|
|
@pytest.mark.parametrize("notification_type",
|
|
["email", "letter", "sms"])
|
|
def test__send_data_to_service_callback_api_does_not_retry_if_request_returns_404_with_encrypted_data(
|
|
notify_db_session,
|
|
mocker,
|
|
notification_type
|
|
):
|
|
callback_api, template = _set_up_test_data(notification_type, "delivery_status")
|
|
datestr = datetime(2017, 6, 20)
|
|
notification = create_notification(template=template,
|
|
created_at=datestr,
|
|
updated_at=datestr,
|
|
sent_at=datestr,
|
|
status='sent'
|
|
)
|
|
encrypted_data = _set_up_data_for_status_update(callback_api, notification)
|
|
mocked = mocker.patch('app.celery.service_callback_tasks.send_delivery_status_to_service.retry')
|
|
with requests_mock.Mocker() as request_mock:
|
|
request_mock.post(callback_api.url,
|
|
json={},
|
|
status_code=404)
|
|
send_delivery_status_to_service(notification.id, encrypted_status_update=encrypted_data)
|
|
|
|
assert mocked.call_count == 0
|
|
|
|
|
|
def test_send_delivery_status_to_service_succeeds_if_sent_at_is_none(
|
|
notify_db_session,
|
|
mocker
|
|
):
|
|
callback_api, template = _set_up_test_data('email', "delivery_status")
|
|
datestr = datetime(2017, 6, 20)
|
|
notification = create_notification(template=template,
|
|
created_at=datestr,
|
|
updated_at=datestr,
|
|
sent_at=None,
|
|
status='technical-failure'
|
|
)
|
|
encrypted_data = _set_up_data_for_status_update(callback_api, notification)
|
|
mocked = mocker.patch('app.celery.service_callback_tasks.send_delivery_status_to_service.retry')
|
|
with requests_mock.Mocker() as request_mock:
|
|
request_mock.post(callback_api.url,
|
|
json={},
|
|
status_code=404)
|
|
send_delivery_status_to_service(notification.id, encrypted_status_update=encrypted_data)
|
|
|
|
assert mocked.call_count == 0
|
|
|
|
|
|
def _set_up_test_data(notification_type, callback_type):
|
|
service = create_service(restricted=True)
|
|
template = create_template(service=service, template_type=notification_type, subject='Hello')
|
|
callback_api = create_service_callback_api(service=service, url="https://some.service.gov.uk/",
|
|
bearer_token="something_unique", callback_type=callback_type)
|
|
return callback_api, template
|
|
|
|
|
|
def _set_up_data_for_status_update(callback_api, notification):
|
|
data = {
|
|
"notification_id": str(notification.id),
|
|
"notification_client_reference": notification.client_reference,
|
|
"notification_to": notification.to,
|
|
"notification_status": notification.status,
|
|
"notification_created_at": notification.created_at.strftime(DATETIME_FORMAT),
|
|
"notification_updated_at": notification.updated_at.strftime(
|
|
DATETIME_FORMAT) if notification.updated_at else None,
|
|
"notification_sent_at": notification.sent_at.strftime(DATETIME_FORMAT) if notification.sent_at else None,
|
|
"notification_type": notification.notification_type,
|
|
"service_callback_api_url": callback_api.url,
|
|
"service_callback_api_bearer_token": callback_api.bearer_token,
|
|
}
|
|
encrypted_status_update = encryption.encrypt(data)
|
|
return encrypted_status_update
|
|
|
|
|
|
def _set_up_data_for_complaint(callback_api, complaint, notification):
|
|
data = {
|
|
"complaint_id": str(complaint.id),
|
|
"notification_id": str(notification.id),
|
|
"reference": notification.client_reference,
|
|
"to": notification.to,
|
|
"complaint_date": complaint.complaint_date.strftime(DATETIME_FORMAT),
|
|
"service_callback_api_url": callback_api.url,
|
|
"service_callback_api_bearer_token": callback_api.bearer_token,
|
|
}
|
|
obscured_status_update = encryption.encrypt(data)
|
|
return obscured_status_update
|