notifications-api/tests/app/aws/test_s3.py

from unittest.mock import call
from datetime import datetime, timedelta
import pytest
import pytz

from freezegun import freeze_time

from app.aws.s3 import (
    get_s3_bucket_objects,
    get_s3_file,
    filter_s3_bucket_objects_within_date_range,
    get_list_of_files_by_suffix,
)
from tests.app.conftest import datetime_in_past


def single_s3_object_stub(key='foo', last_modified=datetime.utcnow()):
    return {
        'ETag': '"d41d8cd98f00b204e9800998ecf8427e"',
        'Key': key,
        'LastModified': last_modified
    }


def test_get_s3_file_makes_correct_call(notify_api, mocker):
    get_s3_mock = mocker.patch('app.aws.s3.get_s3_object')
    get_s3_file('foo-bucket', 'bar-file.txt')

    get_s3_mock.assert_called_with(
        'foo-bucket',
        'bar-file.txt'
    )


def test_get_s3_bucket_objects_make_correct_pagination_call(notify_api, mocker):
    paginator_mock = mocker.patch('app.aws.s3.client')

    get_s3_bucket_objects('foo-bucket', subfolder='bar')

    paginator_mock.assert_has_calls([
        call().get_paginator().paginate(Bucket='foo-bucket', Prefix='bar')
    ])


def test_get_s3_bucket_objects_builds_objects_list_from_paginator(notify_api, mocker):
    AFTER_SEVEN_DAYS = datetime_in_past(days=8)
    paginator_mock = mocker.patch('app.aws.s3.client')
    multiple_pages_s3_object = [
        {
            "Contents": [
                single_s3_object_stub('bar/foo.txt', AFTER_SEVEN_DAYS),
            ]
        },
        {
            "Contents": [
                single_s3_object_stub('bar/foo1.txt', AFTER_SEVEN_DAYS),
            ]
        }
    ]
    paginator_mock.return_value.get_paginator.return_value.paginate.return_value = multiple_pages_s3_object

    bucket_objects = get_s3_bucket_objects('foo-bucket', subfolder='bar')

    assert len(bucket_objects) == 2
    assert set(bucket_objects[0].keys()) == set(['ETag', 'Key', 'LastModified'])


@freeze_time("2016-01-01 11:00:00")
def test_get_s3_bucket_objects_removes_redundant_root_object(notify_api, mocker):
    AFTER_SEVEN_DAYS = datetime_in_past(days=8)
    s3_objects_stub = [
        single_s3_object_stub('bar/', AFTER_SEVEN_DAYS),
        single_s3_object_stub('bar/foo.txt', AFTER_SEVEN_DAYS),
    ]

    filtered_items = filter_s3_bucket_objects_within_date_range(s3_objects_stub)

    assert len(filtered_items) == 1

    assert filtered_items[0]["Key"] == 'bar/foo.txt'
    assert filtered_items[0]["LastModified"] == datetime_in_past(days=8)


@freeze_time("2016-01-01 11:00:00")
def test_filter_s3_bucket_objects_within_date_range_filters_by_date_range(notify_api, mocker):
    START_DATE = datetime_in_past(days=9)
    JUST_BEFORE_START_DATE = START_DATE - timedelta(seconds=1)
    JUST_AFTER_START_DATE = START_DATE + timedelta(seconds=1)
    END_DATE = datetime_in_past(days=7)
    JUST_BEFORE_END_DATE = END_DATE - timedelta(seconds=1)
    JUST_AFTER_END_DATE = END_DATE + timedelta(seconds=1)

    s3_objects_stub = [
        single_s3_object_stub('bar/', JUST_BEFORE_START_DATE),
        single_s3_object_stub('bar/foo.txt', START_DATE),
        single_s3_object_stub('bar/foo2.txt', JUST_AFTER_START_DATE),
        single_s3_object_stub('bar/foo3.txt', JUST_BEFORE_END_DATE),
        single_s3_object_stub('bar/foo4.txt', END_DATE),
        single_s3_object_stub('bar/foo5.txt', JUST_AFTER_END_DATE),
    ]

    filtered_items = filter_s3_bucket_objects_within_date_range(s3_objects_stub)

    assert len(filtered_items) == 2

    assert filtered_items[0]["Key"] == 'bar/foo2.txt'
    assert filtered_items[0]["LastModified"] == JUST_AFTER_START_DATE

    assert filtered_items[1]["Key"] == 'bar/foo3.txt'
    assert filtered_items[1]["LastModified"] == JUST_BEFORE_END_DATE


@freeze_time("2016-01-01 11:00:00")
def test_get_s3_bucket_objects_does_not_return_outside_of_date_range(notify_api, mocker):
    START_DATE = datetime_in_past(days=9)
    JUST_BEFORE_START_DATE = START_DATE - timedelta(seconds=1)
    END_DATE = datetime_in_past(days=7)
    JUST_AFTER_END_DATE = END_DATE + timedelta(seconds=1)

    s3_objects_stub = [
        single_s3_object_stub('bar/', JUST_BEFORE_START_DATE),
        single_s3_object_stub('bar/foo1.txt', START_DATE),
        single_s3_object_stub('bar/foo2.txt', END_DATE),
        single_s3_object_stub('bar/foo3.txt', JUST_AFTER_END_DATE)
    ]

    filtered_items = filter_s3_bucket_objects_within_date_range(s3_objects_stub)

    assert len(filtered_items) == 0


@freeze_time("2018-01-11 00:00:00")
@pytest.mark.parametrize('suffix_str, days_before, returned_no', [
    ('.ACK.txt', None, 1),
    ('.ack.txt', None, 1),
    ('.ACK.TXT', None, 1),
    ('', None, 2),
    ('', 1, 1),
])
def test_get_list_of_files_by_suffix(notify_api, mocker, suffix_str, days_before, returned_no):
    paginator_mock = mocker.patch('app.aws.s3.client')
    multiple_pages_s3_object = [
        {
            "Contents": [
                single_s3_object_stub('bar/foo.ACK.txt', datetime_in_past(1, 0)),
            ]
        },
        {
            "Contents": [
                single_s3_object_stub('bar/foo1.rs.txt', datetime_in_past(2, 0)),
            ]
        }
    ]
    paginator_mock.return_value.get_paginator.return_value.paginate.return_value = multiple_pages_s3_object
    if (days_before):
        key = get_list_of_files_by_suffix('foo-bucket', subfolder='bar', suffix=suffix_str,
                                          last_modified=datetime.now(tz=pytz.utc) - timedelta(days=days_before))
    else:
        key = get_list_of_files_by_suffix('foo-bucket', subfolder='bar', suffix=suffix_str)

    assert sum(1 for x in key) == returned_no
    for k in key:
        assert k == 'bar/foo.ACK.txt'


def test_get_list_of_files_by_suffix_empty_contents_return_with_no_error(notify_api, mocker):
    paginator_mock = mocker.patch('app.aws.s3.client')
    multiple_pages_s3_object = [
        {
            "other_content": [
                'some_values',
            ]
        }
    ]
    paginator_mock.return_value.get_paginator.return_value.paginate.return_value = multiple_pages_s3_object
    key = get_list_of_files_by_suffix('foo-bucket', subfolder='bar', suffix='.pdf')

    assert sum(1 for x in key) == 0