E2E Notification subscriber

 - Add enable/disable actions for notifications subscriber
 - Add e2e test suite for notification subscribers

Author: jentyk

e2e_config.test.json

@@ -42,5 +42,6 @@
   "commerce.subscription.agreement.id": "AGR-2473-3299-1721",
   "commerce.subscription.id": "SUB-3678-1831-2188",
   "commerce.subscription.product.item.id": "ITM-1767-7355-0001",
+  "notifications.subscriber.id": "NTS-0829-7123-7123",
   "notifications.message.id": "MSG-0000-6215-1019-0139"
 }

mpt_api_client/http/mixins.py

@@ -395,6 +395,46 @@ async def get(self, resource_id: str, select: list[str] | str | None = None) ->
         return await self._resource_action(resource_id=resource_id, query_params={"select": select})  # type: ignore[attr-defined, no-any-return]
 
 
+class AsyncEnableMixin[Model: BaseModel]:
+    """Enable resource mixin."""
+
+    async def enable(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Disable a specific resource using."""
+        return await self._resource_action(  # type: ignore[attr-defined, no-any-return]
+            resource_id=resource_id, method="POST", action="enable", json=resource_data
+        )
+
+
+class EnableMixin[Model: BaseModel]:
+    """Disable resource mixin."""
+
+    def enable(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Disable a specific resource using."""
+        return self._resource_action(  # type: ignore[attr-defined, no-any-return]
+            resource_id=resource_id, method="POST", action="enable", json=resource_data
+        )
+
+
+class AsyncDisableMixin[Model: BaseModel]:
+    """Disable resource mixin."""
+
+    async def disable(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Disable a specific resource using."""
+        return await self._resource_action(  # type: ignore[attr-defined, no-any-return]
+            resource_id=resource_id, method="POST", action="disable", json=resource_data
+        )
+
+
+class DisableMixin[Model: BaseModel]:
+    """Disable resource mixin."""
+
+    def disable(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Disable a specific resource using."""
+        return self._resource_action(  # type: ignore[attr-defined, no-any-return]
+            resource_id=resource_id, method="POST", action="disable", json=resource_data
+        )
+
+
 class QueryableMixin:
     """Mixin providing query functionality for filtering, ordering, and selecting fields."""
 

mpt_api_client/resources/notifications/subscribers.py

@@ -1,8 +1,12 @@
 from mpt_api_client.http import AsyncService, Service
 from mpt_api_client.http.mixins import (
     AsyncCollectionMixin,
+    AsyncDisableMixin,
+    AsyncEnableMixin,
     AsyncManagedResourceMixin,
     CollectionMixin,
+    DisableMixin,
+    EnableMixin,
     ManagedResourceMixin,
 )
 from mpt_api_client.models import Model
@@ -21,6 +25,8 @@ class SubscribersServiceConfig:
 
 
 class SubscribersService(
+    EnableMixin[Subscriber],
+    DisableMixin[Subscriber],
     ManagedResourceMixin[Subscriber],
     CollectionMixin[Subscriber],
     Service[Subscriber],
@@ -30,6 +36,8 @@ class SubscribersService(
 
 
 class AsyncSubscribersService(
+    AsyncEnableMixin[Subscriber],
+    AsyncDisableMixin[Subscriber],
     AsyncManagedResourceMixin[Subscriber],
     AsyncCollectionMixin[Subscriber],
     AsyncService[Subscriber],

tests/e2e/conftest.py

@@ -151,3 +151,8 @@ def authorization_id(e2e_config):
 @pytest.fixture
 def price_list_id(e2e_config):
     return e2e_config["catalog.price_list.id"]
+
+
+@pytest.fixture
+def user_group_id(e2e_config):
+    return e2e_config["accounts.user_group.id"]

tests/e2e/notifications/subscribers/__init__.py

@@ -0,0 +1,64 @@
+import pytest
+
+from mpt_api_client.exceptions import MPTAPIError
+
+
+@pytest.fixture
+def subscriber_id(e2e_config):
+    return e2e_config.get("notifications.subscriber.id")
+
+
+@pytest.fixture
+def invalid_subscriber_id():
+    return "NTS-0000-0000-0000"
+
+
+@pytest.fixture
+def recipients_factory(user_id, user_group_id):
+    def _recipients(  # noqa: WPS430
+        users: list | None = None,
+        user_groups: list | None = None,
+    ) -> dict:
+        return {
+            "users": users or [{"id": user_id}],
+            "userGroups": user_groups or [{"id": user_group_id}],
+        }
+
+    return _recipients
+
+
+@pytest.fixture
+def subscriber_factory(recipients_factory):
+    def _subscriber(  # noqa: WPS430
+        recipients: dict | None = None,
+        note: str = "Test note",
+    ) -> dict:
+        return {
+            "recipients": recipients or recipients_factory(),
+            "note": note,
+        }
+
+    return _subscriber
+
+
+@pytest.fixture
+def disabled_subscriber_id(mpt_client, subscriber_id):
+    subscriber = mpt_client.notifications.subscribers.get(subscriber_id)
+    if subscriber.status != "Disabled":
+        subscriber = mpt_client.notifications.subscribers.disable(subscriber_id)
+
+    yield subscriber.id
+
+    try:
+        mpt_client.notifications.subscribers.enable(subscriber_id)
+    except MPTAPIError:
+        print(f"TEARDOWN - Unable to re-enable subscriber {subscriber_id=}")  # noqa: WPS421
+
+
+@pytest.fixture
+def active_subscriber_id(mpt_client, subscriber_id):
+    subscriber = mpt_client.notifications.subscribers.get(subscriber_id)
+    if subscriber.status != "Active":
+        subscriber = mpt_client.notifications.subscribers.enable(subscriber_id)
+
+    return subscriber.id

tests/e2e/notifications/subscribers/conftest.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]
+
+
+async def test_get_subscriber_by_id(async_mpt_client, subscriber_id):
+    result = await async_mpt_client.notifications.subscribers.get(subscriber_id)
+
+    assert result is not None
+
+
+async def test_list_subscribers(async_mpt_client):
+    limit = 10
+
+    result = await async_mpt_client.notifications.subscribers.fetch_page(limit=limit)
+
+    assert len(result) > 0
+
+
+async def test_get_subscriber_by_id_not_found(async_mpt_client, invalid_subscriber_id):
+    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+        await async_mpt_client.notifications.subscribers.get(invalid_subscriber_id)
+
+
+async def test_filter_subscribers(async_mpt_client, subscriber_id):
+    select_fields = ["-config"]
+    async_filtered_subscribers = async_mpt_client.notifications.subscribers.filter(
+        RQLQuery(id=subscriber_id)
+    ).select(*select_fields)
+
+    result = [
+        filtered_subscriber async for filtered_subscriber in async_filtered_subscribers.iterate()
+    ]
+
+    assert len(result) > 0
+
+
+async def test_update_subscriber_not_found(
+    async_mpt_client, subscriber_factory, invalid_subscriber_id, recipients_factory
+):
+    updated_subscriber_data = subscriber_factory(recipients=recipients_factory())
+
+    with pytest.raises(MPTAPIError):
+        await async_mpt_client.notifications.subscribers.update(
+            invalid_subscriber_id, updated_subscriber_data
+        )
+
+
+async def test_disable_subscriber(async_mpt_client, active_subscriber_id):
+    result = await async_mpt_client.notifications.subscribers.disable(active_subscriber_id)
+
+    assert result is not None
+    assert result.status == "Disabled"
+
+
+async def test_disable_subscriber_not_found(async_mpt_client, invalid_subscriber_id):
+    with pytest.raises(
+        MPTAPIError, match=r"400 Bad Request - Subscriber with id 'NTS-0000-0000-0000' not found"
+    ):
+        await async_mpt_client.notifications.subscribers.disable(invalid_subscriber_id)
+
+
+async def test_enable_subscriber(async_mpt_client, disabled_subscriber_id):
+    result = await async_mpt_client.notifications.subscribers.enable(disabled_subscriber_id)
+
+    assert result is not None
+    assert result.status == "Active"
+
+
+async def test_enable_subscriber_not_found(async_mpt_client, invalid_subscriber_id):
+    with pytest.raises(
+        MPTAPIError, match=r"400 Bad Request - Subscriber with id 'NTS-0000-0000-0000' not found"
+    ):
+        await async_mpt_client.notifications.subscribers.enable(invalid_subscriber_id)

tests/e2e/notifications/subscribers/test_async_subscribers.py

@@ -0,0 +1,73 @@
+import pytest
+
+from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.rql.query_builder import RQLQuery
+
+pytestmark = [pytest.mark.flaky]
+
+
+def test_get_subscriber_by_id(mpt_client, subscriber_id):
+    result = mpt_client.notifications.subscribers.get(subscriber_id)
+
+    assert result is not None
+
+
+def test_list_subscribers(mpt_client):
+    limit = 10
+
+    result = mpt_client.notifications.subscribers.fetch_page(limit=limit)
+
+    assert len(result) > 0
+
+
+def test_get_subscriber_by_id_not_found(mpt_client, invalid_subscriber_id):
+    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+        mpt_client.notifications.subscribers.get(invalid_subscriber_id)
+
+
+def test_filter_subscribers(mpt_ops, subscriber_id):
+    select_fields = ["-config"]
+    filtered_subscribers = mpt_ops.notifications.subscribers.filter(
+        RQLQuery(id=subscriber_id)
+    ).select(*select_fields)
+
+    result = list(filtered_subscribers.iterate())
+
+    assert len(result) > 0
+
+
+def test_update_subscriber_not_found(
+    mpt_ops, subscriber_factory, invalid_subscriber_id, recipients_factory
+):
+    updated_subscriber_data = subscriber_factory(recipients=recipients_factory())
+
+    with pytest.raises(MPTAPIError):
+        mpt_ops.notifications.subscribers.update(invalid_subscriber_id, updated_subscriber_data)
+
+
+def test_disable_subscriber(mpt_client, active_subscriber_id):
+    result = mpt_client.notifications.subscribers.disable(active_subscriber_id)
+
+    assert result is not None
+    assert result.status == "Disabled"
+
+
+def test_disable_subscriber_not_found(mpt_client, invalid_subscriber_id):
+    with pytest.raises(
+        MPTAPIError, match=r"400 Bad Request - Subscriber with id 'NTS-0000-0000-0000' not found"
+    ):
+        mpt_client.notifications.subscribers.disable(invalid_subscriber_id)
+
+
+def test_enable_subscriber(mpt_client, disabled_subscriber_id):
+    result = mpt_client.notifications.subscribers.enable(disabled_subscriber_id)
+
+    assert result is not None
+    assert result.status == "Active"
+
+
+def test_enable_subscriber_not_found(mpt_client, invalid_subscriber_id):
+    with pytest.raises(
+        MPTAPIError, match=r"400 Bad Request - Subscriber with id 'NTS-0000-0000-0000' not found"
+    ):
+        mpt_client.notifications.subscribers.enable(invalid_subscriber_id)