🐛: ensure negative values are set to 0 (ITISFoundation#2985)

Author: sanderegg

services/director-v2/src/simcore_service_director_v2/models/schemas/clusters.py

@@ -23,24 +23,40 @@
     validator,
 )
 from pydantic.networks import AnyUrl
-from pydantic.types import ByteSize, PositiveFloat
+from pydantic.types import ByteSize, NonNegativeInt, PositiveFloat
 
 
 class WorkerMetrics(BaseModel):
-    cpu: float = Field(..., description="consumed # of cpus")
+    cpu: float = Field(..., description="consumed % of cpus")
     memory: ByteSize = Field(..., description="consumed memory")
     num_fds: int = Field(..., description="consumed file descriptors")
-    ready: int = Field(..., description="# tasks ready to run")
-    executing: int = Field(..., description="# tasks currently executing")
-    in_flight: int = Field(..., description="# tasks currenntly waiting for data")
-    in_memory: ByteSize = Field(..., description="result data still in memory")
+    ready: NonNegativeInt = Field(..., description="# tasks ready to run")
+    executing: NonNegativeInt = Field(..., description="# tasks currently executing")
+    in_flight: NonNegativeInt = Field(..., description="# tasks waiting for data")
+    in_memory: NonNegativeInt = Field(..., description="# tasks in worker memory")
+
+
+AvailableResources = DictModel[str, PositiveFloat]
+
+
+class UsedResources(DictModel[str, NonNegativeFloat]):
+    @root_validator(pre=True)
+    @classmethod
+    def ensure_negative_value_is_zero(cls, values):
+        # dasks adds/remove resource values and sometimes
+        # they end up being negative instead of 0
+        if v := values.get("__root__", {}):
+            for res_key, res_value in v.items():
+                if res_value < 0:
+                    v[res_key] = 0
+        return values
 
 
 class Worker(BaseModel):
     id: str
     name: str
-    resources: DictModel[str, PositiveFloat]
-    used_resources: DictModel[str, NonNegativeFloat]
+    resources: AvailableResources
+    used_resources: UsedResources
     memory_limit: ByteSize
     metrics: WorkerMetrics
 

services/director-v2/tests/unit/test_models_clusters.py

@@ -3,11 +3,15 @@
 
 import pytest
 from faker import Faker
-from pydantic import BaseModel
+from pydantic import BaseModel, parse_obj_as
 from simcore_service_director_v2.models.schemas.clusters import (
+    AvailableResources,
     ClusterCreate,
     ClusterPatch,
     Scheduler,
+    UsedResources,
+    Worker,
+    WorkerMetrics,
     WorkersDict,
 )
 
@@ -52,3 +56,27 @@ def test_scheduler_constructor_with_no_workers_has_correct_dict(faker: Faker):
     scheduler = Scheduler(status=faker.text(), workers=None)
     assert isinstance(scheduler.workers, WorkersDict)
     assert len(scheduler.workers) == 0
+
+
+def test_worker_constructor_corrects_negative_used_resources(faker: Faker):
+    worker = Worker(
+        id=faker.pyint(min_value=1),
+        name=faker.name(),
+        resources=parse_obj_as(AvailableResources, {}),
+        used_resources=parse_obj_as(UsedResources, {"CPU": -0.0000234}),
+        memory_limit=faker.pyint(min_value=1),
+        metrics=parse_obj_as(
+            WorkerMetrics,
+            {
+                "cpu": faker.pyfloat(min_value=0),
+                "memory": faker.pyint(min_value=0),
+                "num_fds": faker.pyint(),
+                "ready": faker.pyint(min_value=0),
+                "executing": faker.pyint(min_value=0),
+                "in_flight": faker.pyint(min_value=0),
+                "in_memory": faker.pyint(min_value=0),
+            },
+        ),
+    )
+    assert worker
+    assert worker.used_resources["CPU"] == 0