add get_earlier_provider_message fn to broadcast_event

replacing get_earlier_provider_messages. The old function returned the
previous references for earlier events for a broadcast_message. However,
these depend on the message sent to a specific provider, so the function
needs to change. It now takes in a provider, and only returns
broadcast_provider_messages sent to that provider. If there are earlier
broadcast_events without a provider_message for the chosen provider, it
raises an exception - you cannot cancel a message if all the previous
events have not been created properly (as we wouldn't know what
references to cancel).

tests/app/celery/test_broadcast_message_tasks.py

@@ -7,7 +7,12 @@ import pytest
 from app.models import BROADCAST_TYPE, BroadcastStatusType, BroadcastEventMessageType, BroadcastProviderMessageStatus
 from app.celery.broadcast_message_tasks import send_broadcast_event, send_broadcast_provider_message, trigger_link_test
 
-from tests.app.db import create_template, create_broadcast_message, create_broadcast_event
+from tests.app.db import (
+    create_template,
+    create_broadcast_message,
+    create_broadcast_event,
+    create_broadcast_provider_message
+)
 from tests.conftest import set_config
 
 
@@ -86,6 +91,7 @@ def test_send_broadcast_provider_message_sends_update_with_references(mocker, sa
     )
 
     alert_event = create_broadcast_event(broadcast_message, message_type=BroadcastEventMessageType.ALERT)
+    create_broadcast_provider_message(alert_event, 'ee')
     update_event = create_broadcast_event(broadcast_message, message_type=BroadcastEventMessageType.UPDATE)
 
     mock_update_broadcast = mocker.patch(
@@ -95,7 +101,7 @@ def test_send_broadcast_provider_message_sends_update_with_references(mocker, sa
     send_broadcast_provider_message(provider='ee', broadcast_event_id=str(update_event.id))
 
     broadcast_provider_message = update_event.get_provider_message('ee')
-    assert broadcast_provider_message.state == BroadcastProviderMessageStatus.SENDING
+    assert broadcast_provider_message.status == BroadcastProviderMessageStatus.SENDING
 
     mock_update_broadcast.assert_called_once_with(
         identifier=str(broadcast_provider_message.id),
@@ -104,7 +110,9 @@ def test_send_broadcast_provider_message_sends_update_with_references(mocker, sa
         areas=[{
             "polygon": [[50.12, 1.2], [50.13, 1.2], [50.14, 1.21]],
         }],
-        references=[alert_event.reference],
+        previous_provider_messages=[
+            alert_event.get_provider_message('ee')
+        ],
         sent=update_event.sent_at_as_cap_datetime_string,
         expires=update_event.transmitted_finishes_at_as_cap_datetime_string,
     )
@@ -128,6 +136,9 @@ def test_send_broadcast_provider_message_sends_cancel_with_references(mocker, sa
     update_event = create_broadcast_event(broadcast_message, message_type=BroadcastEventMessageType.UPDATE)
     cancel_event = create_broadcast_event(broadcast_message, message_type=BroadcastEventMessageType.CANCEL)
 
+    create_broadcast_provider_message(alert_event, 'ee')
+    create_broadcast_provider_message(update_event, 'ee')
+
     mock_cancel_broadcast = mocker.patch(
         'app.cbc_proxy_client.cancel_broadcast',
     )
@@ -135,7 +146,7 @@ def test_send_broadcast_provider_message_sends_cancel_with_references(mocker, sa
     send_broadcast_provider_message(provider='ee', broadcast_event_id=str(cancel_event.id))
 
     broadcast_provider_message = cancel_event.get_provider_message('ee')
-    assert broadcast_provider_message.state == BroadcastProviderMessageStatus.SENDING
+    assert broadcast_provider_message.status == BroadcastProviderMessageStatus.SENDING
 
     mock_cancel_broadcast.assert_called_once_with(
         identifier=str(broadcast_provider_message.id),
@@ -144,7 +155,10 @@ def test_send_broadcast_provider_message_sends_cancel_with_references(mocker, sa
         areas=[{
             "polygon": [[50.12, 1.2], [50.13, 1.2], [50.14, 1.21]],
         }],
-        references=[alert_event.reference, update_event.reference],
+        previous_provider_messages=[
+            alert_event.get_provider_message('ee'),
+            update_event.get_provider_message('ee')
+        ],
         sent=cancel_event.sent_at_as_cap_datetime_string,
         expires=cancel_event.transmitted_finishes_at_as_cap_datetime_string,
     )

tests/app/dao/test_broadcast_message_dao.py

@@ -1,12 +1,11 @@
 from datetime import datetime
 
-from freezegun import freeze_time
-
-from app.models import BROADCAST_TYPE, BroadcastStatusType, BroadcastEventMessageType
+from app.models import BROADCAST_TYPE, BroadcastEventMessageType
 from app.dao.broadcast_message_dao import get_earlier_events_for_broadcast_event, create_broadcast_provider_message
 
 from tests.app.db import create_broadcast_message, create_template, create_broadcast_event
 
+
 def test_get_earlier_events_for_broadcast_event(sample_service):
     t = create_template(sample_service, BROADCAST_TYPE)
     bm = create_broadcast_message(t)
@@ -44,10 +43,9 @@ def test_get_earlier_events_for_broadcast_event(sample_service):
     assert earlier_events == [events[0], events[1]]
 
 
-@freeze_time('2020-02-03 04:05:06')
 def test_create_broadcast_provider_message_creates_in_correct_state(sample_broadcast_service):
     t = create_template(sample_broadcast_service, BROADCAST_TYPE)
-    broadcast_message = create_broadcast_message(t, status=BroadcastStatusType.APPROVED)
+    broadcast_message = create_broadcast_message(t)
     broadcast_event = create_broadcast_event(
         broadcast_message,
         sent_at=datetime(2020, 1, 1, 12, 0, 0),
@@ -59,4 +57,5 @@ def test_create_broadcast_provider_message_creates_in_correct_state(sample_broad
 
     assert broadcast_provider_message.status == 'sending'
     assert broadcast_provider_message.broadcast_event_id == broadcast_event.id
-    assert broadcast_provider_message.created_at == datetime.utcnow()
+    assert broadcast_provider_message.created_at is not None
+    assert broadcast_provider_message.updated_at is None

tests/app/db.py

@@ -62,7 +62,8 @@ from app.models import (
     ServiceContactList,
     BroadcastMessage,
     BroadcastStatusType,
-    BroadcastEvent
+    BroadcastEvent,
+    BroadcastProviderMessage
 )
 
 
@@ -1050,3 +1051,18 @@ def create_broadcast_event(
     db.session.add(b_e)
     db.session.commit()
     return b_e
+
+
+def create_broadcast_provider_message(
+    broadcast_event,
+    provider,
+    status='sending'
+):
+    provider_message = BroadcastProviderMessage(
+        broadcast_event=broadcast_event,
+        provider=provider,
+        status=status
+    )
+    db.session.add(provider_message)
+    db.session.commit()
+    return provider_message