feat(tests): add e2e test suite for notification subscribers handling

Author: jentyk

e2e_config.test.json

@@ -20,5 +20,6 @@
   "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",
+  "notifications.subscriber.id": "NTS-0829-7123-7123"
 }

tests/e2e/accounts/conftest.py

@@ -18,11 +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"]
@@ -33,11 +28,6 @@ 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"]
-
-
 @pytest.fixture
 def module_id(e2e_config):
     return e2e_config["accounts.module.id"]

tests/e2e/conftest.py

@@ -116,3 +116,13 @@ def logo_fd():
 @pytest.fixture
 def user_id(e2e_config):
     return e2e_config["accounts.user.id"]
+
+
+@pytest.fixture
+def user_group_id(e2e_config):
+    return e2e_config["accounts.user_group.id"]
+
+
+@pytest.fixture
+def account_id(e2e_config):
+    return e2e_config["accounts.account.id"]

tests/e2e/notifications/__init__.py

@@ -0,0 +1,39 @@
+import pytest
+
+
+@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[str, list[str]] | None = None,
+        note: str = "Test note",
+    ) -> dict:
+        return {
+            "recipients": recipients or recipients_factory(),
+            "note": note,
+        }
+
+    return _subscriber

tests/e2e/notifications/subscribers/__init__.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]
+
+
+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, user_group_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, subscriber_id):
+    result = await async_mpt_client.notifications.subscribers.disable(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"404 Not Found"):
+        await async_mpt_client.notifications.subscribers.disable(invalid_subscriber_id)
+
+
+async def test_enable_subscriber(async_mpt_client, subscriber_id):
+    result = await async_mpt_client.notifications.subscribers.enable(subscriber_id)
+
+    assert result is not None
+    assert result.status == "enabled"
+
+
+async def test_enable_subscriber_not_found(async_mpt_client, invalid_subscriber_id):
+    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+        await async_mpt_client.notifications.subscribers.enable(invalid_subscriber_id)

tests/e2e/notifications/subscribers/conftest.py

@@ -0,0 +1,69 @@
+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, user_group_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, subscriber_id):
+    result = mpt_client.notifications.subscribers.disable(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"404 Not Found"):
+        mpt_client.notifications.subscribers.disable(invalid_subscriber_id)
+
+
+def test_enable_subscriber(mpt_client, subscriber_id):
+    result = mpt_client.notifications.subscribers.enable(subscriber_id)
+
+    assert result is not None
+    assert result.status == "enabled"
+
+
+def test_enable_subscriber_not_found(mpt_client, invalid_subscriber_id):
+    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+        mpt_client.notifications.subscribers.enable(invalid_subscriber_id)