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

Merge pull request #4182 from alphagov/refactor-email-branding-181415991

Browse Source 
First set of refactorings for branding
This commit is contained in:
Ben Thorner
2022-03-22 13:43:10 +00:00
committed by GitHub
parent a6e4f3441f 6e81d05504
commit d1d3a6a6c3
11 changed files with 314 additions and 361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

236
tests/app/main/views/test_service_settings.py
View File

@@ -4753,32 +4753,15 @@ def test_update_service_organisation_does_not_update_if_same_value(
@pytest.mark.parametrize('organisation_type, expected_options', (
('central', [
('something_else', 'Something else'),
]),
('local', [
('something_else', 'Something else'),
]),
('nhs_central', [
('nhs', 'NHS'),
('something_else', 'Something else'),
]),
('nhs_local', [
('nhs', 'NHS'),
('something_else', 'Something else'),
]),
('nhs_gp', [
('nhs', 'NHS'),
('something_else', 'Something else'),
]),
('emergency_service', [
('something_else', 'Something else'),
]),
('other', [
('something_else', 'Something else'),
])
))
def test_show_email_branding_request_page_when_no_branding_is_set(
def test_email_branding_request_page_when_no_branding_is_set(
service_one,
client_request,
mocker,
@@ -4818,24 +4801,13 @@ def test_show_email_branding_request_page_when_no_branding_is_set(
@pytest.mark.parametrize('organisation_type, expected_options', (
('central', None),
('local', None),
('nhs_central', [
('nhs', 'NHS'),
('something_else', 'Something else'),
]),
('nhs_local', [
('nhs', 'NHS'),
('something_else', 'Something else'),
]),
('nhs_gp', [
('nhs', 'NHS'),
('something_else', 'Something else'),
]),
('emergency_service', None),
('other', None),
))
def test_letter_show_branding_request_page_when_no_branding_is_set(
def test_letter_branding_request_page_when_no_branding_is_set(
service_one,
client_request,
mock_get_email_branding,
@@ -4853,6 +4825,9 @@ def test_letter_show_branding_request_page_when_no_branding_is_set(
assert mock_get_email_branding.called is False
assert mock_get_letter_branding_by_id.called is False
button_text = normalize_spaces(page.select_one('.page-footer button').text)
assert button_text == 'Request new branding'
if expected_options:
assert [
(
@@ -4875,183 +4850,26 @@ def test_letter_show_branding_request_page_when_no_branding_is_set(
assert not page.select('.conditional-radios-panel')
@pytest.mark.parametrize('branding_type', ['email', 'letter'])
@pytest.mark.parametrize('organisation_type, expected_options', (
('local', [
('organisation', 'Test Organisation'),
('something_else', 'Something else'),
]),
('nhs_central', [
('nhs', 'NHS'),
('something_else', 'Something else'),
]),
('nhs_local', [
('nhs', 'NHS'),
('something_else', 'Something else'),
]),
('nhs_gp', [
('nhs', 'NHS'),
('something_else', 'Something else'),
]),
('emergency_service', [
('organisation', 'Test Organisation'),
('something_else', 'Something else'),
]),
('other', [
('organisation', 'Test Organisation'),
('something_else', 'Something else'),
]),
))
def test_show_branding_request_page_when_no_branding_is_set_but_organisation_exists(
mocker,
service_one,
client_request,
mock_get_email_branding,
mock_get_letter_branding_by_id,
mock_get_service_organisation,
organisation_type,
expected_options,
branding_type
):
service_one['{}_branding'.format(branding_type)] = None
mocker.patch(
'app.organisations_client.get_organisation',
return_value=organisation_json(organisation_type=organisation_type),
)
page = client_request.get(
f'.{branding_type}_branding_request', service_id=SERVICE_ONE_ID
)
assert mock_get_email_branding.called is False
assert mock_get_letter_branding_by_id.called is False
assert [
(
radio['value'],
page.select_one('label[for={}]'.format(radio['id'])).text.strip()
)
for radio in page.select('input[type=radio]')
] == expected_options
button_text = normalize_spaces(page.select_one('.page-footer button').text)
if branding_type == 'email':
assert button_text == 'Continue'
else:
assert button_text == 'Request new branding'
@pytest.mark.parametrize('organisation_type, expected_options, branding_type', (
('central', [
('govuk_and_org', 'GOV.UK and Test Organisation'),
('organisation', 'Test Organisation'),
('something_else', 'Something else'),
], 'email'),
('central', [
('organisation', 'Test Organisation'),
('something_else', 'Something else'),
], 'letter'),
))
def test_show_branding_request_page_when_no_branding_is_set_but_organisation_exists_central_org(
mocker,
service_one,
client_request,
mock_get_email_branding,
mock_get_letter_branding_by_id,
mock_get_service_organisation,
organisation_type,
expected_options,
branding_type
):
service_one['{}_branding'.format(branding_type)] = None
mocker.patch(
'app.organisations_client.get_organisation',
return_value=organisation_json(organisation_type=organisation_type),
)
page = client_request.get(
f'.{branding_type}_branding_request', service_id=SERVICE_ONE_ID
)
assert mock_get_email_branding.called is False
assert mock_get_letter_branding_by_id.called is False
assert [
(
radio['value'],
page.select_one('label[for={}]'.format(radio['id'])).text.strip()
)
for radio in page.select('input[type=radio]')
] == expected_options
def test_show_email_branding_request_page_when_email_branding_is_set(
def test_email_branding_request_page_shows_branding_if_set(
mocker,
service_one,
client_request,
mock_get_email_branding,
mock_get_service_organisation,
):
service_one['email_branding'] = sample_uuid()
mocker.patch(
'app.organisations_client.get_organisation',
return_value=organisation_json(),
)
mocker.patch(
'app.models.service.Service.email_branding_id',
new_callable=PropertyMock,
return_value='1234-abcd',
return_value='some-random-branding',
)
page = client_request.get(
'.email_branding_request', service_id=SERVICE_ONE_ID
)
assert page.find('iframe')['src'] == url_for('main.email_template', branding_style='1234-abcd')
assert [
(
radio['value'],
page.select_one('label[for={}]'.format(radio['id'])).text.strip()
)
for radio in page.select('input[type=radio]')
] == [
('govuk', 'GOV.UK'),
('govuk_and_org', 'GOV.UK and Test Organisation'),
('organisation', 'Test Organisation'),
('something_else', 'Something else'),
]
assert page.find('iframe')['src'] == url_for('main.email_template', branding_style='some-random-branding')
def test_show_letter_branding_request_page_when_letter_branding_is_set(
mocker,
service_one,
client_request,
mock_get_letter_branding_by_id,
mock_get_service_organisation,
active_user_with_permissions,
):
service_one['letter_branding'] = sample_uuid()
mocker.patch(
'app.organisations_client.get_organisation',
return_value=organisation_json(),
)
page = client_request.get(
'.letter_branding_request', service_id=SERVICE_ONE_ID
)
assert [
(
radio['value'],
page.select_one('label[for={}]'.format(radio['id'])).text.strip()
)
for radio in page.select('input[type=radio]')
] == [
('organisation', 'Test Organisation'),
('something_else', 'Something else'),
]
def test_back_link_on_email_branding_request_page(
def test_email_branding_request_page_back_link(
client_request,
):
page = client_request.get(
@@ -5066,7 +4884,7 @@ def test_back_link_on_email_branding_request_page(
(None, '/services/{}/service-settings'.format(SERVICE_ONE_ID),),
(TEMPLATE_ONE_ID, '/services/{}/templates/{}'.format(SERVICE_ONE_ID, TEMPLATE_ONE_ID),)
])
def test_back_link_on_letter_branding_request_page(
def test_letter_branding_request_page_back_link(
client_request,
from_template,
back_link_url,
@@ -5084,7 +4902,7 @@ def test_back_link_on_letter_branding_request_page(
assert back_link[0].attrs['href'] == back_link_url
def test_show_letter_branding_request_page_when_branding_is_same_as_org(
def test_letter_branding_request_page_when_branding_is_same_as_org(
mocker,
service_one,
client_request,
@@ -5155,7 +4973,7 @@ def test_show_letter_branding_request_page_when_branding_is_same_as_org(
'main.email_branding_nhs',
),
))
def test_submit_email_branding_request(
def test_email_branding_request_submit(
client_request,
service_one,
mocker,
@@ -5187,7 +5005,7 @@ def test_submit_email_branding_request(
)
def test_submit_email_branding_request_when_no_radio_button_is_selected(
def test_email_branding_request_submit_when_no_radio_button_is_selected(
client_request,
service_one,
mock_get_email_branding,
@@ -5207,7 +5025,7 @@ def test_submit_email_branding_request_when_no_radio_button_is_selected(
(None, 'Can’t tell (domain is user.gov.uk)'),
('Test Organisation', 'Test Organisation'),
))
def test_submit_letter_branding_request(
def test_letter_branding_request_submit(
client_request,
service_one,
mocker,
@@ -5277,7 +5095,7 @@ def test_submit_letter_branding_request(
({'options': 'something_else'}, 'Cannot be empty'), # no data in 'something_else' textbox
({'options': ''}, 'Select an option'), # no radio button selected
))
def test_submit_letter_branding_request_when_form_has_missing_data(
def test_letter_branding_request_submit_when_form_has_missing_data(
client_request,
mocker,
service_one,
@@ -5306,7 +5124,7 @@ def test_submit_letter_branding_request_when_form_has_missing_data(
None,
TEMPLATE_ONE_ID
])
def test_submit_letter_branding_request_redirects_if_from_template_is_set(
def test_letter_branding_request_submit_redirects_if_from_template_is_set(
client_request,
service_one,
mocker,
@@ -5333,7 +5151,7 @@ def test_submit_letter_branding_request_redirects_if_from_template_is_set(
)
def test_submit_letter_branding_when_something_else_is_only_option(
def test_letter_branding_submit_when_something_else_is_only_option(
client_request,
service_one,
mocker,
@@ -5366,7 +5184,7 @@ def test_submit_letter_branding_when_something_else_is_only_option(
('main.email_branding_govuk_and_org', 'Before you request new branding'),
('main.email_branding_organisation', 'When you request new branding'),
])
def test_get_email_branding_description_pages_for_org_branding(
def test_email_branding_description_pages_for_org_branding(
client_request,
mocker,
service_one,
@@ -5395,7 +5213,7 @@ def test_get_email_branding_description_pages_for_org_branding(
('main.email_branding_govuk', 'central', '__NONE__'),
('main.email_branding_nhs', 'nhs_local', NHS_BRANDING_ID),
])
def test_get_email_branding_govuk_and_nhs_pages(
def test_email_branding_govuk_and_nhs_pages(
client_request,
mocker,
service_one,
@@ -5424,7 +5242,7 @@ def test_get_email_branding_govuk_and_nhs_pages(
assert normalize_spaces(page.select_one('.page-footer button').text) == 'Use this branding'
def test_get_email_branding_something_else_page(client_request, service_one):
def test_email_branding_something_else_page(client_request, service_one):
# expect to have a "NHS" option as well as the
# fallback, so back button goes to choices page
service_one['organisation_type'] = 'nhs_central'
@@ -5461,7 +5279,7 @@ def test_get_email_branding_something_else_page_is_only_option(client_request, s
('main.email_branding_nhs'),
('main.email_branding_organisation'),
])
def test_get_email_branding_description_pages_give_404_if_selected_branding_not_allowed(
def test_email_branding_pages_give_404_if_selected_branding_not_allowed(
client_request,
endpoint,
):
@@ -5474,7 +5292,7 @@ def test_get_email_branding_description_pages_give_404_if_selected_branding_not_
)
def test_update_email_branding_from_govuk_preview_page(
def test_email_branding_govuk_submit(
mocker,
client_request,
service_one,
@@ -5510,7 +5328,7 @@ def test_update_email_branding_from_govuk_preview_page(
assert normalize_spaces(page.select_one('.banner-default').text) == 'You’ve updated your email branding'
def test_submit_email_branding_request_from_govuk_and_org_description_page(
def test_email_branding_govuk_and_org_submit(
mocker,
client_request,
service_one,
@@ -5569,7 +5387,7 @@ def test_submit_email_branding_request_from_govuk_and_org_description_page(
)
def test_update_email_branding_from_nhs_preview_page(
def test_email_branding_nhs_submit(
mocker,
client_request,
service_one,
@@ -5597,7 +5415,7 @@ def test_update_email_branding_from_nhs_preview_page(
assert normalize_spaces(page.select_one('.banner-default').text) == 'You’ve updated your email branding'
def test_submit_email_branding_request_from_organisation_description_page(
def test_email_branding_organisation_submit(
mocker,
client_request,
service_one,
@@ -5656,7 +5474,7 @@ def test_submit_email_branding_request_from_organisation_description_page(
)
def test_submit_email_branding_something_else_page(
def test_email_branding_something_else_submit(
client_request,
mocker,
service_one,
@@ -5708,7 +5526,7 @@ def test_submit_email_branding_something_else_page(
)
def test_submit_email_branding_something_else_page_shows_error_if_textbox_is_empty(
def test_email_branding_something_else_submit_shows_error_if_textbox_is_empty(
client_request,
):
page = client_request.post(

117
tests/app/utils/test_branding.py Normal file
View File

@@ -0,0 +1,117 @@
from unittest.mock import PropertyMock
import pytest
from app.models.service import Service
from app.utils.branding import get_available_choices
from tests import organisation_json
@pytest.mark.parametrize('branding_type', ['email', 'letter'])
@pytest.mark.parametrize('org_type, expected_options', [
('central', []),
('local', []),
('nhs_central', [('nhs', 'NHS')]),
('nhs_local', [('nhs', 'NHS')]),
('nhs_gp', [('nhs', 'NHS')]),
('emergency_service', []),
('other', []),
])
def test_get_available_choices_service_not_assigned_to_org(
service_one,
branding_type,
org_type,
expected_options,
):
service_one['organisation_type'] = org_type
service = Service(service_one)
options = get_available_choices(service, branding_type=branding_type)
assert list(options) == expected_options
@pytest.mark.parametrize('branding_type', ['email', 'letter'])
@pytest.mark.parametrize('org_type, expected_options', [
('local', [('organisation', 'Test Organisation')]),
('nhs_central', [('nhs', 'NHS')]),
('nhs_local', [('nhs', 'NHS')]),
('nhs_gp', [('nhs', 'NHS')]),
('emergency_service', [('organisation', 'Test Organisation')]),
('other', [('organisation', 'Test Organisation')]),
])
def test_get_available_choices_service_assigned_to_org(
mocker,
service_one,
branding_type,
org_type,
expected_options,
mock_get_service_organisation,
):
service = Service(service_one)
mocker.patch(
'app.organisations_client.get_organisation',
return_value=organisation_json(organisation_type=org_type)
)
options = get_available_choices(service, branding_type=branding_type)
assert list(options) == expected_options
@pytest.mark.parametrize('service_branding, expected_options', [
(None, [
('govuk_and_org', 'GOV.UK and Test Organisation'),
('organisation', 'Test Organisation'),
]),
('some-random-branding', [
('govuk', 'GOV.UK'), # central orgs can switch back to GOV.UK
('govuk_and_org', 'GOV.UK and Test Organisation'),
('organisation', 'Test Organisation'),
])
])
def test_get_available_choices_email_branding_central_org(
mocker,
service_one,
service_branding,
expected_options,
mock_get_service_organisation,
mock_get_email_branding,
):
service = Service(service_one)
mocker.patch(
'app.organisations_client.get_organisation',
return_value=organisation_json(organisation_type='central'),
)
mocker.patch(
'app.models.service.Service.email_branding_id',
new_callable=PropertyMock,
return_value=service_branding,
)
options = get_available_choices(service, branding_type='email')
assert list(options) == expected_options
def test_get_available_choices_letter_branding_set(
mocker,
service_one,
mock_get_service_organisation,
mock_get_letter_branding_by_id,
):
service = Service(service_one)
mocker.patch(
'app.organisations_client.get_organisation',
return_value=organisation_json()
)
mocker.patch(
'app.models.service.Service.letter_branding_id',
new_callable=PropertyMock,
return_value='some-random-branding',
)
options = get_available_choices(service, branding_type='letter')
assert list(options) == [
('organisation', 'Test Organisation'),
]