🐛 Fix/backwards compatibility on service annotation labels (ITISFoundation#3041)

Author: pcrespov

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

@@ -47,7 +47,13 @@ class SimcoreServiceSettingLabelEntry(BaseModel):
     _destination_container: str = PrivateAttr()
     name: str = Field(..., description="The name of the service setting")
     setting_type: Literal[
-        "string", "int", "integer", "number", "object", "ContainerSpec", "Resources"
+        "string",
+        "int",
+        "integer",
+        "number",
+        "object",
+        "ContainerSpec",
+        "Resources",
     ] = Field(
         ...,
         description="The type of the service setting (follows Docker REST API naming scheme)",
@@ -58,6 +64,14 @@ class SimcoreServiceSettingLabelEntry(BaseModel):
         description="The value of the service setting (shall follow Docker REST API scheme for services",
     )
 
+    @validator("setting_type", pre=True)
+    @classmethod
+    def ensure_backwards_compatible_setting_type(cls, v):
+        if v == "resources":
+            # renamed in the latest version as
+            return "Resources"
+        return v
+
     class Config(_BaseConfig):
         schema_extra = {
             "examples": [
@@ -73,7 +87,7 @@ class Config(_BaseConfig):
                     "type": "ContainerSpec",
                     "value": {"Command": ["run"]},
                 },
-                # SEE service_resources.py::ResourceValue
+                # SEE services_resources.py::ResourceValue
                 {
                     "name": "Resources",
                     "type": "Resources",
@@ -103,6 +117,20 @@ class Config(_BaseConfig):
                 },
                 # environments
                 {"name": "env", "type": "string", "value": ["DISPLAY=:0"]},
+                # SEE 'simcore.service.settings' label annotations for simcore/services/dynamic/jupyter-octave-python-math:1.6.5
+                {"name": "ports", "type": "int", "value": 8888},
+                {
+                    "name": "constraints",
+                    "type": "string",
+                    "value": ["node.platform.os == linux"],
+                },
+                {
+                    "name": "resources",
+                    "type": "resources",
+                    "value": {
+                        "Limits": {"NanoCPUs": 4000000000, "MemoryBytes": 8589934592}
+                    },
+                },
             ]
         }
 

packages/service-integration/tests/test_osparc_config.py

@@ -5,12 +5,11 @@
 import json
 from pathlib import Path
 from pprint import pformat
-from typing import Any, Type
+from typing import Any
 
 import pytest
 import yaml
 from models_library.service_settings_labels import SimcoreServiceSettingLabelEntry
-from pydantic import BaseModel
 from service_integration.osparc_config import MetaConfig, RuntimeConfig, SettingsItem
 
 
@@ -66,12 +65,24 @@ def test_load_from_labels(
 
 
 @pytest.mark.parametrize(
-    "model_cls",
-    (SimcoreServiceSettingLabelEntry,),
+    "example_data", SimcoreServiceSettingLabelEntry.Config.schema_extra["examples"]
 )
 def test_settings_item_in_sync_with_service_settings_label(
-    model_cls: Type[BaseModel], model_cls_examples: dict[str, dict[str, Any]]
+    example_data: dict[str, Any]
 ):
-    for name, example in model_cls_examples.items():
-        print(name, ":", pformat(example))
-        SettingsItem.parse_obj(example)
+
+    print(pformat(example_data))
+
+    # First we parse with SimcoreServiceSettingLabelEntry since it also supports backwards compatibility
+    # and will upgrade old version
+    example_model = SimcoreServiceSettingLabelEntry.parse_obj(example_data)
+
+    # SettingsItem is exclusively for NEW labels, so it should not support backwards compatibility
+    new_model = SettingsItem(
+        name=example_model.name,
+        type=example_model.setting_type,
+        value=example_model.value,
+    )
+
+    # check back
+    SimcoreServiceSettingLabelEntry.parse_obj(new_model.dict(by_alias=True))

requirements/tools/Dockerfile

@@ -22,7 +22,7 @@ RUN apt-get update \
 
 # SEE bug with pip==22.1 https://github.com/jazzband/pip-tools/issues/1617
 RUN pip --no-cache-dir install --upgrade \
-  pip~=22.0.1  \
+  pip~=22.0  \
   wheel \
   setuptools