added tests for rpc endpoint

Author: Andrei Neagu

packages/models-library/src/models_library/api_schemas_api_agent/__init__.py

@@ -0,0 +1,54 @@
+import logging
+from datetime import timedelta
+
+from models_library.projects_nodes_io import NodeID
+from models_library.rabbitmq_basic_types import RPCMethodName, RPCNamespace
+from pydantic import parse_obj_as
+from servicelib.logging_utils import log_decorator
+from servicelib.rabbitmq import RabbitMQRPCClient
+
+_logger = logging.getLogger(__name__)
+
+
+@log_decorator(_logger, level=logging.DEBUG)
+async def remove_volumes_without_backup_for_service(
+    rabbitmq_rpc_client: RabbitMQRPCClient,
+    *,
+    docker_node_id: str,
+    swarm_stack_name: str,
+    node_id: NodeID,
+) -> None:
+    result = await rabbitmq_rpc_client.request(
+        RPCNamespace.from_entries(
+            {
+                "service": "agent",
+                "docker_node_id": docker_node_id,
+                "swarm_stack_name": swarm_stack_name,
+            }
+        ),
+        parse_obj_as(RPCMethodName, "remove_volumes_without_backup_for_service"),
+        node_id=node_id,
+        timeout_s=int(timedelta(minutes=60).total_seconds()),
+    )
+    assert result is None  # noec
+
+
+@log_decorator(_logger, level=logging.DEBUG)
+async def backup_and_remove_volumes_for_all_services(
+    rabbitmq_rpc_client: RabbitMQRPCClient,
+    *,
+    docker_node_id: str,
+    swarm_stack_name: str,
+) -> None:
+    result = await rabbitmq_rpc_client.request(
+        RPCNamespace.from_entries(
+            {
+                "service": "agent",
+                "docker_node_id": docker_node_id,
+                "swarm_stack_name": swarm_stack_name,
+            }
+        ),
+        parse_obj_as(RPCMethodName, "backup_and_remove_volumes_for_all_services"),
+        timeout_s=int(timedelta(minutes=60).total_seconds()),
+    )
+    assert result is None  # noec

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/agent/__init__.py

@@ -16,6 +16,3 @@ async def remove_volumes_without_backup_for_service(
 @router.expose()
 async def backup_and_remove_volumes_for_all_services(app: FastAPI) -> None:
     await get_volumes_manager(app).remove_all_volumes()
-
-
-# TODO: add tests for these

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

@@ -1,6 +1,7 @@
 from fastapi import FastAPI
-from models_library.api_schemas_api_agent import AGENT_RPC_NAMESPACE
+from models_library.rabbitmq_basic_types import RPCNamespace
 from servicelib.rabbitmq import RPCRouter
+from simcore_service_agent.core.settings import ApplicationSettings
 
 from ....services.rabbitmq import get_rabbitmq_rpc_server
 from . import _volumes
@@ -13,7 +14,15 @@
 def setup_rpc_api_routes(app: FastAPI) -> None:
     async def startup() -> None:
         rpc_server = get_rabbitmq_rpc_server(app)
+        settings: ApplicationSettings = app.state.settings
+        namespace = RPCNamespace.from_entries(
+            {
+                "service": "agent",
+                "docker_node_id": settings.AGENT_DOCKER_NODE_ID,
+                "swarm_stack_name": settings.AGENT_VOLUMES_CLEANUP_TARGET_SWARM_STACK_NAME,
+            }
+        )
         for router in ROUTERS:
-            await rpc_server.register_router(router, AGENT_RPC_NAMESPACE, app)
+            await rpc_server.register_router(router, namespace, app)
 
     app.add_event_handler("startup", startup)

services/agent/src/simcore_service_agent/core/api/rpc/_volumes.py

@@ -65,6 +65,8 @@ class ApplicationSettings(BaseCustomSettings, MixinLoggingSettings):
 
     AGENT_PROMETHEUS_INSTRUMENTATION_ENABLED: bool = True
 
+    AGENT_DOCKER_NODE_ID: str = Field(..., description="used by the rabbitmq module")
+
     AGENT_RABBITMQ: RabbitSettings = Field(
         auto_default_from_env=True, description="settings for service/rabbitmq"
     )

services/agent/src/simcore_service_agent/core/api/rpc/routes.py

@@ -24,6 +24,11 @@ def swarm_stack_name() -> str:
     return "test-simcore"
 
 
+@pytest.fixture
+def docker_node_id() -> str:
+    return "test-node-id"
+
+
 @pytest.fixture
 def bucket(faker: Faker) -> str:
     return f"test-bucket-{faker.uuid4()}"
@@ -35,6 +40,7 @@ def mock_environment(
     mocked_s3_server_url: HttpUrl,
     bucket: str,
     swarm_stack_name: str,
+    docker_node_id: str,
 ) -> EnvVarsDict:
     return setenvs_from_dict(
         monkeypatch,
@@ -51,6 +57,7 @@ def mock_environment(
             "RABBIT_PASSWORD": "test",
             "RABBIT_SECURE": "false",
             "RABBIT_USER": "test",
+            "AGENT_DOCKER_NODE_ID": docker_node_id,
         },
     )
 

services/agent/src/simcore_service_agent/core/settings.py

@@ -0,0 +1,68 @@
+# pylint:disable=redefined-outer-name
+# pylint:disable=unused-argument
+
+from collections.abc import Awaitable, Callable
+from unittest.mock import AsyncMock
+from uuid import uuid4
+
+import pytest
+import pytest_mock
+from fastapi import FastAPI
+from servicelib.rabbitmq import RabbitMQRPCClient
+from servicelib.rabbitmq.rpc_interfaces.agent import volumes
+from simcore_service_agent.services.volumes_manager import get_volumes_manager
+
+pytest_simcore_core_services_selection = [
+    "rabbit",
+]
+
+
+@pytest.fixture
+async def rpc_client(
+    initialized_app: FastAPI,
+    rabbitmq_rpc_client: Callable[[str], Awaitable[RabbitMQRPCClient]],
+) -> RabbitMQRPCClient:
+    return await rabbitmq_rpc_client("client")
+
+
+@pytest.fixture
+def spy_remove_service_volumes(
+    mocker: pytest_mock.MockerFixture, initialized_app: FastAPI
+) -> AsyncMock:
+    return mocker.spy(get_volumes_manager(initialized_app), "remove_service_volumes")
+
+
+@pytest.fixture
+def spy_remove_all_volumes(
+    mocker: pytest_mock.MockerFixture, initialized_app: FastAPI
+) -> AsyncMock:
+    return mocker.spy(get_volumes_manager(initialized_app), "remove_all_volumes")
+
+
+async def test_backup_and_remove_volumes_for_all_services(
+    rpc_client: RabbitMQRPCClient,
+    swarm_stack_name: str,
+    docker_node_id: str,
+    spy_remove_all_volumes: AsyncMock,
+):
+    assert spy_remove_all_volumes.call_count == 0
+    await volumes.backup_and_remove_volumes_for_all_services(
+        rpc_client, docker_node_id=docker_node_id, swarm_stack_name=swarm_stack_name
+    )
+    assert spy_remove_all_volumes.call_count == 1
+
+
+async def test_remove_volumes_without_backup_for_service(
+    rpc_client: RabbitMQRPCClient,
+    swarm_stack_name: str,
+    docker_node_id: str,
+    spy_remove_service_volumes: AsyncMock,
+):
+    assert spy_remove_service_volumes.call_count == 0
+    await volumes.remove_volumes_without_backup_for_service(
+        rpc_client,
+        docker_node_id=docker_node_id,
+        swarm_stack_name=swarm_stack_name,
+        node_id=uuid4(),
+    )
+    assert spy_remove_service_volumes.call_count == 1

services/agent/tests/conftest.py

@@ -42,9 +42,6 @@ def get_unused_dynamc_sidecar_volumes(self) -> set[str]:
         return deepcopy(self.volumes)
 
 
-# spy on remove_volume
-
-
 @pytest.fixture
 async def mock_docker_utils(
     mocker: pytest_mock.MockerFixture, run_id: RunID

services/agent/tests/unit/test_api_rpc__volumes.py

@@ -1005,6 +1005,11 @@ services:
       AGENT_VOLUMES_CLEANUP_S3_SECRET_KEY: ${AGENT_VOLUMES_CLEANUP_S3_SECRET_KEY}
       AGENT_VOLUMES_CLEANUP_S3_BUCKET: ${AGENT_VOLUMES_CLEANUP_S3_BUCKET}
       AGENT_VOLUMES_CLEANUP_S3_PROVIDER: ${AGENT_VOLUMES_CLEANUP_S3_PROVIDER}
+      AGENT_DOCKER_NODE_ID: "{{.Node.ID}}"
+      RABBIT_HOST: ${RABBIT_HOST}
+      RABBIT_PASSWORD: ${RABBIT_PASSWORD}
+      RABBIT_PORT: ${RABBIT_PORT}
+      RABBIT_USER: ${RABBIT_USER}
 
   dask-sidecar:
     image: ${DOCKER_REGISTRY:-itisfoundation}/dask-sidecar:${DOCKER_IMAGE_TAG:-latest}