Merge pull request #3 from softwareone-platform/feature/MPT-8099/draft-validation

MPT-8098 Add draft validation for Purchase Order

Author: d3rky

ffc/flows/fulfillment.py

@@ -15,7 +15,9 @@
     CreateEmployee,
     CreateOrganization,
     CreateSubscription,
+    QueryIfInvalid,
     ResetDueDate,
+    ResetOrderErrors,
     SetupAgreementExternalId,
     SetupDueDate,
 )
@@ -25,9 +27,11 @@
 
 
 purchase = Pipeline(
+    ResetOrderErrors(),
     SetupDueDate(),
     CheckDueDate(),
     CheckOrderParameters(),
+    QueryIfInvalid(),
     CreateEmployee(),
     CreateOrganization(),
     SetupAgreementExternalId(),
@@ -54,7 +58,8 @@ def fulfill_order(client, order):
     try:
         if is_purchase_order(order):
             purchase.run(client, context)
-    except Exception:
+    except Exception:  # pragma: no cover
+        # should be covered by SDK tests
         notify_unhandled_exception_in_teams(
             "fulfillment",
             order["id"],

ffc/flows/order.py

@@ -26,6 +26,7 @@ def is_purchase_order(order):
 @dataclass
 class OrderContext(BaseContext):
     order: dict
+    validation_succeeded: bool = True
     employee: dict = field(init=False, default=None)
     organization: dict = field(init=False, default=None)
 

ffc/flows/steps/__init__.py

@@ -3,6 +3,8 @@
 from ffc.flows.steps.order import (
     CheckOrderParameters,
     CompleteOrder,
+    QueryIfInvalid,
+    ResetOrderErrors,
     SetupAgreementExternalId,
 )
 from ffc.flows.steps.subscription import CreateSubscription
@@ -11,7 +13,9 @@
     "CompleteOrder",
     "CreateSubscription",
     "CheckDueDate",
+    "QueryIfInvalid",
     "ResetDueDate",
+    "ResetOrderErrors",
     "SetupDueDate",
     "CreateEmployee",
     "CreateOrganization",

ffc/flows/steps/order.py

@@ -14,12 +14,14 @@
     ERR_ORGANIZATION_NAME,
 )
 from ffc.flows.order import MPT_ORDER_STATUS_COMPLETED, MPT_ORDER_STATUS_QUERYING
+from ffc.flows.steps.utils import reset_order_error
 from ffc.notifications import send_email_notification
 from ffc.parameters import (
     PARAM_ADMIN_CONTACT,
     PARAM_CURRENCY,
     PARAM_ORGANIZATION_NAME,
     get_ordering_parameter,
+    reset_ordering_parameters_error,
     set_ordering_parameter_error,
 )
 
@@ -73,8 +75,8 @@ def __call__(self, client, context, next_step):
 
 class CheckOrderParameters(Step):
     """
-    Check if all required parameters are submitted, if not
-    query order
+    Check if all required parameters are submitted
+    If not sets `validation_succeeded` to False
     """
 
     def __call__(self, client, context, next_step):
@@ -84,7 +86,6 @@ def __call__(self, client, context, next_step):
             PARAM_ADMIN_CONTACT: ERR_ADMIN_CONTACT,
         }
         order = context.order
-        empty_parameters = []
 
         for param_name in [
             PARAM_ORGANIZATION_NAME,
@@ -96,9 +97,20 @@ def __call__(self, client, context, next_step):
                 order = set_ordering_parameter_error(
                     order, param_name, errors[param_name]
                 )
-                empty_parameters.append(param_name)
+                context.validation_succeeded = False
 
-        if empty_parameters:
+        next_step(client, context)
+
+
+class QueryIfInvalid(Step):
+    """
+    Check if `validation_succeeded` context parameter is True
+    If not - query order
+    """
+
+    def __call__(self, client, context, next_step):
+        order = context.order
+        if not context.validation_succeeded:
             template = get_product_template_or_default(
                 client,
                 context.product_id,
@@ -109,9 +121,22 @@ def __call__(self, client, context, next_step):
             order["agreement"] = agreement
             context.order = order
             logger.info(
-                f"{context}: parameters {', '.join(empty_parameters)} are empty, move to querying",
+                f"{context}: ordering parameters are invalid, move to querying",
             )
             send_email_notification(client, order)
             return
 
         next_step(client, context)
+
+
+class ResetOrderErrors(Step):
+    """
+    Reset order errors and parameter errors. Is used before processing
+    to not to show errors during procesing or after validation is succeseed
+    """
+
+    def __call__(self, client, context, next_step):
+        context.order = reset_order_error(context.order)
+        context.order = reset_ordering_parameters_error(context.order)
+
+        next_step(client, context)

ffc/flows/steps/subscription.py

@@ -1,8 +1,10 @@
 import logging
 
-from swo.mpt.client.mpt import create_subscription, get_subscription_by_line_and_item_id
+from swo.mpt.client.mpt import create_subscription
 from swo.mpt.extensions.flows.pipeline import Step
 
+from ffc.flows.order import get_subscription_by_line_and_item_id
+
 logger = logging.getLogger(__name__)
 
 

ffc/flows/steps/utils.py

@@ -1,3 +1,5 @@
+from copy import deepcopy
+
 from swo.mpt.client.mpt import fail_order
 
 from ffc.notifications import send_email_notification
@@ -24,3 +26,9 @@ def switch_order_to_failed(client, order, status_notes):
     order["agreement"] = agreement
     send_email_notification(client, order)
     return order
+
+
+def reset_order_error(order):
+    updated_order = deepcopy(order)
+    updated_order["error"] = None
+    return updated_order

ffc/flows/validation/base.py ffc/flows/validation.pyffc/flows/validation/base.py renamed to ffc/flows/validation.py

@@ -2,13 +2,12 @@
 import traceback
 
 from ffc.flows.error import strip_trace_id
-from ffc.flows.order import is_purchase_order
 from ffc.notifications import notify_unhandled_exception_in_teams
 
 logger = logging.getLogger(__name__)
 
 
-def validate_order(client, order):
+def validate_order(client, order):  # pragma: no cover
     """
     Performs the validation of a draft order.
 
@@ -22,9 +21,6 @@ def validate_order(client, order):
     try:
         has_errors = False
 
-        if is_purchase_order(order):
-            pass
-
         logger.info(
             f"Validation of order {order['id']} succeeded "
             f"with{'out' if not has_errors else ''} errors"

ffc/flows/validation/__init__.py

@@ -53,7 +53,7 @@ def send_notification(
     color: str,
     button: Button | None = None,
     facts: FactsSection | None = None,
-) -> None:
+) -> None:  # pragma: no cover
     message = pymsteams.connectorcard(settings.EXTENSION_CONFIG["MSTEAMS_WEBHOOK_URL"])
     message.color(color)
     message.title(title)
@@ -78,7 +78,7 @@ def send_warning(
     text: str,
     button: Button | None = None,
     facts: FactsSection | None = None,
-) -> None:
+) -> None:  # pragma: no cover
     send_notification(
         f"\u2622 {title}",
         text,
@@ -93,7 +93,7 @@ def send_error(
     text: str,
     button: Button | None = None,
     facts: FactsSection | None = None,
-) -> None:
+) -> None:  # pragma: no cover
     send_notification(
         f"\U0001f4a3 {title}",
         text,
@@ -108,7 +108,7 @@ def send_exception(
     text: str,
     button: Button | None = None,
     facts: FactsSection | None = None,
-) -> None:
+) -> None:  # pragma: no cover
     send_notification(
         f"\U0001f525 {title}",
         text,
@@ -118,7 +118,7 @@ def send_exception(
     )
 
 
-def send_email(recipient, subject, template_name, context):
+def send_email(recipient, subject, template_name, context):  # pragma: no cover
     template = env.get_template(f"{template_name}.html")
     rendered_email = template.render(context)
 
@@ -149,17 +149,17 @@ def send_email(recipient, subject, template_name, context):
         )
 
 
-def get_notifications_recipient(order):
+def get_notifications_recipient(order):  # pragma: no cover
     return (get_ordering_parameter(order, PARAM_CONTACT).get("value", {}) or {}).get(
         "email"
     ) or (order["agreement"]["buyer"].get("contact", {}) or {}).get("email")
 
 
-def md2html(template):
+def md2html(template):  # pragma: no cover
     return MarkdownIt("commonmark", {"breaks": True, "html": True}).render(template)
 
 
-def send_email_notification(client, order):
+def send_email_notification(client, order):  # pragma: no cover
     """
     Send a notification email to the customer according to the
     current order status.
@@ -206,7 +206,9 @@ def send_email_notification(client, order):
 
 
 @functools.cache
-def notify_unhandled_exception_in_teams(process, order_id, traceback):
+def notify_unhandled_exception_in_teams(
+    process, order_id, traceback
+):  # pragma: no cover
     send_exception(
         f"Order {process} unhandled exception!",
         f"An unhandled exception has been raised while performing {process} "

ffc/notifications.py

@@ -93,3 +93,21 @@ def set_due_date(order, due_date):
     param["value"] = due_date
 
     return updated_order
+
+
+def reset_ordering_parameters_error(order):
+    """
+    Reset errors for all ordering parameters
+
+    Args:
+        order (dict): The order that contains the parameter.
+
+    Returns:
+        dict: The order updated.
+    """
+    updated_order = copy.deepcopy(order)
+
+    for param in updated_order["parameters"][PARAM_PHASE_ORDERING]:
+        param["error"] = None
+
+    return updated_order