def test_main_catches_email_errors_and_returns_ids(data_api_client,
notify_client):
logger = mock.Mock()
notify_client.send_email.side_effect = [EmailError, True]
data_api_client.find_brief_responses_iter.side_effect = [
[_get_dummy_brief_response(4321, AWARDED_BRIEFS[0], awarded=True)],
[_get_dummy_brief_response(1234, AWARDED_BRIEFS[0], awarded=False)],
]
assert not tested_script.main(data_api_client, notify_client,
'notify_template_id', 'preview', logger)
assert logger.error.call_args_list == [
mock.call(
'Email sending failed for BriefResponse {brief_response_id} (Brief ID {brief_id})',
extra={
"brief_id": 123,
"brief_response_id": 4321
}),
mock.call(
"Email sending failed for the following {count} BriefResponses: {brief_response_ids}",
extra={
'brief_response_ids': '4321',
'count': 1
})
]
assert logger.info.call_args_list == [
mock.call(
"{dry_run}EMAIL: Award of Brief Response ID: {brief_response_id} to {email_address}",
extra={
'dry_run': '',
'brief_response_id': 1234,
'email_address': hash_string('*****@*****.**'),
})
]
def test_main_uses_awarded_at_date_param_if_provided(data_api_client,
notify_client):
data_api_client.find_brief_responses_iter.side_effect = [
[ # Awarded brief response for the awarded brief
_get_dummy_brief_response(4321, AWARDED_BRIEFS[0], awarded=True),
],
[
# No 'losing' brief responses for the awarded brief
],
[ # Brief response for a cancelled brief
_get_dummy_brief_response(4321, CANCELLED_BRIEFS[0])
],
[ # Brief response for an unsuccessful brief
_get_dummy_brief_response(4321, UNSUCCESSFUL_BRIEFS[0])
]
]
data_api_client.find_briefs_iter.side_effect = [
CANCELLED_BRIEFS, UNSUCCESSFUL_BRIEFS
]
with freeze_time('2018-02-02'):
assert tested_script.main(data_api_client,
notify_client,
"notify_template_id",
"preview",
mock.Mock(),
awarded_at="2018-01-01")
assert data_api_client.find_brief_responses_iter.call_args_list == [
mock.call(awarded_at="2018-01-01"),
mock.call(brief_id=123, status="submitted"),
mock.call(brief_id=333),
mock.call(brief_id=555)
]
def test_main_calls_get_brief_response_when_brief_response_ids_specified(
data_api_client, notify_client):
"""Script should only look up brief responses for a given list of ids if they are specified."""
data_api_client.get_brief_response.side_effect = [{
'briefResponses':
_get_dummy_brief_response(4321, AWARDED_BRIEFS[0], awarded=True)
}, {
'briefResponses':
_get_dummy_brief_response(4322, AWARDED_BRIEFS[0])
}]
with freeze_time('2018-01-02'):
assert tested_script.main(data_api_client,
notify_client,
'notify_template_id',
'preview',
mock.Mock(),
brief_response_ids=[4321, 4322])
assert data_api_client.get_brief_response.call_args_list == [
mock.call(4321), mock.call(4322)
]
assert notify_client.send_email.call_args_list == [
mock.call("*****@*****.**",
"notify_template_id",
EXPECTED_BRIEF_CONTEXT,
allow_resend=False),
mock.call("*****@*****.**",
"notify_template_id",
EXPECTED_BRIEF_CONTEXT,
allow_resend=False)
]
def test_main_does_not_catch_email_template_errors(data_api_client,
notify_client):
logger = mock.Mock()
notify_client.send_email.side_effect = EmailTemplateError
data_api_client.find_brief_responses_iter.side_effect = [
[_get_dummy_brief_response(4321, AWARDED_BRIEFS[0], awarded=True)],
[_get_dummy_brief_response(1234, AWARDED_BRIEFS[0], awarded=False)],
]
with pytest.raises(EmailTemplateError):
tested_script.main(data_api_client, notify_client,
'notify_template_id', 'preview', logger)
assert logger.error.call_args_list == [
mock.call(
'Email sending failed for BriefResponse {brief_response_id} (Brief ID {brief_id})',
extra={
"brief_id": 123,
"brief_response_id": 4321
}),
]
assert logger.info.call_args_list == []
brief_response_ids = arguments.get('--brief_response_ids', None)
dry_run = arguments['--dry-run']
verbose = arguments['--verbose']
# Set defaults, instantiate clients
logger = logging_helpers.configure_logger(
{"dmapiclient": logging.
INFO} if verbose else {"dmapiclient": logging.WARN})
notify_client = scripts_notify_client(govuk_notify_api_key, logger=logger)
data_api_client = DataAPIClient(
base_url=get_api_endpoint_from_stage(stage),
auth_token=get_auth_token('api', stage))
list_of_brief_response_ids = list(map(
int, brief_response_ids.split(','))) if brief_response_ids else None
# Do send
ok = main(
data_api_client=data_api_client,
mail_client=notify_client,
template_id=govuk_notify_template_id,
stage=stage,
logger=logger,
awarded_at=awarded_at,
brief_response_ids=list_of_brief_response_ids,
dry_run=dry_run,
)
if not ok:
sys.exit(1)
def test_main_calls_correct_methods(data_api_client, create_context_for_brief,
notify_client):
data_api_client.find_brief_responses_iter.side_effect = [
[ # Awarded brief responses for each awarded brief
_get_dummy_brief_response(4321, AWARDED_BRIEFS[0], awarded=True),
_get_dummy_brief_response(4322, AWARDED_BRIEFS[1], awarded=True),
],
[ # 'Losing' brief responses for the first awarded brief
_get_dummy_brief_response(4322, AWARDED_BRIEFS[0]),
_get_dummy_brief_response(4323,
AWARDED_BRIEFS[0],
valid_email=False),
],
[ # No 'losing' brief responses for the 2nd awarded brief
],
[ # One brief response for the cancelled brief
_get_dummy_brief_response(4325, CANCELLED_BRIEFS[0]),
],
[ # One brief response for the unsuccessful brief
_get_dummy_brief_response(4326, UNSUCCESSFUL_BRIEFS[0]),
],
]
data_api_client.find_briefs_iter.side_effect = [
CANCELLED_BRIEFS, UNSUCCESSFUL_BRIEFS
]
tested_script._create_context_for_brief.return_value = EXPECTED_BRIEF_CONTEXT
with freeze_time('2018-01-02'):
assert tested_script.main(data_api_client, notify_client,
"notify_template_id", "preview", mock.Mock())
assert data_api_client.find_brief_responses_iter.call_args_list == [
mock.call(awarded_at="2018-01-01"),
mock.call(brief_id=123, status='submitted'),
mock.call(brief_id=456, status='submitted'),
mock.call(brief_id=333),
mock.call(brief_id=555)
]
assert create_context_for_brief.call_args_list == [
mock.call("preview", AWARDED_BRIEFS[0]),
mock.call("preview", AWARDED_BRIEFS[0]),
mock.call("preview", AWARDED_BRIEFS[1]),
mock.call("preview", CANCELLED_BRIEFS[0]),
mock.call("preview", UNSUCCESSFUL_BRIEFS[0])
]
# Only email if a valid email address is present
assert notify_client.send_email.call_args_list == [
mock.call("*****@*****.**",
"notify_template_id",
EXPECTED_BRIEF_CONTEXT,
allow_resend=False),
mock.call("*****@*****.**",
"notify_template_id",
EXPECTED_BRIEF_CONTEXT,
allow_resend=False),
mock.call("*****@*****.**",
"notify_template_id",
EXPECTED_BRIEF_CONTEXT,
allow_resend=False),
mock.call("*****@*****.**",
"notify_template_id",
EXPECTED_BRIEF_CONTEXT,
allow_resend=False),
mock.call("*****@*****.**",
"notify_template_id",
EXPECTED_BRIEF_CONTEXT,
allow_resend=False)
]
# Single BriefResponse API request not called
assert data_api_client.get_brief_response.called is False