MPT-14900 E2E tests for catalog pricing-policies

Author: albertsola

e2e_config.test.json

@@ -19,5 +19,7 @@
   "catalog.product.template.id": "TPL-7255-3950-0001",
   "catalog.product.terms.id": "TCS-7255-3950-0001",
   "catalog.product.terms.variant.id": "TCV-7255-3950-0001-0001",
-  "catalog.unit.id": "UNT-1229"
+  "catalog.unit.id": "UNT-1229",
+  "catalog.pricing_policy.id": "PRP-1123-5132-3456",
+  "catalog.pricing_policy.attachment.id": "PPA-1123-5132-3456-0001"
 }

mpt_api_client/resources/catalog/pricing_policy_attachments.py

@@ -1,14 +1,17 @@
 from mpt_api_client.http import AsyncService, Service
 from mpt_api_client.http.mixins import (
     AsyncCollectionMixin,
-    AsyncFilesOperationsMixin,
+    AsyncDownloadFileMixin,
     AsyncModifiableResourceMixin,
     CollectionMixin,
-    FilesOperationsMixin,
+    DownloadFileMixin,
     ModifiableResourceMixin,
 )
 from mpt_api_client.models import Model
-from mpt_api_client.resources.catalog.mixins import ActivatableMixin, AsyncActivatableMixin
+from mpt_api_client.resources.catalog.mixins import (
+    AsyncCreateFileMixin,
+    CreateFileMixin,
+)
 
 
 class PricingPolicyAttachment(Model):
@@ -21,11 +24,13 @@ class PricingPolicyAttachmentsServiceConfig:
     _endpoint = "/public/v1/catalog/pricing-policies/{pricing_policy_id}/attachments"
     _model_class = PricingPolicyAttachment
     _collection_key = "data"
+    _upload_file_key = "file"
+    _upload_data_key = "attachment"
 
 
 class PricingPolicyAttachmentsService(
-    FilesOperationsMixin[PricingPolicyAttachment],
-    ActivatableMixin[PricingPolicyAttachment],
+    CreateFileMixin[PricingPolicyAttachment],
+    DownloadFileMixin[PricingPolicyAttachment],
     ModifiableResourceMixin[PricingPolicyAttachment],
     CollectionMixin[PricingPolicyAttachment],
     Service[PricingPolicyAttachment],
@@ -35,8 +40,8 @@ class PricingPolicyAttachmentsService(
 
 
 class AsyncPricingPolicyAttachmentsService(
-    AsyncFilesOperationsMixin[PricingPolicyAttachment],
-    AsyncActivatableMixin[PricingPolicyAttachment],
+    AsyncCreateFileMixin[PricingPolicyAttachment],
+    AsyncDownloadFileMixin[PricingPolicyAttachment],
     AsyncModifiableResourceMixin[PricingPolicyAttachment],
     AsyncCollectionMixin[PricingPolicyAttachment],
     AsyncService[PricingPolicyAttachment],

tests/e2e/catalog/pricing_policies/attachments/__init__.py

@@ -0,0 +1,14 @@
+import pytest
+
+
+@pytest.fixture
+def attachment_id(e2e_config):
+    return e2e_config.get("catalog.pricing_policy.attachment.id")
+
+
+@pytest.fixture
+def attachment_data():
+    return {
+        "name": "e2e test attachment - please delete",
+        "description": "E2E test attachment for automated testing",
+    }

tests/e2e/catalog/pricing_policies/attachments/conftest.py

@@ -0,0 +1,67 @@
+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 async_attachment_service(async_mpt_ops, pricing_policy_id):
+    return async_mpt_ops.catalog.pricing_policies.attachments(pricing_policy_id)
+
+
+@pytest.fixture
+async def created_attachment_async(logger, async_attachment_service, attachment_data, pdf_fd):
+    attachment_data["documenttype"] = "File"
+    attachment = await async_attachment_service.create(attachment_data, file=pdf_fd)
+    yield attachment
+    try:
+        await async_attachment_service.delete(attachment.id)
+    except MPTAPIError as error:
+        print(f"TEARDOWN - Unable to delete attachment {attachment.id}: {error.title}")
+
+
+def test_create_attachment_async(created_attachment_async, attachment_data):
+    assert created_attachment_async.name == attachment_data["name"]
+    assert created_attachment_async.description == attachment_data["description"]
+
+
+async def test_update_attachment_async(async_attachment_service, created_attachment_async):
+    update_data = {"name": "Updated e2e test attachment - please delete"}
+    attachment = await async_attachment_service.update(created_attachment_async.id, update_data)
+    assert attachment.name == update_data["name"]
+
+
+async def test_get_attachment_async(async_attachment_service, attachment_id):
+    attachment = await async_attachment_service.get(attachment_id)
+    assert attachment.id == attachment_id
+
+
+async def test_download_attachment_async(async_attachment_service, attachment_id):
+    file_response = await async_attachment_service.download(attachment_id)
+    assert file_response.file_contents is not None
+    assert file_response.filename == "empty.pdf"
+
+
+async def test_iterate_attachments_async(async_attachment_service, created_attachment_async):
+    attachments = [att async for att in async_attachment_service.iterate()]
+    assert any(att.id == created_attachment_async.id for att in attachments)
+
+
+async def test_filter_attachments_async(async_attachment_service, created_attachment_async):
+    filtered_service = async_attachment_service.filter(RQLQuery(id=created_attachment_async.id))
+    attachments = [att async for att in filtered_service.iterate()]
+    assert len(attachments) == 1
+    assert attachments[0].id == created_attachment_async.id
+
+
+async def test_not_found_async(async_attachment_service):
+    with pytest.raises(MPTAPIError):
+        await async_attachment_service.get("ATT-000-000-000")
+
+
+async def test_delete_attachment_async(async_attachment_service, created_attachment_async):
+    await async_attachment_service.delete(created_attachment_async.id)
+    with pytest.raises(MPTAPIError):
+        await async_attachment_service.get(created_attachment_async.id)

tests/e2e/catalog/pricing_policies/attachments/test_async_attachment.py

@@ -0,0 +1,66 @@
+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 attachment_service(mpt_ops, pricing_policy_id):
+    return mpt_ops.catalog.pricing_policies.attachments(pricing_policy_id)
+
+
+@pytest.fixture
+def created_attachment(logger, attachment_service, attachment_data, pdf_fd):
+    attachment_data["documenttype"] = "File"
+    attachment = attachment_service.create(attachment_data, file=pdf_fd)
+    yield attachment
+    try:
+        attachment_service.delete(attachment.id)
+    except MPTAPIError as error:
+        print(f"TEARDOWN - Unable to delete attachment {attachment.id}: {error.title}")
+
+
+def test_create_attachment(created_attachment, attachment_data):
+    assert created_attachment.name == attachment_data["name"]
+    assert created_attachment.description == attachment_data["description"]
+
+
+def test_update_attachment(attachment_service, created_attachment):
+    update_data = {"name": "Updated e2e test attachment - please delete"}
+    attachment = attachment_service.update(created_attachment.id, update_data)
+    assert attachment.name == update_data["name"]
+
+
+def test_get_attachment(attachment_service, attachment_id):
+    attachment = attachment_service.get(attachment_id)
+    assert attachment.id == attachment_id
+
+
+def test_download_attachment(attachment_service, attachment_id):
+    file_response = attachment_service.download(attachment_id)
+    assert file_response.file_contents is not None
+    assert file_response.filename == "empty.pdf"
+
+
+def test_iterate_attachments(attachment_service, created_attachment):
+    attachments = list(attachment_service.iterate())
+    assert any(att.id == created_attachment.id for att in attachments)
+
+
+def test_filter_attachments(attachment_service, created_attachment):
+    attachments = list(attachment_service.filter(RQLQuery(id=created_attachment.id)).iterate())
+    assert len(attachments) == 1
+    assert attachments[0].id == created_attachment.id
+
+
+def test_not_found(attachment_service):
+    with pytest.raises(MPTAPIError):
+        attachment_service.get("ATT-000-000-000")
+
+
+def test_delete_attachment(attachment_service, created_attachment):
+    attachment_service.delete(created_attachment.id)
+    with pytest.raises(MPTAPIError):
+        attachment_service.get(created_attachment.id)

tests/e2e/catalog/pricing_policies/attachments/test_sync_attachment.py

@@ -36,15 +36,11 @@ def test_async_endpoint(async_pricing_policy_attachments_service) -> None:
     )
 
 
-@pytest.mark.parametrize(
-    "method", ["get", "create", "delete", "update", "download", "activate", "deactivate"]
-)
+@pytest.mark.parametrize("method", ["get", "create", "delete", "update", "download"])
 def test_methods_present(pricing_policy_attachments_service, method: str) -> None:
     assert hasattr(pricing_policy_attachments_service, method)
 
 
-@pytest.mark.parametrize(
-    "method", ["get", "create", "delete", "update", "download", "activate", "deactivate"]
-)
+@pytest.mark.parametrize("method", ["get", "create", "delete", "update", "download"])
 def test_async_methods_present(async_pricing_policy_attachments_service, method: str) -> None:
     assert hasattr(async_pricing_policy_attachments_service, method)