Merge pull request #1403 from alphagov/ken-admin-orgs

Add pages to create and manage organisation branding for Emails

tests/app/main/test_s3_client.py

@@ -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)

tests/app/main/views/test_organisations.py

@@ -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']
+    )

tests/app/notify_client/test_organisations_client.py

@@ -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
+    )