Refactor to split s3_client.py into multiple files

Separated s3_client.py into 3 files - for logos, CSV files and the MOU.
This helps to keep things clearer now that we need to add lots more logo
functions for letters.

tests/app/main/test_s3_client.py

@@ -1,130 +0,0 @@
-from collections import namedtuple
-from unittest.mock import Mock, call
-
-import pytest
-
-from app.main.s3_client import (
-    LOGO_LOCATION_STRUCTURE,
-    TEMP_TAG,
-    delete_temp_file,
-    delete_temp_files_created_by,
-    permanent_logo_name,
-    persist_logo,
-    set_metadata_on_csv_upload,
-    upload_logo,
-)
-
-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_get_s3_object = mocker.patch('app.main.s3_client.get_s3_object')
-    mocked_delete_s3_object = mocker.patch('app.main.s3_client.delete_s3_object')
-
-    new_filename = permanent_logo_name(upload_filename, fake_uuid)
-
-    persist_logo(upload_filename, new_filename)
-
-    assert mocked_get_s3_object.called_once_with(bucket, new_filename)
-    assert mocked_delete_s3_object.called_once_with(bucket, upload_filename)
-
-
-def test_persist_logo_returns_if_not_temp(client, mocker, fake_uuid):
-    filename = 'logo.png'
-    persist_logo(filename, filename)
-
-    mocked_get_s3_object = mocker.patch('app.main.s3_client.get_s3_object')
-    mocked_delete_s3_object = mocker.patch('app.main.s3_client.delete_s3_object')
-
-    mocked_get_s3_object.assert_not_called()
-    mocked_delete_s3_object.assert_not_called()
-
-
-def test_permanent_logo_name_removes_temp_tag_from_filename(upload_filename, fake_uuid):
-    new_name = permanent_logo_name(upload_filename, fake_uuid)
-
-    assert new_name == 'test_uuid-test.png'
-
-
-def test_permanent_logo_name_does_not_change_filenames_with_no_temp_tag():
-    filename = 'logo.png'
-    new_name = permanent_logo_name(filename, filename)
-
-    assert new_name == 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)
-
-
-def test_sets_metadata(client, mocker):
-    mocked_s3_object = Mock()
-    mocked_get_s3_object = mocker.patch(
-        'app.main.s3_client.get_csv_upload',
-        return_value=mocked_s3_object,
-    )
-
-    set_metadata_on_csv_upload('1234', '5678', foo='bar', baz=True)
-
-    mocked_get_s3_object.assert_called_once_with('1234', '5678')
-    mocked_s3_object.copy_from.assert_called_once_with(
-        CopySource='test-notifications-csv-upload/service-1234-notify/5678.csv',
-        Metadata={'baz': 'True', 'foo': 'bar'},
-        MetadataDirective='REPLACE',
-        ServerSideEncryption='AES256',
-    )

tests/app/main/views/test_agreement.py

@@ -78,7 +78,7 @@ def test_downloading_agreement(
     expected_file_served,
 ):
     mock_get_s3_object = mocker.patch(
-        'app.main.s3_client.get_s3_object',
+        'app.s3_client.s3_mou_client.get_s3_object',
         return_value=_MockS3Object(b'foo')
     )
     user = active_user_with_permissions(fake_uuid)
@@ -100,7 +100,7 @@ def test_agreement_cant_be_downloaded_unknown_crown_status(
     fake_uuid,
 ):
     mock_get_s3_object = mocker.patch(
-        'app.main.s3_client.get_s3_object',
+        'app.s3_client.s3_mou_client.get_s3_object',
         return_value=_MockS3Object()
     )
     user = active_user_with_permissions(fake_uuid)
@@ -116,7 +116,7 @@ def test_agreement_requires_login(
     mocker,
 ):
     mock_get_s3_object = mocker.patch(
-        'app.main.s3_client.get_s3_object',
+        'app.s3_client.s3_mou_client.get_s3_object',
         return_value=_MockS3Object()
     )
     response = client.get(url_for('main.download_agreement'))
@@ -142,7 +142,7 @@ def test_show_public_agreement_page(
     expected_status,
 ):
     mocker.patch(
-        'app.main.s3_client.get_s3_object',
+        'app.s3_client.s3_mou_client.get_s3_object',
         return_value=_MockS3Object()
     )
     response = client.get(url_for(

tests/app/main/views/test_email_branding.py

@@ -6,7 +6,7 @@ from bs4 import BeautifulSoup
 from flask import url_for
 from notifications_python_client.errors import HTTPError
 
-from app.main.s3_client import LOGO_LOCATION_STRUCTURE, TEMP_TAG
+from app.s3_client.s3_logo_client import LOGO_LOCATION_STRUCTURE, TEMP_TAG
 from tests.conftest import (
     mock_get_email_branding,
     normalize_spaces,