Seeded and created e2e tests for commerce agreements

Author: Robert Segal

e2e_config.test.json

@@ -11,6 +11,13 @@
   "accounts.seller.id": "SEL-7310-3075",
   "accounts.user.id": "USR-9673-3314",
   "accounts.user_group.id": "UGR-6822-0561",
+  "commerce.agreement.id": "AGR-9850-2169-6098",
+  "commerce.product.id": "PRD-1767-7355",
+  "commerce.product.item.id": "ITM-1767-7355-0001",
+  "commerce.product.listing.id": "LST-5489-0806",
+  "commerce.product.template.id": "TPL-1767-7355-0003",
+  "commerce.authorization.id": "AUT-0031-2873",
+  "commerce.client.id": "ACC-1086-6867",
   "catalog.product.item.id": "ITM-7255-3950-0751",
   "catalog.product.document.id": "PDC-7255-3950-0001",
   "catalog.product.id": "PRD-7255-3950",

mpt_api_client/resources/commerce/agreements.py

@@ -44,6 +44,18 @@ def template(self, agreement_id: str) -> str:
         response = self._resource_do_request(agreement_id, action="template")
         return response.text
 
+    def render(self, agreement_id: str) -> str:
+        """Renders the template for the given Agreement id.
+
+        Args:
+            agreement_id: Agreement ID.
+
+        Returns:
+            Rendered Agreement.
+        """
+        response = self._resource_do_request(agreement_id, action="render")
+        return response.text
+
     def attachments(self, agreement_id: str) -> AgreementsAttachmentService:
         """Get the attachments service for the given Agreement id.
 
@@ -79,6 +91,18 @@ async def template(self, agreement_id: str) -> str:
         response = await self._resource_do_request(agreement_id, action="template")
         return response.text
 
+    async def render(self, agreement_id: str) -> str:
+        """Renders the template for the given Agreement id.
+
+        Args:
+            agreement_id: Agreement ID.
+
+        Returns:
+            Rendered Agreement.
+        """
+        response = await self._resource_do_request(agreement_id, action="render")
+        return response.text
+
     def attachments(self, agreement_id: str) -> AsyncAgreementsAttachmentService:
         """Get the attachments service for the given Agreement id.
 

mpt_api_client/utils.py

@@ -0,0 +1,6 @@
+import datetime as dt
+
+
+def get_iso_dt_str(dt_obj: dt.datetime) -> str:
+    """Convert datetime to ISO 8601 string."""
+    return dt_obj.isoformat(timespec="milliseconds").replace("+00:00", "Z")

pyproject.toml

@@ -48,6 +48,7 @@ dev = [
     "ruff==0.12.11", # force ruff version to have same formatting everywhere
     "typing-extensions==4.13.*",
     "wemake-python-styleguide==1.3.*",
+    "types-python-dateutil",
 ]
 
 [tool.hatch.build.targets.sdist]
@@ -119,6 +120,7 @@ per-file-ignores = [
   "mpt_api_client/resources/catalog/mixins.py: WPS110 WPS202 WPS214 WPS215 WPS235",
   "mpt_api_client/resources/catalog/products.py: WPS204 WPS214 WPS215 WPS235",
   "mpt_api_client/rql/query_builder.py: WPS110 WPS115 WPS210 WPS214",
+  "mpt_api_client/utils.py: WPS100 WPS453",
   "tests/unit/http/test_async_service.py: WPS204 WPS202",
   "tests/unit/http/test_service.py: WPS204 WPS202",
   "tests/unit/http/test_mixins.py: WPS204 WPS202 WPS210",

tests/e2e/accounts/conftest.py

@@ -18,21 +18,6 @@ def currencies():
     return ["USD", "EUR"]
 
 
-@pytest.fixture
-def account_id(e2e_config):
-    return e2e_config["accounts.account.id"]
-
-
-@pytest.fixture
-def seller_id(e2e_config):
-    return e2e_config["accounts.seller.id"]
-
-
-@pytest.fixture
-def buyer_id(e2e_config):
-    return e2e_config["accounts.buyer.id"]
-
-
 @pytest.fixture
 def user_group_id(e2e_config):
     return e2e_config["accounts.user_group.id"]

tests/e2e/accounts/licensees/conftest.py

@@ -11,11 +11,6 @@ def licensee_group_id(e2e_config):
     return e2e_config["accounts.licensee.group.id"]
 
 
-@pytest.fixture
-def licensee_id(e2e_config):
-    return e2e_config["accounts.licensee.id"]
-
-
 @pytest.fixture
 def invalid_licensee_id():
     return "LCE-0000-0000-0000"

tests/e2e/commerce/agreement/conftest.py

@@ -0,0 +1,60 @@
+import datetime as dt
+
+import pytest
+from dateutil.relativedelta import relativedelta
+from freezegun import freeze_time
+
+from mpt_api_client.utils import get_iso_dt_str
+
+
+@pytest.fixture
+def invalid_agreement_id():
+    return "AGR-0000-0000"
+
+
+@pytest.fixture
+def agreement_factory(  # noqa: WPS211
+    account_id,
+    seller_id,
+    buyer_id,
+    licensee_id,
+    commerce_product_id,
+    authorization_id,
+):
+    @freeze_time("2025-11-14T09:00:00.000Z")
+    def _agreement_factory(  # noqa: WPS430
+        name: str = "E2E Created Agreement",
+        client_external_id: str = "test-client-external-id",
+        vendor_external_id: str = "test-vendor-external-id",
+    ):
+        """Factory to create agreement data."""
+        start_date = dt.datetime.now(tz=dt.UTC)
+        end_date = start_date + relativedelta(years=1)
+
+        return {
+            "name": name,
+            "status": "Active",
+            "vendor": {"id": account_id},
+            "authorization": {"id": authorization_id},
+            "seller": {"id": seller_id},
+            "buyer": {"id": buyer_id},
+            "licensee": {"id": licensee_id},
+            "product": {"id": commerce_product_id},
+            "value": {
+                "PPxY": 150,
+                "PPxM": 12.5,
+                "SPxY": 165,
+                "SPxM": 13.75,
+                "markup": 0.1,
+                "margin": 0.11,
+                "currency": "USD",
+            },
+            "startDate": get_iso_dt_str(start_date),
+            "endDate": get_iso_dt_str(end_date),
+            "externalIds": {
+                "client": client_external_id,
+                "vendor": vendor_external_id,
+            },
+        }
+
+    return _agreement_factory

tests/e2e/commerce/agreement/test_async_agreement.py

@@ -0,0 +1,77 @@
+import pytest
+
+from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.rql.query_builder import RQLQuery
+
+pytestmark = [pytest.mark.flaky]
+
+
+@pytest.fixture
+async def created_agreement(async_mpt_ops, agreement_factory):
+    new_agreement_request_data = agreement_factory(
+        name="E2E Created Agreement",
+    )
+
+    return await async_mpt_ops.commerce.agreements.create(new_agreement_request_data)
+
+
+async def test_get_agreement_by_id(async_mpt_ops, agreement_id):
+    result = await async_mpt_ops.commerce.agreements.get(agreement_id)
+
+    assert result is not None
+
+
+async def test_list_agreements(async_mpt_ops):
+    limit = 10
+
+    result = await async_mpt_ops.commerce.agreements.fetch_page(limit=limit)
+
+    assert len(result) > 0
+
+
+async def test_get_agreement_by_id_not_found(async_mpt_ops, invalid_agreement_id):
+    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+        await async_mpt_ops.commerce.agreements.get(invalid_agreement_id)  # act
+
+
+async def test_filter_agreements(async_mpt_ops, agreement_id):
+    select_fields = ["-value"]
+
+    filtered_agreements = (
+        async_mpt_ops.commerce.agreements.filter(RQLQuery(id=agreement_id))
+        .filter(RQLQuery(name="E2E Seeded For Commerce for Test Api Client Client"))
+        .select(*select_fields)
+    )
+
+    result = [filtered_agreements async for filtered_agreement in filtered_agreements.iterate()]
+
+    assert len(result) == 1
+
+
+def test_create_agreement(created_agreement):
+    result = created_agreement
+
+    assert result is not None
+
+
+async def test_update_agreement(async_mpt_ops, created_agreement, agreement_factory):
+    updated_name = "E2E Updated Agreement Name"
+    updated_agreement_data = agreement_factory(name=updated_name)
+
+    result = await async_mpt_ops.commerce.agreements.update(
+        created_agreement.id, updated_agreement_data
+    )
+
+    assert result is not None
+
+
+async def test_get_agreement_render(async_mpt_ops, agreement_id):
+    result = await async_mpt_ops.commerce.agreements.render(agreement_id)
+
+    assert result is not None
+
+
+async def test_get_agreement_template(async_mpt_ops, agreement_id):
+    result = await async_mpt_ops.commerce.agreements.template(agreement_id)
+
+    assert result is not None

tests/e2e/commerce/agreement/test_sync_agreement.py

@@ -0,0 +1,74 @@
+import pytest
+
+from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.rql.query_builder import RQLQuery
+
+pytestmark = [pytest.mark.flaky]
+
+
+@pytest.fixture
+def created_agreement(mpt_ops, agreement_factory):
+    new_agreement_request_data = agreement_factory(
+        name="E2E Created Agreement",
+    )
+
+    return mpt_ops.commerce.agreements.create(new_agreement_request_data)
+
+
+def test_get_agreement_by_id(mpt_ops, agreement_id):
+    result = mpt_ops.commerce.agreements.get(agreement_id)
+
+    assert result is not None
+
+
+def test_list_agreements(mpt_ops):
+    limit = 10
+
+    result = mpt_ops.commerce.agreements.fetch_page(limit=limit)
+
+    assert len(result) > 0
+
+
+def test_get_agreement_by_id_not_found(mpt_ops, invalid_agreement_id):
+    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+        mpt_ops.commerce.agreements.get(invalid_agreement_id)  # act
+
+
+def test_filter_agreements(mpt_ops, agreement_id):
+    select_fields = ["-value"]
+    filtered_agreements = (
+        mpt_ops.commerce.agreements.filter(RQLQuery(id=agreement_id))
+        .filter(RQLQuery(name="E2E Seeded For Commerce for Test Api Client Client"))
+        .select(*select_fields)
+    )
+
+    result = list(filtered_agreements.iterate())
+
+    assert len(result) == 1
+
+
+def test_create_agreement(created_agreement):
+    result = created_agreement
+
+    assert result is not None
+
+
+def test_update_agreement(mpt_ops, created_agreement, agreement_factory):
+    updated_name = "E2E Updated Agreement Name"
+    updated_agreement_data = agreement_factory(name=updated_name)
+
+    result = mpt_ops.commerce.agreements.update(created_agreement.id, updated_agreement_data)
+
+    assert result is not None
+
+
+def test_get_agreement_render(mpt_ops, agreement_id):
+    result = mpt_ops.commerce.agreements.render(agreement_id)
+
+    assert result is not None
+
+
+def test_get_agreement_template(mpt_ops, agreement_id):
+    result = mpt_ops.commerce.agreements.template(agreement_id)
+
+    assert result is not None

tests/e2e/commerce/conftest.py

@@ -0,0 +1,11 @@
+import pytest
+
+
+@pytest.fixture
+def agreement_id(e2e_config):
+    return e2e_config["commerce.agreement.id"]
+
+
+@pytest.fixture
+def commerce_product_id(e2e_config):
+    return e2e_config["commerce.product.id"]