mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-21 07:51:13 -05:00
Don’t require template when content is provided
So that the admin app can create broadcasts without a template it needs to be allowed to create broadcasts from content instead.
This commit is contained in:
@@ -15,8 +15,13 @@ create_broadcast_message_schema = {
|
||||
'finishes_at': {'type': 'string', 'format': 'datetime'},
|
||||
'areas': {"type": "array", "items": {"type": "string"}},
|
||||
'simple_polygons': {"type": "array", "items": {"type": "array"}},
|
||||
'content': {'type': 'string', 'minLength': 1, 'maxLength': 1395},
|
||||
},
|
||||
'required': ['template_id', 'service_id', 'created_by'],
|
||||
'required': ['service_id', 'created_by'],
|
||||
'oneOf': [
|
||||
{'required': ['template_id']},
|
||||
{'required': ['content']},
|
||||
],
|
||||
'additionalProperties': False
|
||||
}
|
||||
|
||||
|
||||
@@ -99,22 +99,30 @@ def create_broadcast_message(service_id):
|
||||
validate(data, create_broadcast_message_schema)
|
||||
service = dao_fetch_service_by_id(data['service_id'])
|
||||
user = get_user_by_id(data['created_by'])
|
||||
template = dao_get_template_by_id_and_service_id(data['template_id'], data['service_id'])
|
||||
|
||||
personalisation = data.get('personalisation', {})
|
||||
template_id = data.get('template_id')
|
||||
|
||||
if template_id:
|
||||
template = dao_get_template_by_id_and_service_id(
|
||||
template_id, data['service_id']
|
||||
)
|
||||
content = template._as_utils_template_with_personalisation(
|
||||
personalisation
|
||||
).content_with_placeholders_filled_in
|
||||
else:
|
||||
template, content = None, data['content']
|
||||
|
||||
broadcast_message = BroadcastMessage(
|
||||
service_id=service.id,
|
||||
template_id=template.id,
|
||||
template_version=template.version,
|
||||
template_id=template_id,
|
||||
template_version=template.version if template else None,
|
||||
personalisation=personalisation,
|
||||
areas={"areas": data.get("areas", []), "simple_polygons": data.get("simple_polygons", [])},
|
||||
status=BroadcastStatusType.DRAFT,
|
||||
starts_at=_parse_nullable_datetime(data.get('starts_at')),
|
||||
finishes_at=_parse_nullable_datetime(data.get('finishes_at')),
|
||||
created_by_id=user.id,
|
||||
content=template._as_utils_template_with_personalisation(
|
||||
personalisation
|
||||
).content_with_placeholders_filled_in,
|
||||
content=content,
|
||||
)
|
||||
|
||||
dao_save_object(broadcast_message)
|
||||
|
||||
@@ -143,9 +143,9 @@ def test_create_broadcast_message(admin_request, sample_broadcast_service):
|
||||
(
|
||||
{},
|
||||
[
|
||||
{'error': 'ValidationError', 'message': 'template_id is a required property'},
|
||||
{'error': 'ValidationError', 'message': 'service_id is a required property'},
|
||||
{'error': 'ValidationError', 'message': 'created_by is a required property'}
|
||||
{'error': 'ValidationError', 'message': 'created_by is a required property'},
|
||||
{'error': 'ValidationError', 'message': '{} is not valid under any of the given schemas'},
|
||||
]
|
||||
),
|
||||
(
|
||||
@@ -178,12 +178,30 @@ def test_create_broadcast_message_400s_if_json_schema_fails_validation(
|
||||
|
||||
|
||||
@freeze_time('2020-01-01')
|
||||
def test_create_broadcast_message_400s_if_content_provided_but_no_template(admin_request, sample_broadcast_service):
|
||||
# we don't currently support this, but might in the future
|
||||
def test_create_broadcast_message_can_be_created_from_content(admin_request, sample_broadcast_service):
|
||||
response = admin_request.post(
|
||||
'broadcast_message.create_broadcast_message',
|
||||
_data={
|
||||
'template_id': None,
|
||||
'content': 'Some tailor made broadcast content',
|
||||
'service_id': str(sample_broadcast_service.id),
|
||||
'created_by': str(sample_broadcast_service.created_by_id),
|
||||
},
|
||||
service_id=sample_broadcast_service.id,
|
||||
_expected_status=201
|
||||
)
|
||||
assert response['content'] == 'Some tailor made broadcast content'
|
||||
assert response['template_id'] is None
|
||||
|
||||
|
||||
def test_create_broadcast_message_400s_if_content_and_template_provided(
|
||||
admin_request,
|
||||
sample_broadcast_service,
|
||||
):
|
||||
template = create_template(sample_broadcast_service, BROADCAST_TYPE)
|
||||
response = admin_request.post(
|
||||
'broadcast_message.create_broadcast_message',
|
||||
_data={
|
||||
'template_id': str(template.id),
|
||||
'content': 'Some tailor made broadcast content',
|
||||
'service_id': str(sample_broadcast_service.id),
|
||||
'created_by': str(sample_broadcast_service.created_by_id),
|
||||
@@ -191,11 +209,20 @@ def test_create_broadcast_message_400s_if_content_provided_but_no_template(admin
|
||||
service_id=sample_broadcast_service.id,
|
||||
_expected_status=400
|
||||
)
|
||||
assert response['errors'] ==[
|
||||
{'error': 'ValidationError', 'message': 'template_id is not a valid UUID'},
|
||||
{'error': 'ValidationError', 'message': 'Additional properties are not allowed (content was unexpected)'},
|
||||
]
|
||||
|
||||
assert len(response['errors']) == 1
|
||||
assert response['errors'][0]['error'] == 'ValidationError'
|
||||
# The error message for oneOf is ugly, non-deterministic in ordering
|
||||
# and contains some UUID, so let’s just pick out the important bits
|
||||
assert (
|
||||
' is valid under each of '
|
||||
) in response['errors'][0]['message']
|
||||
assert (
|
||||
'{required: [content]}'
|
||||
) in response['errors'][0]['message']
|
||||
assert (
|
||||
'{required: [template_id]}'
|
||||
) in response['errors'][0]['message']
|
||||
|
||||
@pytest.mark.parametrize('status', [
|
||||
BroadcastStatusType.DRAFT,
|
||||
|
||||
Reference in New Issue
Block a user