mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-25 09:51:42 -05:00
7d92a0869a
In response to: [^1].
The stacktrace conveys the same and more information. We don't do
anything different for each exception class, so there's no value
in having three of them over one exception.
I did think about DRYing-up the duplicate exception behaviour into
the base class one. This isn't ideal because the base class would
be making assumptions about how inheriting classes make requests,
which might change with future providers. Although it might be nice
to have more info in the top-level message, we'll still get it in
the stacktrace e.g.
ValueError: Expected 'code' to be '0'
During handling of the above exception, another exception occurred:
app.clients.sms.SmsClientResponseException: SMS client error (Invalid response JSON)
requests.exceptions.ReadTimeout
During handling of the above exception, another exception occurred:
app.clients.sms.SmsClientResponseException: SMS client error (Request failed)
[^1]: https://github.com/alphagov/notifications-api/pull/3493#discussion_r837363717
160 lines
6.1 KiB
Python
160 lines
6.1 KiB
Python
from urllib.parse import parse_qs
|
|
|
|
import pytest
|
|
import requests_mock
|
|
from requests.exceptions import ConnectTimeout, ReadTimeout
|
|
|
|
from app.clients.sms.firetext import (
|
|
SmsClientResponseException,
|
|
get_firetext_responses,
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize('detailed_status_code, result', [
|
|
(None, ('delivered', None)), ('000', ('delivered', 'No error reported'))
|
|
])
|
|
def test_get_firetext_responses_should_return_correct_details_for_delivery(detailed_status_code, result):
|
|
assert get_firetext_responses('0', detailed_status_code) == result
|
|
|
|
|
|
@pytest.mark.parametrize('detailed_status_code, result', [
|
|
(None, ('permanent-failure', None)), ('401', ('permanent-failure', 'Message Rejected'))
|
|
])
|
|
def test_get_firetext_responses_should_return_correct_details_for_bounced(detailed_status_code, result):
|
|
assert get_firetext_responses('1', detailed_status_code) == result
|
|
|
|
|
|
def test_get_firetext_responses_should_return_correct_details_for_complaint():
|
|
assert get_firetext_responses('2') == ('pending', None)
|
|
|
|
|
|
def test_get_firetext_responses_raises_KeyError_if_unrecognised_status_code():
|
|
with pytest.raises(KeyError) as e:
|
|
get_firetext_responses('99')
|
|
assert '99' in str(e.value)
|
|
|
|
|
|
def test_try_send_sms_successful_returns_firetext_response(mocker, mock_firetext_client):
|
|
to = content = reference = 'foo'
|
|
response_dict = {
|
|
'data': [],
|
|
'description': 'SMS successfully queued',
|
|
'code': 0,
|
|
'responseData': 1
|
|
}
|
|
|
|
with requests_mock.Mocker() as request_mock:
|
|
request_mock.post('https://example.com/firetext', json=response_dict, status_code=200)
|
|
response = mock_firetext_client.try_send_sms(to, content, reference, False, 'sender')
|
|
|
|
response_json = response.json()
|
|
assert response.status_code == 200
|
|
assert response_json['code'] == 0
|
|
assert response_json['description'] == 'SMS successfully queued'
|
|
|
|
|
|
def test_try_send_sms_calls_firetext_correctly(mocker, mock_firetext_client):
|
|
to = '+447234567890'
|
|
content = 'my message'
|
|
reference = 'my reference'
|
|
response_dict = {
|
|
'code': 0,
|
|
}
|
|
|
|
with requests_mock.Mocker() as request_mock:
|
|
request_mock.post('https://example.com/firetext', json=response_dict, status_code=200)
|
|
mock_firetext_client.try_send_sms(to, content, reference, False, 'bar')
|
|
|
|
assert request_mock.call_count == 1
|
|
assert request_mock.request_history[0].url == 'https://example.com/firetext'
|
|
assert request_mock.request_history[0].method == 'POST'
|
|
|
|
request_args = parse_qs(request_mock.request_history[0].text)
|
|
assert request_args['apiKey'][0] == 'foo'
|
|
assert request_args['from'][0] == 'bar'
|
|
assert request_args['to'][0] == '447234567890'
|
|
assert request_args['message'][0] == content
|
|
assert request_args['reference'][0] == reference
|
|
|
|
|
|
def test_try_send_sms_calls_firetext_correctly_for_international(mocker, mock_firetext_client):
|
|
to = '+607234567890'
|
|
content = 'my message'
|
|
reference = 'my reference'
|
|
response_dict = {
|
|
'code': 0,
|
|
}
|
|
|
|
with requests_mock.Mocker() as request_mock:
|
|
request_mock.post('https://example.com/firetext', json=response_dict, status_code=200)
|
|
mock_firetext_client.try_send_sms(to, content, reference, True, 'bar')
|
|
|
|
assert request_mock.call_count == 1
|
|
assert request_mock.request_history[0].url == 'https://example.com/firetext'
|
|
assert request_mock.request_history[0].method == 'POST'
|
|
|
|
request_args = parse_qs(request_mock.request_history[0].text)
|
|
assert request_args['apiKey'][0] == 'international'
|
|
assert request_args['from'][0] == 'bar'
|
|
assert request_args['to'][0] == '607234567890'
|
|
assert request_args['message'][0] == content
|
|
assert request_args['reference'][0] == reference
|
|
|
|
|
|
def test_try_send_sms_raises_if_firetext_rejects(mocker, mock_firetext_client):
|
|
to = content = reference = 'foo'
|
|
response_dict = {
|
|
'data': [],
|
|
'description': 'Some kind of error',
|
|
'code': 1,
|
|
'responseData': ''
|
|
}
|
|
|
|
with pytest.raises(SmsClientResponseException) as exc, requests_mock.Mocker() as request_mock:
|
|
request_mock.post('https://example.com/firetext', json=response_dict, status_code=200)
|
|
mock_firetext_client.try_send_sms(to, content, reference, False, 'sender')
|
|
|
|
assert "Invalid response JSON" in str(exc.value)
|
|
|
|
|
|
def test_try_send_sms_raises_if_firetext_rejects_with_unexpected_data(mocker, mock_firetext_client):
|
|
to = content = reference = 'foo'
|
|
response_dict = {"something": "gone bad"}
|
|
|
|
with pytest.raises(SmsClientResponseException) as exc, requests_mock.Mocker() as request_mock:
|
|
request_mock.post('https://example.com/firetext', json=response_dict, status_code=400)
|
|
mock_firetext_client.try_send_sms(to, content, reference, False, 'sender')
|
|
|
|
assert "Request failed" in str(exc.value)
|
|
|
|
|
|
def test_try_send_sms_raises_if_firetext_fails_to_return_json(notify_api, mock_firetext_client):
|
|
to = content = reference = 'foo'
|
|
response_dict = 'NOT AT ALL VALID JSON {"key" : "value"}}'
|
|
|
|
with pytest.raises(SmsClientResponseException) as exc, requests_mock.Mocker() as request_mock:
|
|
request_mock.post('https://example.com/firetext', text=response_dict, status_code=200)
|
|
mock_firetext_client.try_send_sms(to, content, reference, False, 'sender')
|
|
|
|
assert "Invalid response JSON" in str(exc.value)
|
|
|
|
|
|
def test_try_send_sms_raises_if_firetext_rejects_with_connect_timeout(rmock, mock_firetext_client):
|
|
to = content = reference = 'foo'
|
|
|
|
with pytest.raises(SmsClientResponseException) as exc:
|
|
rmock.register_uri('POST', 'https://example.com/firetext', exc=ConnectTimeout)
|
|
mock_firetext_client.try_send_sms(to, content, reference, False, 'sender')
|
|
|
|
assert "Request failed" in str(exc.value)
|
|
|
|
|
|
def test_try_send_sms_raises_if_firetext_rejects_with_read_timeout(rmock, mock_firetext_client):
|
|
to = content = reference = 'foo'
|
|
|
|
with pytest.raises(SmsClientResponseException) as exc:
|
|
rmock.register_uri('POST', 'https://example.com/firetext', exc=ReadTimeout)
|
|
mock_firetext_client.try_send_sms(to, content, reference, False, 'sender')
|
|
|
|
assert "Request failed" in str(exc.value)
|