MPT-19058 Adopt notification templates in AWS Extension

Author: alephsur

swo_aws_extension/flows/order_utils.py

@@ -67,9 +67,7 @@ def set_order_template(
     return context.order
 
 
-def switch_order_status_to_query_and_notify(
-    client: MPTClient, context: InitialAWSContext, template_name: str
-):
+def switch_order_status_to_query(client: MPTClient, context: InitialAWSContext, template_name: str):
     """Switch the order status to 'Querying' if it is not already in that status."""
     context.order = set_order_template(client, context, MPT_ORDER_STATUS_QUERYING, template_name)
     kwargs = {
@@ -84,12 +82,9 @@ def switch_order_status_to_query_and_notify(
         context.order_id,
         **kwargs,
     )
-    MPTNotificationManager(client).send_notification(context)
 
 
-def switch_order_status_to_failed_and_notify(
-    client: MPTClient, context: InitialAWSContext, error: dict
-):
+def switch_order_status_to_failed(client: MPTClient, context: InitialAWSContext, error: dict):
     """Switch the order status to 'Failed'."""
     kwargs = {
         "parameters": context.order["parameters"],
@@ -101,10 +96,9 @@ def switch_order_status_to_failed_and_notify(
         error,
         **kwargs,
     )
-    MPTNotificationManager(client).send_notification(context)
 
 
-def switch_order_status_to_process_and_notify(
+def switch_order_status_to_process(
     client: MPTClient, context: InitialAWSContext, template_name: str
 ):
     """Switch the order status to 'Processing'."""
@@ -126,10 +120,9 @@ def switch_order_status_to_process_and_notify(
             error,
         )
         return
-    MPTNotificationManager(client).send_notification(context)
 
 
-def switch_order_status_to_complete_and_notify(
+def switch_order_status_to_complete(
     client: MPTClient, context: InitialAWSContext, template_name: str
 ):
     """Updates the order status to completed."""
@@ -144,7 +137,6 @@ def switch_order_status_to_complete_and_notify(
     }
 
     context.order = complete_order(client, context.order_id, **kwargs)
-    MPTNotificationManager(client).send_notification(context)
     logger.info("%s - Action - Set order to completed", context.order_id)
 
 

swo_aws_extension/flows/steps/base.py

@@ -11,8 +11,8 @@
     InitialAWSContext,
 )
 from swo_aws_extension.flows.order_utils import (
-    switch_order_status_to_failed_and_notify,
-    switch_order_status_to_query_and_notify,
+    switch_order_status_to_failed,
+    switch_order_status_to_query,
 )
 from swo_aws_extension.flows.steps.errors import (
     AlreadyProcessedStepError,
@@ -99,7 +99,7 @@ def _run_process(self, context: InitialAWSContext) -> bool:
             return False
         except QueryStepError as error:
             logger.info("%s - Query Order: %s", context.order_id, error.message)
-            switch_order_status_to_query_and_notify(self._client, context, error.template_id)
+            switch_order_status_to_query(self._client, context, error.template_id)
             return False
         except FailStepError as error:
             logger.info("%s - Fail Order: %s", context.order_id, error)
@@ -108,6 +108,6 @@ def _run_process(self, context: InitialAWSContext) -> bool:
                 "id": error.id,
                 "message": error.message,
             }
-            switch_order_status_to_failed_and_notify(self._client, context, fail_error)
+            switch_order_status_to_failed(self._client, context, fail_error)
             return False
         return True

swo_aws_extension/flows/steps/complete_order.py

@@ -7,7 +7,7 @@
 from swo_aws_extension.config import Config
 from swo_aws_extension.constants import ChannelHandshakeDeployed, OrderCompletedTemplate, PhasesEnum
 from swo_aws_extension.flows.order import InitialAWSContext
-from swo_aws_extension.flows.order_utils import switch_order_status_to_complete_and_notify
+from swo_aws_extension.flows.order_utils import switch_order_status_to_complete
 from swo_aws_extension.flows.steps.base import BasePhaseStep
 from swo_aws_extension.flows.steps.errors import SkipStepError
 from swo_aws_extension.parameters import (
@@ -49,7 +49,7 @@ def process(self, client: MPTClient, context: InitialAWSContext) -> None:
             context.order_id,
             mpa_id,
         )
-        switch_order_status_to_complete_and_notify(client, context, template_name)
+        switch_order_status_to_complete(client, context, template_name)
 
     @override
     def post_step(self, client: MPTClient, context: InitialAWSContext) -> None:
@@ -72,7 +72,7 @@ def process(self, client: MPTClient, context: InitialAWSContext) -> None:
             template = OrderCompletedTemplate.TERMINATION
         else:
             template = OrderCompletedTemplate.TERMINATION_WITHOUT_HANDSHAKE
-        switch_order_status_to_complete_and_notify(client, context, template)
+        switch_order_status_to_complete(client, context, template)
 
     @override
     def post_step(self, client: MPTClient, context: InitialAWSContext) -> None:

swo_aws_extension/processors/querying/aws_billing_transfer_invitation.py

@@ -10,7 +10,7 @@
     ResponsibilityTransferStatus,
 )
 from swo_aws_extension.flows.order import PurchaseContext
-from swo_aws_extension.flows.order_utils import switch_order_status_to_process_and_notify
+from swo_aws_extension.flows.order_utils import switch_order_status_to_process
 from swo_aws_extension.parameters import get_responsibility_transfer_id
 from swo_aws_extension.processors.processor import Processor
 from swo_aws_extension.processors.querying.helper import get_template_name
@@ -80,9 +80,7 @@ def process_invitation(self, context: PurchaseContext, transfer_id: str):
                 transfer_id,
                 status,
             )
-            switch_order_status_to_process_and_notify(
-                self.client, context, get_template_name(context)
-            )
+            switch_order_status_to_process(self.client, context, get_template_name(context))
             return
 
         logger.info(

swo_aws_extension/processors/querying/aws_channel_handshake.py

@@ -11,7 +11,7 @@
     PhasesEnum,
 )
 from swo_aws_extension.flows.order import PurchaseContext
-from swo_aws_extension.flows.order_utils import switch_order_status_to_process_and_notify
+from swo_aws_extension.flows.order_utils import switch_order_status_to_process
 from swo_aws_extension.parameters import (
     get_channel_handshake_id,
     get_relationship_id,
@@ -52,7 +52,7 @@ def process(self, context: PurchaseContext) -> None:
                 context.order_id,
                 handshake_id,
             )
-            switch_order_status_to_process_and_notify(
+            switch_order_status_to_process(
                 self.client, context, OrderProcessingTemplateEnum.EXISTING_ACCOUNT
             )
             return
@@ -64,9 +64,7 @@ def process(self, context: PurchaseContext) -> None:
                 handshake_id,
                 handshake.get("status"),
             )
-            switch_order_status_to_process_and_notify(
-                self.client, context, get_template_name(context)
-            )
+            switch_order_status_to_process(self.client, context, get_template_name(context))
             return
 
         if is_querying_timeout(context, self._config.querying_timeout_days):
@@ -103,4 +101,4 @@ def _manage_querying_timeout(
         context.order = update_order(
             self.client, context.order_id, parameters=context.order["parameters"]
         )
-        switch_order_status_to_process_and_notify(self.client, context, get_template_name(context))
+        switch_order_status_to_process(self.client, context, get_template_name(context))

swo_aws_extension/processors/querying/aws_customer_roles.py

@@ -8,7 +8,7 @@
     PhasesEnum,
 )
 from swo_aws_extension.flows.order import PurchaseContext
-from swo_aws_extension.flows.order_utils import switch_order_status_to_process_and_notify
+from swo_aws_extension.flows.order_utils import switch_order_status_to_process
 from swo_aws_extension.flows.steps.crm_tickets.templates.deploy_roles import DEPLOY_ROLES_TEMPLATE
 from swo_aws_extension.flows.steps.crm_tickets.ticket_manager import TicketManager
 from swo_aws_extension.parameters import (
@@ -56,9 +56,7 @@ def process(self, context: PurchaseContext) -> None:
             logger.info(
                 "%s - Customer roles are deployed. Updating order to processing.", context.order_id
             )
-            switch_order_status_to_process_and_notify(
-                self.client, context, get_template_name(context)
-            )
+            switch_order_status_to_process(self.client, context, get_template_name(context))
             return
 
         if is_querying_timeout(context, self._config.customer_roles_querying_timeout_days):
@@ -85,7 +83,7 @@ def _manage_querying_timeout(self, context: PurchaseContext):
             self.client, context.order_id, parameters=context.order["parameters"]
         )
 
-        switch_order_status_to_process_and_notify(self.client, context, get_template_name(context))
+        switch_order_status_to_process(self.client, context, get_template_name(context))
 
     def _manage_customer_roles_ticket_timeout(self, context: PurchaseContext) -> None:
         """Manage customer roles ticket timeout."""

tests/flows/steps/test_base_phase_step.py

@@ -106,7 +106,7 @@ def test_query_step_error(mocker, initial_context):
     error = QueryStepError("msg", "template-id")
     step.proc_exc = error
     switch_mock = mocker.patch(
-        "swo_aws_extension.flows.steps.base.switch_order_status_to_query_and_notify",
+        "swo_aws_extension.flows.steps.base.switch_order_status_to_query",
     )
 
     client, next_step = _run_step(mocker, step, initial_context)  # act
@@ -120,7 +120,7 @@ def test_fail_step_error(mocker, initial_context):
     error = FailStepError("Error_id", "Error")
     step.proc_exc = error
     switch_mock = mocker.patch(
-        "swo_aws_extension.flows.steps.base.switch_order_status_to_failed_and_notify",
+        "swo_aws_extension.flows.steps.base.switch_order_status_to_failed",
     )
 
     client, next_step = _run_step(mocker, step, initial_context)  # act

tests/flows/steps/test_complete_order.py

@@ -55,7 +55,7 @@ def test_complete_order_process_completed(
 ):
     order = order_factory()
     mock_switch = mocker.patch(
-        "swo_aws_extension.flows.steps.complete_order.switch_order_status_to_complete_and_notify"
+        "swo_aws_extension.flows.steps.complete_order.switch_order_status_to_complete"
     )
     mocker.patch("swo_aws_extension.flows.steps.complete_order.update_agreement")
     context = initial_context(order)
@@ -99,7 +99,7 @@ def test_termination_process(
         ),
     )
     mock_switch = mocker.patch(
-        "swo_aws_extension.flows.steps.complete_order.switch_order_status_to_complete_and_notify"
+        "swo_aws_extension.flows.steps.complete_order.switch_order_status_to_complete"
     )
     context = initial_context(order)
     step = CompleteTerminationOrder(config)
@@ -118,7 +118,7 @@ def test_termination_process_without_handshake(
         ),
     )
     mock_switch = mocker.patch(
-        "swo_aws_extension.flows.steps.complete_order.switch_order_status_to_complete_and_notify"
+        "swo_aws_extension.flows.steps.complete_order.switch_order_status_to_complete"
     )
     context = initial_context(order)
     step = CompleteTerminationOrder(config)

tests/flows/test_order_utils.py

@@ -5,10 +5,10 @@
 from swo_aws_extension.flows.order import PurchaseContext
 from swo_aws_extension.flows.order_utils import (
     set_order_template,
-    switch_order_status_to_complete_and_notify,
-    switch_order_status_to_failed_and_notify,
-    switch_order_status_to_process_and_notify,
-    switch_order_status_to_query_and_notify,
+    switch_order_status_to_complete,
+    switch_order_status_to_failed,
+    switch_order_status_to_process,
+    switch_order_status_to_query,
     update_processing_template_and_notify,
 )
 
@@ -50,19 +50,15 @@ def test_switch_order_to_query_and_notify(
         "swo_aws_extension.flows.order_utils.query_order",
         return_value=order,
     )
-    notification_mock = mocker.patch(
-        "swo_aws_extension.flows.order_utils.MPTNotificationManager",
-    )
 
-    switch_order_status_to_query_and_notify(client, context, "TemplateName")  # act
+    switch_order_status_to_query(client, context, "TemplateName")  # act
 
     query_order_mock.assert_called_with(
         client,
         context.order_id,
         parameters=context.order["parameters"],
         template=new_template,
     )
-    notification_mock.assert_called_once()
 
 
 def test_switch_order_to_query_and_notify_error(
@@ -86,11 +82,8 @@ def test_switch_order_to_query_and_notify_error(
         "swo_aws_extension.flows.order_utils.query_order",
         return_value=context.order,
     )
-    notification_mock = mocker.patch(
-        "swo_aws_extension.flows.order_utils.MPTNotificationManager",
-    )
 
-    switch_order_status_to_query_and_notify(client, context, "TemplateName")  # act
+    switch_order_status_to_query(client, context, "TemplateName")  # act
 
     query_order_mock.assert_called_with(
         client,
@@ -99,30 +92,26 @@ def test_switch_order_to_query_and_notify_error(
         template=new_template,
         error=context.order["error"],
     )
-    notification_mock.assert_called_once()
 
 
-def test_switch_order_to_failed_and_notify(mocker, order_factory, fulfillment_parameters_factory):
+def test_switch_order_to_failed(mocker, order_factory, fulfillment_parameters_factory):
     client = mocker.MagicMock(spec=MPTClient)
     order = order_factory(fulfillment_parameters=fulfillment_parameters_factory())
     context = PurchaseContext.from_order_data(order)
     fail_order_mock = mocker.patch(
         "swo_aws_extension.flows.order_utils.fail_order",
         return_value=order,
-    )
-    notification_mock = mocker.patch(
-        "swo_aws_extension.flows.order_utils.MPTNotificationManager",
+        autospec=True,
     )
 
-    switch_order_status_to_failed_and_notify(client, context, "Failure reason")  # act
+    switch_order_status_to_failed(client, context, "Failure reason")  # act
 
     fail_order_mock.assert_called_with(
         client,
         context.order_id,
         "Failure reason",
         parameters=context.order["parameters"],
     )
-    notification_mock.assert_called_once()
 
 
 def test_switch_order_to_process_and_notify(
@@ -142,19 +131,15 @@ def test_switch_order_to_process_and_notify(
         "swo_aws_extension.flows.order_utils.process_order",
         return_value=order,
     )
-    notification_mock = mocker.patch(
-        "swo_aws_extension.flows.order_utils.MPTNotificationManager",
-    )
 
-    switch_order_status_to_process_and_notify(mpt_client, context, "TemplateName")  # act
+    switch_order_status_to_process(mpt_client, context, "TemplateName")  # act
 
     process_order_mock.assert_called_once_with(
         mpt_client,
         context.order_id,
         parameters=context.order["parameters"],
         template=new_template,
     )
-    notification_mock.assert_called_once()
 
 
 def test_switch_order_to_process_and_notify_error(
@@ -178,7 +163,7 @@ def test_switch_order_to_process_and_notify_error(
         "swo_aws_extension.flows.order_utils.MPTNotificationManager",
     )
 
-    switch_order_status_to_process_and_notify(mpt_client, context, "TemplateName")  # act
+    switch_order_status_to_process(mpt_client, context, "TemplateName")  # act
 
     notification_mock.assert_not_called()
 
@@ -194,24 +179,20 @@ def test_switch_order_status_to_complete(
         return_value=new_template,
     )
     order = order_factory(template=default_template)
-    notification_mock = mocker.patch(
-        "swo_aws_extension.flows.order_utils.MPTNotificationManager",
-    )
     context = PurchaseContext.from_order_data(order)
     complete_order_mock = mocker.patch(
         "swo_aws_extension.flows.order_utils.complete_order",
         return_value=order,
     )
 
-    switch_order_status_to_complete_and_notify(client, context, "TemplateName")  # act
+    switch_order_status_to_complete(client, context, "TemplateName")  # act
 
     complete_order_mock.assert_called_with(
         client,
         context.order_id,
         parameters=context.order["parameters"],
         template=new_template,
     )
-    notification_mock.assert_called_once()
 
 
 def test_update_processing_template_and_notify(

tests/processor/querying/test_aws_billing_transfer_invitation.py

@@ -141,7 +141,7 @@ def test_process_invitation_status_requested(
         "ResponsibilityTransfer": {"Status": ResponsibilityTransferStatus.REQUESTED}
     }
     mock_switch = mocker.patch(
-        "swo_aws_extension.processors.querying.aws_billing_transfer_invitation.switch_order_status_to_process_and_notify"
+        "swo_aws_extension.processors.querying.aws_billing_transfer_invitation.switch_order_status_to_process"
     )
 
     processor.process_invitation(mock_context, "tr-123")  # act
@@ -158,7 +158,7 @@ def test_process_invitation_status_accepted(
         "ResponsibilityTransfer": {"Status": ResponsibilityTransferStatus.ACCEPTED}
     }
     mock_switch = mocker.patch(
-        "swo_aws_extension.processors.querying.aws_billing_transfer_invitation.switch_order_status_to_process_and_notify"
+        "swo_aws_extension.processors.querying.aws_billing_transfer_invitation.switch_order_status_to_process"
     )
 
     processor.process_invitation(mock_context, "tr-123")  # act