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/accounts_users/conftest.py

@@ -4,33 +4,3 @@
 @pytest.fixture
 def invalid_user_id():
     return "USR-0000-0000"
-
-
-@pytest.fixture
-def account_user_factory(account_id, user_group_id, uuid_str):
-    def _account_user(  # noqa: WPS430
-        email: str | None = None,  # Must be unique in Marketplace
-        first_name: str = "E2E Created",
-        last_name: str = "Account User",
-    ):
-        if not email:
-            email = f"e2e_{uuid_str}@dummy.com"
-
-        return {
-            "user": {
-                "firstName": first_name,
-                "lastName": last_name,
-                "email": email,
-            },
-            "account": {
-                "id": account_id,
-            },
-            "groups": [
-                {"id": user_group_id},
-            ],
-            "invitation": {
-                "status": "Invited",
-            },
-        }
-
-    return _account_user

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"]
@@ -31,32 +26,3 @@ def seller_id(e2e_config):
 @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"]
-
-
-@pytest.fixture
-def module_id(e2e_config):
-    return e2e_config["accounts.module.id"]
-
-
-@pytest.fixture
-def user_group_factory(account_id, module_id):
-    # Used in user group and licensee fixtures
-    def _user_group(
-        name: str = "E2E Test Api Client User Group",
-        user_group_account_id: str = account_id,
-    ):
-        return {
-            "name": name,
-            "account": {"id": user_group_account_id},
-            "buyers": None,
-            "logo": "",
-            "description": "User group for E2E tests",
-            "modules": [{"id": module_id}],
-        }
-
-    return _user_group

tests/e2e/conftest.py

@@ -116,3 +116,67 @@ 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"]
+
+
+@pytest.fixture
+def user_group_factory(account_id, module_id):
+    # Used in user group and licensee fixtures
+    def _user_group(
+        name: str = "E2E Test Api Client User Group",
+        user_group_account_id: str = account_id,
+    ):
+        return {
+            "name": name,
+            "account": {"id": user_group_account_id},
+            "buyers": None,
+            "logo": "",
+            "description": "User group for E2E tests",
+            "modules": [{"id": module_id}],
+        }
+
+    return _user_group
+
+
+@pytest.fixture
+def module_id(e2e_config):
+    return e2e_config["accounts.module.id"]
+
+
+@pytest.fixture
+def account_user_factory(account_id, user_group_id, uuid_str):
+    def _account_user(  # noqa: WPS430
+        email: str | None = None,  # Must be unique in Marketplace
+        first_name: str = "E2E Created",
+        last_name: str = "Account User",
+    ):
+        if not email:
+            email = f"e2e_{uuid_str}@dummy.com"
+
+        return {
+            "user": {
+                "firstName": first_name,
+                "lastName": last_name,
+                "email": email,
+            },
+            "account": {
+                "id": account_id,
+            },
+            "groups": [
+                {"id": user_group_id},
+            ],
+            "invitation": {
+                "status": "Invited",
+            },
+        }
+
+    return _account_user

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", "SUB-0000-0000-0001")
+
+
+@pytest.fixture
+def invalid_subscriber_id():
+    return "SUB-0000-0000-0000"
+
+
+@pytest.fixture
+def recipients_factory(account_user_factory, user_group_factory):
+    def _recipients(
+        users: list[str] | None = None,
+        user_groups: list[str] | None = None,
+    ) -> dict[str, list[str]]:
+        return {
+            "users": users or account_user_factory(),
+            "userGroups": user_groups or user_group_factory(),
+        }
+
+    return _recipients
+
+
+@pytest.fixture
+def subscriber_factory(recipients_factory):
+    def _subscriber(
+        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/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
+async def async_created_subscriber(async_mpt_client, subscriber_factory):
+    new_subscriber_request_data = subscriber_factory(name="E2E Created subscriber")
+
+    new_subscriber = await async_mpt_client.notifications.subscribers.create(
+        new_subscriber_request_data
+    )
+
+    yield new_subscriber
+
+    try:
+        await async_mpt_client.notifications.subscribers.delete(new_subscriber.id)
+    except MPTAPIError as error:
+        print(f"TEARDOWN - Unable to delete subscriber: {error.title}")  # noqa: WPS421
+
+
+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))
+        .filter(RQLQuery(status="enabled"))
+        .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
+):
+    updated_subscriber_data = subscriber_factory(name="Nonexistent Subscriber")
+
+    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+        await async_mpt_client.notifications.subscribers.update(
+            invalid_subscriber_id, updated_subscriber_data
+        )

tests/e2e/notifications/test_async_subscribers.py

@@ -0,0 +1,49 @@
+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_client, subscriber_id):
+    select_fields = ["-config"]
+    filtered_subscribers = (
+        mpt_client.notifications.subscribers.filter(RQLQuery(id=subscriber_id))
+        .filter(RQLQuery(status="enabled"))
+        .select(*select_fields)
+    )
+
+    result = list(filtered_subscribers.iterate())
+
+    assert len(result) >= 0
+
+
+def test_update_subscriber_not_found(
+    mpt_client, subscriber_factory, invalid_subscriber_id, user_group_id, recipients_factory
+):
+    updated_subscriber_data = subscriber_factory(
+        recipients=recipients_factory(user_groups=[{"id": user_group_id}])
+    )
+
+    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+        mpt_client.notifications.subscribers.update(invalid_subscriber_id, updated_subscriber_data)