darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-08-25 00:33:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into optimise-platform-admin-live-services

Browse Source
This commit is contained in:
Rebecca Law
2019-01-07 15:25:50 +00:00
parent bd9a6352fd fe498f9a79
commit 4522547753
19 changed files with 306 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
tests/app/conftest.py
View File

@@ -76,20 +76,26 @@ def service_factory(notify_db, notify_db_session):
user = create_user()
if not email_from:
email_from = service_name
service = sample_service(notify_db, notify_db_session, service_name, user, email_from=email_from)
service = create_service(
email_from=email_from,
service_name=service_name,
service_permissions=None,
user=user,
check_if_service_exists=True,
)
if template_type == 'email':
sample_template(
notify_db,
notify_db_session,
create_template(
service,
template_name="Template Name",
template_type=template_type,
subject_line=service.email_from,
service=service
subject=service.email_from,
)
else:
sample_template(
notify_db,
notify_db_session,
service=service
create_template(
service,
template_name="Template Name",
template_type='sms',
)
return service
@@ -158,6 +164,7 @@ def sample_service(
email_from=None,
permissions=None,
research_mode=None,
postage="second",
):
if user is None:
user = create_user()
@@ -170,6 +177,7 @@ def sample_service(
'restricted': restricted,
'email_from': email_from,
'created_by': user,
"postage": postage,
}
service = Service.query.filter_by(name=service_name).first()
if not service:
@@ -193,7 +201,8 @@ def sample_service(
def _sample_service_full_permissions(notify_db_session):
service = create_service(
service_name="sample service full permissions",
service_permissions=set(SERVICE_PERMISSION_TYPES)
service_permissions=set(SERVICE_PERMISSION_TYPES),
check_if_service_exists=True
)
create_inbound_number('12345', service_id=service.id)
return service
@@ -226,7 +235,7 @@ def sample_template(
if service is None:
service = Service.query.filter_by(name='Sample service').first()
if not service:
service = create_service(service_permissions=permissions)
service = create_service(service_permissions=permissions, check_if_service_exists=True)
if created_by is None:
created_by = create_user()
@@ -288,7 +297,7 @@ def sample_email_template(
if user is None:
user = create_user()
if service is None:
service = sample_service(notify_db, notify_db_session, permissions=permissions)
service = create_service(user=user, service_permissions=permissions, check_if_service_exists=True)
data = {
'name': template_name,
'template_type': template_type,
@@ -343,7 +352,7 @@ def sample_api_key(notify_db,
key_type=KEY_TYPE_NORMAL,
name=None):
if service is None:
service = sample_service(notify_db, notify_db_session)
service = create_service(check_if_service_exists=True)
data = {'service': service, 'name': name or uuid.uuid4(), 'created_by': service.created_by, 'key_type': key_type}
api_key = ApiKey(**data)
save_model_api_key(api_key)
@@ -375,10 +384,9 @@ def sample_job(
archived=False
):
if service is None:
service = sample_service(notify_db, notify_db_session)
service = create_service(check_if_service_exists=True)
if template is None:
template = sample_template(notify_db, notify_db_session,
service=service)
template = create_template(service=service)
data = {
'id': uuid.uuid4(),
'service_id': service.id,
@@ -435,7 +443,7 @@ def sample_email_job(notify_db,
service=None,
template=None):
if service is None:
service = sample_service(notify_db, notify_db_session)
service = create_service(check_if_service_exists=True)
if template is None:
template = sample_email_template(
notify_db,
@@ -543,9 +551,9 @@ def sample_notification(
if created_at is None:
created_at = datetime.utcnow()
if service is None:
service = sample_service(notify_db, notify_db_session)
service = create_service(check_if_service_exists=True)
if template is None:
template = sample_template(notify_db, notify_db_session, service=service)
template = create_template(service=service)
if job is None and api_key is None:
# we didn't specify in test - lets create it
@@ -632,7 +640,7 @@ def sample_notification_with_api_key(notify_db, notify_db_session):
@pytest.fixture(scope='function')
def sample_email_notification(notify_db, notify_db_session):
created_at = datetime.utcnow()
service = sample_service(notify_db, notify_db_session)
service = create_service(check_if_service_exists=True)
template = sample_email_template(notify_db, notify_db_session, service=service)
job = sample_job(notify_db, notify_db_session, service=service, template=template)
@@ -734,7 +742,7 @@ def sample_invited_user(notify_db,
to_email_address=None):
if service is None:
service = sample_service(notify_db, notify_db_session)
service = create_service(check_if_service_exists=True)
if to_email_address is None:
to_email_address = 'invited_user@digital.gov.uk'
@@ -774,7 +782,7 @@ def sample_permission(notify_db,
'permission': permission
}
if service is None:
service = sample_service(notify_db, notify_db_session)
service = create_service(check_if_service_exists=True)
if service:
data['service'] = service
p_model = Permission.query.filter_by(
@@ -795,7 +803,7 @@ def sample_user_service_permission(
if user is None:
user = create_user()
if service is None:
service = sample_service(notify_db, notify_db_session, user=user)
service = create_service(user=user, check_if_service_exists=True)
data = {
'user': user,
'service': service,
@@ -1029,7 +1037,7 @@ def notify_service(notify_db, notify_db_session):
@pytest.fixture(scope='function')
def sample_service_whitelist(notify_db, notify_db_session, service=None, email_address=None, mobile_number=None):
if service is None:
service = sample_service(notify_db, notify_db_session)
service = create_service(check_if_service_exists=True)
if email_address:
whitelisted_user = ServiceWhitelist.from_string(service.id, EMAIL_TYPE, email_address)
@@ -1054,7 +1062,7 @@ def sample_provider_rate(notify_db, notify_db_session, valid_from=None, rate=Non
@pytest.fixture
def sample_inbound_numbers(notify_db, notify_db_session, sample_service):
service = create_service(service_name='sample service 2')
service = create_service(service_name='sample service 2', check_if_service_exists=True)
inbound_numbers = list()
inbound_numbers.append(create_inbound_number(number='1', provider='mmg'))
inbound_numbers.append(create_inbound_number(number='2', provider='mmg', active=False, service_id=service.id))

2
tests/app/dao/notification_dao/test_notification_dao_template_usage.py
View File

@@ -22,7 +22,7 @@ from tests.app.db import (
def test_last_template_usage_should_get_right_data(sample_notification):
results = dao_get_last_template_usage(sample_notification.template_id, 'sms', sample_notification.service_id)
assert results.template.name == 'Template Name'
assert results.template.name == 'sms Template Name'
assert results.template.template_type == 'sms'
assert results.created_at == sample_notification.created_at
assert results.template_id == sample_notification.template_id

2
tests/app/dao/test_templates_dao.py
View File

@@ -153,7 +153,7 @@ def test_dao_update_template_reply_to_none_to_some(sample_service, sample_user):
assert template_history.updated_at == updated.updated_at
def test_dao_update_tempalte_reply_to_some_to_some(sample_service, sample_user):
def test_dao_update_template_reply_to_some_to_some(sample_service, sample_user):
letter_contact = create_letter_contact(sample_service, 'Edinburgh, ED1 1AA')
letter_contact_2 = create_letter_contact(sample_service, 'London, N1 1DE')

38
tests/app/db.py
View File

@@ -17,7 +17,7 @@ from app.dao.service_data_retention_dao import insert_service_data_retention
from app.dao.service_inbound_api_dao import save_service_inbound_api
from app.dao.service_permissions_dao import dao_add_service_permission
from app.dao.service_sms_sender_dao import update_existing_sms_sender_with_inbound_number, dao_update_service_sms_sender
from app.dao.services_dao import dao_create_service
from app.dao.services_dao import dao_create_service, dao_add_user_to_service
from app.dao.templates_dao import dao_create_template, dao_update_template
from app.dao.users_dao import save_model_user
from app.models import (
@@ -81,21 +81,29 @@ def create_service(
prefix_sms=True,
message_limit=1000,
organisation_type='central',
postage='second',
check_if_service_exists=False
):
service = Service(
name=service_name,
message_limit=message_limit,
restricted=restricted,
email_from=email_from if email_from else service_name.lower().replace(' ', '.'),
created_by=user or create_user(email='{}@digital.cabinet-office.gov.uk'.format(uuid.uuid4())),
prefix_sms=prefix_sms,
organisation_type=organisation_type,
)
if check_if_service_exists:
service = Service.query.filter_by(name=service_name).first()
if (not check_if_service_exists) or (check_if_service_exists and not service):
service = Service(
name=service_name,
message_limit=message_limit,
restricted=restricted,
email_from=email_from if email_from else service_name.lower().replace(' ', '.'),
created_by=user if user else create_user(email='{}@digital.cabinet-office.gov.uk'.format(uuid.uuid4())),
prefix_sms=prefix_sms,
organisation_type=organisation_type,
postage=postage
)
dao_create_service(service, service.created_by, service_id, service_permissions=service_permissions)
dao_create_service(service, service.created_by, service_id, service_permissions=service_permissions)
service.active = active
service.research_mode = research_mode
service.active = active
service.research_mode = research_mode
else:
if user and user not in service.users:
dao_add_user_to_service(service, user)
return service
@@ -140,6 +148,7 @@ def create_template(
hidden=False,
archived=False,
folder=None,
postage=None,
):
data = {
'name': template_name or '{} Template Name'.format(template_type),
@@ -150,6 +159,7 @@ def create_template(
'reply_to': reply_to,
'hidden': hidden,
'folder': folder,
'postage': postage,
}
if template_type != SMS_TYPE:
data['subject'] = subject

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

@@ -13,7 +13,9 @@ from app.models import (
Notification,
NotificationHistory,
ScheduledNotification,
Template
Template,
LETTER_TYPE,
CHOOSE_POSTAGE
)
from app.notifications.process_notifications import (
create_content_for_notification,
@@ -27,6 +29,8 @@ from app.utils import cache_key_for_service_template_counter
from app.v2.errors import BadRequestError
from tests.app.conftest import sample_api_key as create_api_key
from tests.app.db import create_service, create_template
def test_create_content_for_notification_passes(sample_email_template):
template = Template.query.get(sample_email_template.id)
@@ -477,6 +481,41 @@ def test_persist_email_notification_stores_normalised_email(
assert persisted_notification.normalised_to == expected_recipient_normalised
@pytest.mark.parametrize(
"service_permissions, template_postage, expected_postage",
[
([LETTER_TYPE], "first", "second"),
([LETTER_TYPE, CHOOSE_POSTAGE], "first", "first"),
([LETTER_TYPE, CHOOSE_POSTAGE], None, "second"),
]
)
def test_persist_letter_notification_finds_correct_postage(
mocker,
notify_db,
notify_db_session,
service_permissions,
template_postage,
expected_postage
):
service = create_service(service_permissions=service_permissions, postage="second")
api_key = create_api_key(notify_db, notify_db_session, service=service)
template = create_template(service, template_type=LETTER_TYPE, postage=template_postage)
mocker.patch('app.dao.templates_dao.dao_get_template_by_id', return_value=template)
persist_notification(
template_id=template.id,
template_version=template.version,
recipient="Jane Doe, 10 Downing Street, London",
service=service,
personalisation=None,
notification_type=LETTER_TYPE,
api_key_id=api_key.id,
key_type=api_key.key_type,
)
persisted_notification = Notification.query.all()[0]
assert persisted_notification.postage == expected_postage
@pytest.mark.parametrize('utc_time, day_in_key', [
('2016-01-01 23:00:00', '2016-01-01'),
('2016-06-01 22:59:00', '2016-06-01'),

2
tests/app/notifications/test_rest.py
View File

@@ -153,7 +153,7 @@ def test_get_all_notifications(client, sample_notification):
assert notifications['notifications'][0]['to'] == '+447700900855'
assert notifications['notifications'][0]['service'] == str(sample_notification.service_id)
assert notifications['notifications'][0]['body'] == "This is a template:\nwith a newline"
assert notifications['notifications'][0]['body'] == 'Dear Sir/Madam, Hello. Yours Truly, The Government.'
def test_normal_api_key_returns_notifications_created_from_jobs_and_from_api(

85
tests/app/template/test_rest.py
View File

@@ -18,7 +18,8 @@ from app.models import (
LETTER_TYPE,
SMS_TYPE,
Template,
TemplateHistory
TemplateHistory,
CHOOSE_POSTAGE
)
from app.dao.templates_dao import dao_get_template_by_id, dao_redact_template
@@ -43,7 +44,7 @@ from tests.conftest import set_config_values
def test_should_create_a_new_template_for_a_service(
client, sample_user, template_type, subject
):
service = create_service(service_permissions=[template_type])
service = create_service(service_permissions=[template_type, CHOOSE_POSTAGE])
data = {
'name': 'my template',
'template_type': template_type,
@@ -53,6 +54,8 @@ def test_should_create_a_new_template_for_a_service(
}
if subject:
data.update({'subject': subject})
if template_type == LETTER_TYPE:
data.update({'postage': 'first'})
data = json.dumps(data)
auth_header = create_authorization_header()
@@ -76,6 +79,11 @@ def test_should_create_a_new_template_for_a_service(
else:
assert not json_resp['data']['subject']
if template_type == LETTER_TYPE:
assert json_resp['data']['postage'] == 'first'
else:
assert not json_resp['data']['postage']
template = Template.query.get(json_resp['data']['id'])
from app.schemas import template_schema
assert sorted(json_resp['data']) == sorted(template_schema.dump(template).data)
@@ -210,6 +218,34 @@ def test_should_raise_error_on_create_if_no_permission(
assert json_resp['message'] == expected_error
def test_should_raise_error_on_create_if_no_choose_postage_permission(client, sample_user):
service = create_service(service_permissions=[LETTER_TYPE])
data = {
'name': 'my template',
'template_type': LETTER_TYPE,
'content': 'template content',
'service': str(service.id),
'created_by': str(sample_user.id),
'subject': "Some letter",
'postage': 'first',
}
data = json.dumps(data)
auth_header = create_authorization_header()
response = client.post(
'/service/{}/template'.format(service.id),
headers=[('Content-Type', 'application/json'), auth_header],
data=data
)
json_resp = json.loads(response.get_data(as_text=True))
assert response.status_code == 403
assert json_resp['result'] == 'error'
assert json_resp['message'] == {
"template_postage": ["Setting postage on templates is not enabled for this service."]
}
@pytest.mark.parametrize('template_factory, expected_error', [
(sample_template_without_sms_permission, {'template_type': ['Updating text message templates is not allowed']}),
(sample_template_without_email_permission, {'template_type': ['Updating email templates is not allowed']}),
@@ -239,6 +275,33 @@ def test_should_be_error_on_update_if_no_permission(
assert json_resp['message'] == expected_error
def test_should_be_error_on_update_if_no_choose_postage_permission(client, sample_user):
service = create_service(service_name='some_service', service_permissions=[LETTER_TYPE])
template = create_template(service, template_type=LETTER_TYPE)
data = {
'content': 'new template content',
'created_by': str(sample_user.id),
'postage': 'first'
}
data = json.dumps(data)
auth_header = create_authorization_header()
update_response = client.post(
'/service/{}/template/{}'.format(
template.service_id, template.id),
headers=[('Content-Type', 'application/json'), auth_header],
data=data
)
json_resp = json.loads(update_response.get_data(as_text=True))
assert update_response.status_code == 403
assert json_resp['result'] == 'error'
assert json_resp['message'] == {
"template_postage": ["Setting postage on templates is not enabled for this service."]
}
def test_should_error_if_created_by_missing(client, sample_user, sample_service):
service_id = str(sample_service.id)
data = {
@@ -301,16 +364,19 @@ def test_must_have_a_subject_on_an_email_or_letter_template(client, sample_user,
assert json_resp['errors'][0]["message"] == 'subject is a required property'
def test_update_should_update_a_template(client, sample_user, sample_template):
def test_update_should_update_a_template(client, sample_user):
service = create_service(service_permissions=[LETTER_TYPE, CHOOSE_POSTAGE])
template = create_template(service, template_type="letter", postage="second")
data = {
'content': 'my template has new content <script type="text/javascript">alert("foo")</script>',
'created_by': str(sample_user.id)
'content': 'my template has new content, swell!',
'created_by': str(sample_user.id),
'postage': 'first'
}
data = json.dumps(data)
auth_header = create_authorization_header()
update_response = client.post(
'/service/{}/template/{}'.format(sample_template.service_id, sample_template.id),
'/service/{}/template/{}'.format(service.id, template.id),
headers=[('Content-Type', 'application/json'), auth_header],
data=data
)
@@ -318,10 +384,11 @@ def test_update_should_update_a_template(client, sample_user, sample_template):
assert update_response.status_code == 200
update_json_resp = json.loads(update_response.get_data(as_text=True))
assert update_json_resp['data']['content'] == (
'my template has new content <script type="text/javascript">alert("foo")</script>'
'my template has new content, swell!'
)
assert update_json_resp['data']['name'] == sample_template.name
assert update_json_resp['data']['template_type'] == sample_template.template_type
assert update_json_resp['data']['postage'] == 'first'
assert update_json_resp['data']['name'] == template.name
assert update_json_resp['data']['template_type'] == template.template_type
assert update_json_resp['data']['version'] == 2

2
tests/app/template_statistics/test_rest.py
View File

@@ -59,7 +59,7 @@ def test_get_template_statistics_for_service_by_day_returns_template_info(admin_
assert json_resp['data'][0]['count'] == 1
assert json_resp['data'][0]['template_id'] == str(sample_notification.template_id)
assert json_resp['data'][0]['template_name'] == 'Template Name'
assert json_resp['data'][0]['template_name'] == 'sms Template Name'
assert json_resp['data'][0]['template_type'] == 'sms'
assert json_resp['data'][0]['is_precompiled_letter'] is False

24
tests/app/v2/notifications/test_post_letter_notifications.py
View File

@@ -20,6 +20,7 @@ from app.models import (
NOTIFICATION_DELIVERED,
NOTIFICATION_PENDING_VIRUS_CHECK,
SMS_TYPE,
CHOOSE_POSTAGE
)
from app.schema_validation import validate
from app.v2.errors import RateLimitError
@@ -95,12 +96,23 @@ def test_post_letter_notification_returns_201(client, sample_letter_template, mo
mock.assert_called_once_with([str(notification.id)], queue=QueueNames.CREATE_LETTERS_PDF)
@pytest.mark.parametrize('postage', ['first', 'second'])
def test_post_letter_notification_sets_postage(client, sample_letter_template, mocker, postage):
sample_letter_template.service.postage = postage
@pytest.mark.parametrize('service_permissions, service_postage, template_postage, expected_postage', [
([LETTER_TYPE], "second", "first", "second"),
([LETTER_TYPE], "first", "second", "first"),
([LETTER_TYPE], "first", None, "first"),
([LETTER_TYPE, CHOOSE_POSTAGE], "second", "first", "first"),
([LETTER_TYPE, CHOOSE_POSTAGE], "second", None, "second"),
([LETTER_TYPE, CHOOSE_POSTAGE], "second", "second", "second"),
([LETTER_TYPE, CHOOSE_POSTAGE], "first", "second", "second"),
])
def test_post_letter_notification_sets_postage(
client, notify_db_session, mocker, service_permissions, service_postage, template_postage, expected_postage
):
service = create_service(service_permissions=service_permissions, postage=service_postage)
template = create_template(service, template_type="letter", postage=template_postage)
mocker.patch('app.celery.tasks.letters_pdf_tasks.create_letters_pdf.apply_async')
data = {
'template_id': str(sample_letter_template.id),
'template_id': str(template.id),
'personalisation': {
'address_line_1': 'Her Royal Highness Queen Elizabeth II',
'address_line_2': 'Buckingham Palace',
@@ -110,11 +122,11 @@ def test_post_letter_notification_sets_postage(client, sample_letter_template, m
}
}
resp_json = letter_request(client, data, service_id=sample_letter_template.service_id)
resp_json = letter_request(client, data, service_id=service.id)
assert validate(resp_json, post_letter_response) == resp_json
notification = Notification.query.one()
assert notification.postage == postage
assert notification.postage == expected_postage
@pytest.mark.parametrize('env', [