MPT-19908: add /integration/installations service

e2e_config.test.json

@@ -69,6 +69,7 @@
   "notifications.message.id": "MSG-0000-6215-1019-0139",
   "notifications.subscriber.id": "NTS-0829-7123-7123",
   "integration.extension.id": "EXT-6587-4477",
+  "integration.installation.id": "EXI-0022-3978-5547",
   "integration.term.id": "ETC-6587-4477-0062",
   "program.certificate.id": "CER-9646-2171-8417",
   "program.document.file.id": "PDM-9643-3741-0001",

mpt_api_client/resources/integration/installations.py

@@ -0,0 +1,69 @@
+from mpt_api_client.http import AsyncService, Service
+from mpt_api_client.http.mixins import (
+    AsyncCollectionMixin,
+    AsyncManagedResourceMixin,
+    CollectionMixin,
+    ManagedResourceMixin,
+)
+from mpt_api_client.models import Model
+from mpt_api_client.models.model import BaseModel
+from mpt_api_client.resources.integration.mixins import (
+    AsyncInstallationMixin,
+    InstallationMixin,
+)
+
+
+class Installation(Model):
+    """Installation resource.
+
+    Attributes:
+        name: Installation name.
+        revision: Revision number.
+        account: Reference to the account.
+        extension: Reference to the extension.
+        status: Installation status (Invited, Installed, Uninstalled, Expired).
+        configuration: Installation configuration data.
+        invitation: Invitation details.
+        modules: Modules included in the installation.
+        terms: Accepted terms for this installation.
+        audit: Audit information (created, updated, invited, installed, expired, uninstalled).
+    """
+
+    name: str | None
+    revision: int | None
+    account: BaseModel | None
+    extension: BaseModel | None
+    status: str | None
+    configuration: BaseModel | None
+    invitation: BaseModel | None
+    modules: list[BaseModel] | None
+    terms: list[BaseModel] | None
+    audit: BaseModel | None
+
+
+class InstallationsServiceConfig:
+    """Installations service configuration."""
+
+    _endpoint = "/public/v1/integration/installations"
+    _model_class = Installation
+    _collection_key = "data"
+
+
+class InstallationsService(
+    InstallationMixin[Installation],
+    ManagedResourceMixin[Installation],
+    CollectionMixin[Installation],
+    Service[Installation],
+    InstallationsServiceConfig,
+):
+    """Sync service for the /public/v1/integration/installations endpoint."""
+
+
+class AsyncInstallationsService(
+    AsyncInstallationMixin[Installation],
+    AsyncManagedResourceMixin[Installation],
+    AsyncCollectionMixin[Installation],
+    AsyncService[Installation],
+    InstallationsServiceConfig,
+):
+    """Async service for the /public/v1/integration/installations endpoint."""

mpt_api_client/resources/integration/integration.py

@@ -7,6 +7,10 @@
     AsyncExtensionsService,
     ExtensionsService,
 )
+from mpt_api_client.resources.integration.installations import (
+    AsyncInstallationsService,
+    InstallationsService,
+)
 
 
 class Integration:
@@ -25,6 +29,11 @@ def categories(self) -> CategoriesService:
         """Categories service."""
         return CategoriesService(http_client=self.http_client)
 
+    @property
+    def installations(self) -> InstallationsService:
+        """Installations service."""
+        return InstallationsService(http_client=self.http_client)
+
 
 class AsyncIntegration:
     """Async Integration MPT API Module."""
@@ -41,3 +50,8 @@ def extensions(self) -> AsyncExtensionsService:
     def categories(self) -> AsyncCategoriesService:
         """Categories service."""
         return AsyncCategoriesService(http_client=self.http_client)
+
+    @property
+    def installations(self) -> AsyncInstallationsService:
+        """Installations service."""
+        return AsyncInstallationsService(http_client=self.http_client)

mpt_api_client/resources/integration/mixins/__init__.py

@@ -2,14 +2,20 @@
     AsyncExtensionMixin,
     ExtensionMixin,
 )
+from mpt_api_client.resources.integration.mixins.installation_mixin import (
+    AsyncInstallationMixin,
+    InstallationMixin,
+)
 from mpt_api_client.resources.integration.mixins.media_mixin import (
     AsyncMediaMixin,
     MediaMixin,
 )
 
 __all__ = [  # noqa: WPS410
     "AsyncExtensionMixin",
+    "AsyncInstallationMixin",
     "AsyncMediaMixin",
     "ExtensionMixin",
+    "InstallationMixin",
     "MediaMixin",
 ]

mpt_api_client/resources/integration/mixins/installation_mixin.py

@@ -0,0 +1,33 @@
+from mpt_api_client.models import ResourceData
+
+
+class InstallationMixin[Model]:
+    """Mixin that adds the installation redeem action."""
+
+    def redeem(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Redeem an installation invitation.
+
+        Args:
+            resource_id: Installation ID.
+            resource_data: Redeem payload, for example ``{"code": "...", "modules": [...]}``.
+
+        Returns:
+            Updated installation.
+        """
+        return self._resource(resource_id).post("redeem", json=resource_data)  # type: ignore[attr-defined, no-any-return]
+
+
+class AsyncInstallationMixin[Model]:
+    """Async mixin that adds the installation redeem action."""
+
+    async def redeem(self, resource_id: str, resource_data: ResourceData | None = None) -> Model:
+        """Redeem an installation invitation.
+
+        Args:
+            resource_id: Installation ID.
+            resource_data: Redeem payload, for example ``{"code": "...", "modules": [...]}``.
+
+        Returns:
+            Updated installation.
+        """
+        return await self._resource(resource_id).post("redeem", json=resource_data)  # type: ignore[attr-defined, no-any-return]

pyproject.toml

@@ -149,6 +149,7 @@ per-file-ignores = [
   "tests/unit/resources/catalog/test_products.py: WPS202 WPS210",
   "tests/e2e/integration/*.py: WPS453",
   "tests/e2e/integration/extensions/*.py: WPS453 WPS202",
+  "tests/e2e/integration/installations/*.py: WPS453 WPS202",
   "tests/unit/resources/integration/*.py: WPS202 WPS210 WPS218 WPS453",
   "tests/unit/resources/integration/mixins/*.py: WPS453 WPS202",
   "tests/unit/resources/commerce/*.py: WPS202 WPS204",

tests/e2e/integration/conftest.py

@@ -0,0 +1,6 @@
+import pytest
+
+
+@pytest.fixture
+def extension_id(e2e_config):
+    return e2e_config["integration.extension.id"]

tests/e2e/integration/extensions/conftest.py

@@ -4,18 +4,13 @@
 
 
 @pytest.fixture
-def extensions_service(mpt_ops):
-    return mpt_ops.integration.extensions
+def extensions_service(mpt_vendor):
+    return mpt_vendor.integration.extensions
 
 
 @pytest.fixture
-def async_extensions_service(async_mpt_ops):
-    return async_mpt_ops.integration.extensions
-
-
-@pytest.fixture(scope="session")
-def extension_id(e2e_config):
-    return e2e_config["integration.extension.id"]
+def async_extensions_service(async_mpt_vendor):
+    return async_mpt_vendor.integration.extensions
 
 
 @pytest.fixture

tests/e2e/integration/extensions/test_async_extensions.py

@@ -7,7 +7,6 @@
 pytestmark = [pytest.mark.flaky]
 
 
-@pytest.mark.skip(reason="unable to create extensions for testing")
 def test_create_extension(async_created_extension, extension_data):
     result = async_created_extension.name
 
@@ -27,7 +26,6 @@ async def test_get_extension_not_found(async_extensions_service):
         await async_extensions_service.get(bogus_id)
 
 
-@pytest.mark.skip(reason="unable to create extensions for testing")
 async def test_update_extension(
     async_extensions_service, async_created_extension, logo_fd, short_uuid
 ):
@@ -40,7 +38,6 @@ async def test_update_extension(
     assert result.name == update_data["name"]
 
 
-@pytest.mark.skip(reason="unable to create extensions for testing")
 async def test_delete_extension(async_extensions_service, async_created_extension):
     await async_extensions_service.delete(async_created_extension.id)  # act
 
@@ -51,7 +48,6 @@ async def test_filter_extensions(async_extensions_service, extension_id):
     )  # act
 
 
-@pytest.mark.skip(reason="unable to create extensions for testing")
 async def test_download_icon(async_extensions_service, async_created_extension):
     result = await async_extensions_service.download_icon(async_created_extension.id)
 

tests/e2e/integration/extensions/test_sync_extensions.py

@@ -9,7 +9,6 @@
 ]
 
 
-@pytest.mark.skip(reason="unable to create extensions for testing")
 def test_create_extension(created_extension, extension_data):
     result = created_extension.name
 
@@ -29,7 +28,6 @@ def test_get_extension_not_found(extensions_service):
         extensions_service.get(bogus_id)
 
 
-@pytest.mark.skip(reason="unable to create extensions for testing")
 def test_update_extension(extensions_service, created_extension, logo_fd, short_uuid):
     update_data = {"name": f"e2e - please delete {short_uuid}"}
 
@@ -38,7 +36,6 @@ def test_update_extension(extensions_service, created_extension, logo_fd, short_
     assert result.name == update_data["name"]
 
 
-@pytest.mark.skip(reason="unable to create extensions for testing")
 def test_delete_extension(extensions_service, created_extension):
     extensions_service.delete(created_extension.id)  # act
 

tests/e2e/integration/installations/conftest.py

@@ -0,0 +1,93 @@
+import pytest
+
+from mpt_api_client.exceptions import MPTAPIError
+
+
+@pytest.fixture
+def installations_service(mpt_vendor):
+    return mpt_vendor.integration.installations
+
+
+@pytest.fixture
+def async_installations_service(async_mpt_vendor):
+    return async_mpt_vendor.integration.installations
+
+
+@pytest.fixture
+def installation_modules():
+    return [
+        {"id": "MOD-0478"},
+        {"id": "MOD-1239"},
+        {"id": "MOD-1756"},
+        {"id": "MOD-4525"},
+        {"id": "MOD-8352"},
+        {"id": "MOD-8743"},
+        {"id": "MOD-9042"},
+    ]
+
+
+@pytest.fixture
+def installation_data(extension_id, installation_modules):
+    return {
+        "extension": {"id": extension_id},
+        "modules": installation_modules,
+    }
+
+
+@pytest.fixture
+def invite_data(extension_id):
+    return {
+        "extension": {"id": extension_id},
+        "invitation": {
+            "message": "E2E testing - Delete",
+            "validity": "7d",
+        },
+    }
+
+
+@pytest.fixture
+def created_installation(installations_service, installation_data):
+    installation = installations_service.create(installation_data)
+
+    yield installation
+
+    try:
+        installations_service.delete(installation.id)
+    except MPTAPIError as error:
+        print(f"TEARDOWN - Unable to delete installation {installation.id}: {error.title}")  # noqa: WPS421
+
+
+@pytest.fixture
+def created_installation_invite(installations_service, invite_data):
+    invite = installations_service.create(invite_data)
+
+    yield invite
+
+    try:
+        installations_service.delete(invite.id)
+    except MPTAPIError as error:
+        print(f"TEARDOWN - Unable to delete installation {invite.id}: {error.title}")  # noqa: WPS421
+
+
+@pytest.fixture
+async def async_created_installation(async_installations_service, installation_data):
+    installation = await async_installations_service.create(installation_data)
+
+    yield installation
+
+    try:
+        await async_installations_service.delete(installation.id)
+    except MPTAPIError as error:
+        print(f"TEARDOWN - Unable to delete installation {installation.id}: {error.title}")  # noqa: WPS421
+
+
+@pytest.fixture
+async def async_created_installation_invite(async_installations_service, invite_data):
+    invite = await async_installations_service.create(invite_data)
+
+    yield invite
+
+    try:
+        await async_installations_service.delete(invite.id)
+    except MPTAPIError as error:
+        print(f"TEARDOWN - Unable to delete installation {invite.id}: {error.title}")  # noqa: WPS421

tests/e2e/integration/installations/helper.py

@@ -0,0 +1,30 @@
+import base64
+import json
+
+
+def _decode_base64_json(candidate: str) -> dict[str, str] | None:
+    normalized_candidate = candidate.strip()
+    if not normalized_candidate:
+        return None
+
+    padding = "=" * (-len(normalized_candidate) % 4)
+
+    try:  # noqa: WPS229
+        decoded_bytes = base64.urlsafe_b64decode(normalized_candidate + padding)
+        decoded_payload = json.loads(decoded_bytes.decode("utf-8"))
+    except (ValueError, json.JSONDecodeError):
+        return None
+
+    if isinstance(decoded_payload, dict) and decoded_payload.get("code"):
+        return decoded_payload
+
+    return None
+
+
+def decode_invitation_payload(invitation_url: str) -> dict[str, str]:
+    """Decode an invitation payload from the API invitation URL field."""
+    decoded_payload = _decode_base64_json(invitation_url)
+    if decoded_payload:
+        return decoded_payload
+
+    raise AssertionError(f"Unable to decode invitation payload from URL: {invitation_url}")