Merge branch 'master' of github.com:alphagov/notifications-api into return-service_sms_sender_value

tests/app/conftest.py

@@ -137,7 +137,8 @@ def sample_service(
     limit=1000,
     email_from=None,
     permissions=[SMS_TYPE, EMAIL_TYPE],
-    research_mode=None
+    research_mode=None,
+    letter_contact_block='London,\nSW1A 1AA',
 ):
     if user is None:
         user = create_user()
@@ -150,7 +151,7 @@ def sample_service(
         'restricted': restricted,
         'email_from': email_from,
         'created_by': user,
-        'letter_contact_block': 'London,\nSW1A 1AA'
+        'letter_contact_block': letter_contact_block,
     }
     service = Service.query.filter_by(name=service_name).first()
     if not service:
@@ -181,6 +182,11 @@ def sample_service_full_permissions(notify_db, notify_db_session):
     )
 
 
+@pytest.fixture(scope='function')
+def sample_service_custom_letter_contact_block(notify_db, notify_db_session):
+    return sample_service(notify_db, notify_db_session, letter_contact_block='((contact block))')
+
+
 @pytest.fixture(scope='function')
 def sample_template(
     notify_db,

tests/app/dao/test_service_letter_contact_dao.py

@@ -0,0 +1,202 @@
+import pytest
+
+from app.dao.service_letter_contact_dao import (
+    add_letter_contact_for_service,
+    create_or_update_letter_contact,
+    dao_get_letter_contacts_by_service_id,
+    update_letter_contact
+)
+from app.errors import InvalidRequest
+from app.models import ServiceLetterContact
+from tests.app.db import create_letter_contact, create_service
+
+
+def test_dao_get_letter_contacts_by_service_id(notify_db_session):
+    service = create_service()
+    default_letter_contact = create_letter_contact(service=service, contact_block='Edinburgh, ED1 1AA')
+    another_letter_contact = create_letter_contact(service=service, contact_block='Cardiff, CA1 2DB')
+
+    results = dao_get_letter_contacts_by_service_id(service_id=service.id)
+
+    assert len(results) == 2
+    assert default_letter_contact in results
+    assert another_letter_contact in results
+
+
+def test_create_or_update_letter_contact_creates_new_entry(notify_db_session):
+    service = create_service()
+
+    create_or_update_letter_contact(service.id, 'Cardiff, CA1 2DB')
+
+    letter_contacts = dao_get_letter_contacts_by_service_id(service.id)
+
+    assert ServiceLetterContact.query.count() == 1
+    assert letter_contacts[0].service.id == service.id
+    assert letter_contacts[0].contact_block == 'Cardiff, CA1 2DB'
+
+
+def test_create_or_update_letter_contact_does_not_create_another_entry(notify_db_session):
+    service = create_service()
+    create_letter_contact(service, 'London, NW1 2DB')
+    create_or_update_letter_contact(service.id, 'Bristol, BR1 2DB')
+
+    letter_contacts = dao_get_letter_contacts_by_service_id(service.id)
+
+    assert len(letter_contacts) == 1
+
+
+def test_create_or_update_letter_contact_updates_existing_entry(notify_db_session):
+    service = create_service()
+    create_letter_contact(service, 'London, NW1 2DB')
+
+    create_or_update_letter_contact(service.id, 'Bristol, BR1 2DB')
+
+    letter_contact = dao_get_letter_contacts_by_service_id(service.id)
+
+    assert len(letter_contact) == 1
+    assert letter_contact[0].service.id == service.id
+    assert letter_contact[0].contact_block == 'Bristol, BR1 2DB'
+
+
+def test_create_or_update_letter_contact_raises_exception_if_multiple_contact_blocks_exist(notify_db_session):
+    service = create_service()
+    create_letter_contact(service=service, contact_block='Edinburgh, ED1 1AA')
+    create_letter_contact(service=service, contact_block='Manchester, MA1 2BB', is_default=False)
+
+    with pytest.raises(expected_exception=InvalidRequest) as e:
+        create_or_update_letter_contact(service_id=service.id, contact_block='Swansea, SN1 3CC')
+    assert e.value.message == "Multiple letter contacts were found, this method should not be used."
+
+
+def test_create_or_update_letter_contact_raises_exception_if_multiple_letter_contacts_exist(notify_db_session):
+    service = create_service()
+    create_letter_contact(service=service, contact_block='Edinburgh, ED1 1AA')
+    create_letter_contact(service=service, contact_block='Manchester, MA1 2BB', is_default=False)
+
+    with pytest.raises(expected_exception=InvalidRequest) as e:
+        create_or_update_letter_contact(service_id=service.id, contact_block='Swansea, SN1 3CC')
+    assert e.value.message == "Multiple letter contacts were found, this method should not be used."
+
+
+def test_add_letter_contact_for_service_creates_additional_letter_contact_for_service(notify_db_session):
+    service = create_service()
+
+    create_letter_contact(service=service, contact_block='Edinburgh, ED1 1AA')
+    add_letter_contact_for_service(service_id=service.id, contact_block='Swansea, SN1 3CC', is_default=False)
+
+    results = dao_get_letter_contacts_by_service_id(service_id=service.id)
+
+    assert len(results) == 2
+
+    assert results[0].contact_block == 'Edinburgh, ED1 1AA'
+    assert results[0].is_default
+
+    assert results[1].contact_block == 'Swansea, SN1 3CC'
+    assert not results[1].is_default
+
+
+def test_add_another_letter_contact_as_default_overrides_existing(notify_db_session):
+    service = create_service()
+
+    create_letter_contact(service=service, contact_block='Edinburgh, ED1 1AA')
+    add_letter_contact_for_service(service_id=service.id, contact_block='Swansea, SN1 3CC', is_default=True)
+
+    results = dao_get_letter_contacts_by_service_id(service_id=service.id)
+
+    assert len(results) == 2
+
+    assert results[0].contact_block == 'Edinburgh, ED1 1AA'
+    assert not results[0].is_default
+
+    assert results[1].contact_block == 'Swansea, SN1 3CC'
+    assert results[1].is_default
+
+
+def test_add_letter_contact_does_not_override_default(notify_db_session):
+    service = create_service()
+
+    add_letter_contact_for_service(service_id=service.id, contact_block='Edinburgh, ED1 1AA', is_default=True)
+    add_letter_contact_for_service(service_id=service.id, contact_block='Swansea, SN1 3CC', is_default=False)
+
+    results = dao_get_letter_contacts_by_service_id(service_id=service.id)
+
+    assert len(results) == 2
+
+    assert results[0].contact_block == 'Edinburgh, ED1 1AA'
+    assert results[0].is_default
+
+    assert results[1].contact_block == 'Swansea, SN1 3CC'
+    assert not results[1].is_default
+
+
+def test_add_letter_contact_with_no_default_raises_exception(notify_db_session):
+    service = create_service()
+    with pytest.raises(expected_exception=InvalidRequest):
+        add_letter_contact_for_service(
+            service_id=service.id,
+            contact_block='Swansea, SN1 3CC',
+            is_default=False
+        )
+
+
+def test_add_letter_contact_when_multiple_defaults_exist_raises_exception(notify_db_session):
+    service = create_service()
+    create_letter_contact(service=service, contact_block='Edinburgh, ED1 1AA')
+    create_letter_contact(service=service, contact_block='Aberdeen, AB12 23X')
+
+    with pytest.raises(Exception):
+        add_letter_contact_for_service(service_id=service.id, contact_block='Swansea, SN1 3CC', is_default=False)
+
+
+def test_can_update_letter_contact(notify_db_session):
+    service = create_service()
+    letter_contact = create_letter_contact(service=service, contact_block='Aberdeen, AB12 23X')
+
+    update_letter_contact(
+        service_id=service.id,
+        letter_contact_id=letter_contact.id,
+        contact_block='Warwick, W14 TSR',
+        is_default=True
+    )
+
+    updated_letter_contact = ServiceLetterContact.query.get(letter_contact.id)
+
+    assert updated_letter_contact.contact_block == 'Warwick, W14 TSR'
+    assert updated_letter_contact.updated_at
+    assert updated_letter_contact.is_default
+
+
+def test_update_letter_contact_as_default_overides_existing_default(notify_db_session):
+    service = create_service()
+
+    create_letter_contact(service=service, contact_block='Aberdeen, AB12 23X')
+    second_letter_contact = create_letter_contact(service=service, contact_block='Swansea, SN1 3CC', is_default=False)
+
+    update_letter_contact(
+        service_id=service.id,
+        letter_contact_id=second_letter_contact.id,
+        contact_block='Warwick, W14 TSR',
+        is_default=True
+    )
+
+    results = dao_get_letter_contacts_by_service_id(service_id=service.id)
+    assert len(results) == 2
+
+    assert results[0].contact_block == 'Aberdeen, AB12 23X'
+    assert not results[0].is_default
+
+    assert results[1].contact_block == 'Warwick, W14 TSR'
+    assert results[1].is_default
+
+
+def test_update_letter_contact_unset_default_for_only_letter_contact_raises_exception(notify_db_session):
+    service = create_service()
+    only_letter_contact = create_letter_contact(service=service, contact_block='Aberdeen, AB12 23X')
+
+    with pytest.raises(expected_exception=InvalidRequest):
+        update_letter_contact(
+            service_id=service.id,
+            letter_contact_id=only_letter_contact.id,
+            contact_block='Warwick, W14 TSR',
+            is_default=False
+        )

tests/app/service/test_rest.py

@@ -12,7 +12,7 @@ from app.dao.services_dao import dao_remove_user_from_service
 from app.dao.templates_dao import dao_redact_template
 from app.dao.users_dao import save_model_user
 from app.models import (
-    User, Organisation, Service, ServicePermission, Notification, ServiceEmailReplyTo,
+    User, Organisation, Service, ServicePermission, Notification, ServiceEmailReplyTo, ServiceLetterContact,
     DVLA_ORG_LAND_REGISTRY,
     KEY_TYPE_NORMAL, KEY_TYPE_TEAM, KEY_TYPE_TEST,
     EMAIL_TYPE, SMS_TYPE, LETTER_TYPE, INTERNATIONAL_SMS_TYPE, INBOUND_SMS_TYPE,
@@ -2304,3 +2304,21 @@ def test_get_email_reply_to_address(client, notify_db, notify_db_session):
 
     assert response.status_code == 200
     assert json.loads(response.get_data(as_text=True)) == reply_to.serialize()
+
+
+def test_update_service_letter_contact_upserts_letter_contact(admin_request, sample_service):
+    response = admin_request.post(
+        'service.update_service',
+        service_id=sample_service.id,
+        _data={
+            'letter_contact_block': 'Aberdeen, AB23 1XH'
+        },
+        _expected_status=200
+    )
+
+    letter_contacts = ServiceLetterContact.query.all()
+
+    assert len(letter_contacts) == 1
+    assert letter_contacts[0].contact_block == 'Aberdeen, AB23 1XH'
+    assert letter_contacts[0].is_default
+    assert response['data']['letter_contact_block'] == 'Aberdeen, AB23 1XH'

tests/app/v2/template/test_get_template.py

@@ -40,11 +40,81 @@ def test_get_template_by_id_returns_200(client, sample_service, tmp_type, expect
         'body': template.content,
         "subject": expected_subject,
         'name': expected_name,
+        'personalisation': {},
     }
 
     assert json_response == expected_response
 
 
+@pytest.mark.parametrize("create_template_args, expected_personalisation", [
+    (
+        {
+            "template_type": SMS_TYPE,
+            "content": "Hello ((placeholder)) ((conditional??yes))",
+        },
+        {
+            "placeholder": {
+                "required": True
+            },
+            "conditional": {
+                "required": True
+            },
+        },
+    ),
+    (
+        {
+            "template_type": EMAIL_TYPE,
+            "subject": "((subject))",
+            "content": "((content))",
+        },
+        {
+            "subject": {
+                "required": True
+            },
+            "content": {
+                "required": True
+            },
+        },
+    ),
+    (
+        {
+            "template_type": LETTER_TYPE,
+            "subject": "((letterSubject))",
+            "content": "((letter_content))",
+        },
+        {
+            "letterSubject": {
+                "required": True,
+            },
+            "letter_content": {
+                "required": True,
+            },
+            "contact block": {
+                "required": True,
+            },
+        },
+    )
+])
+@pytest.mark.parametrize("version", valid_version_params)
+def test_get_template_by_id_returns_placeholders(
+    client,
+    sample_service_custom_letter_contact_block,
+    version,
+    create_template_args,
+    expected_personalisation,
+):
+    template = create_template(sample_service_custom_letter_contact_block, **create_template_args)
+    auth_header = create_authorization_header(service_id=sample_service_custom_letter_contact_block.id)
+
+    version_path = '/version/{}'.format(version) if version else ''
+
+    response = client.get(path='/v2/template/{}{}'.format(template.id, version_path),
+                          headers=[('Content-Type', 'application/json'), auth_header])
+
+    json_response = json.loads(response.get_data(as_text=True))
+    assert json_response['personalisation'] == expected_personalisation
+
+
 def test_get_template_with_non_existent_template_id_returns_404(client, fake_uuid, sample_service):
     auth_header = create_authorization_header(service_id=sample_service.id)