Fixed agreement attachments endpoints, created e2e tests

Author: Robert Segal

e2e_config.test.json

@@ -11,7 +11,9 @@
   "accounts.seller.id": "SEL-7310-3075",
   "accounts.user.id": "USR-9673-3314",
   "accounts.user_group.id": "UGR-6822-0561",
+  "commerce.agreement.attachment.id": "ATT-9850-2169-6098-0001",
   "commerce.agreement.id": "AGR-9850-2169-6098",
+  "commerce.order.id": "ORD-6969-3541-5426",
   "commerce.product.id": "PRD-1767-7355",
   "commerce.product.item.id": "ITM-1767-7355-0001",
   "commerce.product.listing.id": "LST-5489-0806",

mpt_api_client/resources/commerce/agreements_attachments.py

@@ -1,13 +1,17 @@
 from mpt_api_client.http import AsyncService, Service
-from mpt_api_client.http.mixins import (
+from mpt_api_client.http.mixins import (  # noqa: WPS235
     AsyncCollectionMixin,
+    AsyncCreateFileMixin,
     AsyncDeleteMixin,
-    AsyncFilesOperationsMixin,
+    AsyncDownloadFileMixin,
     AsyncGetMixin,
+    AsyncUpdateMixin,
     CollectionMixin,
+    CreateFileMixin,
     DeleteMixin,
-    FilesOperationsMixin,
+    DownloadFileMixin,
     GetMixin,
+    UpdateMixin,
 )
 from mpt_api_client.models import Model
 
@@ -22,10 +26,14 @@ class AgreementsAttachmentServiceConfig:
     _endpoint = "/public/v1/commerce/agreements/{agreement_id}/attachments"
     _model_class = AgreementAttachment
     _collection_key = "data"
+    _upload_file_key = "file"
+    _upload_data_key = "attachment"
 
 
 class AgreementsAttachmentService(
-    FilesOperationsMixin[AgreementAttachment],
+    CreateFileMixin[AgreementAttachment],
+    UpdateMixin[AgreementAttachment],
+    DownloadFileMixin[AgreementAttachment],
     DeleteMixin,
     GetMixin[AgreementAttachment],
     CollectionMixin[AgreementAttachment],
@@ -36,7 +44,9 @@ class AgreementsAttachmentService(
 
 
 class AsyncAgreementsAttachmentService(
-    AsyncFilesOperationsMixin[AgreementAttachment],
+    AsyncCreateFileMixin[AgreementAttachment],
+    AsyncUpdateMixin[AgreementAttachment],
+    AsyncDownloadFileMixin[AgreementAttachment],
     AsyncDeleteMixin,
     AsyncGetMixin[AgreementAttachment],
     AsyncCollectionMixin[AgreementAttachment],

tests/e2e/commerce/agreement/attachment/conftest.py

@@ -0,0 +1,28 @@
+import pytest
+
+
+@pytest.fixture
+def invalid_agreement_attachment_id():
+    return "ATT-0000-0000-0000-0000"
+
+
+@pytest.fixture
+def agreement_attachment_id(e2e_config):
+    return e2e_config["commerce.agreement.attachment.id"]
+
+
+@pytest.fixture
+def agreement_attachment_factory():
+    def factory(
+        name: str = "E2E Created Agreement Attachment",
+        attachment_type: str = "File",
+        license_key: str = "",
+    ):
+        return {
+            "name": name,
+            "description": name,
+            "type": attachment_type,
+            "licenseKey": license_key,
+        }
+
+    return factory

tests/e2e/commerce/agreement/attachment/test_async_agreement_attachment.py

@@ -0,0 +1,86 @@
+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_attachment(agreement_attachments, agreement_attachment_factory, pdf_fd):
+    new_agreement_attachment_request_data = agreement_attachment_factory(
+        name="E2E Created Agreement Attachment",
+    )
+    return await agreement_attachments.create(new_agreement_attachment_request_data, file=pdf_fd)
+
+
+@pytest.fixture
+def agreement_attachments(async_mpt_ops, agreement_id):
+    return async_mpt_ops.commerce.agreements.attachments(agreement_id)
+
+
+async def test_get_agreement_attachment_by_id(agreement_attachments, agreement_attachment_id):
+    result = await agreement_attachments.get(agreement_attachment_id)
+    assert result is not None
+
+
+async def test_get_agreement_attachment_by_id_not_found(
+    agreement_attachments, invalid_agreement_attachment_id
+):
+    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+        await agreement_attachments.get(invalid_agreement_attachment_id)
+
+
+async def test_list_agreement_attachments(agreement_attachments):
+    limit = 10
+
+    result = await agreement_attachments.fetch_page(limit=limit)
+
+    assert len(result) > 0
+
+
+async def test_filter_agreement_attachments(agreement_attachments, agreement_attachment_id):
+    select_fields = ["-description"]
+    filtered_attachments = (
+        agreement_attachments.filter(RQLQuery(id=agreement_attachment_id))
+        .filter(RQLQuery(name="E2E Seeded Agreement Attachment"))
+        .select(*select_fields)
+    )
+
+    result = [att async for att in filtered_attachments.iterate()]
+
+    assert len(result) == 1
+
+
+def test_create_agreement_attachment(created_agreement_attachment):
+    result = created_agreement_attachment
+
+    assert result is not None
+
+
+async def test_update_agreement_attachment(agreement_attachments, created_agreement_attachment):
+    updated_name = "E2E Updated Agreement Attachment Name"
+    updated_attachment_data = {
+        "name": updated_name,
+        "description": updated_name,
+    }
+    attachment = created_agreement_attachment
+
+    result = await agreement_attachments.update(attachment.id, updated_attachment_data)
+
+    assert result is not None
+
+
+async def test_delete_agreement_attachment(agreement_attachments, created_agreement_attachment):
+    result = created_agreement_attachment
+    await agreement_attachments.delete(result.id)
+
+
+async def test_download_agreement_attachment(agreement_attachments, created_agreement_attachment):
+    attachment = created_agreement_attachment
+
+    result = await agreement_attachments.download(attachment.id)
+
+    assert result.file_contents is not None
+    assert result.filename == "empty.pdf"
+    assert result.filename == "empty.pdf"

tests/e2e/commerce/agreement/attachment/test_sync_agreement_attachment.py

@@ -0,0 +1,85 @@
+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_attachment(mpt_ops, agreement_attachment_factory, agreement_id, pdf_fd):
+    new_agreement_attachment_request_data = agreement_attachment_factory(
+        name="E2E Created Agreement Attachment",
+    )
+    agreement_attachments = mpt_ops.commerce.agreements.attachments(agreement_id)
+    return agreement_attachments.create(new_agreement_attachment_request_data, file=pdf_fd)
+
+
+@pytest.fixture
+def agreement_attachments(mpt_ops, agreement_id):
+    return mpt_ops.commerce.agreements.attachments(agreement_id)
+
+
+def test_get_agreement_attachment_by_id(agreement_attachments, agreement_attachment_id):
+    result = agreement_attachments.get(agreement_attachment_id)
+
+    assert result is not None
+
+
+def test_get_agreement_attachment_by_id_not_found(
+    agreement_attachments, invalid_agreement_attachment_id
+):
+    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+        agreement_attachments.get(invalid_agreement_attachment_id)
+
+
+def test_list_agreement_attachments(agreement_attachments):
+    limit = 10
+
+    result = agreement_attachments.fetch_page(limit=limit)
+
+    assert len(result) > 0
+
+
+def test_filter_agreement_attachments(agreement_attachments, agreement_attachment_id):
+    select_fields = ["-description"]
+    filtered_attachments = (
+        agreement_attachments.filter(RQLQuery(id=agreement_attachment_id))
+        .filter(RQLQuery(name="E2E Seeded Agreement Attachment"))
+        .select(*select_fields)
+    )
+
+    result = list(filtered_attachments.iterate())
+
+    assert len(result) == 1
+
+
+def test_create_agreement_attachment(created_agreement_attachment):
+    result = created_agreement_attachment
+
+    assert result is not None
+
+
+def test_update_agreement_attachment(agreement_attachments, created_agreement_attachment):
+    updated_name = "E2E Updated Agreement Attachment Name"
+    updated_attachment_data = {
+        "name": updated_name,
+        "description": updated_name,
+    }
+
+    result = agreement_attachments.update(created_agreement_attachment.id, updated_attachment_data)
+
+    assert result is not None
+
+
+def test_delete_agreement_attachment(agreement_attachments, created_agreement_attachment):
+    result = created_agreement_attachment
+
+    agreement_attachments.delete(result.id)
+
+
+def test_download_agreement_attachment(agreement_attachments, created_agreement_attachment):
+    result = agreement_attachments.download(created_agreement_attachment.id)
+
+    assert result.file_contents is not None
+    assert result.filename == "empty.pdf"

tests/unit/resources/commerce/test_agreements_attachments.py

@@ -32,14 +32,14 @@ def test_async_endpoint(async_attachment_service) -> None:
     assert result is True
 
 
-@pytest.mark.parametrize("method", ["get", "create", "delete", "download"])
+@pytest.mark.parametrize("method", ["get", "create", "update", "delete", "download"])
 def test_methods_present(attachment_service, method: str) -> None:
     result = hasattr(attachment_service, method)
 
     assert result is True
 
 
-@pytest.mark.parametrize("method", ["get", "create", "delete", "download"])
+@pytest.mark.parametrize("method", ["get", "create", "update", "delete", "download"])
 def test_async_methods_present(async_attachment_service, method: str) -> None:
     result = hasattr(async_attachment_service, method)