added validator for docker_node_id

Author: Andrei Neagu

packages/models-library/src/models_library/docker.py

@@ -37,7 +37,15 @@ def from_key(cls, key: str) -> "DockerLabelKey":
     str, StringConstraints(pattern=DOCKER_GENERIC_TAG_KEY_RE)
 ]
 
-DockerPlacementConstraint: TypeAlias = Annotated[str, StringConstraints(strip_whitespace = True, pattern = re.compile(r"^(?!-)(?![.])(?!.*--)(?!.*[.][.])[a-zA-Z0-9.-]*(?<!-)(?<![.])(!=|==)[a-zA-Z0-9_. -]*$"))]
+DockerPlacementConstraint: TypeAlias = Annotated[
+    str,
+    StringConstraints(
+        strip_whitespace=True,
+        pattern=re.compile(
+            r"^(?!-)(?![.])(?!.*--)(?!.*[.][.])[a-zA-Z0-9.-]*(?<!-)(?<![.])(!=|==)[a-zA-Z0-9_. -]*$"
+        ),
+    ),
+]
 
 _SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX: Final[str] = "io.simcore.runtime."
 _BACKWARDS_COMPATIBILITY_SIMCORE_RUNTIME_DOCKER_LABELS_MAP: Final[dict[str, str]] = {
@@ -218,3 +226,8 @@ def from_docker_task(cls, docker_task: Task) -> "StandardSimcoreDockerLabels":
             ]
         },
     )
+
+
+DockerNodeID: TypeAlias = Annotated[
+    str, StringConstraints(strip_whitespace=True, pattern=re.compile(r"^[a-z0-9]$"))
+]

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

@@ -2,6 +2,7 @@
 from datetime import timedelta
 from typing import Final
 
+from models_library.docker import DockerNodeID
 from models_library.projects_nodes_io import NodeID
 from models_library.rabbitmq_basic_types import RPCMethodName, RPCNamespace
 from pydantic import NonNegativeInt, TypeAdapter
@@ -17,7 +18,7 @@
 async def force_container_cleanup(
     rabbitmq_rpc_client: RabbitMQRPCClient,
     *,
-    docker_node_id: str,
+    docker_node_id: DockerNodeID,
     swarm_stack_name: str,
     node_id: NodeID,
 ) -> None:

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

@@ -2,6 +2,7 @@
 from datetime import timedelta
 from typing import Final
 
+from models_library.docker import DockerNodeID
 from models_library.projects_nodes_io import NodeID
 from models_library.rabbitmq_basic_types import RPCMethodName, RPCNamespace
 from pydantic import NonNegativeInt, TypeAdapter
@@ -17,7 +18,7 @@
 async def remove_volumes_without_backup_for_service(
     rabbitmq_rpc_client: RabbitMQRPCClient,
     *,
-    docker_node_id: str,
+    docker_node_id: DockerNodeID,
     swarm_stack_name: str,
     node_id: NodeID,
 ) -> None:
@@ -42,7 +43,7 @@ async def remove_volumes_without_backup_for_service(
 async def backup_and_remove_volumes_for_all_services(
     rabbitmq_rpc_client: RabbitMQRPCClient,
     *,
-    docker_node_id: str,
+    docker_node_id: DockerNodeID,
     swarm_stack_name: str,
 ) -> None:
     result = await rabbitmq_rpc_client.request(

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

@@ -1,6 +1,7 @@
 from datetime import timedelta
 
 from models_library.basic_types import BootModeEnum, LogLevel
+from models_library.docker import DockerNodeID
 from pydantic import AliasChoices, AnyHttpUrl, Field, field_validator
 from servicelib.logging_utils_filtering import LoggerName, MessageSubstring
 from settings_library.base import BaseCustomSettings
@@ -79,7 +80,9 @@ class ApplicationSettings(BaseCustomSettings, MixinLoggingSettings):
 
     AGENT_PROMETHEUS_INSTRUMENTATION_ENABLED: bool = True
 
-    AGENT_DOCKER_NODE_ID: str = Field(..., description="used by the rabbitmq module")
+    AGENT_DOCKER_NODE_ID: DockerNodeID = Field(
+        ..., description="used by the rabbitmq module"
+    )
 
     AGENT_RABBITMQ: RabbitSettings = Field(
         description="settings for service/rabbitmq",

services/agent/src/simcore_service_agent/services/instrumentation/_models.py

@@ -1,6 +1,7 @@
 from dataclasses import dataclass, field
 from typing import Final
 
+from models_library.docker import DockerNodeID
 from prometheus_client import CollectorRegistry, Counter
 from servicelib.instrumentation import MetricsBase, get_metrics_namespace
 
@@ -34,10 +35,10 @@ def __post_init__(self) -> None:
             registry=self.registry,
         )
 
-    def remove_volumes(self, docker_node_id: str) -> None:
+    def remove_volumes(self, docker_node_id: DockerNodeID) -> None:
         self.volumes_removed.labels(docker_node_id=docker_node_id).inc()
 
-    def backedup_volumes(self, docker_node_id: str) -> None:
+    def backedup_volumes(self, docker_node_id: DockerNodeID) -> None:
         self.volumes_backedup.labels(docker_node_id=docker_node_id).inc()
 
 

services/agent/tests/conftest.py

@@ -5,6 +5,7 @@
 import pytest
 from faker import Faker
 from models_library.basic_types import BootModeEnum
+from models_library.docker import DockerNodeID
 from moto.server import ThreadedMotoServer
 from pydantic import HttpUrl, TypeAdapter
 from pytest_simcore.helpers.monkeypatch_envs import EnvVarsDict, setenvs_from_dict
@@ -25,8 +26,8 @@ def swarm_stack_name() -> str:
 
 
 @pytest.fixture
-def docker_node_id() -> str:
-    return "test-node-id"
+def docker_node_id() -> DockerNodeID:
+    return TypeAdapter(DockerNodeID).validate_python("testnodeid")
 
 
 @pytest.fixture
@@ -40,7 +41,7 @@ def mock_environment(
     mocked_s3_server_url: HttpUrl,
     bucket: str,
     swarm_stack_name: str,
-    docker_node_id: str,
+    docker_node_id: DockerNodeID,
 ) -> EnvVarsDict:
     return setenvs_from_dict(
         monkeypatch,

services/agent/tests/unit/test_api_rpc__containers.py

@@ -8,6 +8,7 @@
 import pytest_mock
 from faker import Faker
 from fastapi import FastAPI
+from models_library.docker import DockerNodeID
 from models_library.projects_nodes_io import NodeID
 from servicelib.rabbitmq import RabbitMQRPCClient
 from servicelib.rabbitmq.rpc_interfaces.agent import containers
@@ -40,7 +41,7 @@ def mocked_force_container_cleanup(mocker: pytest_mock.MockerFixture) -> AsyncMo
 async def test_force_container_cleanup(
     rpc_client: RabbitMQRPCClient,
     swarm_stack_name: str,
-    docker_node_id: str,
+    docker_node_id: DockerNodeID,
     node_id: NodeID,
     mocked_force_container_cleanup: AsyncMock,
 ):

services/agent/tests/unit/test_api_rpc__volumes.py

@@ -8,6 +8,7 @@
 import pytest
 import pytest_mock
 from fastapi import FastAPI
+from models_library.docker import DockerNodeID
 from servicelib.rabbitmq import RabbitMQRPCClient
 from servicelib.rabbitmq.rpc_interfaces.agent import volumes
 
@@ -41,7 +42,7 @@ def mocked_remove_all_volumes(mocker: pytest_mock.MockerFixture) -> AsyncMock:
 async def test_backup_and_remove_volumes_for_all_services(
     rpc_client: RabbitMQRPCClient,
     swarm_stack_name: str,
-    docker_node_id: str,
+    docker_node_id: DockerNodeID,
     mocked_remove_all_volumes: AsyncMock,
 ):
     assert mocked_remove_all_volumes.call_count == 0

services/director-v2/src/simcore_service_director_v2/models/dynamic_services_scheduler.py

@@ -20,6 +20,7 @@
 )
 from models_library.basic_types import PortInt
 from models_library.callbacks_mapping import CallbacksMapping
+from models_library.docker import DockerNodeID
 from models_library.generated_models.docker_rest_api import ContainerState, Status2
 from models_library.projects_nodes_io import NodeID
 from models_library.resource_tracker import HardwareInfo, PricingInfo
@@ -299,7 +300,7 @@ def compose_spec_submitted(self) -> bool:
         default=None, description="used for starting the proxy"
     )
 
-    docker_node_id: str | None = Field(
+    docker_node_id: DockerNodeID | None = Field(
         default=None,
         description=(
             "contains node id of the docker node where all services "

services/director-v2/src/simcore_service_director_v2/modules/dynamic_sidecar/docker_api/_core.py

@@ -12,7 +12,7 @@
 from models_library.api_schemas_directorv2.services import (
     DYNAMIC_SIDECAR_SERVICE_PREFIX,
 )
-from models_library.docker import to_simcore_runtime_docker_label_key
+from models_library.docker import DockerNodeID, to_simcore_runtime_docker_label_key
 from models_library.projects import ProjectID
 from models_library.projects_networks import DockerNetworkName
 from models_library.projects_nodes_io import NodeID
@@ -170,7 +170,7 @@ async def _get_service_latest_task(service_id: str) -> Mapping[str, Any]:
 async def get_dynamic_sidecar_placement(
     service_id: str,
     dynamic_services_scheduler_settings: DynamicServicesSchedulerSettings,
-) -> str:
+) -> DockerNodeID:
     """
     Waits until the service has a task in `running` state and
     returns it's `docker_node_id`.
@@ -205,7 +205,7 @@ async def _get_task_data_when_service_running(service_id: str) -> Mapping[str, A
 
     task = await _get_task_data_when_service_running(service_id=service_id)
 
-    docker_node_id: None | str = task.get("NodeID", None)
+    docker_node_id: DockerNodeID | None = task.get("NodeID", None)
     if not docker_node_id:
         msg = f"Could not find an assigned NodeID for service_id={service_id}. Last task inspect result: {task}"
         raise DynamicSidecarError(msg=msg)
@@ -494,7 +494,9 @@ async def update_scheduler_data_label(scheduler_data: SchedulerData) -> None:
             )
 
 
-async def constrain_service_to_node(service_name: str, docker_node_id: str) -> None:
+async def constrain_service_to_node(
+    service_name: str, docker_node_id: DockerNodeID
+) -> None:
     await _update_service_spec(
         service_name,
         update_in_service_spec={