mrok 0.2.2__tar.gz → 0.2.3__tar.gz

{mrok-0.2.2 → mrok-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mrok
-Version: 0.2.2
+Version: 0.2.3
 Summary: MPT Extensions OpenZiti Orchestrator
 Author: SoftwareOne AG
 License:                                  Apache License

{mrok-0.2.2 → mrok-0.2.3}/mrok/controller/app.py

@@ -51,9 +51,15 @@ def setup_app():
 
     # TODO: Add healthcheck
     app.include_router(
-        extensions_router, prefix="/extensions", dependencies=[Depends(authenticate)]
+        extensions_router,
+        prefix="/extensions",
+        dependencies=[Depends(authenticate)],
+    )
+    app.include_router(
+        instances_router,
+        prefix="/instances",
+        dependencies=[Depends(authenticate)],
     )
-    app.include_router(instances_router, prefix="/instances", dependencies=[Depends(authenticate)])
 
     settings = get_settings()
 

{mrok-0.2.2 → mrok-0.2.3}/mrok/controller/routes/extensions.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Annotated
+from typing import Annotated, Literal
 
 from fastapi import APIRouter, Body, HTTPException, status
 
@@ -116,8 +116,26 @@ async def create_extension(
 async def get_extension_by_id_or_extension_id(
     mgmt_api: ZitiManagementAPI,
     id_or_extension_id: str,
+    with_instances: Literal["none", "online", "offline"] = "none",
 ):
-    return ExtensionRead(**(await fetch_extension_or_404(mgmt_api, id_or_extension_id)))
+    extension = await fetch_extension_or_404(mgmt_api, id_or_extension_id)
+
+    if with_instances == "none":
+        return ExtensionRead(**extension)
+
+    instances = list(
+        filter(
+            lambda ir: ir.status == with_instances,
+            [
+                InstanceRead(**identity)
+                async for identity in mgmt_api.identities(
+                    {"filter": f'tags.{MROK_SERVICE_TAG_NAME} = "{extension["name"]}"'}
+                )
+            ],
+        )
+    )
+
+    return ExtensionRead(**extension, instances=instances)
 
 
 @router.delete(
@@ -272,11 +290,7 @@ async def get_instance_by_id_or_instance_id(
     id_or_instance_id: str,
 ):
     identity = await fetch_instance_or_404(mgmt_api, id_or_extension_id, id_or_instance_id)
-    return InstanceRead(
-        id=identity["id"],
-        name=identity["name"],
-        tags=identity["tags"],
-    )
+    return InstanceRead(**identity)
 
 
 @router.delete(

{mrok-0.2.2 → mrok-0.2.3}/mrok/controller/routes/instances.py

@@ -6,6 +6,7 @@ from mrok.controller.dependencies import ZitiManagementAPI
 from mrok.controller.openapi import examples
 from mrok.controller.pagination import LimitOffsetPage, paginate
 from mrok.controller.schemas import InstanceRead
+from mrok.ziti.constants import MROK_IDENTITY_TYPE_TAG_NAME, MROK_IDENTITY_TYPE_TAG_VALUE_INSTANCE
 
 logger = logging.getLogger("mrok.controller")
 
@@ -68,4 +69,7 @@ async def get_instance_by_id_or_instance_id(
 async def get_instances(
     mgmt_api: ZitiManagementAPI,
 ):
-    return await paginate(mgmt_api, "/identities", InstanceRead)
+    params = {
+        "filter": f'tags.{MROK_IDENTITY_TYPE_TAG_NAME}="{MROK_IDENTITY_TYPE_TAG_VALUE_INSTANCE}"'
+    }
+    return await paginate(mgmt_api, "/identities", InstanceRead, extra_params=params)

{mrok-0.2.2 → mrok-0.2.3}/mrok/controller/schemas.py

@@ -1,4 +1,6 @@
-from typing import Annotated, Any
+from __future__ import annotations
+
+from typing import Annotated, Any, Literal
 
 from pydantic import (
     BaseModel,
@@ -34,6 +36,7 @@ class ExtensionBase(BaseSchema):
 
 class ExtensionRead(BaseSchema, IdSchema):
     name: str
+    instances: list[InstanceRead] | None = None
 
     @computed_field
     def extension(self) -> dict:
@@ -51,6 +54,11 @@ class InstanceBase(BaseSchema):
 class InstanceRead(BaseSchema, IdSchema):
     name: str
     identity: dict[str, Any] | None = None
+    has_edge_router_connection: bool | None = Field(
+        False,
+        alias="hasEdgeRouterConnection",
+        exclude=True,
+    )
 
     @computed_field
     def instance(self) -> dict:
@@ -62,6 +70,10 @@ class InstanceRead(BaseSchema, IdSchema):
         _, extension_id = self.name.split(".", 1)
         return {"id": extension_id.upper()}
 
+    @computed_field
+    def status(self) -> Literal["online", "offline"]:
+        return "online" if bool(self.has_edge_router_connection) else "offline"
+
 
 class InstanceCreate(InstanceBase):
     pass

{mrok-0.2.2 → mrok-0.2.3}/mrok/ziti/api.py

@@ -397,7 +397,7 @@ class ZitiManagementAPI(BaseZitiAPI):
     async def search_config_type(self, id_or_name: str) -> dict[str, Any] | None:
         return await self.search_by_id_or_name("/config-types", id_or_name)
 
-    async def delete_config_type(self, config_type_id: str) -> dict[str, Any] | None:
+    async def delete_config_type(self, config_type_id: str) -> None:
         return await self.delete("/config-types", config_type_id)
 
     async def get_identity(self, identity_id: str) -> dict[str, Any]:

{mrok-0.2.2 → mrok-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mrok"
-version = "0.2.2"
+version = "0.2.3"
 description = "MPT Extensions OpenZiti Orchestrator"
 readme = { file = "README.md", content-type = "text/markdown" }
 authors = [

{mrok-0.2.2 → mrok-0.2.3}/tests/controller/test_extensions.py

@@ -305,6 +305,7 @@ async def test_register_instance(mocker: MockerFixture, api_client: AsyncClient)
         "extension": {"id": "EXT-1234-5678"},
         "instance": {"id": "INS-1234-5678-0001"},
         "name": "ins-1234-5678-0001.ext-1234-5678",
+        "status": "offline",
         "tags": {
             MROK_VERSION_TAG_NAME: "0.0.0.dev0",
             MROK_SERVICE_TAG_NAME: "ext-1234-5678",
@@ -321,11 +322,13 @@ async def test_register_instance(mocker: MockerFixture, api_client: AsyncClient)
 
 
 @pytest.mark.asyncio
+@pytest.mark.parametrize("status", ["online", "offline"])
 async def test_get_instance(
     mocker: MockerFixture,
     settings_factory: SettingsFactory,
     api_client: AsyncClient,
     httpx_mock: HTTPXMock,
+    status: str,
 ):
     mocker.patch(
         "mrok.controller.routes.extensions.fetch_extension_or_404",
@@ -349,6 +352,7 @@ async def test_get_instance(
                         MROK_VERSION_TAG_NAME: "0.0.0.dev0",
                         MROK_SERVICE_TAG_NAME: "ext-1234-5678",
                     },
+                    "hasEdgeRouterConnection": status == "online",
                 }
             ],
         },
@@ -361,6 +365,7 @@ async def test_get_instance(
         "extension": {"id": "EXT-1234-5678"},
         "instance": {"id": "INS-1234-5678-0001"},
         "name": "ins-1234-5678-0001.ext-1234-5678",
+        "status": status,
         "tags": {
             MROK_VERSION_TAG_NAME: "0.0.0.dev0",
             MROK_SERVICE_TAG_NAME: "ext-1234-5678",
@@ -369,11 +374,13 @@ async def test_get_instance(
 
 
 @pytest.mark.asyncio
+@pytest.mark.parametrize("status", ["online", "offline"])
 async def test_get_instance_by_instance_id(
     mocker: MockerFixture,
     settings_factory: SettingsFactory,
     api_client: AsyncClient,
     httpx_mock: HTTPXMock,
+    status: str,
 ):
     mocker.patch(
         "mrok.controller.routes.extensions.fetch_extension_or_404",
@@ -390,6 +397,7 @@ async def test_get_instance_by_instance_id(
                 {
                     "id": "ins1",
                     "name": "ins-1234-5678-0001.ext-1234-5678",
+                    "hasEdgeRouterConnection": status == "online",
                     "tags": {
                         MROK_VERSION_TAG_NAME: "0.0.0.dev0",
                         MROK_SERVICE_TAG_NAME: "ext-1234-5678",
@@ -406,6 +414,7 @@ async def test_get_instance_by_instance_id(
         "extension": {"id": "EXT-1234-5678"},
         "instance": {"id": "INS-1234-5678-0001"},
         "name": "ins-1234-5678-0001.ext-1234-5678",
+        "status": status,
         "tags": {
             MROK_VERSION_TAG_NAME: "0.0.0.dev0",
             MROK_SERVICE_TAG_NAME: "ext-1234-5678",
@@ -487,3 +496,54 @@ async def test_delete_instance_extension_not_found(
 
     response = await api_client.delete("/extensions/EXT-1234-5678/instances/INS-1234-5678-0001")
     assert response.status_code == 404
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    ("status", "expected_instance"),
+    [("online", "ins1.svc"), ("offline", "ins2.svc")],
+)
+async def test_get_extension_with_instances(
+    settings_factory: SettingsFactory,
+    api_client: AsyncClient,
+    httpx_mock: HTTPXMock,
+    status: str,
+    expected_instance: str,
+):
+    settings = settings_factory()
+    query = quote(
+        f'(id="EXT-1234-5678" or name="ext-1234-5678") and tags.{MROK_VERSION_TAG_NAME} != null'
+    )
+    httpx_mock.add_response(
+        method="GET",
+        url=f"{settings.ziti.api.management}/edge/management/v1/services?filter={query}",
+        json={
+            "meta": {"pagination": {"totalCount": 1}},
+            "data": [
+                {
+                    "id": "svc1",
+                    "name": "ext-1234-5678",
+                    "tags": {MROK_VERSION_TAG_NAME: "0.0.0.dev0"},
+                }
+            ],
+        },
+    )
+
+    query = quote(f'tags.{MROK_SERVICE_TAG_NAME} = "ext-1234-5678"')
+    httpx_mock.add_response(
+        method="GET",
+        url=f"{settings.ziti.api.management}/edge/management/v1/identities?filter={query}&limit=5&offset=0",
+        json={
+            "meta": {"pagination": {"totalCount": 2, "limit": 5, "offset": 0}},
+            "data": [
+                {"id": "ins1", "name": "ins1.svc", "hasEdgeRouterConnection": True},
+                {"id": "ins2", "name": "ins2.svc", "hasEdgeRouterConnection": False},
+            ],
+        },
+    )
+
+    response = await api_client.get(f"/extensions/EXT-1234-5678?with_instances={status}")
+    assert response.status_code == 200
+    ext = response.json()
+    assert len(ext["instances"]) == 1
+    assert ext["instances"][0]["name"] == expected_instance

{mrok-0.2.2 → mrok-0.2.3}/tests/controller/test_instances.py

@@ -17,7 +17,7 @@ async def test_list_instances(
     settings = settings_factory()
     httpx_mock.add_response(
         method="GET",
-        url=f"{settings.ziti.api.management}/edge/management/v1/identities?&limit=10&offset=0",
+        url=f"{settings.ziti.api.management}/edge/management/v1/identities?filter=tags.mrok-identity-type%3D%22instance%22&limit=10&offset=0",
         json={
             "meta": {"pagination": {"totalCount": 15, "limit": 10, "offset": 0}},
             "data": [{"id": f"ins{i}", "name": "ins.svc"} for i in range(10)],
@@ -25,7 +25,7 @@ async def test_list_instances(
     )
     httpx_mock.add_response(
         method="GET",
-        url=f"{settings.ziti.api.management}/edge/management/v1/identities?&limit=10&offset=10",
+        url=f"{settings.ziti.api.management}/edge/management/v1/identities?filter=tags.mrok-identity-type%3D%22instance%22&limit=10&offset=10",
         json={
             "meta": {"pagination": {"totalCount": 15, "limit": 10, "offset": 10}},
             "data": [{"id": f"ins{i}", "name": "ins.svc"} for i in range(11, 16)],
@@ -49,10 +49,12 @@ async def test_list_instances(
 
 
 @pytest.mark.asyncio
+@pytest.mark.parametrize("status", ["online", "offline"])
 async def test_get_instance(
     settings_factory: SettingsFactory,
     api_client: AsyncClient,
     httpx_mock: HTTPXMock,
+    status: str,
 ):
     settings = settings_factory()
     query = quote(
@@ -68,6 +70,7 @@ async def test_get_instance(
                 {
                     "id": "ins1",
                     "name": "ins-1234-1234-0001.ext-1234-1234",
+                    "hasEdgeRouterConnection": status == "online",
                     "tags": {
                         MROK_VERSION_TAG_NAME: "0.0.0.dev0",
                         MROK_SERVICE_TAG_NAME: "ext-1234-1234",
@@ -85,6 +88,7 @@ async def test_get_instance(
         "extension": {"id": "EXT-1234-1234"},
         "instance": {"id": "INS-1234-1234-0001"},
         "name": "ins-1234-1234-0001.ext-1234-1234",
+        "status": status,
         "tags": {
             MROK_VERSION_TAG_NAME: "0.0.0.dev0",
             MROK_SERVICE_TAG_NAME: "ext-1234-1234",
@@ -93,10 +97,12 @@ async def test_get_instance(
 
 
 @pytest.mark.asyncio
+@pytest.mark.parametrize("status", ["online", "offline"])
 async def test_get_instance_by_instance_id(
     settings_factory: SettingsFactory,
     api_client: AsyncClient,
     httpx_mock: HTTPXMock,
+    status: str,
 ):
     settings = settings_factory()
     query = quote(f'(id="ins1" or name="ins1") and tags.{MROK_VERSION_TAG_NAME} != null')
@@ -109,6 +115,7 @@ async def test_get_instance_by_instance_id(
                 {
                     "id": "ins1",
                     "name": "ins-1234-1234-0001.ext-1234-1234",
+                    "hasEdgeRouterConnection": status == "online",
                     "tags": {
                         MROK_VERSION_TAG_NAME: "0.0.0.dev0",
                         MROK_SERVICE_TAG_NAME: "ext-1234-1234",
@@ -125,6 +132,7 @@ async def test_get_instance_by_instance_id(
         "extension": {"id": "EXT-1234-1234"},
         "instance": {"id": "INS-1234-1234-0001"},
         "name": "ins-1234-1234-0001.ext-1234-1234",
+        "status": status,
         "tags": {
             MROK_VERSION_TAG_NAME: "0.0.0.dev0",
             MROK_SERVICE_TAG_NAME: "ext-1234-1234",