MPT-17590 Add usage item by default in the purchase wizard (#227)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
Closes [MPT-17590](https://softwareone.atlassian.net/browse/MPT-17590)

- Add AWS_ITEMS_SKUS constant containing "AWS Usage"
- Add add_default_lines(client, order) to fetch product items by SKU and
append default order lines (quantity=1)
- Add validate_order(client, order) to orchestrate parameter visibility
update and default line injection
- Update extension.py to call validate_order(request.client, order) in
order validation endpoint
- Update tests and fixtures to mock and cover validate_order behavior
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

[MPT-17590]:
https://softwareone.atlassian.net/browse/MPT-17590?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Author: alephsur

swo_aws_extension/constants.py

@@ -195,3 +195,6 @@ class ExpirationPeriodEnum(IntEnum):
 
     CURRENT_MONTH = 1
     NEXT_MONTH = 2
+
+
+AWS_ITEMS_SKUS = ("AWS Usage",)

swo_aws_extension/extension.py

@@ -12,7 +12,7 @@
 from ninja import Body
 
 from swo_aws_extension.flows.fulfillment.base import fulfill_order
-from swo_aws_extension.flows.validation.base import update_parameters_visibility
+from swo_aws_extension.flows.validation.base import validate_order
 
 logger = logging.getLogger(__name__)
 
@@ -43,7 +43,7 @@ def process_order_fulfillment(client, event):
 def process_order_validation(request, order: Annotated[dict, Body()]):
     """Start order process validation."""
     try:
-        validated_order = update_parameters_visibility(order)
+        validated_order = validate_order(request.client, order)
     except Exception:
         logger.exception("Unexpected error during validation")
         return 400, {

swo_aws_extension/flows/validation/base.py

@@ -1,9 +1,11 @@
 import copy
 import logging
 
+from mpt_extension_sdk.mpt_http.base import MPTClient
+from mpt_extension_sdk.mpt_http.mpt import get_product_items_by_skus
 from mpt_extension_sdk.mpt_http.wrap_http_error import ValidationError
 
-from swo_aws_extension.constants import AccountTypesEnum, OrderParametersEnum
+from swo_aws_extension.constants import AWS_ITEMS_SKUS, AccountTypesEnum, OrderParametersEnum
 from swo_aws_extension.parameters import (
     get_account_type,
     reset_ordering_parameters,
@@ -55,7 +57,58 @@ def _apply_account_type_constraints(order: dict, account_type: str | None) -> di
 
 def update_parameters_visibility(order: dict) -> dict:
     """Updates the visibility of parameters in the given order object."""
-    updated_order = copy.deepcopy(order)
-    updated_order = reset_ordering_parameters_error(updated_order)
-
+    updated_order = reset_ordering_parameters_error(order)
     return _apply_account_type_constraints(updated_order, get_account_type(updated_order))
+
+
+def add_default_lines(client: MPTClient, order: dict) -> dict:
+    """
+    Add default line items to the order based on product SKUs.
+
+    Retrieves product items by SKUs and adds them as lines to the order
+    with quantity 1 each.
+
+    Args:
+        client: MPT client for API calls.
+        order: The order dictionary to add lines to.
+
+    Returns:
+        The order with default lines added.
+    """
+    product_id = order.get("product", {}).get("id", "")
+    if not product_id:
+        logger.warning("No product ID found in order, skipping default lines")
+        return order
+
+    aws_items = get_product_items_by_skus(client, product_id, AWS_ITEMS_SKUS)
+    if not aws_items:
+        logger.error(
+            "Failed to get product items with SKUs %s for product %s",
+            AWS_ITEMS_SKUS,
+            product_id,
+        )
+        return order
+
+    order["lines"] = [{"item": aws_item, "quantity": 1} for aws_item in aws_items]
+    return order
+
+
+def validate_order(client: MPTClient, order: dict) -> dict:
+    """
+    Main validation function that orchestrates all validation steps.
+
+    This function performs the following steps:
+    1. Creates a deep copy of the order to avoid mutations
+    2. Updates parameter visibility based on account type
+    3. Adds default line items to the order
+
+    Args:
+        client: MPT client for API calls.
+        order: The order dictionary to validate.
+
+    Returns:
+        The validated order with updated parameters and default lines.
+    """
+    validated_order = copy.deepcopy(order)
+    validated_order = update_parameters_visibility(validated_order)
+    return add_default_lines(client, validated_order)

tests/conftest.py

@@ -833,8 +833,8 @@ def ffc_client_settings(extension_settings):
 
 
 @pytest.fixture
-def mock_update_parameters_visibility(mocker):
-    return mocker.patch("swo_aws_extension.extension.update_parameters_visibility", spec=True)
+def mock_validate_order(mocker):
+    return mocker.patch("swo_aws_extension.extension.validate_order", spec=True)
 
 
 @pytest.fixture

tests/flows/validation/test_base.py

@@ -1,8 +1,14 @@
+from unittest.mock import MagicMock
+
 from swo_aws_extension.constants import (
     AccountTypesEnum,
     OrderParametersEnum,
 )
-from swo_aws_extension.flows.validation.base import update_parameters_visibility
+from swo_aws_extension.flows.validation.base import (
+    add_default_lines,
+    update_parameters_visibility,
+    validate_order,
+)
 from swo_aws_extension.parameters import get_ordering_parameter
 
 
@@ -55,7 +61,6 @@ def test_new_aws_environment(order_factory, order_parameters_factory):
 
 
 def test_existing_aws_environment(order_factory, order_parameters_factory):
-    """Test update params visibility for an existing AWS environment."""
     order = order_factory(
         order_parameters=order_parameters_factory(
             account_type=AccountTypesEnum.EXISTING_AWS_ENVIRONMENT.value,
@@ -104,7 +109,6 @@ def test_existing_aws_environment(order_factory, order_parameters_factory):
 
 
 def test_empty_values(order_factory, order_parameters_factory):
-    """Test the update_parameters_visibility function when parameter values are empty."""
     order = order_factory(order_parameters=order_parameters_factory(account_type=None))
 
     result = update_parameters_visibility(order)
@@ -114,3 +118,78 @@ def test_empty_values(order_factory, order_parameters_factory):
         "id": "AWS001",
         "message": "Invalid account type: None",
     }
+
+
+def test_add_default_lines_success(order_factory, mocker):
+    mock_client = MagicMock()
+    order = order_factory(lines=[])
+    mock_items = [
+        {
+            "id": "ITM-1234-1234-1234-0001",
+            "name": "AWS Usage",
+            "externalIds": {"vendor": "AWS Usage"},
+        }
+    ]
+    mocker.patch(
+        "swo_aws_extension.flows.validation.base.get_product_items_by_skus",
+        return_value=mock_items,
+    )
+
+    result = add_default_lines(mock_client, order)
+
+    assert result["lines"] == [{"item": mock_items[0], "quantity": 1}]
+
+
+def test_add_default_lines_no_product_id(caplog):
+    mock_client = MagicMock()
+    order = {"product": {}, "lines": []}
+
+    with caplog.at_level("WARNING"):
+        result = add_default_lines(mock_client, order)
+
+    assert result["lines"] == []
+    assert "No product ID found in order, skipping default lines" in caplog.text
+
+
+def test_add_default_lines_no_items_found(order_factory, mocker):
+    mock_client = MagicMock()
+    order = order_factory(lines=[{"existing": "line"}])
+    mocker.patch(
+        "swo_aws_extension.flows.validation.base.get_product_items_by_skus",
+        return_value=[],
+    )
+
+    result = add_default_lines(mock_client, order)
+
+    assert result["lines"] == [{"existing": "line"}]
+
+
+def test_validate_order_orchestrates_all_steps(order_factory, order_parameters_factory, mocker):
+    mock_client = MagicMock()
+    order = order_factory(
+        order_parameters=order_parameters_factory(
+            account_type=AccountTypesEnum.NEW_AWS_ENVIRONMENT.value,
+            constraints={"hidden": None, "required": None, "readonly": None},
+        ),
+        lines=[],
+    )
+    mock_items = [
+        {
+            "id": "ITM-1234-1234-1234-0001",
+            "name": "AWS Usage",
+            "externalIds": {"vendor": "AWS Usage"},
+        }
+    ]
+    mocker.patch(
+        "swo_aws_extension.flows.validation.base.get_product_items_by_skus",
+        return_value=mock_items,
+    )
+
+    result = validate_order(mock_client, order)
+
+    order_account_name_param = get_ordering_parameter(
+        OrderParametersEnum.ORDER_ACCOUNT_NAME.value, result
+    )
+    assert order_account_name_param["constraints"]["hidden"] is False
+    assert order_account_name_param["constraints"]["required"] is True
+    assert result["lines"] == [{"item": mock_items[0], "quantity": 1}]

tests/test_extension.py

@@ -50,10 +50,10 @@ def test_validated_order(
         client,
         order_factory,
         jwt_token,
-        mock_update_parameters_visibility,
+        mock_validate_order,
     ):
         order = order_factory()
-        mock_update_parameters_visibility.return_value = order
+        mock_validate_order.return_value = order
 
         result = client.post(
             "/api/v1/orders/validate",
@@ -73,11 +73,11 @@ def test_handles_exception(
         client,
         order_factory,
         jwt_token,
-        mock_update_parameters_visibility,
+        mock_validate_order,
     ):
         order = order_factory()
         error_message = "Test validation error"
-        mock_update_parameters_visibility.side_effect = Exception(error_message)
+        mock_validate_order.side_effect = Exception(error_message)
 
         result = client.post(
             "/api/v1/orders/validate",