🐛 Fix validation of DIRECTOR_V2_SERVICES_CUSTOM_CONSTRAINTS: Make it conform to docker specs (ITISFoundation#3190)

* add underscore

* Add test (thx pedro)

* make regex according to docker specs

* Fix validation

Co-authored-by: Dustin Kaiser <[email protected]>
Co-authored-by: Pedro Crespo-Valero <[email protected]>

Author: 3 people

services/director-v2/src/simcore_service_director_v2/core/settings.py

@@ -67,7 +67,8 @@
 SUPPORTED_TRAEFIK_LOG_LEVELS: set[str] = {"info", "debug", "warn", "error"}
 
 PlacementConstraintStr = constr(
-    strip_whitespace=True, regex=r"^[a-zA-Z0-9. ]*(!=|==){1}[a-zA-Z0-9. ]*$"
+    strip_whitespace=True,
+    regex=r"^(?!-)(?![.])(?!.*--)(?!.*[.][.])[a-zA-Z0-9.-]*(?<!-)(?<![.])(!=|==){1}[a-zA-Z0-9_. -]*$",
 )
 
 

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

@@ -156,7 +156,12 @@ def test_expected_failure_dynamic_sidecar_settings(
         ('["one==yes"]', ["one==yes"]),
         ('["two!=no"]', ["two!=no"]),
         ('["one==yes", "two!=no"]', ["one==yes", "two!=no"]),
-        ('["     strips.white.spaces   ==  ok "]', ["strips.white.spaces   ==  ok"]),
+        ('["strips.white.spaces==  ok "]', ["strips.white.spaces==  ok"]),
+        (
+            # Bug from https://github.com/ITISFoundation/osparc-simcore/pull/3190
+            '["node.labels.standard-worker==true"]',
+            ["node.labels.standard-worker==true"],
+        ),
     ),
 )
 def test_services_custom_constraints(
@@ -171,6 +176,37 @@ def test_services_custom_constraints(
     assert settings.DIRECTOR_V2_SERVICES_CUSTOM_CONSTRAINTS == expected
 
 
+@pytest.mark.parametrize(
+    "custom_constraints, expected",
+    (
+        # Whitespaces in key are not allowed https://docs.docker.com/config/labels-custom-metadata/#label-keys-and-values
+        ('["strips.white spaces==ok "]', ["strips.white spaces==ok"]),
+        ('[".starting.trailing.dot.==forbidden"]', [".starting.dot==forbidden"]),
+        ('["double...dot==forbidden"]', ["double..dot==forbidden"]),
+        ('["double--hyphen==forbidden"]', ["double--hyphen==forbidden"]),
+        (
+            '["-starting.trailing.hyphen-==forbidden"]',
+            ["-starting.trailing.hyphen-==forbidden"],
+        ),
+        (
+            # Bug from https://github.com/ITISFoundation/osparc-simcore/pull/
+            # Underscores forbidden
+            '["node.labels.standard_worker==true"]',
+            ["node.labels.standard_worker==true"],
+        ),
+    ),
+)
+def test_services_custom_constraint_failures(
+    custom_constraints: str,
+    expected: list[str],
+    project_env_devel_environment: EnvVarsDict,
+    monkeypatch: MonkeyPatch,
+) -> None:
+    monkeypatch.setenv("DIRECTOR_V2_SERVICES_CUSTOM_CONSTRAINTS", custom_constraints)
+    with pytest.raises(Exception) as excinfo:
+        settings = AppSettings.create_from_envs()
+
+
 def test_services_custom_constraints_default_empty_list(
     project_env_devel_environment: EnvVarsDict,
 ) -> None: