MPT-14767 E2E seeding proof of concept

- Added seeding proof of concept
- Fix create product request

Author: albertsola

mpt_api_client/http/client.py

@@ -49,7 +49,6 @@ def __init__(
         base_headers = {
             "User-Agent": "swo-marketplace-client/1.0",
             "Authorization": f"Bearer {api_token}",
-            "content-type": "application/json",
         }
         self.httpx_client = Client(
             base_url=base_url,

mpt_api_client/http/mixins.py

@@ -86,7 +86,6 @@ def create(
                 _json_to_file_payload(resource_data),
                 "application/json",
             )
-
         response = self.http_client.request("post", self.path, files=files)  # type: ignore[attr-defined]
 
         return self._model_class.from_response(response)  # type: ignore[attr-defined, no-any-return]

mpt_api_client/resources/catalog/products.py

@@ -1,10 +1,13 @@
+import json
+
 from mpt_api_client.http import AsyncService, Service
 from mpt_api_client.http.mixins import (
     AsyncCollectionMixin,
-    AsyncManagedResourceMixin,
+    AsyncModifiableResourceMixin,
     CollectionMixin,
-    ManagedResourceMixin,
+    ModifiableResourceMixin,
 )
+from mpt_api_client.http.types import FileTypes
 from mpt_api_client.models import Model, ResourceData
 from mpt_api_client.resources.catalog.mixins import (
     AsyncPublishableMixin,
@@ -54,13 +57,38 @@ class ProductsServiceConfig:
 
 class ProductsService(
     PublishableMixin[Product],
-    ManagedResourceMixin[Product],
+    ModifiableResourceMixin[Product],
     CollectionMixin[Product],
     Service[Product],
     ProductsServiceConfig,
 ):
     """Products service."""
 
+    def create(
+        self,
+        resource_data: ResourceData,
+        icon: FileTypes,
+    ) -> Model:
+        """Create product with icon.
+
+        Args:
+            resource_data: Product data.
+            icon: Icon image in jpg, png, GIF, etc.
+
+        Returns:
+            Created resource.
+        """
+        files: dict[str, FileTypes] = {}
+        files["product"] = (
+            None,
+            json.dumps(resource_data),
+            "application/json",
+        )
+        files["icon"] = icon
+        response = self.http_client.request("post", self.path, files=files)
+
+        return self._model_class.from_response(response)
+
     def item_groups(self, product_id: str) -> ItemGroupsService:
         """Return item_groups service."""
         return ItemGroupsService(
@@ -108,13 +136,37 @@ def update_settings(self, product_id: str, settings: ResourceData) -> Product:
 
 class AsyncProductsService(
     AsyncPublishableMixin[Product],
-    AsyncManagedResourceMixin[Product],
+    AsyncModifiableResourceMixin[Product],
     AsyncCollectionMixin[Product],
     AsyncService[Product],
     ProductsServiceConfig,
 ):
     """Products service."""
 
+    async def create(
+        self,
+        resource_data: ResourceData,
+        icon: FileTypes,
+    ) -> Model:
+        """Create product with icon.
+
+        Args:
+            resource_data: Product data.
+            icon: Icon image in jpg, png, GIF, etc.
+
+        Returns:
+            Created resource.
+        """
+        files: dict[str, FileTypes] = {}
+        files["product"] = (
+            None,
+            json.dumps(resource_data),
+            "application/json",
+        )
+        files["icon"] = icon
+        response = await self.http_client.request("post", self.path, files=files)
+        return self._model_class.from_response(response)
+
     def item_groups(self, product_id: str) -> AsyncItemGroupsService:
         """Return item_groups service."""
         return AsyncItemGroupsService(

pyproject.toml

@@ -60,7 +60,7 @@ build-backend = "hatchling.build"
 [tool.pytest.ini_options]
 testpaths = "tests"
 pythonpath = "."
-addopts = "--cov=mpt_api_client --cov-report=term-missing --cov-report=html --cov-report=xml --import-mode=importlib"
+addopts = "--cov=mpt_api_client --cov-report=term-missing --cov-report=html --cov-report=xml --import-mode=importlib -m 'not dataseed'"
 log_cli = false
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"
@@ -69,6 +69,9 @@ filterwarnings = [
     "ignore:pkg_resources is deprecated as an API:DeprecationWarning",
 ]
 rp_project = "mpt-api-python-client"
+markers = [
+    "dataseed: Creates the required data in the API for E2E tests",
+]
 
 [tool.coverage.run]
 branch = true

setup.cfg

@@ -48,7 +48,7 @@ per-file-ignores =
   tests/unit/resources/accounts/test_users.py: WPS204 WPS202 WPS210
   tests/unit/test_mpt_client.py: WPS235
 
-  tests/unit/*:
+  tests/*:
     # Allow magic strings.
     WPS432
     # Found too many modules members.

tests/seed/__init__.py

@@ -0,0 +1,59 @@
+import datetime as dt
+import json
+import pathlib
+import uuid
+
+import httpx
+import pytest
+
+pytestmark = pytest.mark.dataseed
+
+
+@pytest.fixture
+def icon_path():
+    return pathlib.Path(__file__).parent / "FIL-9920-4780-9379.png"
+
+
+@pytest.fixture
+def product_id(mpt_vendor, mpt_operations, icon_path):
+    product_data = {
+        "name": "Microsoft 365 online services for commercial",
+        "shortDescription": "Microsoft 365 and Office 365 [...]",
+        "longDescription": "Microsoft 365 and Office 365 [...long]",
+        "website": "https://www.microsoft.com",
+    }
+
+    with pathlib.Path.open(icon_path, "rb") as icon_file:
+        new_product = mpt_vendor.catalog.products.create(
+            product_data,
+            icon=icon_file,
+        )
+    assert new_product.meta.response.status_code == httpx.Response.raise_for_status()
+
+    return new_product.id
+
+
+@pytest.fixture
+def product_data(product_id):
+    return {
+        "product_id": product_id,
+    }
+
+
+@pytest.fixture
+def product_json_path():
+    date = dt.datetime.now(tz=dt.UTC).strftime("%Y-%m-%d")
+    test_run_id = str(uuid.uuid4())[:8]
+    return pathlib.Path(__file__).parent / f"../../../test-data-{date}-{test_run_id}.json"
+
+
+def test_dataseed_marker(request):
+    marker = request.node.get_closest_marker("dataseed")
+    assert marker is not None
+
+
+def test_save(product_json_path, product_data, logger):
+    catalog_data_json = json.dumps(product_data, indent=2)
+    pathlib.Path(product_json_path).write_text(catalog_data_json, encoding="utf-8")
+    logger.info("Saved commerce data to `%s`", product_json_path)
+    logger.debug(catalog_data_json)

tests/seed/catalog/FIL-9920-4780-9379.png

@@ -0,0 +1,30 @@
+import os
+
+import pytest
+
+from mpt_api_client import MPTClient
+
+
+@pytest.fixture
+def operations_token():
+    return os.getenv("MPT_API_TOKEN_OPERATIONS")
+
+
+@pytest.fixture
+def base_url():
+    return os.getenv("MPT_API_BASE_URL")
+
+
+@pytest.fixture
+def vendor_token():
+    return os.getenv("MPT_API_TOKEN_VENDOR")
+
+
+@pytest.fixture
+def mpt_vendor(vendor_token, base_url):
+    return MPTClient.from_config(api_token=vendor_token, base_url=base_url)
+
+
+@pytest.fixture
+def mpt_operations(operations_token, base_url):
+    return MPTClient.from_config(api_token=operations_token, base_url=base_url)