mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-08-18 13:39:41 -04:00
notify-api-412 use black to enforce python coding style
This commit is contained in:
Kenneth Kehl
@@ -10,19 +10,18 @@ from tests.conftest import fake_uuid
|
||||
|
||||
def _get_notifications_csv(
|
||||
row_number=1,
|
||||
recipient='foo@bar.com',
|
||||
template_name='foo',
|
||||
template_type='sms',
|
||||
job_name='bar.csv',
|
||||
status='Delivered',
|
||||
created_at='1943-04-19 12:00:00',
|
||||
recipient="foo@bar.com",
|
||||
template_name="foo",
|
||||
template_type="sms",
|
||||
job_name="bar.csv",
|
||||
status="Delivered",
|
||||
created_at="1943-04-19 12:00:00",
|
||||
rows=1,
|
||||
with_links=False,
|
||||
job_id=fake_uuid,
|
||||
created_by_name=None,
|
||||
created_by_email_address=None,
|
||||
):
|
||||
|
||||
def _get(
|
||||
service_id,
|
||||
page=1,
|
||||
@@ -32,30 +31,33 @@ def _get_notifications_csv(
|
||||
links = {}
|
||||
if with_links:
|
||||
links = {
|
||||
'prev': '/service/{}/notifications?page=0'.format(service_id),
|
||||
'next': '/service/{}/notifications?page=1'.format(service_id),
|
||||
'last': '/service/{}/notifications?page=2'.format(service_id)
|
||||
"prev": "/service/{}/notifications?page=0".format(service_id),
|
||||
"next": "/service/{}/notifications?page=1".format(service_id),
|
||||
"last": "/service/{}/notifications?page=2".format(service_id),
|
||||
}
|
||||
|
||||
data = {
|
||||
'notifications': [{
|
||||
"row_number": row_number + i,
|
||||
"to": recipient,
|
||||
"recipient": recipient,
|
||||
"client_reference": 'ref 1234',
|
||||
"template_name": template_name,
|
||||
"template_type": template_type,
|
||||
"template": {"name": template_name, "template_type": template_type},
|
||||
"job_name": job_name,
|
||||
"status": status,
|
||||
"created_at": created_at,
|
||||
"updated_at": None,
|
||||
"created_by_name": created_by_name,
|
||||
"created_by_email_address": created_by_email_address,
|
||||
} for i in range(rows)],
|
||||
'total': rows,
|
||||
'page_size': 50,
|
||||
'links': links
|
||||
"notifications": [
|
||||
{
|
||||
"row_number": row_number + i,
|
||||
"to": recipient,
|
||||
"recipient": recipient,
|
||||
"client_reference": "ref 1234",
|
||||
"template_name": template_name,
|
||||
"template_type": template_type,
|
||||
"template": {"name": template_name, "template_type": template_type},
|
||||
"job_name": job_name,
|
||||
"status": status,
|
||||
"created_at": created_at,
|
||||
"updated_at": None,
|
||||
"created_by_name": created_by_name,
|
||||
"created_by_email_address": created_by_email_address,
|
||||
}
|
||||
for i in range(rows)
|
||||
],
|
||||
"total": rows,
|
||||
"page_size": 50,
|
||||
"links": links,
|
||||
}
|
||||
|
||||
return data
|
||||
@@ -63,31 +65,36 @@ def _get_notifications_csv(
|
||||
return _get
|
||||
|
||||
|
||||
@pytest.fixture(scope='function')
|
||||
@pytest.fixture(scope="function")
|
||||
def _get_notifications_csv_mock(
|
||||
mocker,
|
||||
api_user_active,
|
||||
):
|
||||
return mocker.patch(
|
||||
'app.notification_api_client.get_notifications_for_service',
|
||||
side_effect=_get_notifications_csv()
|
||||
"app.notification_api_client.get_notifications_for_service",
|
||||
side_effect=_get_notifications_csv(),
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize('created_by_name, expected_content', [
|
||||
(
|
||||
None, [
|
||||
'Recipient,Template,Type,Sent by,Job,Status,Time\n',
|
||||
'foo@bar.com,foo,sms,,,Delivered,1943-04-19 12:00:00\r\n',
|
||||
]
|
||||
),
|
||||
(
|
||||
'Anne Example', [
|
||||
'Recipient,Template,Type,Sent by,Job,Status,Time\n',
|
||||
'foo@bar.com,foo,sms,Anne Example,,Delivered,1943-04-19 12:00:00\r\n',
|
||||
]
|
||||
),
|
||||
])
|
||||
@pytest.mark.parametrize(
|
||||
"created_by_name, expected_content",
|
||||
[
|
||||
(
|
||||
None,
|
||||
[
|
||||
"Recipient,Template,Type,Sent by,Job,Status,Time\n",
|
||||
"foo@bar.com,foo,sms,,,Delivered,1943-04-19 12:00:00\r\n",
|
||||
],
|
||||
),
|
||||
(
|
||||
"Anne Example",
|
||||
[
|
||||
"Recipient,Template,Type,Sent by,Job,Status,Time\n",
|
||||
"foo@bar.com,foo,sms,Anne Example,,Delivered,1943-04-19 12:00:00\r\n",
|
||||
],
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_generate_notifications_csv_without_job(
|
||||
notify_admin,
|
||||
mocker,
|
||||
@@ -95,43 +102,98 @@ def test_generate_notifications_csv_without_job(
|
||||
expected_content,
|
||||
):
|
||||
mocker.patch(
|
||||
'app.notification_api_client.get_notifications_for_service',
|
||||
"app.notification_api_client.get_notifications_for_service",
|
||||
side_effect=_get_notifications_csv(
|
||||
created_by_name=created_by_name,
|
||||
created_by_email_address="sender@email.gsa.gov",
|
||||
job_id=None,
|
||||
job_name=None
|
||||
)
|
||||
job_name=None,
|
||||
),
|
||||
)
|
||||
assert list(generate_notifications_csv(service_id=fake_uuid)) == expected_content
|
||||
|
||||
|
||||
@pytest.mark.parametrize('original_file_contents, expected_column_headers, expected_1st_row', [
|
||||
(
|
||||
"""
|
||||
@pytest.mark.parametrize(
|
||||
"original_file_contents, expected_column_headers, expected_1st_row",
|
||||
[
|
||||
(
|
||||
"""
|
||||
phone_number
|
||||
2028675309
|
||||
""",
|
||||
['Row number', 'phone_number', 'Template', 'Type', 'Job', 'Status', 'Time'],
|
||||
['1', '2028675309', 'foo', 'sms', 'bar.csv', 'Delivered', '1943-04-19 12:00:00'],
|
||||
),
|
||||
(
|
||||
"""
|
||||
["Row number", "phone_number", "Template", "Type", "Job", "Status", "Time"],
|
||||
[
|
||||
"1",
|
||||
"2028675309",
|
||||
"foo",
|
||||
"sms",
|
||||
"bar.csv",
|
||||
"Delivered",
|
||||
"1943-04-19 12:00:00",
|
||||
],
|
||||
),
|
||||
(
|
||||
"""
|
||||
phone_number, a, b, c
|
||||
2028675309, 🐜,🐝,🦀
|
||||
""",
|
||||
['Row number', 'phone_number', 'a', 'b', 'c', 'Template', 'Type', 'Job', 'Status', 'Time'],
|
||||
['1', '2028675309', '🐜', '🐝', '🦀', 'foo', 'sms', 'bar.csv', 'Delivered', '1943-04-19 12:00:00'],
|
||||
),
|
||||
(
|
||||
"""
|
||||
[
|
||||
"Row number",
|
||||
"phone_number",
|
||||
"a",
|
||||
"b",
|
||||
"c",
|
||||
"Template",
|
||||
"Type",
|
||||
"Job",
|
||||
"Status",
|
||||
"Time",
|
||||
],
|
||||
[
|
||||
"1",
|
||||
"2028675309",
|
||||
"🐜",
|
||||
"🐝",
|
||||
"🦀",
|
||||
"foo",
|
||||
"sms",
|
||||
"bar.csv",
|
||||
"Delivered",
|
||||
"1943-04-19 12:00:00",
|
||||
],
|
||||
),
|
||||
(
|
||||
"""
|
||||
"phone_number", "a", "b", "c"
|
||||
"2028675309","🐜,🐜","🐝,🐝","🦀"
|
||||
""",
|
||||
['Row number', 'phone_number', 'a', 'b', 'c', 'Template', 'Type', 'Job', 'Status', 'Time'],
|
||||
['1', '2028675309', '🐜,🐜', '🐝,🐝', '🦀', 'foo', 'sms', 'bar.csv', 'Delivered', '1943-04-19 12:00:00'],
|
||||
),
|
||||
])
|
||||
[
|
||||
"Row number",
|
||||
"phone_number",
|
||||
"a",
|
||||
"b",
|
||||
"c",
|
||||
"Template",
|
||||
"Type",
|
||||
"Job",
|
||||
"Status",
|
||||
"Time",
|
||||
],
|
||||
[
|
||||
"1",
|
||||
"2028675309",
|
||||
"🐜,🐜",
|
||||
"🐝,🐝",
|
||||
"🦀",
|
||||
"foo",
|
||||
"sms",
|
||||
"bar.csv",
|
||||
"Delivered",
|
||||
"1943-04-19 12:00:00",
|
||||
],
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_generate_notifications_csv_returns_correct_csv_file(
|
||||
notify_admin,
|
||||
mocker,
|
||||
@@ -141,11 +203,13 @@ def test_generate_notifications_csv_returns_correct_csv_file(
|
||||
expected_1st_row,
|
||||
):
|
||||
mocker.patch(
|
||||
'app.s3_client.s3_csv_client.s3download',
|
||||
"app.s3_client.s3_csv_client.s3download",
|
||||
return_value=original_file_contents,
|
||||
)
|
||||
csv_content = generate_notifications_csv(service_id='1234', job_id=fake_uuid, template_type='sms')
|
||||
csv_file = DictReader(StringIO('\n'.join(csv_content)))
|
||||
csv_content = generate_notifications_csv(
|
||||
service_id="1234", job_id=fake_uuid, template_type="sms"
|
||||
)
|
||||
csv_file = DictReader(StringIO("\n".join(csv_content)))
|
||||
assert csv_file.fieldnames == expected_column_headers
|
||||
assert next(csv_file) == dict(zip(expected_column_headers, expected_1st_row))
|
||||
|
||||
@@ -154,7 +218,7 @@ def test_generate_notifications_csv_only_calls_once_if_no_next_link(
|
||||
notify_admin,
|
||||
_get_notifications_csv_mock,
|
||||
):
|
||||
list(generate_notifications_csv(service_id='1234'))
|
||||
list(generate_notifications_csv(service_id="1234"))
|
||||
|
||||
assert _get_notifications_csv_mock.call_count == 1
|
||||
|
||||
@@ -165,9 +229,8 @@ def test_generate_notifications_csv_calls_twice_if_next_link(
|
||||
mocker,
|
||||
job_id,
|
||||
):
|
||||
|
||||
mocker.patch(
|
||||
'app.s3_client.s3_csv_client.s3download',
|
||||
"app.s3_client.s3_csv_client.s3download",
|
||||
return_value="""
|
||||
phone_number
|
||||
2028675304
|
||||
@@ -180,45 +243,47 @@ def test_generate_notifications_csv_calls_twice_if_next_link(
|
||||
2028675307
|
||||
2028675308
|
||||
2028675309
|
||||
"""
|
||||
""",
|
||||
)
|
||||
|
||||
service_id = '1234'
|
||||
service_id = "1234"
|
||||
response_with_links = _get_notifications_csv(rows=7, with_links=True)
|
||||
response_with_no_links = _get_notifications_csv(rows=3, row_number=8, with_links=False)
|
||||
response_with_no_links = _get_notifications_csv(
|
||||
rows=3, row_number=8, with_links=False
|
||||
)
|
||||
|
||||
mock_get_notifications = mocker.patch(
|
||||
'app.notification_api_client.get_notifications_for_service',
|
||||
"app.notification_api_client.get_notifications_for_service",
|
||||
side_effect=[
|
||||
response_with_links(service_id),
|
||||
response_with_no_links(service_id),
|
||||
]
|
||||
],
|
||||
)
|
||||
|
||||
csv_content = generate_notifications_csv(
|
||||
service_id=service_id,
|
||||
job_id=job_id or fake_uuid,
|
||||
template_type='sms',
|
||||
template_type="sms",
|
||||
)
|
||||
csv = list(DictReader(StringIO('\n'.join(csv_content))))
|
||||
csv = list(DictReader(StringIO("\n".join(csv_content))))
|
||||
|
||||
assert len(csv) == 10
|
||||
assert csv[0]['phone_number'] == '2028675304'
|
||||
assert csv[9]['phone_number'] == '2028675309'
|
||||
assert csv[0]["phone_number"] == "2028675304"
|
||||
assert csv[9]["phone_number"] == "2028675309"
|
||||
assert mock_get_notifications.call_count == 2
|
||||
# mock_calls[0][2] is the kwargs from first call
|
||||
assert mock_get_notifications.mock_calls[0][2]['page'] == 1
|
||||
assert mock_get_notifications.mock_calls[1][2]['page'] == 2
|
||||
assert mock_get_notifications.mock_calls[0][2]["page"] == 1
|
||||
assert mock_get_notifications.mock_calls[1][2]["page"] == 2
|
||||
|
||||
|
||||
MockRecipients = namedtuple(
|
||||
'RecipientCSV',
|
||||
"RecipientCSV",
|
||||
[
|
||||
'rows_with_bad_recipients',
|
||||
'rows_with_missing_data',
|
||||
'rows_with_message_too_long',
|
||||
'rows_with_empty_message'
|
||||
]
|
||||
"rows_with_bad_recipients",
|
||||
"rows_with_missing_data",
|
||||
"rows_with_message_too_long",
|
||||
"rows_with_empty_message",
|
||||
],
|
||||
)
|
||||
|
||||
|
||||
@@ -226,85 +291,64 @@ MockRecipients = namedtuple(
|
||||
"rows_with_bad_recipients, rows_with_missing_data, "
|
||||
"rows_with_message_too_long, rows_with_empty_message, template_type, expected_errors",
|
||||
[
|
||||
([], [], [], [], "sms", []),
|
||||
({2}, [], [], [], "sms", ["fix 1 phone number"]),
|
||||
({2, 4, 6}, [], [], [], "sms", ["fix 3 phone numbers"]),
|
||||
({1}, [], [], [], "email", ["fix 1 email address"]),
|
||||
({2, 4, 6}, [], [], [], "email", ["fix 3 email addresses"]),
|
||||
(
|
||||
[], [], [], [],
|
||||
'sms',
|
||||
[]
|
||||
{2},
|
||||
{3},
|
||||
[],
|
||||
[],
|
||||
"sms",
|
||||
["fix 1 phone number", "enter missing data in 1 row"],
|
||||
),
|
||||
(
|
||||
{2}, [], [], [],
|
||||
'sms',
|
||||
['fix 1 phone number']
|
||||
{2, 4, 6, 8},
|
||||
{3, 6, 9, 12},
|
||||
[],
|
||||
[],
|
||||
"sms",
|
||||
["fix 4 phone numbers", "enter missing data in 4 rows"],
|
||||
),
|
||||
({}, {}, {3}, [], "sms", ["shorten the message in 1 row"]),
|
||||
({}, {}, {3, 12}, [], "sms", ["shorten the messages in 2 rows"]),
|
||||
(
|
||||
{},
|
||||
{},
|
||||
{},
|
||||
{2},
|
||||
"sms",
|
||||
["check you have content for the empty message in 1 row"],
|
||||
),
|
||||
(
|
||||
{2, 4, 6}, [], [], [],
|
||||
'sms',
|
||||
['fix 3 phone numbers']
|
||||
{},
|
||||
{},
|
||||
{},
|
||||
{2, 4, 8},
|
||||
"sms",
|
||||
["check you have content for the empty messages in 3 rows"],
|
||||
),
|
||||
(
|
||||
{1}, [], [], [],
|
||||
'email',
|
||||
['fix 1 email address']
|
||||
),
|
||||
(
|
||||
{2, 4, 6}, [], [], [],
|
||||
'email',
|
||||
['fix 3 email addresses']
|
||||
),
|
||||
(
|
||||
{2}, {3}, [], [],
|
||||
'sms',
|
||||
[
|
||||
'fix 1 phone number',
|
||||
'enter missing data in 1 row'
|
||||
]
|
||||
),
|
||||
(
|
||||
{2, 4, 6, 8}, {3, 6, 9, 12}, [], [],
|
||||
'sms',
|
||||
[
|
||||
'fix 4 phone numbers',
|
||||
'enter missing data in 4 rows'
|
||||
]
|
||||
),
|
||||
(
|
||||
{}, {}, {3}, [],
|
||||
'sms',
|
||||
[
|
||||
'shorten the message in 1 row'
|
||||
]
|
||||
),
|
||||
(
|
||||
{}, {}, {3, 12}, [],
|
||||
'sms',
|
||||
[
|
||||
'shorten the messages in 2 rows'
|
||||
]
|
||||
),
|
||||
(
|
||||
{}, {}, {}, {2},
|
||||
'sms',
|
||||
[
|
||||
'check you have content for the empty message in 1 row'
|
||||
]
|
||||
),
|
||||
(
|
||||
{}, {}, {}, {2, 4, 8},
|
||||
'sms',
|
||||
[
|
||||
'check you have content for the empty messages in 3 rows'
|
||||
]
|
||||
),
|
||||
]
|
||||
],
|
||||
)
|
||||
def test_get_errors_for_csv(
|
||||
rows_with_bad_recipients, rows_with_missing_data, rows_with_message_too_long, rows_with_empty_message,
|
||||
rows_with_bad_recipients,
|
||||
rows_with_missing_data,
|
||||
rows_with_message_too_long,
|
||||
rows_with_empty_message,
|
||||
template_type,
|
||||
expected_errors
|
||||
expected_errors,
|
||||
):
|
||||
assert get_errors_for_csv(
|
||||
MockRecipients(
|
||||
rows_with_bad_recipients, rows_with_missing_data, rows_with_message_too_long, rows_with_empty_message
|
||||
),
|
||||
template_type
|
||||
) == expected_errors
|
||||
assert (
|
||||
get_errors_for_csv(
|
||||
MockRecipients(
|
||||
rows_with_bad_recipients,
|
||||
rows_with_missing_data,
|
||||
rows_with_message_too_long,
|
||||
rows_with_empty_message,
|
||||
),
|
||||
template_type,
|
||||
)
|
||||
== expected_errors
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user