mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-23 17:01:35 -05:00
04e41e3147
The use for the public template API is for building caseworking systems or similar, where you might need a list of templates to pick from (ie instead of using the Notify web interface to pick from and send a message). Right now our API isn’t returning the template name as part of the response. The name is a useful, human-friendly way of identifying a template. This commit changes the response to include the name. Some clients will need updating before this can be useful.
95 lines
3.3 KiB
Python
95 lines
3.3 KiB
Python
import pytest
|
|
|
|
from flask import json
|
|
|
|
from app import DATETIME_FORMAT
|
|
from app.models import TEMPLATE_TYPES, EMAIL_TYPE, SMS_TYPE, LETTER_TYPE
|
|
from tests import create_authorization_header
|
|
from tests.app.db import create_template
|
|
|
|
valid_version_params = [None, 1]
|
|
|
|
|
|
@pytest.mark.parametrize("tmp_type, expected_name, expected_subject", [
|
|
(SMS_TYPE, 'sms Template Name', None),
|
|
(EMAIL_TYPE, 'email Template Name', 'Template subject'),
|
|
(LETTER_TYPE, 'letter Template Name', 'Template subject')
|
|
])
|
|
@pytest.mark.parametrize("version", valid_version_params)
|
|
def test_get_template_by_id_returns_200(client, sample_service, tmp_type, expected_name, expected_subject, version):
|
|
template = create_template(sample_service, template_type=tmp_type)
|
|
auth_header = create_authorization_header(service_id=sample_service.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])
|
|
|
|
assert response.status_code == 200
|
|
assert response.headers['Content-type'] == 'application/json'
|
|
|
|
json_response = json.loads(response.get_data(as_text=True))
|
|
|
|
expected_response = {
|
|
'id': '{}'.format(template.id),
|
|
'type': '{}'.format(template.template_type),
|
|
'created_at': template.created_at.strftime(DATETIME_FORMAT),
|
|
'updated_at': None,
|
|
'version': template.version,
|
|
'created_by': template.created_by.email_address,
|
|
'body': template.content,
|
|
"subject": expected_subject,
|
|
'name': expected_name,
|
|
}
|
|
|
|
assert json_response == expected_response
|
|
|
|
|
|
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)
|
|
|
|
response = client.get(path='/v2/template/{}'.format(fake_uuid),
|
|
headers=[('Content-Type', 'application/json'), auth_header])
|
|
|
|
assert response.status_code == 404
|
|
assert response.headers['Content-type'] == 'application/json'
|
|
|
|
json_response = json.loads(response.get_data(as_text=True))
|
|
|
|
assert json_response == {
|
|
"errors": [
|
|
{
|
|
"error": "NoResultFound",
|
|
"message": "No result found"
|
|
}
|
|
],
|
|
"status_code": 404
|
|
}
|
|
|
|
|
|
@pytest.mark.parametrize("tmp_type", TEMPLATE_TYPES)
|
|
def test_get_template_with_non_existent_version_returns_404(client, sample_service, tmp_type):
|
|
template = create_template(sample_service, template_type=tmp_type)
|
|
|
|
auth_header = create_authorization_header(service_id=sample_service.id)
|
|
|
|
invalid_version = template.version + 1
|
|
|
|
response = client.get(path='/v2/template/{}/version/{}'.format(template.id, invalid_version),
|
|
headers=[('Content-Type', 'application/json'), auth_header])
|
|
|
|
assert response.status_code == 404
|
|
assert response.headers['Content-type'] == 'application/json'
|
|
|
|
json_response = json.loads(response.get_data(as_text=True))
|
|
|
|
assert json_response == {
|
|
"errors": [
|
|
{
|
|
"error": "NoResultFound",
|
|
"message": "No result found"
|
|
}
|
|
],
|
|
"status_code": 404
|
|
}
|