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

merge from main

Browse Source
This commit is contained in:
Kenneth Kehl
2024-03-01 13:50:09 -08:00
parent aef797eb79 18dddf4043
commit b777249b6f
140 changed files with 8031 additions and 5017 deletions
Download Patch File Download Diff File Expand all files Collapse all files

147
tests/app/delivery/test_send_to_providers.py
View File

@@ -14,17 +14,9 @@ from app.dao import notifications_dao
from app.dao.provider_details_dao import get_provider_details_by_identifier
from app.delivery import send_to_providers
from app.delivery.send_to_providers import get_html_email_options, get_logo_url
from app.enums import BrandType, KeyType, NotificationStatus, NotificationType
from app.exceptions import NotificationTechnicalFailureException
from app.models import (
BRANDING_BOTH,
BRANDING_ORG,
BRANDING_ORG_BANNER,
KEY_TYPE_NORMAL,
KEY_TYPE_TEAM,
KEY_TYPE_TEST,
EmailBranding,
Notification,
)
from app.models import EmailBranding, Notification
from app.serialised_models import SerialisedService
from tests.app.db import (
create_email_branding,
@@ -61,7 +53,7 @@ def test_provider_to_use_should_only_return_sns_for_international(
sns = get_provider_details_by_identifier("sns")
sns.priority = international_provider_priority
ret = send_to_providers.provider_to_use("sms", international=True)
ret = send_to_providers.provider_to_use(NotificationType.SMS, international=True)
assert ret.name == "sns"
@@ -74,7 +66,7 @@ def test_provider_to_use_raises_if_no_active_providers(
# flake8 doesn't like raises with a generic exception
try:
send_to_providers.provider_to_use("sms")
send_to_providers.provider_to_use(NotificationType.SMS)
assert 1 == 0
except Exception:
assert 1 == 1
@@ -85,10 +77,10 @@ def test_should_send_personalised_template_to_correct_sms_provider_and_persist(
):
db_notification = create_notification(
template=sample_sms_template_with_html,
status="created",
personalisation={},
status=NotificationStatus.CREATED,
reply_to_text=sample_sms_template_with_html.service.get_default_sms_sender(),
)
db_notification.personalisation = {"name": "Jo"}
mocker.patch("app.aws_sns_client.send_sms")
@@ -112,7 +104,7 @@ def test_should_send_personalised_template_to_correct_sms_provider_and_persist(
notification = Notification.query.filter_by(id=db_notification.id).one()
assert notification.status == "sending"
assert notification.status == NotificationStatus.SENDING
assert notification.sent_at <= datetime.utcnow()
assert notification.sent_by == "sns"
assert notification.billable_units == 1
@@ -123,24 +115,21 @@ def test_should_send_personalised_template_to_correct_email_provider_and_persist
sample_email_template_with_html, mocker
):
mock_redis = mocker.patch("app.delivery.send_to_providers.redis_store")
mock_redis.get.return_value = "jo.smith@example.com".encode("utf-8")
email = "jo.smith@example.com".encode("utf-8")
utf8_encoded_email = "jo.smith@example.com".encode("utf-8")
mock_redis.get.return_value = utf8_encoded_email
email = utf8_encoded_email
personalisation = {
"name": "Jo",
}
personalisation = json.dumps(personalisation)
personalisation = personalisation.encode("utf-8")
mock_redis.get.side_effect = [email, personalisation]
db_notification = create_notification(
template=sample_email_template_with_html,
)
db_notification.personalisation = {"name": "Jo"}
mocker.patch("app.aws_ses_client.send_email", return_value="reference")
send_to_providers.send_email_to_provider(db_notification)
app.aws_ses_client.send_email.assert_called_once_with(
f'"Sample service" <sample.service@{cloud_config.ses_email_domain}>',
"jo.smith@example.com",
@@ -157,7 +146,7 @@ def test_should_send_personalised_template_to_correct_email_provider_and_persist
)
notification = Notification.query.filter_by(id=db_notification.id).one()
assert notification.status == "sending"
assert notification.status == NotificationStatus.SENDING
assert notification.sent_at <= datetime.utcnow()
assert notification.sent_by == "ses"
assert notification.personalisation == {"name": "Jo"}
@@ -191,7 +180,10 @@ def test_should_not_send_email_message_when_service_is_inactive_notifcation_is_i
send_to_providers.send_email_to_provider(sample_notification)
assert str(sample_notification.id) in str(e.value)
send_mock.assert_not_called()
assert Notification.query.get(sample_notification.id).status == "technical-failure"
assert (
Notification.query.get(sample_notification.id).status
== NotificationStatus.TECHNICAL_FAILURE
)
def test_should_not_send_sms_message_when_service_is_inactive_notification_is_in_tech_failure(
@@ -212,7 +204,10 @@ def test_should_not_send_sms_message_when_service_is_inactive_notification_is_in
send_to_providers.send_sms_to_provider(sample_notification)
assert str(sample_notification.id) in str(e.value)
send_mock.assert_not_called()
assert Notification.query.get(sample_notification.id).status == "technical-failure"
assert (
Notification.query.get(sample_notification.id).status
== NotificationStatus.TECHNICAL_FAILURE
)
def test_send_sms_should_use_template_version_from_notification_not_latest(
@@ -221,7 +216,7 @@ def test_send_sms_should_use_template_version_from_notification_not_latest(
db_notification = create_notification(
template=sample_template,
to_field="2028675309",
status="created",
status=NotificationStatus.CREATED,
reply_to_text=sample_template.service.get_default_sms_sender(),
normalised_to="2028675309",
)
@@ -268,7 +263,7 @@ def test_send_sms_should_use_template_version_from_notification_not_latest(
assert persisted_notification.template_id == expected_template_id
assert persisted_notification.template_version == version_on_notification
assert persisted_notification.template_version != t.version
assert persisted_notification.status == "sending"
assert persisted_notification.status == NotificationStatus.SENDING
assert not persisted_notification.personalisation
@@ -276,7 +271,8 @@ def test_should_have_sending_status_if_fake_callback_function_fails(
sample_notification, mocker
):
mocker.patch(
"app.delivery.send_to_providers.send_sms_response", side_effect=HTTPError
"app.delivery.send_to_providers.send_sms_response",
side_effect=HTTPError,
)
mock_s3 = mocker.patch("app.delivery.send_to_providers.get_phone_number_from_s3")
@@ -285,19 +281,22 @@ def test_should_have_sending_status_if_fake_callback_function_fails(
mock_personalisation = mocker.patch(
"app.delivery.send_to_providers.get_personalisation_from_s3"
)
mock_personalisation.return_value = {"name": "Jo"}
mock_personalisation.return_value = {}
sample_notification.key_type = KEY_TYPE_TEST
sample_notification.key_type = KeyType.TEST
with pytest.raises(HTTPError):
send_to_providers.send_sms_to_provider(sample_notification)
assert sample_notification.status == "sending"
assert sample_notification.status == NotificationStatus.SENDING
assert sample_notification.sent_by == "sns"
def test_should_not_send_to_provider_when_status_is_not_created(
sample_template, mocker
):
notification = create_notification(template=sample_template, status="sending")
notification = create_notification(
template=sample_template,
status=NotificationStatus.SENDING,
)
mocker.patch("app.aws_sns_client.send_sms")
response_mock = mocker.patch("app.delivery.send_to_providers.send_sms_response")
@@ -307,7 +306,7 @@ def test_should_not_send_to_provider_when_status_is_not_created(
mock_personalisation = mocker.patch(
"app.delivery.send_to_providers.get_personalisation_from_s3"
)
mock_personalisation.return_value = {"name": "Jo"}
mock_personalisation.return_value = {}
send_to_providers.send_sms_to_provider(notification)
@@ -385,7 +384,9 @@ def test_send_email_to_provider_should_not_send_to_provider_when_status_is_not_c
mock_redis = mocker.patch("app.delivery.send_to_providers.redis_store")
mock_redis.get.return_value = "test@example.com".encode("utf-8")
notification = create_notification(template=sample_email_template, status="sending")
notification = create_notification(
template=sample_email_template, status=NotificationStatus.SENDING
)
mocker.patch("app.aws_ses_client.send_email")
mocker.patch("app.delivery.send_to_providers.send_email_response")
mock_phone = mocker.patch("app.delivery.send_to_providers.get_phone_number_from_s3")
@@ -421,12 +422,15 @@ def test_send_email_should_use_service_reply_to_email(
)
create_reply_to_email(service=sample_service, email_address="foo@bar.com")
send_to_providers.send_email_to_provider(
db_notification,
)
send_to_providers.send_email_to_provider(db_notification)
app.aws_ses_client.send_email.assert_called_once_with(
ANY, ANY, ANY, body=ANY, html_body=ANY, reply_to_address="foo@bar.com"
ANY,
ANY,
ANY,
body=ANY,
html_body=ANY,
reply_to_address="foo@bar.com",
)
@@ -441,7 +445,7 @@ def test_get_html_email_renderer_should_return_for_normal_service(sample_service
@pytest.mark.parametrize(
"branding_type, govuk_banner",
[(BRANDING_ORG, False), (BRANDING_BOTH, True), (BRANDING_ORG_BANNER, False)],
[(BrandType.ORG, False), (BrandType.BOTH, True), (BrandType.ORG_BANNER, False)],
)
def test_get_html_email_renderer_with_branding_details(
branding_type, govuk_banner, notify_db_session, sample_service
@@ -464,7 +468,7 @@ def test_get_html_email_renderer_with_branding_details(
assert options["brand_text"] == "League of Justice"
assert options["brand_name"] == "Justice League"
if branding_type == BRANDING_ORG_BANNER:
if branding_type == BrandType.ORG_BANNER:
assert options["brand_banner"] is True
else:
assert options["brand_banner"] is False
@@ -485,11 +489,12 @@ def test_get_html_email_renderer_with_branding_details_and_render_govuk_banner_o
def test_get_html_email_renderer_prepends_logo_path(notify_api):
Service = namedtuple("Service", ["email_branding"])
EmailBranding = namedtuple(
"EmailBranding", ["brand_type", "colour", "name", "logo", "text"]
"EmailBranding",
["brand_type", "colour", "name", "logo", "text"],
)
email_branding = EmailBranding(
brand_type=BRANDING_ORG,
brand_type=BrandType.ORG,
colour="#000000",
logo="justice-league.png",
name="Justice League",
@@ -509,11 +514,12 @@ def test_get_html_email_renderer_prepends_logo_path(notify_api):
def test_get_html_email_renderer_handles_email_branding_without_logo(notify_api):
Service = namedtuple("Service", ["email_branding"])
EmailBranding = namedtuple(
"EmailBranding", ["brand_type", "colour", "name", "logo", "text"]
"EmailBranding",
["brand_type", "colour", "name", "logo", "text"],
)
email_branding = EmailBranding(
brand_type=BRANDING_ORG_BANNER,
brand_type=BrandType.ORG_BANNER,
colour="#000000",
logo=None,
name="Justice League",
@@ -565,9 +571,9 @@ def test_get_logo_url_works_for_different_environments(base_url, expected_url):
@pytest.mark.parametrize(
"starting_status, expected_status",
[
("delivered", "delivered"),
("created", "sending"),
("technical-failure", "technical-failure"),
(NotificationStatus.DELIVERED, NotificationStatus.DELIVERED),
(NotificationStatus.CREATED, NotificationStatus.SENDING),
(NotificationStatus.TECHNICAL_FAILURE, NotificationStatus.TECHNICAL_FAILURE),
],
)
def test_update_notification_to_sending_does_not_update_status_from_a_final_status(
@@ -577,32 +583,37 @@ def test_update_notification_to_sending_does_not_update_status_from_a_final_stat
notification = create_notification(template=template, status=starting_status)
send_to_providers.update_notification_to_sending(
notification,
notification_provider_clients.get_client_by_name_and_type("sns", "sms"),
notification_provider_clients.get_client_by_name_and_type(
"sns", NotificationType.SMS
),
)
assert notification.status == expected_status
def __update_notification(notification_to_update, research_mode, expected_status):
if research_mode or notification_to_update.key_type == KEY_TYPE_TEST:
if research_mode or notification_to_update.key_type == KeyType.TEST:
notification_to_update.status = expected_status
@pytest.mark.parametrize(
"research_mode,key_type, billable_units, expected_status",
[
(True, KEY_TYPE_NORMAL, 0, "delivered"),
(False, KEY_TYPE_NORMAL, 1, "sending"),
(False, KEY_TYPE_TEST, 0, "sending"),
(True, KEY_TYPE_TEST, 0, "sending"),
(True, KEY_TYPE_TEAM, 0, "delivered"),
(False, KEY_TYPE_TEAM, 1, "sending"),
(True, KeyType.NORMAL, 0, NotificationStatus.DELIVERED),
(False, KeyType.NORMAL, 1, NotificationStatus.SENDING),
(False, KeyType.TEST, 0, NotificationStatus.SENDING),
(True, KeyType.TEST, 0, NotificationStatus.SENDING),
(True, KeyType.TEAM, 0, NotificationStatus.DELIVERED),
(False, KeyType.TEAM, 1, NotificationStatus.SENDING),
],
)
def test_should_update_billable_units_and_status_according_to_research_mode_and_key_type(
sample_template, mocker, research_mode, key_type, billable_units, expected_status
):
notification = create_notification(
template=sample_template, billable_units=0, status="created", key_type=key_type
template=sample_template,
billable_units=0,
status=NotificationStatus.CREATED,
key_type=key_type,
)
mocker.patch("app.aws_sns_client.send_sms")
mocker.patch(
@@ -662,7 +673,7 @@ def test_should_send_sms_to_international_providers(
template=sample_template,
to_field="+6011-17224412",
personalisation={"name": "Jo"},
status="created",
status=NotificationStatus.CREATED,
international=True,
reply_to_text=sample_template.service.get_default_sms_sender(),
normalised_to="601117224412",
@@ -686,7 +697,7 @@ def test_should_send_sms_to_international_providers(
international=True,
)
assert notification_international.status == "sending"
assert notification_international.status == NotificationStatus.SENDING
assert notification_international.sent_by == "sns"
@@ -743,15 +754,19 @@ def test_send_email_to_provider_uses_reply_to_from_notification(
mocker.patch("app.aws_ses_client.send_email", return_value="reference")
db_notification = create_notification(
template=sample_email_template, reply_to_text="test@test.com"
template=sample_email_template,
reply_to_text="test@test.com",
)
send_to_providers.send_email_to_provider(
db_notification,
)
send_to_providers.send_email_to_provider(db_notification)
app.aws_ses_client.send_email.assert_called_once_with(
ANY, ANY, ANY, body=ANY, html_body=ANY, reply_to_address="test@test.com"
ANY,
ANY,
ANY,
body=ANY,
html_body=ANY,
reply_to_address="test@test.com",
)
@@ -912,8 +927,8 @@ def test_get_html_email_options_return_email_branding_from_serialised_service(
email_options = get_html_email_options(service)
assert email_options is not None
assert email_options == {
"govuk_banner": branding.brand_type == BRANDING_BOTH,
"brand_banner": branding.brand_type == BRANDING_ORG_BANNER,
"govuk_banner": branding.brand_type == BrandType.BOTH,
"brand_banner": branding.brand_type == BrandType.ORG_BANNER,
"brand_colour": branding.colour,
"brand_logo": get_logo_url(current_app.config["ADMIN_BASE_URL"], branding.logo),
"brand_text": branding.text,
@@ -927,8 +942,8 @@ def test_get_html_email_options_add_email_branding_from_service(sample_service):
email_options = get_html_email_options(sample_service)
assert email_options is not None
assert email_options == {
"govuk_banner": branding.brand_type == BRANDING_BOTH,
"brand_banner": branding.brand_type == BRANDING_ORG_BANNER,
"govuk_banner": branding.brand_type == BrandType.BOTH,
"brand_banner": branding.brand_type == BrandType.ORG_BANNER,
"brand_colour": branding.colour,
"brand_logo": get_logo_url(current_app.config["ADMIN_BASE_URL"], branding.logo),
"brand_text": branding.text,