added volumes and refactored testing for rpc and rest

Author: Andrei Neagu

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/dynamic_sidecar/volumes.py

@@ -0,0 +1,31 @@
+import logging
+
+from models_library.projects_nodes_io import NodeID
+from models_library.rabbitmq_basic_types import RPCMethodName, RPCNamespace
+from models_library.sidecar_volumes import VolumeCategory, VolumeStatus
+from pydantic import TypeAdapter
+
+from ....logging_utils import log_decorator
+from ... import RabbitMQRPCClient
+
+_logger = logging.getLogger(__name__)
+
+
+@log_decorator(_logger, level=logging.DEBUG)
+async def save_volume_state(
+    rabbitmq_rpc_client: RabbitMQRPCClient,
+    *,
+    node_id: NodeID,
+    status: VolumeStatus,
+    category: VolumeCategory,
+) -> None:
+    rpc_namespace = RPCNamespace.from_entries(
+        {"service": "dy-sidecar", "node_id": f"{node_id}"}
+    )
+    result = await rabbitmq_rpc_client.request(
+        rpc_namespace,
+        TypeAdapter(RPCMethodName).validate_python("save_volume_state"),
+        status=status,
+        category=category,
+    )
+    assert result is None  # nosec

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/api/rest/volumes.py

@@ -1,11 +1,13 @@
-from fastapi import APIRouter, Depends
+from typing import Annotated
+
+from fastapi import APIRouter, Depends, FastAPI
 from fastapi import Path as PathParam
 from fastapi import status
-from models_library.sidecar_volumes import VolumeCategory, VolumeState, VolumeStatus
+from models_library.sidecar_volumes import VolumeCategory, VolumeStatus
 from pydantic import BaseModel
 
-from ...models.shared_store import SharedStore
-from ._dependencies import get_shared_store
+from ...services import volumes
+from ._dependencies import get_application
 
 router = APIRouter()
 
@@ -21,8 +23,7 @@ class PutVolumeItem(BaseModel):
 )
 async def put_volume_state(
     item: PutVolumeItem,
-    volume_category: VolumeCategory = PathParam(..., alias="id"),
-    shared_store: SharedStore = Depends(get_shared_store),
+    app: Annotated[FastAPI, Depends(get_application)],
+    volume_category: Annotated[VolumeCategory, PathParam(..., alias="id")],
 ) -> None:
-    async with shared_store:
-        shared_store.volume_states[volume_category] = VolumeState(status=item.status)
+    await volumes.save_volume_state(app, status=item.status, category=volume_category)

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/api/rpc/_volumes.py

@@ -0,0 +1,16 @@
+from fastapi import FastAPI
+from models_library.sidecar_volumes import VolumeCategory, VolumeStatus
+from pydantic import validate_call
+from servicelib.rabbitmq import RPCRouter
+
+from ...services import volumes
+
+router = RPCRouter()
+
+
+@router.expose()
+@validate_call(config={"arbitrary_types_allowed": True})
+async def save_volume_state(
+    app: FastAPI, *, status: VolumeStatus, category: VolumeCategory
+) -> None:
+    await volumes.save_volume_state(app, status=status, category=category)

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/api/rpc/routes.py

@@ -4,10 +4,11 @@
 
 from ...core.rabbitmq import get_rabbitmq_rpc_server
 from ...core.settings import ApplicationSettings
-from . import _disk_usage
+from . import _disk_usage, _volumes
 
 ROUTERS: list[RPCRouter] = [
     _disk_usage.router,
+    _volumes.router,
 ]
 
 

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/models/shared_store.py

@@ -4,6 +4,7 @@
 
 import aiofiles
 from fastapi import FastAPI
+from models_library.api_schemas_dynamic_sidecar.containers import DcokerComposeYamlStr
 from models_library.sidecar_volumes import VolumeCategory, VolumeState, VolumeStatus
 from pydantic import BaseModel, Field, PrivateAttr
 
@@ -50,7 +51,7 @@ class SharedStore(_StoreMixin):
             shared_store.container_names = copied_list
     """
 
-    compose_spec: str | None = Field(
+    compose_spec: DcokerComposeYamlStr | None = Field(
         default=None, description="stores the stringified compose spec"
     )
     container_names: list[ContainerNameStr] = Field(
@@ -119,3 +120,8 @@ async def on_startup() -> None:
         )
 
     app.add_event_handler("startup", on_startup)
+
+
+def get_shared_store(app: FastAPI) -> SharedStore:
+    shared_store: SharedStore = app.state.shared_store
+    return shared_store

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/services/__init__.py

@@ -0,0 +1,12 @@
+from fastapi import FastAPI
+from models_library.sidecar_volumes import VolumeCategory, VolumeState, VolumeStatus
+
+from ..models.shared_store import get_shared_store
+
+
+async def save_volume_state(
+    app: FastAPI, *, status: VolumeStatus, category: VolumeCategory
+) -> None:
+    shared_store = get_shared_store(app)
+    async with shared_store:
+        shared_store.volume_states[category] = VolumeState(status=status)

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/services/volumes.py

@@ -1,4 +1,3 @@
-# pylint:disable=protected-access
 # pylint:disable=redefined-outer-name
 # pylint:disable=unused-argument
 
@@ -8,30 +7,16 @@
 import pytest
 from asgi_lifespan import LifespanManager
 from fastapi import FastAPI
-from models_library.api_schemas_dynamic_sidecar.telemetry import DiskUsage
-from pydantic import ByteSize
 from pytest_simcore.helpers.monkeypatch_envs import EnvVarsDict, setenvs_from_dict
 from servicelib.rabbitmq import RabbitMQRPCClient
-from servicelib.rabbitmq.rpc_interfaces.dynamic_sidecar import disk_usage
 from settings_library.rabbit import RabbitSettings
-from settings_library.redis import RedisSettings
 from simcore_service_dynamic_sidecar.core.application import create_app
-from simcore_service_dynamic_sidecar.core.settings import ApplicationSettings
-from simcore_service_dynamic_sidecar.modules.system_monitor._disk_usage import (
-    get_disk_usage_monitor,
-)
-
-pytest_simcore_core_services_selection = [
-    "redis",
-    "rabbit",
-]
 
 
 @pytest.fixture
 def mock_environment(
     monkeypatch: pytest.MonkeyPatch,
     rabbit_service: RabbitSettings,
-    redis_service: RedisSettings,
     mock_environment: EnvVarsDict,
     mock_registry_service: AsyncMock,
 ) -> EnvVarsDict:
@@ -61,19 +46,3 @@ async def rpc_client(
     rabbitmq_rpc_client: Callable[[str], Awaitable[RabbitMQRPCClient]],
 ) -> RabbitMQRPCClient:
     return await rabbitmq_rpc_client("client")
-
-
-async def test_get_state(app: FastAPI, rpc_client: RabbitMQRPCClient):
-    usage = {
-        "some_path": DiskUsage(
-            total=ByteSize(0), used=ByteSize(0), free=ByteSize(0), used_percent=0
-        )
-    }
-    settings: ApplicationSettings = app.state.settings
-
-    result = await disk_usage.update_disk_usage(
-        rpc_client, node_id=settings.DY_SIDECAR_NODE_ID, usage=usage
-    )
-    assert result is None
-
-    assert get_disk_usage_monitor(app)._usage_overwrite == usage  # noqa: SLF001

services/dynamic-sidecar/tests/unit/test_api_rest_volumes.py renamed to services/dynamic-sidecar/tests/unit/api/rest/test_volumes.py

@@ -0,0 +1,44 @@
+# pylint:disable=protected-access
+# pylint:disable=redefined-outer-name
+# pylint:disable=unused-argument
+
+import pytest
+from fastapi import FastAPI
+from models_library.api_schemas_dynamic_sidecar.telemetry import DiskUsage
+from pydantic import ByteSize
+from pytest_simcore.helpers.monkeypatch_envs import EnvVarsDict
+from servicelib.rabbitmq import RabbitMQRPCClient
+from servicelib.rabbitmq.rpc_interfaces.dynamic_sidecar import disk_usage
+from settings_library.redis import RedisSettings
+from simcore_service_dynamic_sidecar.core.settings import ApplicationSettings
+from simcore_service_dynamic_sidecar.modules.system_monitor._disk_usage import (
+    get_disk_usage_monitor,
+)
+
+pytest_simcore_core_services_selection = [
+    "redis",
+    "rabbit",
+]
+
+
+@pytest.fixture
+def mock_environment(
+    redis_service: RedisSettings, mock_environment: EnvVarsDict
+) -> EnvVarsDict:
+    return mock_environment
+
+
+async def test_get_state(app: FastAPI, rpc_client: RabbitMQRPCClient):
+    usage = {
+        "some_path": DiskUsage(
+            total=ByteSize(0), used=ByteSize(0), free=ByteSize(0), used_percent=0
+        )
+    }
+    settings: ApplicationSettings = app.state.settings
+
+    result = await disk_usage.update_disk_usage(
+        rpc_client, node_id=settings.DY_SIDECAR_NODE_ID, usage=usage
+    )
+    assert result is None
+
+    assert get_disk_usage_monitor(app)._usage_overwrite == usage  # noqa: SLF001