mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-08-04 05:31:44 -04:00
50eae6f935
We have a `client_request` fixture which does a bunch of useful stuff like: - checking the status code of the response - returning a `BeautifulSoup` object For most tests of a platform admin view we used `platform_admin_client` instead. This is not as good because it returns a raw `Response` object and doesn’t do the additional checks. This commit converts all the tests using `platform_admin_client` to: use new `client_request` and log in as `platform_admin_user` before making any requests. This is also nice because it makes any test easy to parametrize with additional users, for example to test differences in behaviour dependant on being platform admin or not.
453 lines
13 KiB
Python
453 lines
13 KiB
Python
from io import BytesIO
|
|
from unittest.mock import call
|
|
|
|
import pytest
|
|
from flask import url_for
|
|
from notifications_python_client.errors import HTTPError
|
|
|
|
from app.s3_client.s3_logo_client import EMAIL_LOGO_LOCATION_STRUCTURE, TEMP_TAG
|
|
from tests.conftest import create_email_branding, normalize_spaces
|
|
|
|
|
|
def test_email_branding_page_shows_full_branding_list(
|
|
client_request,
|
|
platform_admin_user,
|
|
mock_get_all_email_branding
|
|
):
|
|
|
|
client_request.login(platform_admin_user)
|
|
page = client_request.get('.email_branding')
|
|
|
|
links = page.select('.message-name a')
|
|
brand_names = [normalize_spaces(link.text) for link in links]
|
|
hrefs = [link['href'] for link in links]
|
|
|
|
assert normalize_spaces(
|
|
page.select_one('h1').text
|
|
) == "Email branding"
|
|
|
|
assert page.select('.govuk-grid-column-three-quarters a')[-1]['href'] == url_for('main.create_email_branding')
|
|
|
|
assert brand_names == [
|
|
'org 1',
|
|
'org 2',
|
|
'org 3',
|
|
'org 4',
|
|
'org 5',
|
|
]
|
|
assert hrefs == [
|
|
url_for('.update_email_branding', branding_id=1),
|
|
url_for('.update_email_branding', branding_id=2),
|
|
url_for('.update_email_branding', branding_id=3),
|
|
url_for('.update_email_branding', branding_id=4),
|
|
url_for('.update_email_branding', branding_id=5),
|
|
]
|
|
|
|
|
|
def test_edit_email_branding_shows_the_correct_branding_info(
|
|
client_request,
|
|
platform_admin_user,
|
|
mock_get_email_branding,
|
|
fake_uuid
|
|
):
|
|
client_request.login(platform_admin_user)
|
|
page = client_request.get(
|
|
'.update_email_branding',
|
|
branding_id=fake_uuid,
|
|
_test_page_title=False, # TODO: Fix page titles
|
|
)
|
|
|
|
assert page.select_one('#logo-img > img')['src'].endswith('/example.png')
|
|
assert page.select_one('#name').attrs.get('value') == 'Organisation name'
|
|
assert page.select_one('#file').attrs.get('accept') == '.png'
|
|
assert page.select_one('#text').attrs.get('value') == 'Organisation text'
|
|
assert page.select_one('#colour').attrs.get('value') == '#f00'
|
|
|
|
|
|
def test_create_email_branding_does_not_show_any_branding_info(
|
|
client_request,
|
|
platform_admin_user,
|
|
mock_no_email_branding
|
|
):
|
|
client_request.login(platform_admin_user)
|
|
page = client_request.get(
|
|
'.create_email_branding',
|
|
_test_page_title=False, # TODO: Fix page titles
|
|
)
|
|
|
|
assert page.select_one('#logo-img > img') is None
|
|
assert page.select_one('#name').attrs.get('value') is None
|
|
assert page.select_one('#file').attrs.get('accept') == '.png'
|
|
assert page.select_one('#text').attrs.get('value') is None
|
|
assert page.select_one('#colour').attrs.get('value') is None
|
|
|
|
|
|
def test_create_new_email_branding_without_logo(
|
|
client_request,
|
|
platform_admin_user,
|
|
mocker,
|
|
fake_uuid,
|
|
mock_create_email_branding,
|
|
):
|
|
data = {
|
|
'logo': None,
|
|
'colour': '#ff0000',
|
|
'text': 'new text',
|
|
'name': 'new name',
|
|
'brand_type': 'org'
|
|
}
|
|
|
|
mock_persist = mocker.patch('app.main.views.email_branding.persist_logo')
|
|
mocker.patch('app.main.views.email_branding.delete_email_temp_files_created_by')
|
|
|
|
client_request.login(platform_admin_user)
|
|
client_request.post(
|
|
'.create_email_branding',
|
|
_content_type='multipart/form-data',
|
|
_data=data,
|
|
)
|
|
|
|
assert mock_create_email_branding.called
|
|
assert mock_create_email_branding.call_args == call(
|
|
logo=data['logo'],
|
|
name=data['name'],
|
|
text=data['text'],
|
|
colour=data['colour'],
|
|
brand_type=data['brand_type']
|
|
)
|
|
assert mock_persist.call_args_list == []
|
|
|
|
|
|
def test_create_email_branding_requires_a_name_when_submitting_logo_details(
|
|
client_request,
|
|
mocker,
|
|
mock_create_email_branding,
|
|
platform_admin_user,
|
|
):
|
|
mocker.patch('app.main.views.email_branding.persist_logo')
|
|
mocker.patch('app.main.views.email_branding.delete_email_temp_files_created_by')
|
|
data = {
|
|
'operation': 'email-branding-details',
|
|
'logo': '',
|
|
'colour': '#ff0000',
|
|
'text': 'new text',
|
|
'name': '',
|
|
'brand_type': 'org',
|
|
}
|
|
client_request.login(platform_admin_user)
|
|
page = client_request.post(
|
|
'.create_email_branding',
|
|
_content_type='multipart/form-data',
|
|
_data=data,
|
|
_expected_status=200,
|
|
)
|
|
|
|
assert page.select_one('.govuk-error-message').text.strip() == 'Error: This field is required'
|
|
assert mock_create_email_branding.called is False
|
|
|
|
|
|
def test_create_email_branding_does_not_require_a_name_when_uploading_a_file(
|
|
client_request,
|
|
mocker,
|
|
platform_admin_user,
|
|
):
|
|
mocker.patch('app.main.views.email_branding.upload_email_logo', return_value='temp_filename')
|
|
data = {
|
|
'file': (BytesIO(''.encode('utf-8')), 'test.png'),
|
|
'colour': '',
|
|
'text': '',
|
|
'name': '',
|
|
'brand_type': 'org',
|
|
}
|
|
client_request.login(platform_admin_user)
|
|
page = client_request.post(
|
|
'.create_email_branding',
|
|
_content_type='multipart/form-data',
|
|
_data=data,
|
|
_follow_redirects=True
|
|
)
|
|
|
|
assert not page.find('.error-message')
|
|
|
|
|
|
def test_create_new_email_branding_when_branding_saved(
|
|
client_request,
|
|
platform_admin_user,
|
|
mocker,
|
|
mock_create_email_branding,
|
|
fake_uuid
|
|
):
|
|
with client_request.session_transaction() as session:
|
|
user_id = session["user_id"]
|
|
|
|
data = {
|
|
'logo': 'test.png',
|
|
'colour': '#ff0000',
|
|
'text': 'new text',
|
|
'name': 'new name',
|
|
'brand_type': 'org_banner'
|
|
}
|
|
|
|
temp_filename = EMAIL_LOGO_LOCATION_STRUCTURE.format(
|
|
temp=TEMP_TAG.format(user_id=user_id),
|
|
unique_id=fake_uuid,
|
|
filename=data['logo']
|
|
)
|
|
|
|
mocker.patch('app.main.views.email_branding.persist_logo')
|
|
mocker.patch('app.main.views.email_branding.delete_email_temp_files_created_by')
|
|
|
|
client_request.login(platform_admin_user)
|
|
client_request.post(
|
|
'.create_email_branding',
|
|
logo=temp_filename,
|
|
_content_type='multipart/form-data',
|
|
_data={
|
|
'colour': data['colour'],
|
|
'name': data['name'],
|
|
'text': data['text'],
|
|
'cdn_url': 'https://static-logos.cdn.com',
|
|
'brand_type': data['brand_type']
|
|
}
|
|
)
|
|
|
|
updated_logo_name = '{}-{}'.format(fake_uuid, data['logo'])
|
|
|
|
assert mock_create_email_branding.called
|
|
assert mock_create_email_branding.call_args == call(
|
|
logo=updated_logo_name,
|
|
name=data['name'],
|
|
text=data['text'],
|
|
colour=data['colour'],
|
|
brand_type=data['brand_type']
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize('endpoint, has_data', [
|
|
('main.create_email_branding', False),
|
|
('main.update_email_branding', True),
|
|
])
|
|
def test_deletes_previous_temp_logo_after_uploading_logo(
|
|
client_request,
|
|
platform_admin_user,
|
|
mocker,
|
|
endpoint,
|
|
has_data,
|
|
fake_uuid
|
|
):
|
|
if has_data:
|
|
mocker.patch('app.email_branding_client.get_email_branding', return_value=create_email_branding(fake_uuid))
|
|
|
|
with client_request.session_transaction() as session:
|
|
user_id = session["user_id"]
|
|
|
|
temp_old_filename = EMAIL_LOGO_LOCATION_STRUCTURE.format(
|
|
temp=TEMP_TAG.format(user_id=user_id),
|
|
unique_id=fake_uuid,
|
|
filename='old_test.png'
|
|
)
|
|
|
|
temp_filename = EMAIL_LOGO_LOCATION_STRUCTURE.format(
|
|
temp=TEMP_TAG.format(user_id=user_id),
|
|
unique_id=fake_uuid,
|
|
filename='test.png'
|
|
)
|
|
|
|
mocked_upload_email_logo = mocker.patch(
|
|
'app.main.views.email_branding.upload_email_logo',
|
|
return_value=temp_filename
|
|
)
|
|
|
|
mocked_delete_email_temp_file = mocker.patch('app.main.views.email_branding.delete_email_temp_file')
|
|
|
|
client_request.login(platform_admin_user)
|
|
client_request.post(
|
|
'main.create_email_branding',
|
|
logo=temp_old_filename,
|
|
branding_id=fake_uuid,
|
|
_data={'file': (BytesIO(''.encode('utf-8')), 'test.png')},
|
|
_content_type='multipart/form-data',
|
|
)
|
|
|
|
assert mocked_upload_email_logo.called
|
|
assert mocked_delete_email_temp_file.called
|
|
assert mocked_delete_email_temp_file.call_args == call(temp_old_filename)
|
|
|
|
|
|
def test_update_existing_branding(
|
|
client_request,
|
|
platform_admin_user,
|
|
mocker,
|
|
fake_uuid,
|
|
mock_get_email_branding,
|
|
mock_update_email_branding
|
|
):
|
|
with client_request.session_transaction() as session:
|
|
user_id = session["user_id"]
|
|
|
|
data = {
|
|
'logo': 'test.png',
|
|
'colour': '#0000ff',
|
|
'text': 'new text',
|
|
'name': 'new name',
|
|
'brand_type': 'both'
|
|
}
|
|
|
|
temp_filename = EMAIL_LOGO_LOCATION_STRUCTURE.format(
|
|
temp=TEMP_TAG.format(user_id=user_id),
|
|
unique_id=fake_uuid,
|
|
filename=data['logo']
|
|
)
|
|
|
|
mocker.patch('app.main.views.email_branding.persist_logo')
|
|
mocker.patch('app.main.views.email_branding.delete_email_temp_files_created_by')
|
|
|
|
client_request.login(platform_admin_user)
|
|
client_request.post(
|
|
'.update_email_branding',
|
|
logo=temp_filename,
|
|
branding_id=fake_uuid,
|
|
_content_type='multipart/form-data',
|
|
_data={
|
|
'colour': data['colour'],
|
|
'name': data['name'],
|
|
'text': data['text'],
|
|
'cdn_url': 'https://static-logos.cdn.com',
|
|
'brand_type': data['brand_type'],
|
|
},
|
|
)
|
|
|
|
updated_logo_name = '{}-{}'.format(fake_uuid, data['logo'])
|
|
|
|
assert mock_update_email_branding.called
|
|
assert mock_update_email_branding.call_args == call(
|
|
branding_id=fake_uuid,
|
|
logo=updated_logo_name,
|
|
name=data['name'],
|
|
text=data['text'],
|
|
colour=data['colour'],
|
|
brand_type=data['brand_type']
|
|
)
|
|
|
|
|
|
def test_temp_logo_is_shown_after_uploading_logo(
|
|
client_request,
|
|
platform_admin_user,
|
|
mocker,
|
|
fake_uuid,
|
|
):
|
|
with client_request.session_transaction() as session:
|
|
user_id = session["user_id"]
|
|
|
|
temp_filename = EMAIL_LOGO_LOCATION_STRUCTURE.format(
|
|
temp=TEMP_TAG.format(user_id=user_id),
|
|
unique_id=fake_uuid,
|
|
filename='test.png'
|
|
)
|
|
|
|
mocker.patch('app.main.views.email_branding.upload_email_logo', return_value=temp_filename)
|
|
mocker.patch('app.main.views.email_branding.delete_email_temp_file')
|
|
|
|
client_request.login(platform_admin_user)
|
|
page = client_request.post(
|
|
'main.create_email_branding',
|
|
_data={'file': (BytesIO(''.encode('utf-8')), 'test.png')},
|
|
_content_type='multipart/form-data',
|
|
_follow_redirects=True,
|
|
)
|
|
|
|
assert page.select_one('#logo-img > img').attrs['src'].endswith(temp_filename)
|
|
|
|
|
|
def test_logo_persisted_when_organisation_saved(
|
|
client_request,
|
|
platform_admin_user,
|
|
mock_create_email_branding,
|
|
mocker,
|
|
fake_uuid
|
|
):
|
|
with client_request.session_transaction() as session:
|
|
user_id = session["user_id"]
|
|
|
|
temp_filename = EMAIL_LOGO_LOCATION_STRUCTURE.format(
|
|
temp=TEMP_TAG.format(user_id=user_id), unique_id=fake_uuid, filename='test.png')
|
|
|
|
mocked_upload_email_logo = mocker.patch('app.main.views.email_branding.upload_email_logo')
|
|
mocked_persist_logo = mocker.patch('app.main.views.email_branding.persist_logo')
|
|
mocked_delete_email_temp_files_by = mocker.patch('app.main.views.email_branding.delete_email_temp_files_created_by')
|
|
|
|
client_request.login(platform_admin_user)
|
|
client_request.post(
|
|
'.create_email_branding',
|
|
logo=temp_filename,
|
|
_content_type='multipart/form-data',
|
|
)
|
|
|
|
assert not mocked_upload_email_logo.called
|
|
assert mocked_persist_logo.called
|
|
assert mocked_delete_email_temp_files_by.called
|
|
assert mocked_delete_email_temp_files_by.call_args == call(user_id)
|
|
assert mock_create_email_branding.called
|
|
|
|
|
|
def test_logo_does_not_get_persisted_if_updating_email_branding_client_throws_an_error(
|
|
client_request,
|
|
platform_admin_user,
|
|
mock_create_email_branding,
|
|
mocker,
|
|
fake_uuid
|
|
):
|
|
with client_request.session_transaction() as session:
|
|
user_id = session["user_id"]
|
|
|
|
temp_filename = EMAIL_LOGO_LOCATION_STRUCTURE.format(
|
|
temp=TEMP_TAG.format(user_id=user_id), unique_id=fake_uuid, filename='test.png')
|
|
|
|
mocked_persist_logo = mocker.patch('app.main.views.email_branding.persist_logo')
|
|
mocked_delete_email_temp_files_by = mocker.patch('app.main.views.email_branding.delete_email_temp_files_created_by')
|
|
mocker.patch('app.main.views.email_branding.email_branding_client.create_email_branding', side_effect=HTTPError())
|
|
|
|
client_request.login(platform_admin_user)
|
|
client_request.post(
|
|
'.create_email_branding',
|
|
logo=temp_filename,
|
|
_content_type='multipart/form-data',
|
|
_expected_status=500,
|
|
)
|
|
|
|
assert not mocked_persist_logo.called
|
|
assert not mocked_delete_email_temp_files_by.called
|
|
|
|
|
|
@pytest.mark.parametrize('colour_hex, expected_status_code', [
|
|
('#FF00FF', 302),
|
|
('hello', 200),
|
|
('', 302),
|
|
])
|
|
def test_colour_regex_validation(
|
|
client_request,
|
|
platform_admin_user,
|
|
mocker,
|
|
fake_uuid,
|
|
colour_hex,
|
|
expected_status_code,
|
|
mock_create_email_branding
|
|
):
|
|
data = {
|
|
'logo': None,
|
|
'colour': colour_hex,
|
|
'text': 'new text',
|
|
'name': 'new name',
|
|
'brand_type': 'org'
|
|
}
|
|
|
|
mocker.patch('app.main.views.email_branding.delete_email_temp_files_created_by')
|
|
|
|
client_request.login(platform_admin_user)
|
|
client_request.post(
|
|
'.create_email_branding',
|
|
_content_type='multipart/form-data',
|
|
_data=data,
|
|
_expected_status=expected_status_code,
|
|
)
|