import json import uuid from collections import namedtuple from datetime import datetime from io import BytesIO from unittest.mock import Mock, call import pytest from botocore.exceptions import ClientError as BotoClientError from app import db from app.clients.cbc_proxy import ( CBCProxyClient, CBCProxyEE, CBCProxyO2, CBCProxyRetryableException, CBCProxyThree, CBCProxyVodafone, ) from app.utils import DATETIME_FORMAT EXAMPLE_AREAS = [{ 'description': 'london', 'polygon': [ [51.12, -1.2], [51.12, 1.2], [51.74, 1.2], [51.74, -1.2], [51.12, -1.2], ], }] @pytest.fixture(scope='function') def cbc_proxy_client(client, mocker): client = CBCProxyClient() current_app = mocker.Mock(config={ 'CBC_PROXY_AWS_ACCESS_KEY_ID': 'cbc-proxy-aws-access-key-id', 'CBC_PROXY_AWS_SECRET_ACCESS_KEY': 'cbc-proxy-aws-secret-access-key', 'CBC_PROXY_ENABLED': True, }) client.init_app(current_app) return client @pytest.fixture def cbc_proxy_ee(cbc_proxy_client): return cbc_proxy_client.get_proxy('ee') @pytest.fixture def cbc_proxy_vodafone(cbc_proxy_client): return cbc_proxy_client.get_proxy('vodafone') @pytest.mark.parametrize('provider_name, expected_provider_class', [ ('ee', CBCProxyEE), ('three', CBCProxyThree), ('o2', CBCProxyO2), ('vodafone', CBCProxyVodafone), ]) def test_cbc_proxy_client_returns_correct_client(provider_name, expected_provider_class): mock_lambda = Mock() cbc_proxy_client = CBCProxyClient() cbc_proxy_client._lambda_client = mock_lambda ret = cbc_proxy_client.get_proxy(provider_name) assert type(ret) == expected_provider_class assert ret._lambda_client == mock_lambda def test_cbc_proxy_lambda_client_has_correct_region(cbc_proxy_ee): assert cbc_proxy_ee._lambda_client._client_config.region_name == 'eu-west-2' def test_cbc_proxy_lambda_client_has_correct_keys(cbc_proxy_ee): key = cbc_proxy_ee._lambda_client._request_signer._credentials.access_key secret = cbc_proxy_ee._lambda_client._request_signer._credentials.secret_key assert key == 'cbc-proxy-aws-access-key-id' assert secret == 'cbc-proxy-aws-secret-access-key' def test_cbc_proxy_send_link_test(mocker, cbc_proxy_ee): mock_send_link_test = mocker.patch.object(cbc_proxy_ee, '_send_link_test') cbc_proxy_ee.send_link_test() mock_send_link_test.assert_any_call(cbc_proxy_ee.lambda_name) mock_send_link_test.assert_any_call(cbc_proxy_ee.failover_lambda_name) @pytest.mark.parametrize('description, expected_language', ( ('my-description', 'en-GB'), ('mŷ-description', 'cy-GB'), )) @pytest.mark.parametrize('cbc', ['ee', 'three', 'o2']) def test_cbc_proxy_one_2_many_create_and_send_invokes_function( mocker, cbc_proxy_client, description, cbc, expected_language, ): cbc_proxy = cbc_proxy_client.get_proxy(cbc) identifier = 'my-identifier' headline = 'my-headline' sent = 'a-passed-through-sent-value' expires = 'a-passed-through-expires-value' ld_client_mock = mocker.patch.object( cbc_proxy, '_lambda_client', create=True, ) ld_client_mock.invoke.return_value = { 'StatusCode': 200, } cbc_proxy.create_and_send_broadcast( identifier=identifier, message_number='0000007b', headline=headline, description=description, areas=EXAMPLE_AREAS, sent=sent, expires=expires, channel="severe", ) ld_client_mock.invoke.assert_called_once_with( FunctionName=f'{cbc}-1-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ) kwargs = ld_client_mock.invoke.mock_calls[0][-1] payload_bytes = kwargs['Payload'] payload = json.loads(payload_bytes) assert payload['identifier'] == identifier assert 'message_number' not in payload assert payload['message_format'] == 'cap' assert payload['message_type'] == 'alert' assert payload['headline'] == headline assert payload['description'] == description assert payload['areas'] == EXAMPLE_AREAS assert payload['sent'] == sent assert payload['expires'] == expires assert payload['language'] == expected_language assert payload['channel'] == 'severe' @pytest.mark.parametrize('cbc', ['ee', 'three', 'o2']) def test_cbc_proxy_one_2_many_cancel_invokes_function(mocker, cbc_proxy_client, cbc): cbc_proxy = cbc_proxy_client.get_proxy(cbc) identifier = 'my-identifier' MockProviderMessage = namedtuple( 'BroadcastProviderMessage', ['id', 'message_number', 'created_at'] ) provider_messages = [ MockProviderMessage(uuid.uuid4(), '0000007b', datetime(2020, 12, 16)), MockProviderMessage(uuid.uuid4(), '0000004e', datetime(2020, 12, 17)) ] sent = '2020-12-17 14:19:44.130585' ld_client_mock = mocker.patch.object( cbc_proxy, '_lambda_client', create=True, ) ld_client_mock.invoke.return_value = { 'StatusCode': 200, } cbc_proxy.cancel_broadcast( identifier=identifier, message_number='00000050', previous_provider_messages=provider_messages, sent=sent ) ld_client_mock.invoke.assert_called_once_with( FunctionName=f'{cbc}-1-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ) kwargs = ld_client_mock.invoke.mock_calls[0][-1] payload_bytes = kwargs['Payload'] payload = json.loads(payload_bytes) assert payload['identifier'] == identifier assert 'message_number' not in payload assert payload['message_format'] == 'cap' assert payload['message_type'] == 'cancel' assert payload['references'] == [ { "message_id": str(provider_messages[0].id), "sent": provider_messages[0].created_at.strftime(DATETIME_FORMAT) }, { "message_id": str(provider_messages[1].id), "sent": provider_messages[1].created_at.strftime(DATETIME_FORMAT) }, ] assert payload['sent'] == sent @pytest.mark.parametrize('description, expected_language', ( ('my-description', 'English'), ('mŷ-description', 'Welsh'), )) def test_cbc_proxy_vodafone_create_and_send_invokes_function( mocker, cbc_proxy_vodafone, description, expected_language, ): identifier = 'my-identifier' headline = 'my-headline' sent = 'a-passed-through-sent-value' expires = 'a-passed-through-expires-value' ld_client_mock = mocker.patch.object( cbc_proxy_vodafone, '_lambda_client', create=True, ) ld_client_mock.invoke.return_value = { 'StatusCode': 200, } cbc_proxy_vodafone.create_and_send_broadcast( identifier=identifier, message_number='0000007b', headline=headline, description=description, areas=EXAMPLE_AREAS, sent=sent, expires=expires, channel="test", ) ld_client_mock.invoke.assert_called_once_with( FunctionName='vodafone-1-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ) kwargs = ld_client_mock.invoke.mock_calls[0][-1] payload_bytes = kwargs['Payload'] payload = json.loads(payload_bytes) assert payload['identifier'] == identifier assert payload['message_number'] == '0000007b' assert payload['message_format'] == 'ibag' assert payload['message_type'] == 'alert' assert payload['headline'] == headline assert payload['description'] == description assert payload['areas'] == EXAMPLE_AREAS assert payload['sent'] == sent assert payload['expires'] == expires assert payload['language'] == expected_language assert payload['channel'] == 'test' def test_cbc_proxy_vodafone_cancel_invokes_function(mocker, cbc_proxy_vodafone): identifier = 'my-identifier' MockProviderMessage = namedtuple( 'BroadcastProviderMessage', ['id', 'message_number', 'created_at'] ) provider_messages = [ MockProviderMessage(uuid.uuid4(), 78, datetime(2020, 12, 16)), MockProviderMessage(uuid.uuid4(), 123, datetime(2020, 12, 17)) ] sent = '2020-12-18 14:19:44.130585' ld_client_mock = mocker.patch.object( cbc_proxy_vodafone, '_lambda_client', create=True, ) ld_client_mock.invoke.return_value = { 'StatusCode': 200, } cbc_proxy_vodafone.cancel_broadcast( identifier=identifier, message_number='00000050', previous_provider_messages=provider_messages, sent=sent ) ld_client_mock.invoke.assert_called_once_with( FunctionName='vodafone-1-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ) kwargs = ld_client_mock.invoke.mock_calls[0][-1] payload_bytes = kwargs['Payload'] payload = json.loads(payload_bytes) assert payload['identifier'] == identifier assert payload['message_number'] == '00000050' assert payload['message_format'] == 'ibag' assert payload['message_type'] == 'cancel' assert payload['references'] == [ { "message_id": str(provider_messages[0].id), "message_number": '0000004e', "sent": provider_messages[0].created_at.strftime(DATETIME_FORMAT) }, { "message_id": str(provider_messages[1].id), "message_number": '0000007b', "sent": provider_messages[1].created_at.strftime(DATETIME_FORMAT) }, ] assert payload['sent'] == sent @pytest.mark.parametrize('cbc', ['ee', 'vodafone', 'three', 'o2']) def test_cbc_proxy_will_failover_to_second_lambda_if_boto_client_error( mocker, cbc_proxy_client, cbc ): cbc_proxy = cbc_proxy_client.get_proxy(cbc) ld_client_mock = mocker.patch.object( cbc_proxy, '_lambda_client', create=True, ) ld_client_mock.invoke.side_effect = BotoClientError({}, 'error') with pytest.raises(CBCProxyRetryableException) as e: cbc_proxy.create_and_send_broadcast( identifier='my-identifier', message_number='0000007b', headline='my-headline', description='test-description', areas=EXAMPLE_AREAS, sent='a-passed-through-sent-value', expires='a-passed-through-expires-value', channel="severe", ) assert e.match(f'Lambda failed for both {cbc}-1-proxy and {cbc}-2-proxy') assert ld_client_mock.invoke.call_args_list == [ call( FunctionName=f'{cbc}-1-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ), call( FunctionName=f'{cbc}-2-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ) ] @pytest.mark.parametrize('cbc', ['ee', 'vodafone', 'three', 'o2']) def test_cbc_proxy_will_failover_to_second_lambda_if_function_error( mocker, cbc_proxy_client, cbc ): cbc_proxy = cbc_proxy_client.get_proxy(cbc) ld_client_mock = mocker.patch.object( cbc_proxy, '_lambda_client', create=True, ) ld_client_mock.invoke.side_effect = [ { 'StatusCode': 200, 'FunctionError': 'Handled', 'Payload': BytesIO(json.dumps({"errorMessage": "", "errorType": "CBCNewConnectionError"}).encode('utf-8')), }, { 'StatusCode': 200 } ] cbc_proxy.create_and_send_broadcast( identifier='my-identifier', message_number='0000007b', headline='my-headline', description='test-description', areas=EXAMPLE_AREAS, sent='a-passed-through-sent-value', expires='a-passed-through-expires-value', channel="severe", ) assert ld_client_mock.invoke.call_args_list == [ call( FunctionName=f'{cbc}-1-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ), call( FunctionName=f'{cbc}-2-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ) ] @pytest.mark.parametrize('cbc', ['ee', 'vodafone', 'three', 'o2']) def test_cbc_proxy_will_failover_to_second_lambda_if_invoke_error( mocker, cbc_proxy_client, cbc ): cbc_proxy = cbc_proxy_client.get_proxy(cbc) ld_client_mock = mocker.patch.object( cbc_proxy, '_lambda_client', create=True, ) ld_client_mock.invoke.side_effect = [ { 'StatusCode': 400 }, { 'StatusCode': 200 } ] cbc_proxy.create_and_send_broadcast( identifier='my-identifier', message_number='0000007b', headline='my-headline', description='test-description', areas=EXAMPLE_AREAS, sent='a-passed-through-sent-value', expires='a-passed-through-expires-value', channel="test", ) assert ld_client_mock.invoke.call_args_list == [ call( FunctionName=f'{cbc}-1-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ), call( FunctionName=f'{cbc}-2-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ) ] @pytest.mark.parametrize('cbc', ['ee', 'vodafone', 'three', 'o2']) def test_cbc_proxy_create_and_send_tries_failover_lambda_on_invoke_error_and_raises_if_both_invoke_error( mocker, cbc_proxy_client, cbc ): cbc_proxy = cbc_proxy_client.get_proxy(cbc) ld_client_mock = mocker.patch.object( cbc_proxy, '_lambda_client', create=True, ) ld_client_mock.invoke.return_value = { 'StatusCode': 400, } with pytest.raises(CBCProxyRetryableException) as e: cbc_proxy.create_and_send_broadcast( identifier='my-identifier', message_number='0000007b', headline='my-headline', description='my-description', areas=EXAMPLE_AREAS, sent='a-passed-through-sent-value', expires='a-passed-through-expires-value', channel="test", ) assert e.match(f'Lambda failed for both {cbc}-1-proxy and {cbc}-2-proxy') assert ld_client_mock.invoke.call_args_list == [ call( FunctionName=f'{cbc}-1-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ), call( FunctionName=f'{cbc}-2-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ) ] @pytest.mark.parametrize('cbc', ['ee', 'vodafone', 'three', 'o2']) def test_cbc_proxy_create_and_send_tries_failover_lambda_on_function_error_and_raises_if_both_function_error( mocker, cbc_proxy_client, cbc ): cbc_proxy = cbc_proxy_client.get_proxy(cbc) ld_client_mock = mocker.patch.object( cbc_proxy, '_lambda_client', create=True, ) ld_client_mock.invoke.return_value = { 'StatusCode': 200, 'FunctionError': 'something', 'Payload': BytesIO(json.dumps({"errorMessage": "some message", "errorType": "SomeErrorType"}).encode('utf-8')), } with pytest.raises(CBCProxyRetryableException) as e: cbc_proxy.create_and_send_broadcast( identifier='my-identifier', message_number='0000007b', headline='my-headline', description='my-description', areas=EXAMPLE_AREAS, sent='a-passed-through-sent-value', expires='a-passed-through-expires-value', channel="severe", ) assert e.match(f'Lambda failed for both {cbc}-1-proxy and {cbc}-2-proxy') assert ld_client_mock.invoke.call_args_list == [ call( FunctionName=f'{cbc}-1-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ), call( FunctionName=f'{cbc}-2-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ) ] @pytest.mark.parametrize('cbc', ['ee', 'three', 'o2']) def test_cbc_proxy_one_2_many_send_link_test_invokes_function(mocker, cbc_proxy_client, cbc): cbc_proxy = cbc_proxy_client.get_proxy(cbc) mocker.patch('app.clients.cbc_proxy.uuid.uuid4', return_value=123) ld_client_mock = mocker.patch.object( cbc_proxy, '_lambda_client', create=True, ) ld_client_mock.invoke.return_value = { 'StatusCode': 200, } cbc_proxy._send_link_test( lambda_name=f'{cbc}-1-proxy' ) ld_client_mock.invoke.assert_called_once_with( FunctionName=f'{cbc}-1-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ) kwargs = ld_client_mock.invoke.mock_calls[0][-1] payload_bytes = kwargs['Payload'] payload = json.loads(payload_bytes) assert payload['identifier'] == '123' assert payload['message_type'] == 'test' assert 'message_number' not in payload assert payload['message_format'] == 'cap' def test_cbc_proxy_vodafone_send_link_test_invokes_function(mocker, cbc_proxy_vodafone): mocker.patch('app.clients.cbc_proxy.uuid.uuid4', return_value=123) db.session.connection().execute( 'ALTER SEQUENCE broadcast_provider_message_number_seq RESTART WITH 1' ) ld_client_mock = mocker.patch.object( cbc_proxy_vodafone, '_lambda_client', create=True, ) ld_client_mock.invoke.return_value = { 'StatusCode': 200, } cbc_proxy_vodafone._send_link_test( lambda_name='vodafone-1-proxy' ) ld_client_mock.invoke.assert_called_once_with( FunctionName='vodafone-1-proxy', InvocationType='RequestResponse', Payload=mocker.ANY, ) kwargs = ld_client_mock.invoke.mock_calls[0][-1] payload_bytes = kwargs['Payload'] payload = json.loads(payload_bytes) assert payload['identifier'] == '123' assert payload['message_type'] == 'test' assert payload['message_number'] == '00000001' assert payload['message_format'] == 'ibag'