darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-09-06 06:18:24 -04:00
Code Issues Packages Projects Releases Wiki Activity

notify-api-412 use black to enforce python coding style

Browse Source
This commit is contained in:
Kenneth Kehl
2023-08-25 09:12:23 -07:00
parent c6eb007386
commit 8c9721d8e2
201 changed files with 31660 additions and 28105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

594
tests/app/main/views/test_activity.py
View File

@@ -20,72 +20,75 @@ from tests.conftest import (
@pytest.mark.parametrize(
"user,extra_args,expected_update_endpoint,expected_limit_days,page_title", [
"user,extra_args,expected_update_endpoint,expected_limit_days,page_title",
[
(
create_active_user_view_permissions(),
{'message_type': 'email'},
'/email.json',
{"message_type": "email"},
"/email.json",
7,
'Emails',
"Emails",
),
(
create_active_user_view_permissions(),
{'message_type': 'sms'},
'/sms.json',
{"message_type": "sms"},
"/sms.json",
7,
'Text messages',
"Text messages",
),
(
create_active_caseworking_user(),
{},
'.json',
".json",
None,
'Sent messages',
"Sent messages",
),
]
],
)
@pytest.mark.parametrize(
"status_argument, expected_api_call", [
"status_argument, expected_api_call",
[
(
'',
"",
[
'created', 'pending', 'sending', 'delivered', 'sent', 'failed',
'temporary-failure', 'permanent-failure', 'technical-failure',
'validation-failed'
]
"created",
"pending",
"sending",
"delivered",
"sent",
"failed",
"temporary-failure",
"permanent-failure",
"technical-failure",
"validation-failed",
],
),
("sending", ["sending", "created", "pending"]),
("delivered", ["delivered", "sent"]),
(
'sending',
['sending', 'created', 'pending']
),
(
'delivered',
['delivered', 'sent']
),
(
'failed',
"failed",
[
'failed', 'temporary-failure', 'permanent-failure', 'technical-failure',
'validation-failed'
]
)
]
"failed",
"temporary-failure",
"permanent-failure",
"technical-failure",
"validation-failed",
],
),
],
)
@pytest.mark.parametrize(
"page_argument, expected_page_argument", [
(1, 1),
(22, 22),
(None, 1)
]
"page_argument, expected_page_argument", [(1, 1), (22, 22), (None, 1)]
)
@pytest.mark.parametrize(
"to_argument, expected_to_argument", [
('', ''),
('+12029000123', '+12029000123'),
('test@example.com', 'test@example.com'),
]
"to_argument, expected_to_argument",
[
("", ""),
("+12029000123", "+12029000123"),
("test@example.com", "test@example.com"),
],
)
@freeze_time('2020-01-01 06:00')
@freeze_time("2020-01-01 06:00")
def test_can_show_notifications(
client_request,
service_one,
@@ -110,67 +113,63 @@ def test_can_show_notifications(
client_request.login(user)
if expected_to_argument:
page = client_request.post(
'main.view_notifications',
"main.view_notifications",
service_id=SERVICE_ONE_ID,
status=status_argument,
page=page_argument,
_data={
'to': to_argument
},
_data={"to": to_argument},
_expected_status=200,
**extra_args
)
else:
page = client_request.get(
'main.view_notifications',
"main.view_notifications",
service_id=SERVICE_ONE_ID,
status=status_argument,
page=page_argument,
**extra_args
)
first_row = page.select_one('tbody tr')
first_row = page.select_one("tbody tr")
assert normalize_spaces(
first_row.select_one('a.file-list-filename.usa-link').text
first_row.select_one("a.file-list-filename.usa-link").text
) == (
# Comes from
# https://github.com/alphagov/notifications-admin/blob/8faffad508f9a087b0006989c197741c693cc2e2/tests/__init__.py#L436
'2021234567'
"2021234567"
)
assert normalize_spaces(
# We’re doing str() here not .text to make sure there’s no extra
# HTML sneaking in
str(first_row.select_one('.file-list-hint'))
str(first_row.select_one(".file-list-hint"))
) == (
# Comes from
# https://github.com/alphagov/notifications-admin/blob/8faffad508f9a087b0006989c197741c693cc2e2/tests/__init__.py#L271
'template content'
"template content"
) or (
# Comes from
# https://github.com/alphagov/notifications-admin/blob/8faffad508f9a087b0006989c197741c693cc2e2/tests/__init__.py#L273
'template subject'
"template subject"
)
assert normalize_spaces(
first_row.select_one('.table-field-right-aligned .align-with-message-body').text
) == (
'Delivered 1 January at 06:01 UTC'
)
first_row.select_one(".table-field-right-aligned .align-with-message-body").text
) == ("Delivered 1 January at 06:01 UTC")
assert page_title in page.h1.text.strip()
path_to_json = page.find("div", {'data-key': 'notifications'})['data-resource']
path_to_json = page.find("div", {"data-key": "notifications"})["data-resource"]
url = urlparse(path_to_json)
assert url.path == '/services/{}/notifications{}'.format(
assert url.path == "/services/{}/notifications{}".format(
SERVICE_ONE_ID,
expected_update_endpoint,
)
query_dict = parse_qs(url.query)
if status_argument:
assert query_dict['status'] == [status_argument]
assert query_dict["status"] == [status_argument]
if expected_page_argument:
assert query_dict['page'] == [str(expected_page_argument)]
assert 'to' not in query_dict
assert query_dict["page"] == [str(expected_page_argument)]
assert "to" not in query_dict
mock_get_notifications.assert_called_with(
limit_days=expected_limit_days,
@@ -182,13 +181,17 @@ def test_can_show_notifications(
)
json_response = client_request.get_response(
'main.get_notifications_as_json',
service_id=service_one['id'],
"main.get_notifications_as_json",
service_id=service_one["id"],
status=status_argument,
**extra_args
)
json_content = json.loads(json_response.get_data(as_text=True))
assert json_content.keys() == {'counts', 'notifications', 'service_data_retention_days'}
assert json_content.keys() == {
"counts",
"notifications",
"service_data_retention_days",
}
def test_can_show_notifications_if_data_retention_not_available(
@@ -199,55 +202,54 @@ def test_can_show_notifications_if_data_retention_not_available(
mock_get_no_api_keys,
):
page = client_request.get(
'main.view_notifications',
"main.view_notifications",
service_id=SERVICE_ONE_ID,
status='sending,delivered,failed',
status="sending,delivered,failed",
)
assert page.h1.text.strip() == 'Messages'
assert page.h1.text.strip() == "Messages"
@pytest.mark.parametrize('user, query_parameters, expected_download_link', [
(
create_active_user_with_permissions(),
{},
partial(
url_for,
'.download_notifications_csv',
message_type=None,
@pytest.mark.parametrize(
"user, query_parameters, expected_download_link",
[
(
create_active_user_with_permissions(),
{},
partial(
url_for,
".download_notifications_csv",
message_type=None,
),
),
),
(
create_active_user_with_permissions(),
{'status': 'failed'},
partial(
url_for,
'.download_notifications_csv',
status='failed'
(
create_active_user_with_permissions(),
{"status": "failed"},
partial(url_for, ".download_notifications_csv", status="failed"),
),
),
(
create_active_user_with_permissions(),
{'message_type': 'sms'},
partial(
url_for,
'.download_notifications_csv',
message_type='sms',
(
create_active_user_with_permissions(),
{"message_type": "sms"},
partial(
url_for,
".download_notifications_csv",
message_type="sms",
),
),
),
(
create_active_user_view_permissions(),
{},
partial(
url_for,
'.download_notifications_csv',
(
create_active_user_view_permissions(),
{},
partial(
url_for,
".download_notifications_csv",
),
),
),
(
create_active_caseworking_user(),
{},
lambda service_id: None,
),
])
(
create_active_caseworking_user(),
{},
lambda service_id: None,
),
],
)
def test_link_to_download_notifications(
client_request,
mock_get_notifications,
@@ -261,14 +263,12 @@ def test_link_to_download_notifications(
):
client_request.login(user)
page = client_request.get(
'main.view_notifications',
service_id=SERVICE_ONE_ID,
**query_parameters
"main.view_notifications", service_id=SERVICE_ONE_ID, **query_parameters
)
download_link = page.select_one("a[download=download]")
assert (download_link["href"] if download_link else None) == expected_download_link(
service_id=SERVICE_ONE_ID
)
download_link = page.select_one('a[download=download]')
assert (
download_link['href'] if download_link else None
) == expected_download_link(service_id=SERVICE_ONE_ID)
def test_download_not_available_to_users_without_dashboard(
@@ -277,7 +277,7 @@ def test_download_not_available_to_users_without_dashboard(
):
client_request.login(active_caseworking_user)
client_request.get(
'main.download_notifications_csv',
"main.download_notifications_csv",
service_id=SERVICE_ONE_ID,
_expected_status=403,
)
@@ -290,61 +290,63 @@ def test_shows_message_when_no_notifications(
mock_get_notifications_with_no_notifications,
mock_get_no_api_keys,
):
page = client_request.get(
'main.view_notifications',
"main.view_notifications",
service_id=SERVICE_ONE_ID,
message_type='sms',
message_type="sms",
)
assert normalize_spaces(page.select('tbody tr')[0].text) == (
'No messages found (messages are kept for 7 days)'
assert normalize_spaces(page.select("tbody tr")[0].text) == (
"No messages found (messages are kept for 7 days)"
)
@pytest.mark.parametrize((
'initial_query_arguments,'
'form_post_data,'
'expected_search_box_label,'
'expected_search_box_contents'
), [
@pytest.mark.parametrize(
(
{},
{},
'Search by recipient',
None,
"initial_query_arguments,"
"form_post_data,"
"expected_search_box_label,"
"expected_search_box_contents"
),
(
{
'message_type': 'sms',
},
{},
'Search by phone number',
None,
),
(
{
'message_type': 'sms',
},
{
'to': '+33(0)5-12-34-56-78',
},
'Search by phone number',
'+33(0)5-12-34-56-78',
),
(
{
'status': 'failed',
'message_type': 'email',
'page': '99',
},
{
'to': 'test@example.com',
},
'Search by email address',
'test@example.com',
),
])
[
(
{},
{},
"Search by recipient",
None,
),
(
{
"message_type": "sms",
},
{},
"Search by phone number",
None,
),
(
{
"message_type": "sms",
},
{
"to": "+33(0)5-12-34-56-78",
},
"Search by phone number",
"+33(0)5-12-34-56-78",
),
(
{
"status": "failed",
"message_type": "email",
"page": "99",
},
{
"to": "test@example.com",
},
"Search by email address",
"test@example.com",
),
],
)
def test_search_recipient_form(
client_request,
mock_get_notifications,
@@ -357,37 +359,39 @@ def test_search_recipient_form(
expected_search_box_contents,
):
page = client_request.post(
'main.view_notifications',
"main.view_notifications",
service_id=SERVICE_ONE_ID,
_data=form_post_data,
_expected_status=200,
**initial_query_arguments
)
assert page.find("form")['method'] == 'post'
action_url = page.find("form")['action']
assert page.find("form")["method"] == "post"
action_url = page.find("form")["action"]
url = urlparse(action_url)
assert url.path == '/services/{}/notifications/{}'.format(
SERVICE_ONE_ID,
initial_query_arguments.get('message_type', '')
).rstrip('/')
assert url.path == "/services/{}/notifications/{}".format(
SERVICE_ONE_ID, initial_query_arguments.get("message_type", "")
).rstrip("/")
query_dict = parse_qs(url.query)
assert query_dict == {}
assert page.select_one('label[for=to]').text.strip() == expected_search_box_label
assert page.select_one("label[for=to]").text.strip() == expected_search_box_label
recipient_inputs = page.select("input[name=to]")
assert (len(recipient_inputs) == 2)
assert len(recipient_inputs) == 2
for field in recipient_inputs:
assert field.get("value") == expected_search_box_contents
@pytest.mark.parametrize('message_type, expected_search_box_label', [
(None, 'Search by recipient or reference'),
('sms', 'Search by phone number or reference'),
('email', 'Search by email address or reference'),
])
@pytest.mark.parametrize(
"message_type, expected_search_box_label",
[
(None, "Search by recipient or reference"),
("sms", "Search by phone number or reference"),
("email", "Search by email address or reference"),
],
)
def test_api_users_are_told_they_can_search_by_reference_when_service_has_api_keys(
client_request,
mocker,
@@ -400,18 +404,21 @@ def test_api_users_are_told_they_can_search_by_reference_when_service_has_api_ke
mock_get_api_keys,
):
page = client_request.get(
'main.view_notifications',
"main.view_notifications",
service_id=SERVICE_ONE_ID,
message_type=message_type,
)
assert page.select_one('label[for=to]').text.strip() == expected_search_box_label
assert page.select_one("label[for=to]").text.strip() == expected_search_box_label
@pytest.mark.parametrize('message_type, expected_search_box_label', [
(None, 'Search by recipient'),
('sms', 'Search by phone number'),
('email', 'Search by email address'),
])
@pytest.mark.parametrize(
"message_type, expected_search_box_label",
[
(None, "Search by recipient"),
("sms", "Search by phone number"),
("email", "Search by email address"),
],
)
def test_api_users_are_not_told_they_can_search_by_reference_when_service_has_no_api_keys(
client_request,
mocker,
@@ -424,11 +431,11 @@ def test_api_users_are_not_told_they_can_search_by_reference_when_service_has_no
mock_get_no_api_keys,
):
page = client_request.get(
'main.view_notifications',
"main.view_notifications",
service_id=SERVICE_ONE_ID,
message_type=message_type,
)
assert page.select_one('label[for=to]').text.strip() == expected_search_box_label
assert page.select_one("label[for=to]").text.strip() == expected_search_box_label
def test_should_show_notifications_for_a_service_with_next_previous(
@@ -442,26 +449,36 @@ def test_should_show_notifications_for_a_service_with_next_previous(
mocker,
):
page = client_request.get(
'main.view_notifications',
service_id=service_one['id'],
message_type='sms',
page=2
"main.view_notifications",
service_id=service_one["id"],
message_type="sms",
page=2,
)
next_page_link = page.find('a', {'rel': 'next'})
prev_page_link = page.find('a', {'rel': 'previous'})
next_page_link = page.find("a", {"rel": "next"})
prev_page_link = page.find("a", {"rel": "previous"})
assert (
url_for('main.view_notifications', service_id=service_one['id'], message_type='sms', page=3) in
next_page_link['href']
url_for(
"main.view_notifications",
service_id=service_one["id"],
message_type="sms",
page=3,
)
in next_page_link["href"]
)
assert 'Next page' in next_page_link.text.strip()
assert 'page 3' in next_page_link.text.strip()
assert "Next page" in next_page_link.text.strip()
assert "page 3" in next_page_link.text.strip()
assert (
url_for('main.view_notifications', service_id=service_one['id'], message_type='sms', page=1) in
prev_page_link['href']
url_for(
"main.view_notifications",
service_id=service_one["id"],
message_type="sms",
page=1,
)
in prev_page_link["href"]
)
assert 'Previous page' in prev_page_link.text.strip()
assert 'page 1' in prev_page_link.text.strip()
assert "Previous page" in prev_page_link.text.strip()
assert "page 1" in prev_page_link.text.strip()
def test_doesnt_show_pagination_with_search_term(
@@ -475,70 +492,68 @@ def test_doesnt_show_pagination_with_search_term(
mocker,
):
page = client_request.post(
'main.view_notifications',
service_id=service_one['id'],
message_type='sms',
"main.view_notifications",
service_id=service_one["id"],
message_type="sms",
_data={
'to': 'test@example.com',
"to": "test@example.com",
},
_expected_status=200,
)
assert len(page.select('tbody tr')) == 50
assert not page.find('a', {'rel': 'next'})
assert not page.find('a', {'rel': 'previous'})
assert normalize_spaces(
page.select_one('.table-show-more-link').text
) == (
'Only showing the first 50 messages'
assert len(page.select("tbody tr")) == 50
assert not page.find("a", {"rel": "next"})
assert not page.find("a", {"rel": "previous"})
assert normalize_spaces(page.select_one(".table-show-more-link").text) == (
"Only showing the first 50 messages"
)
@pytest.mark.parametrize(
"job_created_at, expected_message", [
"job_created_at, expected_message",
[
("2016-01-10 11:09:00.000000+00:00", "Data available for 7 days"),
("2016-01-04 11:09:00.000000+00:00", "Data available for 1 day"),
("2016-01-03 11:09:00.000000+00:00", "Data available for 12 hours"),
("2016-01-02 23:59:59.000000+00:00", "Data no longer available")
]
("2016-01-02 23:59:59.000000+00:00", "Data no longer available"),
],
)
@freeze_time("2016-01-10 12:00:00.000000")
def test_time_left(job_created_at, expected_message):
assert get_time_left(job_created_at) == expected_message
STATISTICS = {
'sms': {
'requested': 6,
'failed': 2,
'delivered': 1
}
}
STATISTICS = {"sms": {"requested": 6, "failed": 2, "delivered": 1}}
def test_get_status_filters_calculates_stats(client_request):
ret = get_status_filters(Service({'id': 'foo'}), 'sms', STATISTICS)
ret = get_status_filters(Service({"id": "foo"}), "sms", STATISTICS)
assert {label: count for label, _option, _link, count in ret} == {
'total': 6,
'pending': 3,
'failed': 2,
'delivered': 1
"total": 6,
"pending": 3,
"failed": 2,
"delivered": 1,
}
def test_get_status_filters_in_right_order(client_request):
ret = get_status_filters(Service({'id': 'foo'}), 'sms', STATISTICS)
ret = get_status_filters(Service({"id": "foo"}), "sms", STATISTICS)
assert [label for label, _option, _link, _count in ret] == [
'total', 'pending', 'delivered', 'failed'
"total",
"pending",
"delivered",
"failed",
]
def test_get_status_filters_constructs_links(client_request):
ret = get_status_filters(Service({'id': 'foo'}), 'sms', STATISTICS)
ret = get_status_filters(Service({"id": "foo"}), "sms", STATISTICS)
link = ret[0][2]
assert link == '/services/foo/notifications/sms?status={}'.format('sending,delivered,failed')
assert link == "/services/foo/notifications/sms?status={}".format(
"sending,delivered,failed"
)
def test_html_contains_notification_id(
@@ -552,15 +567,15 @@ def test_html_contains_notification_id(
mocker,
):
page = client_request.get(
'main.view_notifications',
service_id=service_one['id'],
message_type='sms',
status='',
"main.view_notifications",
service_id=service_one["id"],
message_type="sms",
status="",
)
notifications = page.tbody.find_all('tr')
notifications = page.tbody.find_all("tr")
for tr in notifications:
assert uuid.UUID(tr.attrs['id'])
assert uuid.UUID(tr.attrs["id"])
def test_html_contains_links_for_failed_notifications(
@@ -570,29 +585,31 @@ def test_html_contains_links_for_failed_notifications(
mock_get_no_api_keys,
mocker,
):
notifications = create_notifications(status='technical-failure')
mocker.patch('app.notification_api_client.get_notifications_for_service', return_value=notifications)
notifications = create_notifications(status="technical-failure")
mocker.patch(
"app.notification_api_client.get_notifications_for_service",
return_value=notifications,
)
response = client_request.get(
'main.view_notifications',
"main.view_notifications",
service_id=SERVICE_ONE_ID,
message_type='sms',
status='sending%2Cdelivered%2Cfailed'
message_type="sms",
status="sending%2Cdelivered%2Cfailed",
)
notifications = response.tbody.find_all('tr')
notifications = response.tbody.find_all("tr")
for tr in notifications:
link_text = tr.find('div', class_='table-field-status-error').find('a').text
assert normalize_spaces(link_text) == 'Technical failure'
link_text = tr.find("div", class_="table-field-status-error").find("a").text
assert normalize_spaces(link_text) == "Technical failure"
@pytest.mark.parametrize('notification_type, expected_row_contents', (
('sms', (
'2021234567 hello & welcome hidden'
)),
('email', (
'example@gsa.gov hidden, hello & welcome'
)),
))
@pytest.mark.parametrize(
"notification_type, expected_row_contents",
(
("sms", ("2021234567 hello & welcome hidden")),
("email", ("example@gsa.gov hidden, hello & welcome")),
),
)
def test_redacts_templates_that_should_be_redacted(
client_request,
mocker,
@@ -603,40 +620,59 @@ def test_redacts_templates_that_should_be_redacted(
expected_row_contents,
):
notifications = create_notifications(
status='technical-failure',
content='hello & welcome ((name))',
subject='((name)), hello & welcome',
personalisation={'name': 'Jo'},
status="technical-failure",
content="hello & welcome ((name))",
subject="((name)), hello & welcome",
personalisation={"name": "Jo"},
redact_personalisation=True,
template_type=notification_type,
)
mocker.patch('app.notification_api_client.get_notifications_for_service', return_value=notifications)
mocker.patch(
"app.notification_api_client.get_notifications_for_service",
return_value=notifications,
)
page = client_request.get(
'main.view_notifications',
"main.view_notifications",
service_id=SERVICE_ONE_ID,
message_type=notification_type,
)
assert normalize_spaces(page.select('tbody tr th')[0].text) == (
assert normalize_spaces(page.select("tbody tr th")[0].text) == (
expected_row_contents
)
@freeze_time("2017-09-27 12:30:00.000000")
@pytest.mark.parametrize(
"message_type, status, expected_hint_status, single_line", [
('email', 'created', 'Sending since 27 September at 12:30 UTC', True),
('email', 'sending', 'Sending since 27 September at 12:30 UTC', True),
('email', 'temporary-failure', 'Inbox not accepting messages right now 27 September at 12:31 UTC', False),
('email', 'permanent-failure', 'Email address does not exist 27 September at 12:31 UTC', False),
('email', 'delivered', 'Delivered 27 September at 12:31 UTC', True),
('sms', 'created', 'Sending since 27 September at 12:30 UTC', True),
('sms', 'sending', 'Sending since 27 September at 12:30 UTC', True),
('sms', 'temporary-failure', 'Phone not accepting messages right now 27 September at 12:31 UTC', False),
('sms', 'permanent-failure', 'Not delivered 27 September at 12:31 UTC', False),
('sms', 'delivered', 'Delivered 27 September at 12:31 UTC', True),
]
"message_type, status, expected_hint_status, single_line",
[
("email", "created", "Sending since 27 September at 12:30 UTC", True),
("email", "sending", "Sending since 27 September at 12:30 UTC", True),
(
"email",
"temporary-failure",
"Inbox not accepting messages right now 27 September at 12:31 UTC",
False,
),
(
"email",
"permanent-failure",
"Email address does not exist 27 September at 12:31 UTC",
False,
),
("email", "delivered", "Delivered 27 September at 12:31 UTC", True),
("sms", "created", "Sending since 27 September at 12:30 UTC", True),
("sms", "sending", "Sending since 27 September at 12:30 UTC", True),
(
"sms",
"temporary-failure",
"Phone not accepting messages right now 27 September at 12:31 UTC",
False,
),
("sms", "permanent-failure", "Not delivered 27 September at 12:31 UTC", False),
("sms", "delivered", "Delivered 27 September at 12:31 UTC", True),
],
)
def test_sending_status_hint_displays_correctly_on_notifications_page(
client_request,
@@ -648,16 +684,22 @@ def test_sending_status_hint_displays_correctly_on_notifications_page(
status,
expected_hint_status,
single_line,
mocker
mocker,
):
notifications = create_notifications(template_type=message_type, status=status)
mocker.patch('app.notification_api_client.get_notifications_for_service', return_value=notifications)
page = client_request.get(
'main.view_notifications',
service_id=service_one['id'],
message_type=message_type
mocker.patch(
"app.notification_api_client.get_notifications_for_service",
return_value=notifications,
)
assert normalize_spaces(page.select(".table-field-right-aligned")[0].text) == expected_hint_status
assert bool(page.select('.align-with-message-body')) is single_line
page = client_request.get(
"main.view_notifications",
service_id=service_one["id"],
message_type=message_type,
)
assert (
normalize_spaces(page.select(".table-field-right-aligned")[0].text)
== expected_hint_status
)
assert bool(page.select(".align-with-message-body")) is single_line