merge from main

tests/app/celery/test_provider_tasks.py

@@ -23,6 +23,7 @@ def test_should_call_send_sms_to_provider_from_deliver_sms_task(
         sample_notification,
         mocker):
     mocker.patch('app.delivery.send_to_providers.send_sms_to_provider')
+    mocker.patch('app.celery.provider_tasks.check_sms_delivery_receipt')
 
     deliver_sms(sample_notification.id)
     app.delivery.send_to_providers.send_sms_to_provider.assert_called_with(sample_notification)

tests/app/clients/test_aws_cloudwatch.py

@@ -0,0 +1,87 @@
+import pytest
+from flask import current_app
+
+from app import aws_cloudwatch_client
+
+
+def test_check_sms_no_event_error_condition(notify_api, mocker):
+    boto_mock = mocker.patch.object(aws_cloudwatch_client, '_client', create=True)
+    # TODO
+    #  we do this to get the AWS account number, and it seems like unit tests locally have
+    #  access to the env variables but when we push the PR they do not.  Is there a better way to get it?
+    mocker.patch.dict('os.environ', {"SES_DOMAIN_ARN": "1111:"})
+    message_id = 'aaa'
+    notification_id = 'bbb'
+    boto_mock.filter_log_events.return_value = []
+    with notify_api.app_context():
+        aws_cloudwatch_client.init_app(current_app)
+        with pytest.raises(Exception):
+            aws_cloudwatch_client.check_sms(message_id, notification_id)
+
+
+def side_effect(filterPattern, logGroupName, startTime, endTime):
+    if "Failure" in logGroupName and 'fail' in filterPattern:
+        return {
+            "events":
+                [
+                    {
+                        'logStreamName': '89db9712-c6d1-49f9-be7c-4caa7ed9efb1',
+                        'message': '{"delivery":{"destination":"+1661","providerResponse":"Invalid phone number"}}',
+                        'eventId': '37535432778099870001723210579798865345508698025292922880'
+                    }
+                ]
+        }
+
+    elif 'succeed' in filterPattern:
+        return {
+            "events":
+                [
+                    {
+                     'logStreamName': '89db9712-c6d1-49f9-be7c-4caa7ed9efb1',
+                     'timestamp': 1683147017911,
+                     'message': '{"delivery":{"destination":"+1661","providerResponse":"Phone accepted msg"}}',
+                     'ingestionTime': 1683147018026,
+                     'eventId': '37535432778099870001723210579798865345508698025292922880'
+                    }
+                ]
+        }
+    else:
+        return {"events": []}
+
+
+def test_check_sms_success(notify_api, mocker):
+    aws_cloudwatch_client.init_app(current_app)
+    boto_mock = mocker.patch.object(aws_cloudwatch_client, '_client', create=True)
+    boto_mock.filter_log_events.side_effect = side_effect
+    mocker.patch.dict('os.environ', {"SES_DOMAIN_ARN": "1111:"})
+
+    message_id = 'succeed'
+    notification_id = 'ccc'
+    with notify_api.app_context():
+        aws_cloudwatch_client.check_sms(message_id, notification_id, 1000000000000)
+
+    # We check the 'success' log group first and if we find the message_id, we are done, so there is only 1 call
+    assert boto_mock.filter_log_events.call_count == 1
+    mock_call = str(boto_mock.filter_log_events.mock_calls[0])
+    assert 'Failure' not in mock_call
+    assert 'succeed' in mock_call
+    assert 'notification.messageId' in mock_call
+
+
+def test_check_sms_failure(notify_api, mocker):
+    aws_cloudwatch_client.init_app(current_app)
+    boto_mock = mocker.patch.object(aws_cloudwatch_client, '_client', create=True)
+    boto_mock.filter_log_events.side_effect = side_effect
+    mocker.patch.dict('os.environ', {"SES_DOMAIN_ARN": "1111:"})
+
+    message_id = 'fail'
+    notification_id = 'bbb'
+    with notify_api.app_context():
+        aws_cloudwatch_client.check_sms(message_id, notification_id, 1000000000000)
+
+    # We check the 'success' log group and find nothing, so we then check the 'fail' log group -- two calls.
+    assert boto_mock.filter_log_events.call_count == 2
+    mock_call = str(boto_mock.filter_log_events.mock_calls[1])
+    assert 'Failure' in mock_call
+    assert 'fail' in mock_call
+    assert 'notification.messageId' in mock_call

tests/app/test_config.py

@@ -4,12 +4,13 @@ from app.config import QueueNames
 def test_queue_names_all_queues_correct():
     # Need to ensure that all_queues() only returns queue names used in API
     queues = QueueNames.all_queues()
-    assert len(queues) == 15
+    assert len(queues) == 16
     assert set([
         QueueNames.PRIORITY,
         QueueNames.PERIODIC,
         QueueNames.DATABASE,
         QueueNames.SEND_SMS,
+        QueueNames.CHECK_SMS,
         QueueNames.SEND_EMAIL,
         QueueNames.RESEARCH_MODE,
         QueueNames.REPORTING,