mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-07-10 03:14:58 -04:00
Merge pull request #1403 from alphagov/ken-admin-orgs
Add pages to create and manage organisation branding for Emails
This commit is contained in:
@@ -87,6 +87,8 @@ class Config(object):
|
||||
r"cqc\.org\.uk",
|
||||
]
|
||||
|
||||
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-local'
|
||||
|
||||
|
||||
class Development(Config):
|
||||
DEBUG = True
|
||||
@@ -94,6 +96,7 @@ class Development(Config):
|
||||
SESSION_PROTECTION = None
|
||||
STATSD_ENABLED = False
|
||||
CSV_UPLOAD_BUCKET_NAME = 'development-notifications-csv-upload'
|
||||
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-tools'
|
||||
|
||||
|
||||
class Test(Development):
|
||||
@@ -102,6 +105,7 @@ class Test(Development):
|
||||
STATSD_ENABLED = True
|
||||
WTF_CSRF_ENABLED = False
|
||||
CSV_UPLOAD_BUCKET_NAME = 'test-notifications-csv-upload'
|
||||
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-test'
|
||||
NOTIFY_ENVIRONMENT = 'test'
|
||||
TEMPLATE_PREVIEW_API_HOST = 'http://localhost:9999'
|
||||
|
||||
@@ -111,6 +115,7 @@ class Preview(Config):
|
||||
HEADER_COLOUR = '#F499BE' # $baby-pink
|
||||
STATSD_ENABLED = True
|
||||
CSV_UPLOAD_BUCKET_NAME = 'preview-notifications-csv-upload'
|
||||
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-preview'
|
||||
NOTIFY_ENVIRONMENT = 'preview'
|
||||
|
||||
|
||||
@@ -120,6 +125,7 @@ class Staging(Config):
|
||||
HEADER_COLOUR = '#6F72AF' # $mauve
|
||||
STATSD_ENABLED = True
|
||||
CSV_UPLOAD_BUCKET_NAME = 'staging-notify-csv-upload'
|
||||
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-staging'
|
||||
NOTIFY_ENVIRONMENT = 'staging'
|
||||
|
||||
|
||||
@@ -129,6 +135,7 @@ class Live(Config):
|
||||
HTTP_PROTOCOL = 'https'
|
||||
STATSD_ENABLED = True
|
||||
CSV_UPLOAD_BUCKET_NAME = 'live-notifications-csv-upload'
|
||||
LOGO_UPLOAD_BUCKET_NAME = 'public-logos-live'
|
||||
NOTIFY_ENVIRONMENT = 'live'
|
||||
|
||||
|
||||
@@ -142,6 +149,7 @@ class Sandbox(CloudFoundryConfig):
|
||||
HEADER_COLOUR = '#F499BE' # $baby-pink
|
||||
STATSD_ENABLED = True
|
||||
CSV_UPLOAD_BUCKET_NAME = 'cf-sandbox-notifications-csv-upload'
|
||||
LOGO_UPLOAD_BUCKET_NAME = 'cf-sandbox-notifications-logo-upload'
|
||||
NOTIFY_ENVIRONMENT = 'sandbox'
|
||||
|
||||
|
||||
|
||||
@@ -28,6 +28,7 @@ from app.main.views import (
|
||||
providers,
|
||||
platform_admin,
|
||||
letter_jobs,
|
||||
organisations,
|
||||
conversation,
|
||||
notifications
|
||||
)
|
||||
|
||||
@@ -26,6 +26,7 @@ from wtforms import (
|
||||
SelectField)
|
||||
from wtforms.fields.html5 import EmailField, TelField, SearchField
|
||||
from wtforms.validators import (DataRequired, Email, Length, Regexp, Optional)
|
||||
from flask_wtf.file import FileField as FileField_wtf, FileAllowed
|
||||
|
||||
from app.main.validators import (Blacklist, CsvFileValidator, ValidGovEmail, NoCommasInPlaceHolders, OnlyGSMCharacters)
|
||||
|
||||
@@ -548,6 +549,28 @@ class ServiceBrandingOrg(Form):
|
||||
)
|
||||
|
||||
|
||||
class ServiceSelectOrg(Form):
|
||||
|
||||
def __init__(self, organisations=[], *args, **kwargs):
|
||||
self.organisation.choices = organisations
|
||||
super(ServiceSelectOrg, self).__init__(*args, **kwargs)
|
||||
|
||||
organisation = RadioField(
|
||||
'Organisation',
|
||||
validators=[
|
||||
DataRequired()
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
class ServiceManageOrg(Form):
|
||||
|
||||
name = StringField('Name')
|
||||
|
||||
colour = StringField('Colour', render_kw={'onkeyup': 'update_colour_span()', 'onblur': 'update_colour_span()'})
|
||||
file = FileField_wtf('Upload a PNG logo', validators=[FileAllowed(['png'], 'PNG Images only!')])
|
||||
|
||||
|
||||
class LetterBranding(Form):
|
||||
|
||||
def __init__(self, choices=[], *args, **kwargs):
|
||||
|
||||
102
app/main/s3_client.py
Normal file
102
app/main/s3_client.py
Normal file
@@ -0,0 +1,102 @@
|
||||
import uuid
|
||||
import botocore
|
||||
from boto3 import resource
|
||||
from flask import current_app
|
||||
from notifications_utils.s3 import s3upload as utils_s3upload
|
||||
|
||||
FILE_LOCATION_STRUCTURE = 'service-{}-notify/{}.csv'
|
||||
TEMP_TAG = 'temp-{user_id}_'
|
||||
LOGO_LOCATION_STRUCTURE = '{temp}{unique_id}-{filename}'
|
||||
|
||||
|
||||
def get_s3_object(bucket_name, filename):
|
||||
s3 = resource('s3')
|
||||
return s3.Object(bucket_name, filename)
|
||||
|
||||
|
||||
def delete_s3_object(filename):
|
||||
bucket_name = current_app.config['LOGO_UPLOAD_BUCKET_NAME']
|
||||
get_s3_object(bucket_name, filename).delete()
|
||||
|
||||
|
||||
def rename_s3_object(old_name, new_name):
|
||||
bucket_name = current_app.config['LOGO_UPLOAD_BUCKET_NAME']
|
||||
get_s3_object(bucket_name, new_name).copy_from(
|
||||
CopySource='{}/{}'.format(bucket_name, old_name))
|
||||
delete_s3_object(old_name)
|
||||
|
||||
|
||||
def get_s3_objects_filter_by_prefix(prefix):
|
||||
bucket_name = current_app.config['LOGO_UPLOAD_BUCKET_NAME']
|
||||
s3 = resource('s3')
|
||||
return s3.Bucket(bucket_name).objects.filter(Prefix=prefix)
|
||||
|
||||
|
||||
def get_temp_truncated_filename(filename, user_id):
|
||||
return filename[len(TEMP_TAG.format(user_id=user_id)):]
|
||||
|
||||
|
||||
def s3upload(service_id, filedata, region):
|
||||
upload_id = str(uuid.uuid4())
|
||||
upload_file_name = FILE_LOCATION_STRUCTURE.format(service_id, upload_id)
|
||||
utils_s3upload(filedata=filedata['data'],
|
||||
region=region,
|
||||
bucket_name=current_app.config['CSV_UPLOAD_BUCKET_NAME'],
|
||||
file_location=upload_file_name)
|
||||
return upload_id
|
||||
|
||||
|
||||
def s3download(service_id, upload_id):
|
||||
contents = ''
|
||||
try:
|
||||
bucket_name = current_app.config['CSV_UPLOAD_BUCKET_NAME']
|
||||
upload_file_name = FILE_LOCATION_STRUCTURE.format(service_id, upload_id)
|
||||
key = get_s3_object(bucket_name, upload_file_name)
|
||||
contents = key.get()['Body'].read().decode('utf-8')
|
||||
except botocore.exceptions.ClientError as e:
|
||||
current_app.logger.error("Unable to download s3 file {}".format(
|
||||
FILE_LOCATION_STRUCTURE.format(service_id, upload_id)))
|
||||
raise e
|
||||
return contents
|
||||
|
||||
|
||||
def upload_logo(filename, filedata, region, user_id):
|
||||
upload_file_name = LOGO_LOCATION_STRUCTURE.format(
|
||||
temp=TEMP_TAG.format(user_id=user_id),
|
||||
unique_id=str(uuid.uuid4()),
|
||||
filename=filename
|
||||
)
|
||||
bucket_name = current_app.config['LOGO_UPLOAD_BUCKET_NAME']
|
||||
utils_s3upload(
|
||||
filedata=filedata,
|
||||
region=region,
|
||||
bucket_name=bucket_name,
|
||||
file_location=upload_file_name,
|
||||
content_type='image/png'
|
||||
)
|
||||
|
||||
return upload_file_name
|
||||
|
||||
|
||||
def persist_logo(filename, user_id):
|
||||
if filename.startswith(TEMP_TAG.format(user_id=user_id)):
|
||||
persisted_filename = get_temp_truncated_filename(
|
||||
filename=filename, user_id=user_id)
|
||||
else:
|
||||
return filename
|
||||
|
||||
rename_s3_object(filename, persisted_filename)
|
||||
|
||||
return persisted_filename
|
||||
|
||||
|
||||
def delete_temp_files_created_by(user_id):
|
||||
for obj in get_s3_objects_filter_by_prefix(TEMP_TAG.format(user_id=user_id)):
|
||||
delete_s3_object(obj.key)
|
||||
|
||||
|
||||
def delete_temp_file(filename):
|
||||
if not filename.startswith(TEMP_TAG[:5]):
|
||||
raise ValueError('Not a temp file: {}'.format(filename))
|
||||
|
||||
delete_s3_object(filename)
|
||||
@@ -1,32 +0,0 @@
|
||||
import uuid
|
||||
import botocore
|
||||
from boto3 import resource
|
||||
from flask import current_app
|
||||
from notifications_utils.s3 import s3upload as utils_s3upload
|
||||
|
||||
FILE_LOCATION_STRUCTURE = 'service-{}-notify/{}.csv'
|
||||
|
||||
|
||||
def s3upload(service_id, filedata, region):
|
||||
upload_id = str(uuid.uuid4())
|
||||
upload_file_name = FILE_LOCATION_STRUCTURE.format(service_id, upload_id)
|
||||
utils_s3upload(filedata=filedata['data'],
|
||||
region=region,
|
||||
bucket_name=current_app.config['CSV_UPLOAD_BUCKET_NAME'],
|
||||
file_location=upload_file_name)
|
||||
return upload_id
|
||||
|
||||
|
||||
def s3download(service_id, upload_id):
|
||||
contents = ''
|
||||
try:
|
||||
s3 = resource('s3')
|
||||
bucket_name = current_app.config['CSV_UPLOAD_BUCKET_NAME']
|
||||
upload_file_name = FILE_LOCATION_STRUCTURE.format(service_id, upload_id)
|
||||
key = s3.Object(bucket_name, upload_file_name)
|
||||
contents = key.get()['Body'].read().decode('utf-8')
|
||||
except botocore.exceptions.ClientError as e:
|
||||
current_app.logger.error("Unable to download s3 file {}".format(
|
||||
FILE_LOCATION_STRUCTURE.format(service_id, upload_id)))
|
||||
raise e
|
||||
return contents
|
||||
97
app/main/views/organisations.py
Normal file
97
app/main/views/organisations.py
Normal file
@@ -0,0 +1,97 @@
|
||||
from flask import current_app, redirect, render_template, session, url_for, request
|
||||
from flask_login import login_required
|
||||
|
||||
from app import organisations_client
|
||||
from app.main import main
|
||||
from app.main.forms import (
|
||||
ServiceSelectOrg,
|
||||
ServiceManageOrg)
|
||||
from app.utils import user_has_permissions, get_cdn_domain
|
||||
from app.main.s3_client import (
|
||||
TEMP_TAG,
|
||||
upload_logo,
|
||||
delete_temp_file,
|
||||
delete_temp_files_created_by,
|
||||
persist_logo
|
||||
)
|
||||
from app.main.views.service_settings import get_branding_as_value_and_label, get_branding_as_dict
|
||||
|
||||
|
||||
@main.route("/organisations", methods=['GET', 'POST'])
|
||||
@main.route("/organisations/<organisation_id>", methods=['GET', 'POST'])
|
||||
@login_required
|
||||
@user_has_permissions(admin_override=True)
|
||||
def organisations(organisation_id=None):
|
||||
orgs = organisations_client.get_organisations()
|
||||
|
||||
form = ServiceSelectOrg()
|
||||
form.organisation.choices = get_branding_as_value_and_label(orgs) + [('None', 'Create a new organisation')]
|
||||
|
||||
if form.validate_on_submit():
|
||||
if form.organisation.data != 'None':
|
||||
session['organisation'] = [o for o in orgs if o['id'] == form.organisation.data][0]
|
||||
elif session.get('organisation'):
|
||||
del session['organisation']
|
||||
|
||||
return redirect(url_for('.manage_org'))
|
||||
|
||||
form.organisation.data = organisation_id if organisation_id in [o['id'] for o in orgs] else 'None'
|
||||
|
||||
return render_template(
|
||||
'views/organisations/select-org.html',
|
||||
form=form,
|
||||
branding_dict=get_branding_as_dict(orgs),
|
||||
organisation_id=organisation_id
|
||||
)
|
||||
|
||||
|
||||
@main.route("/organisations/manage", methods=['GET', 'POST'])
|
||||
@main.route("/organisations/manage/<logo>", methods=['GET', 'POST'])
|
||||
@login_required
|
||||
@user_has_permissions(admin_override=True)
|
||||
def manage_org(logo=None):
|
||||
form = ServiceManageOrg()
|
||||
|
||||
org = session.get("organisation")
|
||||
|
||||
logo = logo if logo else org.get('logo') if org else None
|
||||
|
||||
if form.validate_on_submit():
|
||||
if form.file.data:
|
||||
upload_filename = upload_logo(
|
||||
form.file.data.filename,
|
||||
form.file.data,
|
||||
current_app.config['AWS_REGION'],
|
||||
user_id=session["user_id"]
|
||||
)
|
||||
|
||||
if logo and logo.startswith(TEMP_TAG.format(user_id=session['user_id'])):
|
||||
delete_temp_file(logo)
|
||||
|
||||
return redirect(
|
||||
url_for('.manage_org', logo=upload_filename))
|
||||
|
||||
logo = persist_logo(logo, session["user_id"])
|
||||
delete_temp_files_created_by(session["user_id"])
|
||||
|
||||
if org:
|
||||
organisations_client.update_organisation(
|
||||
org_id=org['id'], logo=logo, name=form.name.data, colour=form.colour.data)
|
||||
org_id = org['id']
|
||||
else:
|
||||
resp = organisations_client.create_organisation(
|
||||
logo=logo, name=form.name.data, colour=form.colour.data)
|
||||
org_id = resp['data']['id']
|
||||
|
||||
return redirect(url_for('.organisations', organisation_id=org_id))
|
||||
if org:
|
||||
form.name.data = org['name']
|
||||
form.colour.data = org['colour']
|
||||
|
||||
return render_template(
|
||||
'views/organisations/manage-org.html',
|
||||
form=form,
|
||||
organisation=org,
|
||||
cdn_url=get_cdn_domain(),
|
||||
logo=logo
|
||||
)
|
||||
@@ -33,7 +33,7 @@ from app.main.forms import (
|
||||
ChooseTimeForm,
|
||||
get_placeholder_form_instance
|
||||
)
|
||||
from app.main.uploader import (
|
||||
from app.main.s3_client import (
|
||||
s3upload,
|
||||
s3download
|
||||
)
|
||||
|
||||
@@ -19,3 +19,19 @@ class OrganisationsClient(NotifyAdminAPIClient):
|
||||
|
||||
def get_letter_organisations(self):
|
||||
return self.get(url='/dvla_organisations')
|
||||
|
||||
def create_organisation(self, logo, name, colour):
|
||||
data = {
|
||||
"logo": logo,
|
||||
"name": name,
|
||||
"colour": colour
|
||||
}
|
||||
return self.post(url="/organisation", data=data)
|
||||
|
||||
def update_organisation(self, org_id, logo, name, colour):
|
||||
data = {
|
||||
"logo": logo,
|
||||
"name": name,
|
||||
"colour": colour
|
||||
}
|
||||
return self.post(url="/organisation/{}".format(org_id), data=data)
|
||||
|
||||
@@ -6,12 +6,13 @@
|
||||
secondary_link=False,
|
||||
secondary_link_text=None,
|
||||
delete_link=False,
|
||||
delete_link_text="delete"
|
||||
delete_link_text="delete",
|
||||
button_disabled=False
|
||||
) %}
|
||||
<div class="page-footer">
|
||||
{% if button_text %}
|
||||
<input type="hidden" name="csrf_token" value="{{ csrf_token() }}" />
|
||||
<input type="submit" class="button{% if destructive %}-destructive{% endif %}" value="{{ button_text }}" />
|
||||
<input type="submit" class="button{% if destructive %}-destructive{% endif %}" value="{{ button_text }}"{% if button_disabled %} disabled{% endif %}/>
|
||||
{% endif %}
|
||||
{% if back_link %}
|
||||
<a class="page-footer-back-link" href="{{ back_link }}">{{ back_link_text }}</a>
|
||||
|
||||
@@ -79,16 +79,19 @@
|
||||
{% macro branding_radios(
|
||||
field,
|
||||
hint=None,
|
||||
branding_dict={}
|
||||
branding_dict={},
|
||||
show_header=True
|
||||
) %}
|
||||
<div class="form-group {% if field.errors %} form-group-error{% endif %}">
|
||||
<fieldset>
|
||||
<legend class="form-label">
|
||||
{{ field.label.text }}
|
||||
{% if show_header %}
|
||||
{{ field.label.text }}
|
||||
{% endif %}
|
||||
{% if field.errors %}
|
||||
<span class="error-message">
|
||||
{{ field.errors[0] }}
|
||||
</span>
|
||||
<span class="error-message">
|
||||
{{ field.errors[0] }}
|
||||
</span>
|
||||
{% endif %}
|
||||
</legend>
|
||||
{% for value, option, checked in field.iter_choices() %}
|
||||
@@ -102,7 +105,7 @@
|
||||
/>
|
||||
<label class="block-label" for="{{ field.name }}-{{ loop.index }}">
|
||||
{% if branding_dict.get(value, {}).get('colour') %}
|
||||
<span style="background: {{ branding_dict[value].colour }}; display: inline-block; width: 3px; height: 27px"></span>
|
||||
<span style="background: {{ branding_dict[value].colour }}; display: inline-block; width: 3px; height: 27px;"></span>
|
||||
{% endif %}
|
||||
{% if branding_dict.get(value, {}).get('logo') %}
|
||||
<img
|
||||
|
||||
55
app/templates/views/organisations/manage-org.html
Normal file
55
app/templates/views/organisations/manage-org.html
Normal file
@@ -0,0 +1,55 @@
|
||||
{% extends "views/platform-admin/_base_template.html" %}
|
||||
{% from "components/file-upload.html" import file_upload %}
|
||||
{% from "components/page-footer.html" import page_footer %}
|
||||
{% from "components/textbox.html" import textbox %}
|
||||
|
||||
{% block service_page_title %}
|
||||
{{ '{} an organisations logo'.format('Update' if organisation else 'Create')}}
|
||||
{% endblock %}
|
||||
|
||||
{% block platform_admin_content %}
|
||||
|
||||
<h1 class="heading-large">{{ '{} an organisations logo'.format('Update' if organisation else 'Create')}}</h1>
|
||||
<div class="grid-row">
|
||||
<div class="column-three-quarters">
|
||||
|
||||
{% if logo %}
|
||||
<div id="logo-img">
|
||||
<img src="https://{{ cdn_url }}/{{ logo }}"/>
|
||||
</div>
|
||||
{% endif %}
|
||||
{{
|
||||
file_upload(
|
||||
form.file,
|
||||
button_text='{} logo'.format('Update' if organisation else 'Upload')
|
||||
) }}
|
||||
<form method="post">
|
||||
<div class="form-group">
|
||||
<div style='margin-top:15px;'>{{textbox(form.name)}}</div>
|
||||
<div>{{textbox(form.colour, width='1-4')}}
|
||||
<span id='colour_span' style="background: {{ organisation.colour }}; {% if not organisation.colour %}visibility:hidden; {% endif %}border:1px black solid; width: 3px; height: 25px;position:absolute;margin-top:138px;margin-left:135px;display:block;"></span>
|
||||
</div>
|
||||
{{ page_footer(
|
||||
'Save',
|
||||
back_link=url_for('.organisations', organisation_id=organisation.id if organisation else 'None'),
|
||||
back_link_text='Back to organisation selection',
|
||||
button_disabled=True if not logo else False
|
||||
) }}
|
||||
</div>
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript">
|
||||
function update_colour_span() {
|
||||
document.getElementById('colour_span').style.background = '';
|
||||
if (document.getElementById('colour').value) {
|
||||
document.getElementById('colour_span').style.visibility = 'visible';
|
||||
document.getElementById('colour_span').style.background = document.getElementById('colour').value;
|
||||
}
|
||||
else {
|
||||
document.getElementById('colour_span').style.visibility = 'hidden';
|
||||
}
|
||||
}
|
||||
</script>
|
||||
{% endblock %}
|
||||
26
app/templates/views/organisations/select-org.html
Normal file
26
app/templates/views/organisations/select-org.html
Normal file
@@ -0,0 +1,26 @@
|
||||
{% extends "views/platform-admin/_base_template.html" %}
|
||||
{% from "components/radios.html" import radios, branding_radios %}
|
||||
{% from "components/page-footer.html" import page_footer %}
|
||||
|
||||
{% block service_page_title %}
|
||||
Select organisation
|
||||
{% endblock %}
|
||||
|
||||
{% block platform_admin_content %}
|
||||
|
||||
<h1 class="heading-large">
|
||||
<div>Select an organisation to update</div>
|
||||
<div>or create a new organisation</div>
|
||||
</h1>
|
||||
<div class="grid-row">
|
||||
<div class="column-three-quarters">
|
||||
<form method="post">
|
||||
{{ branding_radios(form.organisation, branding_dict=branding_dict, show_header=False) }}
|
||||
{{ page_footer(
|
||||
'Next'
|
||||
) }}
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{% endblock %}
|
||||
@@ -16,6 +16,7 @@
|
||||
('Live services', url_for('main.live_services')),
|
||||
('Trial mode services', url_for('main.trial_services')),
|
||||
('Providers', url_for('main.view_providers')),
|
||||
('Organisations', url_for('main.organisations')),
|
||||
('Letter jobs', url_for('main.letter_jobs'))
|
||||
] %}
|
||||
<li>
|
||||
|
||||
95
tests/app/main/test_s3_client.py
Normal file
95
tests/app/main/test_s3_client.py
Normal file
@@ -0,0 +1,95 @@
|
||||
from collections import namedtuple
|
||||
from unittest.mock import call
|
||||
import pytest
|
||||
|
||||
from app.main.s3_client import (
|
||||
upload_logo,
|
||||
persist_logo,
|
||||
delete_temp_file,
|
||||
delete_temp_files_created_by,
|
||||
get_temp_truncated_filename,
|
||||
LOGO_LOCATION_STRUCTURE,
|
||||
TEMP_TAG
|
||||
)
|
||||
|
||||
bucket = 'test_bucket'
|
||||
data = {'data': 'some_data'}
|
||||
filename = 'test.png'
|
||||
upload_id = 'test_uuid'
|
||||
region = 'eu-west1'
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def upload_filename(fake_uuid):
|
||||
return LOGO_LOCATION_STRUCTURE.format(
|
||||
temp=TEMP_TAG.format(user_id=fake_uuid), unique_id=upload_id, filename=filename)
|
||||
|
||||
|
||||
def test_upload_logo_calls_correct_args(client, mocker, fake_uuid, upload_filename):
|
||||
mocker.patch('uuid.uuid4', return_value=upload_id)
|
||||
mocker.patch.dict('flask.current_app.config', {'LOGO_UPLOAD_BUCKET_NAME': bucket})
|
||||
mocked_s3_upload = mocker.patch('app.main.s3_client.utils_s3upload')
|
||||
|
||||
upload_logo(filename=filename, user_id=fake_uuid, filedata=data, region=region)
|
||||
|
||||
assert mocked_s3_upload.called_once_with(
|
||||
filedata=data,
|
||||
region=region,
|
||||
file_location=upload_filename,
|
||||
bucket_name=bucket
|
||||
)
|
||||
|
||||
|
||||
def test_persist_logo(client, mocker, fake_uuid, upload_filename):
|
||||
mocker.patch.dict('flask.current_app.config', {'LOGO_UPLOAD_BUCKET_NAME': bucket})
|
||||
mocked_rename_s3_object = mocker.patch('app.main.s3_client.rename_s3_object')
|
||||
|
||||
persisted_filename = persist_logo(filename=upload_filename, user_id=fake_uuid)
|
||||
|
||||
assert mocked_rename_s3_object.called_once_with(
|
||||
upload_filename, get_temp_truncated_filename(upload_filename, fake_uuid))
|
||||
assert persisted_filename == get_temp_truncated_filename(upload_filename, fake_uuid)
|
||||
|
||||
|
||||
def test_persist_logo_returns_if_not_temp(client, mocker, fake_uuid):
|
||||
filename = 'logo.png'
|
||||
mocker.patch.dict('flask.current_app.config', {'LOGO_UPLOAD_BUCKET_NAME': bucket})
|
||||
mocked_rename_s3_object = mocker.patch('app.main.s3_client.rename_s3_object')
|
||||
|
||||
persisted_filename = persist_logo(filename=filename, user_id=fake_uuid)
|
||||
|
||||
assert not mocked_rename_s3_object.called
|
||||
assert persisted_filename == filename
|
||||
|
||||
|
||||
def test_delete_temp_files_created_by_user(client, mocker, fake_uuid):
|
||||
obj = namedtuple("obj", ["key"])
|
||||
objs = [obj(key='test1'), obj(key='test2')]
|
||||
|
||||
mocker.patch('app.main.s3_client.get_s3_objects_filter_by_prefix', return_value=objs)
|
||||
mocked_delete_s3_object = mocker.patch('app.main.s3_client.delete_s3_object')
|
||||
|
||||
delete_temp_files_created_by(fake_uuid)
|
||||
|
||||
assert mocked_delete_s3_object.called_with_args(objs[0].key)
|
||||
for index, arg in enumerate(mocked_delete_s3_object.call_args_list):
|
||||
assert arg == call(objs[index].key)
|
||||
|
||||
|
||||
def test_delete_single_temp_file(client, mocker, fake_uuid, upload_filename):
|
||||
mocked_delete_s3_object = mocker.patch('app.main.s3_client.delete_s3_object')
|
||||
|
||||
delete_temp_file(upload_filename)
|
||||
|
||||
assert mocked_delete_s3_object.called_with_args(upload_filename)
|
||||
|
||||
|
||||
def test_does_not_delete_non_temp_file(client, mocker, fake_uuid):
|
||||
filename = 'logo.png'
|
||||
mocked_delete_s3_object = mocker.patch('app.main.s3_client.delete_s3_object')
|
||||
|
||||
with pytest.raises(ValueError) as error:
|
||||
delete_temp_file(filename)
|
||||
|
||||
assert mocked_delete_s3_object.called_with_args(filename)
|
||||
assert str(error.value) == 'Not a temp file: {}'.format(filename)
|
||||
264
tests/app/main/views/test_organisations.py
Normal file
264
tests/app/main/views/test_organisations.py
Normal file
@@ -0,0 +1,264 @@
|
||||
from io import BytesIO
|
||||
from unittest.mock import call
|
||||
|
||||
from bs4 import BeautifulSoup
|
||||
from flask import url_for
|
||||
import pytest
|
||||
|
||||
from app.main.s3_client import TEMP_TAG, LOGO_LOCATION_STRUCTURE
|
||||
|
||||
sample_orgs = [
|
||||
{'id': '1', 'name': 'org 1', 'colour': 'red', 'logo': 'logo1.png'},
|
||||
{'id': '2', 'name': 'org 2', 'colour': 'orange', 'logo': 'logo2.png'},
|
||||
{'id': '3', 'name': None, 'colour': None, 'logo': 'logo3.png'},
|
||||
{'id': '4', 'name': 'org 4', 'colour': None, 'logo': 'logo4.png'},
|
||||
{'id': '5', 'name': None, 'colour': 'blue', 'logo': 'logo5.png'},
|
||||
]
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def request_get_manage_org_with_org(logged_in_platform_admin_client):
|
||||
with logged_in_platform_admin_client.session_transaction() as session:
|
||||
session['organisation'] = sample_orgs[0]
|
||||
|
||||
response = logged_in_platform_admin_client.get(
|
||||
url_for('.manage_org')
|
||||
)
|
||||
assert response.status_code == 200
|
||||
return BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def request_get_manage_org_without_org(logged_in_platform_admin_client):
|
||||
response = logged_in_platform_admin_client.get(
|
||||
url_for('.manage_org')
|
||||
)
|
||||
assert response.status_code == 200
|
||||
return BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
|
||||
|
||||
|
||||
def test_organisations_page_shows_full_orgs_list(logged_in_platform_admin_client, mocker):
|
||||
mocker.patch('app.organisations_client.get_organisations', return_value=sample_orgs)
|
||||
|
||||
response = logged_in_platform_admin_client.get(
|
||||
url_for('.organisations')
|
||||
)
|
||||
|
||||
assert response.status_code == 200
|
||||
page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
|
||||
assert ' '.join(page.find('h1').text.split()) == "Select an organisation to update or create a new organisation"
|
||||
for index, label in enumerate(page.select('div.multiple-choice > label')):
|
||||
if index < len(sample_orgs):
|
||||
if sample_orgs[index]['colour']:
|
||||
assert 'background: {};'.format(sample_orgs[index]['colour']) in label.find('span')['style']
|
||||
|
||||
assert ' '.join(label.text.split()) == str(sample_orgs[index]['name'])
|
||||
assert label.find('img')['src'].endswith('/' + sample_orgs[index]['logo'])
|
||||
else:
|
||||
assert ' '.join(label.text.split()) == 'Create a new organisation'
|
||||
|
||||
|
||||
@pytest.mark.parametrize("org_id", [
|
||||
'None', '1', '2'
|
||||
])
|
||||
def test_organisations_radio_default_to_just_updated_or_new_org(
|
||||
logged_in_platform_admin_client, mocker, org_id):
|
||||
mocker.patch('app.organisations_client.get_organisations', return_value=sample_orgs)
|
||||
|
||||
response = logged_in_platform_admin_client.get(
|
||||
url_for('.organisations', organisation_id=org_id)
|
||||
)
|
||||
|
||||
assert response.status_code == 200
|
||||
page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
|
||||
|
||||
selected = [r for r in page.select('div.multiple-choice > input') if r.attrs.get('checked')][0]
|
||||
assert selected["value"] == org_id
|
||||
|
||||
|
||||
def test_organisations_post_sets_organisation_in_session_after_selecting_org(
|
||||
logged_in_platform_admin_client, mocker):
|
||||
mocker.patch('app.organisations_client.get_organisations', return_value=sample_orgs)
|
||||
response = logged_in_platform_admin_client.post(
|
||||
url_for('.organisations'),
|
||||
data={'organisation': sample_orgs[0]['id']}
|
||||
)
|
||||
with logged_in_platform_admin_client.session_transaction() as session:
|
||||
assert session['organisation'] == sample_orgs[0]
|
||||
assert response.status_code == 302
|
||||
assert response.location == url_for('.manage_org', _external=True)
|
||||
|
||||
|
||||
def test_organisations_post_deletes_organisation_session_on_new_org(
|
||||
logged_in_platform_admin_client, mocker):
|
||||
mocker.patch('app.organisations_client.get_organisations', return_value=sample_orgs)
|
||||
with logged_in_platform_admin_client.session_transaction() as session:
|
||||
session['organisation'] = sample_orgs[0]
|
||||
|
||||
response = logged_in_platform_admin_client.post(
|
||||
url_for('.organisations'),
|
||||
data={'organisation': 'None'}
|
||||
)
|
||||
|
||||
with logged_in_platform_admin_client.session_transaction() as session:
|
||||
assert session.get('organisation') is None
|
||||
assert response.status_code == 302
|
||||
assert response.location == url_for('.manage_org', _external=True)
|
||||
|
||||
|
||||
def test_manage_orgs_shows_correct_org_info(request_get_manage_org_with_org):
|
||||
assert request_get_manage_org_with_org.select_one('#logo-img > img')['src'].endswith('/' + sample_orgs[0]['logo'])
|
||||
assert request_get_manage_org_with_org.select_one('#name').attrs.get('value') == sample_orgs[0]['name']
|
||||
assert request_get_manage_org_with_org.select_one('#colour').attrs.get('value') == sample_orgs[0]['colour']
|
||||
|
||||
|
||||
def test_manage_orgs_does_not_show_data_for_new_org(request_get_manage_org_without_org):
|
||||
assert request_get_manage_org_without_org.select_one('div.page-footer input.button').has_attr('disabled')
|
||||
assert request_get_manage_org_without_org.select_one('#logo-img > img') is None
|
||||
assert request_get_manage_org_without_org.select_one('#name').attrs.get('value') == ''
|
||||
assert request_get_manage_org_without_org.select_one('#colour').attrs.get('value') == ''
|
||||
|
||||
|
||||
def test_save_is_enabled_when_logo_is_set(request_get_manage_org_with_org):
|
||||
assert request_get_manage_org_with_org.select_one('div.page-footer input.button').has_attr('disabled') is False
|
||||
|
||||
|
||||
def test_save_is_disabled_when_logo_is_not_set(request_get_manage_org_without_org):
|
||||
assert request_get_manage_org_without_org.select_one('div.page-footer input.button').has_attr('disabled')
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def request_post_manage_org_redirect(logged_in_platform_admin_client, mocker, fake_uuid):
|
||||
with logged_in_platform_admin_client.session_transaction() as session:
|
||||
user_id = session["user_id"]
|
||||
|
||||
temp_filename = LOGO_LOCATION_STRUCTURE.format(
|
||||
temp=TEMP_TAG.format(user_id=user_id), unique_id=fake_uuid, filename='test.png')
|
||||
|
||||
mocker.patch('app.main.views.organisations.upload_logo', return_value=temp_filename)
|
||||
mocker.patch('app.main.views.organisations.delete_temp_file')
|
||||
mocker.patch('app.main.views.organisations.delete_temp_files_created_by')
|
||||
|
||||
response = logged_in_platform_admin_client.post(
|
||||
url_for('.manage_org'),
|
||||
data={'file': (BytesIO(''.encode('utf-8')), 'test.png')},
|
||||
content_type='multipart/form-data',
|
||||
follow_redirects=True
|
||||
)
|
||||
|
||||
assert response.status_code == 200
|
||||
return BeautifulSoup(response.data.decode('utf-8'), 'html.parser'), temp_filename
|
||||
|
||||
|
||||
def test_shows_temp_logo_after_uploading_logo(request_post_manage_org_redirect):
|
||||
page, temp_filename = request_post_manage_org_redirect
|
||||
assert page.select_one('#logo-img > img').attrs['src'].endswith(temp_filename)
|
||||
|
||||
|
||||
def test_save_enabled_after_uploading_logo(request_post_manage_org_redirect):
|
||||
page, _ = request_post_manage_org_redirect
|
||||
assert not page.select_one('div.page-footer input.button').has_attr('disabled')
|
||||
|
||||
|
||||
def test_deletes_previous_temp_logo_after_uploading_logo(logged_in_platform_admin_client, mocker, fake_uuid):
|
||||
with logged_in_platform_admin_client.session_transaction() as session:
|
||||
user_id = session["user_id"]
|
||||
|
||||
temp_old_filename = LOGO_LOCATION_STRUCTURE.format(
|
||||
temp=TEMP_TAG.format(user_id=user_id), unique_id=fake_uuid, filename='old_test.png')
|
||||
temp_filename = LOGO_LOCATION_STRUCTURE.format(
|
||||
temp=TEMP_TAG.format(user_id=user_id), unique_id=fake_uuid, filename='test.png')
|
||||
|
||||
mocked_upload_logo = mocker.patch(
|
||||
'app.main.views.organisations.upload_logo',
|
||||
return_value=temp_filename
|
||||
)
|
||||
mocked_delete_temp_file = mocker.patch('app.main.views.organisations.delete_temp_file')
|
||||
|
||||
logged_in_platform_admin_client.post(
|
||||
url_for('.manage_org', logo=temp_old_filename),
|
||||
data={'file': (BytesIO(''.encode('utf-8')), 'test.png')},
|
||||
content_type='multipart/form-data'
|
||||
)
|
||||
|
||||
assert mocked_upload_logo.called
|
||||
assert mocked_delete_temp_file.called
|
||||
assert mocked_delete_temp_file.call_args == call(temp_old_filename)
|
||||
|
||||
|
||||
def test_logo_persisted_when_organisation_saved(logged_in_platform_admin_client, mocker, fake_uuid):
|
||||
with logged_in_platform_admin_client.session_transaction() as session:
|
||||
user_id = session["user_id"]
|
||||
|
||||
temp_filename = LOGO_LOCATION_STRUCTURE.format(
|
||||
temp=TEMP_TAG.format(user_id=user_id), unique_id=fake_uuid, filename='test.png')
|
||||
|
||||
mocked_upload_logo = mocker.patch('app.main.views.organisations.upload_logo')
|
||||
mocked_persist_logo = mocker.patch('app.main.views.organisations.persist_logo', return_value='test.png')
|
||||
mocked_delete_temp_files_by = mocker.patch('app.main.views.organisations.delete_temp_files_created_by')
|
||||
|
||||
logged_in_platform_admin_client.post(
|
||||
url_for('.manage_org', logo=temp_filename),
|
||||
content_type='multipart/form-data'
|
||||
)
|
||||
|
||||
assert not mocked_upload_logo.called
|
||||
assert mocked_persist_logo.called
|
||||
assert mocked_delete_temp_files_by.called
|
||||
assert mocked_delete_temp_files_by.call_args == call(user_id)
|
||||
|
||||
|
||||
def test_existing_organisation_updated_when_organisation_saved(logged_in_platform_admin_client, mocker, fake_uuid):
|
||||
with logged_in_platform_admin_client.session_transaction() as session:
|
||||
session["organisation"] = sample_orgs[0]
|
||||
user_id = session["user_id"]
|
||||
|
||||
update_org = {'logo': 'test.png', 'colour': 'blue', 'name': 'new name'}
|
||||
|
||||
temp_filename = LOGO_LOCATION_STRUCTURE.format(
|
||||
temp=TEMP_TAG.format(user_id=user_id), unique_id=fake_uuid, filename=update_org['logo'])
|
||||
|
||||
mocked_update_org = mocker.patch('app.organisations_client.update_organisation')
|
||||
mocker.patch('app.main.views.organisations.persist_logo', return_value=update_org['logo'])
|
||||
mocker.patch('app.main.views.organisations.delete_temp_files_created_by')
|
||||
|
||||
logged_in_platform_admin_client.post(
|
||||
url_for('.manage_org', logo=temp_filename),
|
||||
content_type='multipart/form-data',
|
||||
data={'colour': update_org['colour'], 'name': update_org['name'], 'cdn_url': 'https://static-logos.cdn.com'}
|
||||
)
|
||||
|
||||
assert mocked_update_org.called
|
||||
assert mocked_update_org.call_args == call(
|
||||
org_id=sample_orgs[0]['id'],
|
||||
logo=update_org['logo'],
|
||||
name=update_org['name'],
|
||||
colour=update_org['colour']
|
||||
)
|
||||
|
||||
|
||||
def test_create_new_organisation_when_organisation_saved(logged_in_platform_admin_client, mocker, fake_uuid):
|
||||
with logged_in_platform_admin_client.session_transaction() as session:
|
||||
user_id = session["user_id"]
|
||||
|
||||
new_org = {'logo': 'test.png', 'colour': 'red', 'name': 'new name'}
|
||||
|
||||
temp_filename = LOGO_LOCATION_STRUCTURE.format(
|
||||
temp=TEMP_TAG.format(user_id=user_id), unique_id=fake_uuid, filename=new_org['logo'])
|
||||
|
||||
mocked_new_org = mocker.patch('app.organisations_client.create_organisation')
|
||||
mocker.patch('app.main.views.organisations.persist_logo', return_value=new_org['logo'])
|
||||
mocker.patch('app.main.views.organisations.delete_temp_files_created_by')
|
||||
|
||||
logged_in_platform_admin_client.post(
|
||||
url_for('.manage_org', logo=temp_filename),
|
||||
content_type='multipart/form-data',
|
||||
data={'colour': new_org['colour'], 'name': new_org['name'], 'cdn_url': 'https://static-logos.cdn.com'}
|
||||
)
|
||||
|
||||
assert mocked_new_org.called
|
||||
assert mocked_new_org.call_args == call(
|
||||
logo=new_org['logo'],
|
||||
name=new_org['name'],
|
||||
colour=new_org['colour']
|
||||
)
|
||||
50
tests/app/notify_client/test_organisations_client.py
Normal file
50
tests/app/notify_client/test_organisations_client.py
Normal file
@@ -0,0 +1,50 @@
|
||||
from app.notify_client.organisations_client import OrganisationsClient
|
||||
|
||||
|
||||
def test_get_organisation(mocker, fake_uuid):
|
||||
mock_get = mocker.patch('app.notify_client.organisations_client.OrganisationsClient.get')
|
||||
OrganisationsClient().get_organisation(fake_uuid)
|
||||
mock_get.assert_called_once_with(
|
||||
url='/organisation/{}'.format(fake_uuid)
|
||||
)
|
||||
|
||||
|
||||
def test_get_organisations(mocker):
|
||||
mock_get = mocker.patch('app.notify_client.organisations_client.OrganisationsClient.get')
|
||||
OrganisationsClient().get_organisations()
|
||||
mock_get.assert_called_once_with(
|
||||
url='/organisation'
|
||||
)
|
||||
|
||||
|
||||
def test_get_letter_organisations(mocker):
|
||||
mock_get = mocker.patch('app.notify_client.organisations_client.OrganisationsClient.get')
|
||||
OrganisationsClient().get_letter_organisations()
|
||||
mock_get.assert_called_once_with(
|
||||
url='/dvla_organisations'
|
||||
)
|
||||
|
||||
|
||||
def test_create_organisations(mocker):
|
||||
org_data = {'logo': 'test.png', 'name': 'test name', 'colour': 'red'}
|
||||
|
||||
mock_post = mocker.patch('app.notify_client.organisations_client.OrganisationsClient.post')
|
||||
OrganisationsClient().create_organisation(logo=org_data['logo'], name=org_data['name'], colour=org_data['colour'])
|
||||
|
||||
mock_post.assert_called_once_with(
|
||||
url='/organisation',
|
||||
data=org_data
|
||||
)
|
||||
|
||||
|
||||
def test_update_organisations(mocker, fake_uuid):
|
||||
org_data = {'logo': 'test.png', 'name': 'test name', 'colour': 'red'}
|
||||
|
||||
mock_post = mocker.patch('app.notify_client.organisations_client.OrganisationsClient.post')
|
||||
OrganisationsClient().update_organisation(
|
||||
org_id=fake_uuid, logo=org_data['logo'], name=org_data['name'], colour=org_data['colour'])
|
||||
|
||||
mock_post.assert_called_once_with(
|
||||
url='/organisation/{}'.format(fake_uuid),
|
||||
data=org_data
|
||||
)
|
||||
Reference in New Issue
Block a user