MPT-14886 Add E2E tests for catalog product parameters

Author: albertsola

e2e_config.test.json

@@ -2,5 +2,6 @@
   "catalog.product.id": "PRD-7255-3950",
   "accounts.seller.id": "SEL-7310-3075",
   "catalog.product.parameter_group.id": "PGR-7255-3950-0001",
+  "catalog.product.parameter.id": "PAR-8645-3987-0001",
   "accounts.account.id": "ACC-9042-0088"
 }

seed/catalog/product.py

@@ -22,6 +22,7 @@ async def get_product(
 ) -> Product | None:
     """Get product from context or fetch from API."""
     product_id = context.get_string(f"{namespace}.id")
+    logger.debug("Getting product: %s", product_id)
     if not product_id:
         return None
     try:
@@ -44,15 +45,17 @@ async def init_product(
 ) -> Product:
     """Get or create product."""
     product = await get_product()
-    if not product:
+    if product is None:
         logger.debug("Creating product ...")
         with pathlib.Path.open(icon, "rb") as icon_file:
             product = await mpt_vendor.catalog.products.create(
                 {"name": "E2E Seeded", "website": "https://www.example.com"}, icon=icon_file
             )
             context.set_resource(namespace, product)
             context[f"{namespace}.id"] = product.id
-        logger.debug("Product created: %s", product.id)
+        logger.info("Product created: %s", product.id)
+    else:
+        logger.info("Product found: %s", product.id)
     return product
 
 

seed/catalog/product_parameters.py

@@ -10,7 +10,7 @@
 
 logger = logging.getLogger(__name__)
 
-namespace = "catalog.parameter"
+namespace = "catalog.product.parameter"
 
 
 @inject
@@ -35,15 +35,15 @@ async def get_parameter(
 @inject
 def build_parameter(context: Context = DEFAULT_CONTEXT) -> dict[str, Any]:
     """Build parameter data dictionary."""
-    parameter_group_id = context.get_string("catalog.parameter_group.id")
+    parameter_group_id = context.get_string("catalog.product.parameter_group.id")
     if not parameter_group_id:
         raise ValueError("Parameter group id is required.")
     return {
-        "name": "Parameter Name",
+        "name": "e2e - seed",
         "scope": "Order",
         "phase": "Order",
-        "description": "Agreement identifier of the reseller",
-        "externalId": "RES-233-33-xx3",
+        "description": "e2e - seeded parameter",
+        "externalId": "e2e-seed-parameter",
         "displayOrder": 100,
         "context": "Purchase",
         "constraints": {"hidden": True, "readonly": True, "required": False},
@@ -71,7 +71,7 @@ async def create_parameter(
         raise ValueError("Product id is required.")
     parameter_data = build_parameter(context=context)
     parameter = await mpt_vendor.catalog.products.parameters(product_id).create(parameter_data)
-    logger.debug("Parameter created: %s", parameter.id)
+    logger.info("Parameter created: %s", parameter.id)
     context[f"{namespace}.id"] = parameter.id
     context.set_resource(namespace, parameter)
     return parameter
@@ -87,7 +87,7 @@ async def init_parameter(
 
     if not parameter:
         logger.debug("Creating parameter ...")
-        return await create_parameter(context, mpt_vendor)
+        return await create_parameter(context=context, mpt_vendor=mpt_vendor)
     logger.debug("Parameter found: %s", parameter.id)
     return parameter
 

seed/context.py

@@ -1,10 +1,13 @@
 import collections
 import json
+import logging
 import pathlib
 from typing import Any
 
 from mpt_api_client.models import Model
 
+logger = logging.getLogger(__name__)
+
 
 class Context(collections.UserDict[str, Any]):
     """Application context."""
@@ -45,6 +48,7 @@ def load_context(json_file: pathlib.Path, context: Context | None = None) -> Con
     with json_file.open("r", encoding="utf-8") as fd:
         existing_data = json.load(fd)
     context.update(existing_data)
+    logger.info("Context loaded: %s", context.items())
     return context
 
 

seed/main.py

@@ -4,7 +4,7 @@
 from seed.container import wire_container
 from seed.seed_api import seed_api
 
-logging.basicConfig(level=logging.INFO)
+logging.basicConfig(level=logging.DEBUG)
 logger = logging.getLogger(__name__)
 
 

setup.cfg

@@ -49,6 +49,7 @@ per-file-ignores =
   tests/unit/resources/accounts/test_users.py: WPS204 WPS202 WPS210
   tests/unit/test_mpt_client.py: WPS235
   tests/e2e/accounts/*.py: WPS430 WPS202
+  tests/e2e/catalog/*.py: WPS421
 
   tests/*:
     # Allow magic strings.

tests/e2e/catalog/product/conftest.py

@@ -12,3 +12,13 @@ def product_icon():
 @pytest.fixture
 def product_data():
     return {"name": "Test Product", "website": "https://www.example.com"}
+
+
+@pytest.fixture
+def parameter_group_id(e2e_config):
+    return e2e_config["catalog.product.parameter_group.id"]
+
+
+@pytest.fixture
+def parameter_id(e2e_config):
+    return e2e_config["catalog.product.parameter.id"]

tests/e2e/catalog/product/parameter_groups/conftest.py

@@ -1,11 +1,6 @@
 import pytest
 
 
-@pytest.fixture
-def parameter_group_id(e2e_config):
-    return e2e_config["catalog.product.parameter_group.id"]
-
-
 @pytest.fixture
 def parameter_group_data():
     return {

tests/e2e/catalog/product/parameters/conftest.py

@@ -0,0 +1,21 @@
+import pytest
+
+
+@pytest.fixture
+def parameter_data(parameter_group_id):
+    return {
+        "constraints": {"hidden": False, "readonly": False, "required": False},
+        "description": "e2e - please delete",
+        "displayOrder": 100,
+        "name": "e2e - please delete",
+        "phase": "Order",
+        "scope": "Order",
+        "type": "SingleLineText",
+        "context": "Purchase",
+        "options": {
+            "hintText": "delete",
+            "defaultValue": "Delete me",
+            "placeholderText": "Place holder text",
+        },
+        "group": {"id": parameter_group_id},
+    }

tests/e2e/catalog/product/parameters/test_async_parameters.py

@@ -0,0 +1,59 @@
+import pytest
+
+from mpt_api_client.exceptions import MPTAPIError
+
+pytestmark = [pytest.mark.flaky]
+
+
+@pytest.fixture
+async def async_created_parameter(async_mpt_vendor, product_id, parameter_data):
+    service = async_mpt_vendor.catalog.products.parameters(product_id)
+    parameter = await service.create(parameter_data)
+    yield parameter
+    try:
+        await service.delete(parameter.id)
+    except MPTAPIError as error:
+        print(f"TEARDOWN - Unable to delete parameter {parameter.id}: {error.title}")
+
+
+@pytest.mark.asyncio
+def test_create_parameter(async_created_parameter):
+    assert async_created_parameter.name == "e2e - please delete"
+
+
+@pytest.mark.asyncio
+async def test_create_parameter_wrong_data(async_mpt_vendor, product_id):
+    parameter_data = {"name": "e2e - please delete - wrong data test"}
+    service = async_mpt_vendor.catalog.products.parameters(product_id)
+    with pytest.raises(MPTAPIError):
+        await service.create(parameter_data)
+
+
+@pytest.mark.asyncio
+async def test_update_parameter(async_mpt_vendor, product_id, async_created_parameter):
+    service = async_mpt_vendor.catalog.products.parameters(product_id)
+    update_data = {"name": "please delete me"}
+    parameter = await service.update(async_created_parameter.id, update_data)
+    assert parameter.name == "please delete me"
+
+
+@pytest.mark.asyncio
+async def test_get_parameter(async_mpt_vendor, product_id, parameter_id):
+    service = async_mpt_vendor.catalog.products.parameters(product_id)
+    parameter = await service.get(parameter_id)
+    assert parameter.id == parameter_id
+
+
+@pytest.mark.asyncio
+async def test_iterate_parameters(async_mpt_vendor, product_id, async_created_parameter):
+    service = async_mpt_vendor.catalog.products.parameters(product_id)
+    product_parameters = [product_param async for product_param in service.iterate()]
+    assert any(parameter.id == async_created_parameter.id for parameter in product_parameters)
+
+
+@pytest.mark.asyncio
+async def test_delete_parameter(async_mpt_vendor, product_id, async_created_parameter):
+    service = async_mpt_vendor.catalog.products.parameters(product_id)
+    await service.delete(async_created_parameter.id)
+    parameter = await service.get(async_created_parameter.id)
+    assert parameter.status == "Deleted"