darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-01 07:35:34 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into notify-300b

Browse Source
This commit is contained in:
stvnrlly
2023-08-31 10:28:44 -04:00
parent 48ce584773 85de5bfc63
commit bf33ed7173
706 changed files with 40498 additions and 30898 deletions
Download Patch File Download Diff File Expand all files Collapse all files

342
tests/app/notifications/test_process_notification.py
View File

@@ -30,51 +30,64 @@ def test_create_content_for_notification_passes(sample_email_template):
sample_email_template.id, sample_email_template.service_id
)
content = create_content_for_notification(template, None)
assert str(content) == template.content + '\n'
assert str(content) == template.content + "\n"
def test_create_content_for_notification_with_placeholders_passes(sample_template_with_placeholders):
def test_create_content_for_notification_with_placeholders_passes(
sample_template_with_placeholders,
):
template = SerialisedTemplate.from_id_and_service_id(
sample_template_with_placeholders.id, sample_template_with_placeholders.service_id
sample_template_with_placeholders.id,
sample_template_with_placeholders.service_id,
)
content = create_content_for_notification(template, {'name': 'Bobby'})
content = create_content_for_notification(template, {"name": "Bobby"})
assert content.content == template.content
assert 'Bobby' in str(content)
assert "Bobby" in str(content)
def test_create_content_for_notification_fails_with_missing_personalisation(sample_template_with_placeholders):
def test_create_content_for_notification_fails_with_missing_personalisation(
sample_template_with_placeholders,
):
template = SerialisedTemplate.from_id_and_service_id(
sample_template_with_placeholders.id, sample_template_with_placeholders.service_id
sample_template_with_placeholders.id,
sample_template_with_placeholders.service_id,
)
with pytest.raises(BadRequestError):
create_content_for_notification(template, None)
def test_create_content_for_notification_allows_additional_personalisation(sample_template_with_placeholders):
def test_create_content_for_notification_allows_additional_personalisation(
sample_template_with_placeholders,
):
template = SerialisedTemplate.from_id_and_service_id(
sample_template_with_placeholders.id, sample_template_with_placeholders.service_id
sample_template_with_placeholders.id,
sample_template_with_placeholders.service_id,
)
create_content_for_notification(
template, {"name": "Bobby", "Additional placeholder": "Data"}
)
create_content_for_notification(template, {'name': 'Bobby', 'Additional placeholder': 'Data'})
@freeze_time("2016-01-01 11:09:00.061258")
def test_persist_notification_creates_and_save_to_db(sample_template, sample_api_key, sample_job):
def test_persist_notification_creates_and_save_to_db(
sample_template, sample_api_key, sample_job
):
assert Notification.query.count() == 0
assert NotificationHistory.query.count() == 0
notification = persist_notification(
template_id=sample_template.id,
template_version=sample_template.version,
recipient='+447111111111',
recipient="+447111111111",
service=sample_template.service,
personalisation={},
notification_type='sms',
notification_type="sms",
api_key_id=sample_api_key.id,
key_type=sample_api_key.key_type,
job_id=sample_job.id,
job_row_number=100,
reference="ref",
reply_to_text=sample_template.service.get_default_sms_sender())
reply_to_text=sample_template.service.get_default_sms_sender(),
)
assert Notification.query.get(notification.id) is not None
@@ -95,21 +108,26 @@ def test_persist_notification_creates_and_save_to_db(sample_template, sample_api
assert notification_from_db.reference == notification.reference
assert notification_from_db.client_reference == notification.client_reference
assert notification_from_db.created_by_id == notification.created_by_id
assert notification_from_db.reply_to_text == sample_template.service.get_default_sms_sender()
assert (
notification_from_db.reply_to_text
== sample_template.service.get_default_sms_sender()
)
def test_persist_notification_throws_exception_when_missing_template(sample_api_key):
assert Notification.query.count() == 0
assert NotificationHistory.query.count() == 0
with pytest.raises(SQLAlchemyError):
persist_notification(template_id=None,
template_version=None,
recipient='+447111111111',
service=sample_api_key.service,
personalisation=None,
notification_type='sms',
api_key_id=sample_api_key.id,
key_type=sample_api_key.key_type)
persist_notification(
template_id=None,
template_version=None,
recipient="+447111111111",
service=sample_api_key.service,
personalisation=None,
notification_type="sms",
api_key_id=sample_api_key.id,
key_type=sample_api_key.key_type,
)
assert Notification.query.count() == 0
assert NotificationHistory.query.count() == 0
@@ -123,10 +141,10 @@ def test_persist_notification_with_optionals(sample_job, sample_api_key):
persist_notification(
template_id=sample_job.template.id,
template_version=sample_job.template.version,
recipient='+12028675309',
recipient="+12028675309",
service=sample_job.service,
personalisation=None,
notification_type='sms',
notification_type="sms",
api_key_id=sample_api_key.id,
key_type=sample_api_key.key_type,
created_at=created_at,
@@ -134,7 +152,7 @@ def test_persist_notification_with_optionals(sample_job, sample_api_key):
job_row_number=10,
client_reference="ref from client",
notification_id=n_id,
created_by_id=sample_job.created_by_id
created_by_id=sample_job.created_by_id,
)
assert Notification.query.count() == 1
assert NotificationHistory.query.count() == 0
@@ -147,43 +165,47 @@ def test_persist_notification_with_optionals(sample_job, sample_api_key):
assert persisted_notification.client_reference == "ref from client"
assert persisted_notification.reference is None
assert persisted_notification.international is False
assert persisted_notification.phone_prefix == '1'
assert persisted_notification.phone_prefix == "1"
assert persisted_notification.rate_multiplier == 1
assert persisted_notification.created_by_id == sample_job.created_by_id
assert not persisted_notification.reply_to_text
def test_persist_notification_cache_is_not_incremented_on_failure_to_create_notification(
notify_api, sample_api_key, mocker
notify_api, sample_api_key, mocker
):
mocked_redis = mocker.patch('app.redis_store.incr')
mocked_redis = mocker.patch("app.redis_store.incr")
with pytest.raises(SQLAlchemyError):
persist_notification(template_id=None,
template_version=None,
recipient='+447111111111',
service=sample_api_key.service,
personalisation=None,
notification_type='sms',
api_key_id=sample_api_key.id,
key_type=sample_api_key.key_type)
persist_notification(
template_id=None,
template_version=None,
recipient="+447111111111",
service=sample_api_key.service,
personalisation=None,
notification_type="sms",
api_key_id=sample_api_key.id,
key_type=sample_api_key.key_type,
)
mocked_redis.assert_not_called()
def test_persist_notification_does_not_increment_cache_if_test_key(
notify_api, sample_template, sample_job, mocker, sample_test_api_key
notify_api, sample_template, sample_job, mocker, sample_test_api_key
):
daily_limit_cache = mocker.patch('app.notifications.process_notifications.redis_store.incr')
daily_limit_cache = mocker.patch(
"app.notifications.process_notifications.redis_store.incr"
)
assert Notification.query.count() == 0
assert NotificationHistory.query.count() == 0
with set_config(notify_api, 'REDIS_ENABLED', True):
with set_config(notify_api, "REDIS_ENABLED", True):
persist_notification(
template_id=sample_template.id,
template_version=sample_template.version,
recipient='+447111111111',
recipient="+447111111111",
service=sample_template.service,
personalisation={},
notification_type='sms',
notification_type="sms",
api_key_id=sample_test_api_key.id,
key_type=sample_test_api_key.key_type,
job_id=sample_job.id,
@@ -196,85 +218,100 @@ def test_persist_notification_does_not_increment_cache_if_test_key(
assert not daily_limit_cache.called
@pytest.mark.parametrize('restricted_service', [True, False])
@pytest.mark.parametrize("restricted_service", [True, False])
@freeze_time("2016-01-01 11:09:00.061258")
def test_persist_notification_increments_cache_for_trial_or_live_service(
notify_api, notify_db_session, mocker, restricted_service
notify_api, notify_db_session, mocker, restricted_service
):
service = create_service(restricted=restricted_service)
template = create_template(service=service)
api_key = create_api_key(service=service)
mocker.patch('app.notifications.process_notifications.redis_store.get', return_value=1)
mock_incr = mocker.patch('app.notifications.process_notifications.redis_store.incr')
with set_config(notify_api, 'REDIS_ENABLED', True):
mocker.patch(
"app.notifications.process_notifications.redis_store.get", return_value=1
)
mock_incr = mocker.patch("app.notifications.process_notifications.redis_store.incr")
with set_config(notify_api, "REDIS_ENABLED", True):
persist_notification(
template_id=template.id,
template_version=template.version,
recipient='+447111111122',
recipient="+447111111122",
service=template.service,
personalisation={},
notification_type='sms',
notification_type="sms",
api_key_id=api_key.id,
key_type=api_key.key_type,
reference="ref2")
reference="ref2",
)
assert mock_incr.call_count == 2
mock_incr.assert_has_calls([
call(str(service.id) + "-2016-01-01-count", ),
call(str(service.id) + "-2016-01-01-total-count", ),
])
assert mock_incr.call_count == 1
mock_incr.assert_has_calls(
[
# call(str(service.id) + "-2016-01-01-count", ),
call(
"2016-01-01-total-count",
)
]
)
@pytest.mark.parametrize('restricted_service', [True, False])
@pytest.mark.parametrize("restricted_service", [True, False])
@freeze_time("2016-01-01 11:09:00.061258")
def test_persist_notification_sets_daily_limit_cache_if_one_does_not_exists(
notify_api, notify_db_session, mocker, restricted_service
notify_api, notify_db_session, mocker, restricted_service
):
service = create_service(restricted=restricted_service)
template = create_template(service=service)
api_key = create_api_key(service=service)
mocker.patch('app.notifications.process_notifications.redis_store.get', return_value=None)
mock_set = mocker.patch('app.notifications.process_notifications.redis_store.set')
with set_config(notify_api, 'REDIS_ENABLED', True):
mocker.patch(
"app.notifications.process_notifications.redis_store.get", return_value=None
)
mock_set = mocker.patch("app.notifications.process_notifications.redis_store.set")
with set_config(notify_api, "REDIS_ENABLED", True):
persist_notification(
template_id=template.id,
template_version=template.version,
recipient='+447111111122',
recipient="+447111111122",
service=template.service,
personalisation={},
notification_type='sms',
notification_type="sms",
api_key_id=api_key.id,
key_type=api_key.key_type,
reference="ref2")
reference="ref2",
)
assert mock_set.call_count == 2
mock_set.assert_has_calls([
call(str(service.id) + "-2016-01-01-count", 1, ex=86400),
call(str(service.id) + "-2016-01-01-total-count", 1, ex=86400),
])
assert mock_set.call_count == 1
mock_set.assert_has_calls(
[
# call(str(service.id) + "-2016-01-01-count", 1, ex=86400),
call("2016-01-01-total-count", 1, ex=86400)
]
)
@pytest.mark.parametrize((
'research_mode, requested_queue, notification_type, key_type, expected_queue, expected_task'
), [
(True, None, 'sms', 'normal', 'research-mode-tasks', 'provider_tasks.deliver_sms'),
(True, None, 'email', 'normal', 'research-mode-tasks', 'provider_tasks.deliver_email'),
(True, None, 'email', 'team', 'research-mode-tasks', 'provider_tasks.deliver_email'),
(False, None, 'sms', 'normal', 'send-sms-tasks', 'provider_tasks.deliver_sms'),
(False, None, 'email', 'normal', 'send-email-tasks', 'provider_tasks.deliver_email'),
(False, None, 'sms', 'team', 'send-sms-tasks', 'provider_tasks.deliver_sms'),
(False, None, 'sms', 'test', 'research-mode-tasks', 'provider_tasks.deliver_sms'),
(True, 'notify-internal-tasks', 'email', 'normal', 'research-mode-tasks', 'provider_tasks.deliver_email'),
(False, 'notify-internal-tasks', 'sms', 'normal', 'notify-internal-tasks', 'provider_tasks.deliver_sms'),
(False, 'notify-internal-tasks', 'email', 'normal', 'notify-internal-tasks', 'provider_tasks.deliver_email'),
(False, 'notify-internal-tasks', 'sms', 'test', 'research-mode-tasks', 'provider_tasks.deliver_sms'),
])
@pytest.mark.parametrize(
("requested_queue, notification_type, key_type, expected_queue, expected_task"),
[
(None, "sms", "normal", "send-sms-tasks", "provider_tasks.deliver_sms"),
(None, "email", "normal", "send-email-tasks", "provider_tasks.deliver_email"),
(None, "sms", "team", "send-sms-tasks", "provider_tasks.deliver_sms"),
(
"notify-internal-tasks",
"sms",
"normal",
"notify-internal-tasks",
"provider_tasks.deliver_sms",
),
(
"notify-internal-tasks",
"email",
"normal",
"notify-internal-tasks",
"provider_tasks.deliver_email",
),
],
)
def test_send_notification_to_queue(
notify_db_session,
research_mode,
requested_queue,
notification_type,
key_type,
@@ -282,8 +319,10 @@ def test_send_notification_to_queue(
expected_task,
mocker,
):
mocked = mocker.patch('app.celery.{}.apply_async'.format(expected_task))
Notification = namedtuple('Notification', ['id', 'key_type', 'notification_type', 'created_at'])
mocked = mocker.patch("app.celery.{}.apply_async".format(expected_task))
Notification = namedtuple(
"Notification", ["id", "key_type", "notification_type", "created_at"]
)
notification = Notification(
id=uuid.uuid4(),
key_type=key_type,
@@ -291,33 +330,43 @@ def test_send_notification_to_queue(
created_at=datetime.datetime(2016, 11, 11, 16, 8, 18),
)
send_notification_to_queue(notification=notification, research_mode=research_mode, queue=requested_queue)
send_notification_to_queue(notification=notification, queue=requested_queue)
mocked.assert_called_once_with([str(notification.id)], queue=expected_queue)
def test_send_notification_to_queue_throws_exception_deletes_notification(sample_notification, mocker):
mocked = mocker.patch('app.celery.provider_tasks.deliver_sms.apply_async', side_effect=Boto3Error("EXPECTED"))
def test_send_notification_to_queue_throws_exception_deletes_notification(
sample_notification, mocker
):
mocked = mocker.patch(
"app.celery.provider_tasks.deliver_sms.apply_async",
side_effect=Boto3Error("EXPECTED"),
)
with pytest.raises(Boto3Error):
send_notification_to_queue(sample_notification, False)
mocked.assert_called_once_with([(str(sample_notification.id))], queue='send-sms-tasks')
mocked.assert_called_once_with(
[(str(sample_notification.id))], queue="send-sms-tasks"
)
assert Notification.query.count() == 0
assert NotificationHistory.query.count() == 0
@pytest.mark.parametrize("to_address, notification_type, expected", [
("+12028675000", "sms", True),
("+12028675111", "sms", True),
("+12028675222", "sms", True),
("2028675000", "sms", True),
("2028675111", "sms", True),
("simulate-delivered@notifications.service.gov.uk", "email", True),
("simulate-delivered-2@notifications.service.gov.uk", "email", True),
("simulate-delivered-3@notifications.service.gov.uk", "email", True),
("2028675309", "sms", False),
("valid_email@test.com", "email", False)
])
@pytest.mark.parametrize(
"to_address, notification_type, expected",
[
("+12028675000", "sms", True),
("+12028675111", "sms", True),
("+12028675222", "sms", True),
("2028675000", "sms", True),
("2028675111", "sms", True),
("simulate-delivered@notifications.service.gov.uk", "email", True),
("simulate-delivered-2@notifications.service.gov.uk", "email", True),
("simulate-delivered-3@notifications.service.gov.uk", "email", True),
("2028675309", "sms", False),
("valid_email@test.com", "email", False),
],
)
def test_simulated_recipient(notify_api, to_address, notification_type, expected):
"""
The values where the expected = 'research-mode' are listed in the config['SIMULATED_EMAIL_ADDRESSES']
@@ -331,7 +380,7 @@ def test_simulated_recipient(notify_api, to_address, notification_type, expected
"""
formatted_address = None
if notification_type == 'email':
if notification_type == "email":
formatted_address = validate_and_format_email_address(to_address)
else:
formatted_address = validate_and_format_phone_number(to_address)
@@ -341,11 +390,14 @@ def test_simulated_recipient(notify_api, to_address, notification_type, expected
assert is_simulated_address == expected
@pytest.mark.parametrize('recipient, expected_international, expected_prefix, expected_units', [
('+447900900123', True, '44', 1), # UK
('+73122345678', True, '7', 1), # Russia
('+360623400400', True, '36', 1), # Hungary
('2028675309', False, '1', 1)] # USA
@pytest.mark.parametrize(
"recipient, expected_international, expected_prefix, expected_units",
[
("+447900900123", True, "44", 1), # UK
("+73122345678", True, "7", 1), # Russia
("+360623400400", True, "36", 1), # Hungary
("2028675309", False, "1", 1),
], # USA
)
def test_persist_notification_with_international_info_stores_correct_info(
sample_job,
@@ -354,7 +406,7 @@ def test_persist_notification_with_international_info_stores_correct_info(
recipient,
expected_international,
expected_prefix,
expected_units
expected_units,
):
persist_notification(
template_id=sample_job.template.id,
@@ -362,12 +414,12 @@ def test_persist_notification_with_international_info_stores_correct_info(
recipient=recipient,
service=sample_job.service,
personalisation=None,
notification_type='sms',
notification_type="sms",
api_key_id=sample_api_key.id,
key_type=sample_api_key.key_type,
job_id=sample_job.id,
job_row_number=10,
client_reference="ref from client"
client_reference="ref from client",
)
persisted_notification = Notification.query.all()[0]
@@ -377,22 +429,20 @@ def test_persist_notification_with_international_info_stores_correct_info(
def test_persist_notification_with_international_info_does_not_store_for_email(
sample_job,
sample_api_key,
mocker
sample_job, sample_api_key, mocker
):
persist_notification(
template_id=sample_job.template.id,
template_version=sample_job.template.version,
recipient='foo@bar.com',
recipient="foo@bar.com",
service=sample_job.service,
personalisation=None,
notification_type='email',
notification_type="email",
api_key_id=sample_api_key.id,
key_type=sample_api_key.key_type,
job_id=sample_job.id,
job_row_number=10,
client_reference="ref from client"
client_reference="ref from client",
)
persisted_notification = Notification.query.all()[0]
@@ -401,20 +451,19 @@ def test_persist_notification_with_international_info_does_not_store_for_email(
assert persisted_notification.rate_multiplier is None
@pytest.mark.parametrize('recipient, expected_recipient_normalised', [
('+4407900900123', '+447900900123'),
('202-867-5309', '+12028675309'),
('1 202-867-5309', '+12028675309'),
('+1 (202) 867-5309', '+12028675309'),
('(202) 867-5309', '+12028675309'),
('2028675309', '+12028675309')
])
@pytest.mark.parametrize(
"recipient, expected_recipient_normalised",
[
("+4407900900123", "+447900900123"),
("202-867-5309", "+12028675309"),
("1 202-867-5309", "+12028675309"),
("+1 (202) 867-5309", "+12028675309"),
("(202) 867-5309", "+12028675309"),
("2028675309", "+12028675309"),
],
)
def test_persist_sms_notification_stores_normalised_number(
sample_job,
sample_api_key,
mocker,
recipient,
expected_recipient_normalised
sample_job, sample_api_key, mocker, recipient, expected_recipient_normalised
):
persist_notification(
template_id=sample_job.template.id,
@@ -422,7 +471,7 @@ def test_persist_sms_notification_stores_normalised_number(
recipient=recipient,
service=sample_job.service,
personalisation=None,
notification_type='sms',
notification_type="sms",
api_key_id=sample_api_key.id,
key_type=sample_api_key.key_type,
job_id=sample_job.id,
@@ -433,17 +482,12 @@ def test_persist_sms_notification_stores_normalised_number(
assert persisted_notification.normalised_to == expected_recipient_normalised
@pytest.mark.parametrize('recipient, expected_recipient_normalised', [
('FOO@bar.com', 'foo@bar.com'),
('BAR@foo.com', 'bar@foo.com')
])
@pytest.mark.parametrize(
"recipient, expected_recipient_normalised",
[("FOO@bar.com", "foo@bar.com"), ("BAR@foo.com", "bar@foo.com")],
)
def test_persist_email_notification_stores_normalised_email(
sample_job,
sample_api_key,
mocker,
recipient,
expected_recipient_normalised
sample_job, sample_api_key, mocker, recipient, expected_recipient_normalised
):
persist_notification(
template_id=sample_job.template.id,
@@ -451,7 +495,7 @@ def test_persist_email_notification_stores_normalised_email(
recipient=recipient,
service=sample_job.service,
personalisation=None,
notification_type='email',
notification_type="email",
api_key_id=sample_api_key.id,
key_type=sample_api_key.key_type,
job_id=sample_job.id,
@@ -462,12 +506,10 @@ def test_persist_email_notification_stores_normalised_email(
assert persisted_notification.normalised_to == expected_recipient_normalised
def test_persist_notification_with_billable_units_stores_correct_info(
mocker
):
def test_persist_notification_with_billable_units_stores_correct_info(mocker):
service = create_service(service_permissions=[SMS_TYPE])
template = create_template(service, template_type=SMS_TYPE)
mocker.patch('app.dao.templates_dao.dao_get_template_by_id', return_value=template)
mocker.patch("app.dao.templates_dao.dao_get_template_by_id", return_value=template)
persist_notification(
template_id=template.id,
template_version=template.version,