🐛 iSeg sometimes stuck with invalid networks (maybe) (ITISFoundation#3281)

Author: sanderegg

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/core/validation.py

@@ -125,27 +125,31 @@ def _gen_parts_env_vars(
     return [f"{k}={v}" for k, v in dict_spec_env_vars.items()]
 
 
-def _inject_backend_networking(
-    parsed_compose_spec: dict[str, Any], network_name: str = "__backend__"
-) -> None:
+_DEFAULT_BACKEND_NETWORK_NAME = "__backend__"
+
+
+def _inject_backend_networking(parsed_compose_spec: dict[str, Any]) -> None:
     """
     Put all containers in the compose spec in the same network.
     The `network_name` must only be unique inside the user defined spec;
     docker-compose will add some prefix to it.
     """
-
-    networks = parsed_compose_spec.get("networks", {})
-    networks[network_name] = None
+    networks = parsed_compose_spec.setdefault("networks", {})
+    if networks is None:
+        parsed_compose_spec["networks"] = {_DEFAULT_BACKEND_NETWORK_NAME: None}
+    else:
+        networks[_DEFAULT_BACKEND_NETWORK_NAME] = None
 
     for service_content in parsed_compose_spec["services"].values():
-        service_networks = service_content.get("networks", [])
-        if isinstance(service_networks, list):
-            service_networks.append(network_name)
+        service_networks = service_content.setdefault("networks", [])
+        if service_networks is None:
+            # if network is set without entries
+            service_content["networks"] = [_DEFAULT_BACKEND_NETWORK_NAME]
+        elif isinstance(service_networks, list):
+            service_networks.append(_DEFAULT_BACKEND_NETWORK_NAME)
         else:
-            service_networks[network_name] = None
-        service_content["networks"] = service_networks
-
-    parsed_compose_spec["networks"] = networks
+            # if the network is set as a dictionary (rather non official but works)
+            service_networks[_DEFAULT_BACKEND_NETWORK_NAME] = None
 
 
 def parse_compose_spec(compose_file_content: str) -> Any:
@@ -172,7 +176,7 @@ async def validate_compose_spec(
 
     Finally runs docker-compose config to properly validate the result
     """
-
+    logger.debug("validating compose spec:\n%s", f"{compose_file_content=}")
     parsed_compose_spec = parse_compose_spec(compose_file_content)
 
     if parsed_compose_spec is None or not isinstance(parsed_compose_spec, dict):

services/dynamic-sidecar/tests/unit/test_core_validation.py

@@ -0,0 +1,117 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+
+from inspect import signature
+
+import pytest
+from simcore_service_dynamic_sidecar.core.validation import (
+    _DEFAULT_BACKEND_NETWORK_NAME,
+    _inject_backend_networking,
+    parse_compose_spec,
+)
+
+
+@pytest.fixture
+def incoming_iseg_compose_file_content() -> str:
+    return """
+networks:
+  dy-sidecar_6f54ecb4-cac2-424a-8b72-ee9366026ff8:
+    driver: overlay
+    external:
+      name: dy-sidecar_6f54ecb4-cac2-424a-8b72-ee9366026ff8
+services:
+  iseg-app:
+    image: registry.osparc.org/simcore/services/dynamic/iseg-app:1.0.7
+  iseg-web:
+    image: registry.osparc.org/simcore/services/dynamic/iseg-web:1.0.7
+    networks:
+      dy-sidecar_6f54ecb4-cac2-424a-8b72-ee9366026ff8:
+version: \'3.7\'
+    """
+
+
+@pytest.fixture
+def incoming_iseg_compose_file_content_missing_network() -> str:
+    return """
+networks:
+services:
+  iseg-app:
+    image: registry.osparc.org/simcore/services/dynamic/iseg-app:1.0.7
+  iseg-web:
+    image: registry.osparc.org/simcore/services/dynamic/iseg-web:1.0.7
+    networks:
+      dy-sidecar_6f54ecb4-cac2-424a-8b72-ee9366026ff8:
+version: \'3.7\'
+    """
+
+
+@pytest.fixture
+def incoming_iseg_compose_file_content_missing_network_list() -> str:
+    return """
+networks:
+services:
+  iseg-app:
+    image: registry.osparc.org/simcore/services/dynamic/iseg-app:1.0.7
+  iseg-web:
+    image: registry.osparc.org/simcore/services/dynamic/iseg-web:1.0.7
+    networks:
+      - dy-sidecar_6f54ecb4-cac2-424a-8b72-ee9366026ff8
+version: \'3.7\'
+    """
+
+
+@pytest.fixture
+def incoming_iseg_compose_file_content_no_networks() -> str:
+    return """
+services:
+  iseg-app:
+    image: registry.osparc.org/simcore/services/dynamic/iseg-app:1.0.7
+  iseg-web:
+    image: registry.osparc.org/simcore/services/dynamic/iseg-web:1.0.7
+version: \'3.7\'
+    """
+
+
+@pytest.fixture(
+    params=[
+        "incoming_iseg_compose_file_content",
+        "incoming_iseg_compose_file_content_missing_network",
+        "incoming_iseg_compose_file_content_missing_network_list",
+        "incoming_iseg_compose_file_content_no_networks",
+    ]
+)
+def incoming_compose_file(
+    request,
+    incoming_iseg_compose_file_content: str,
+    incoming_iseg_compose_file_content_missing_network: str,
+    incoming_iseg_compose_file_content_missing_network_list: str,
+    incoming_iseg_compose_file_content_no_networks: str,
+) -> str:
+    # check that fixture_name is present in this function's parameters
+    fixture_name = request.param
+    sig = signature(incoming_compose_file)
+    assert fixture_name in sig.parameters, (
+        f"Provided fixture name {fixture_name} was not found "
+        f"as a parameter in the signature {sig}"
+    )
+
+    # returns the parameter by name from the ones declared in the signature
+    result: str = locals()[fixture_name]
+    return result
+
+
+def test_inject_backend_networking(incoming_compose_file: str):
+    """
+    NOTE: this goes with issue [https://github.com/ITISFoundation/osparc-simcore/issues/3261]
+    """
+    parsed_compose_spec = parse_compose_spec(incoming_compose_file)
+    _inject_backend_networking(parsed_compose_spec)
+    assert _DEFAULT_BACKEND_NETWORK_NAME in parsed_compose_spec["networks"]
+    assert (
+        _DEFAULT_BACKEND_NETWORK_NAME
+        in parsed_compose_spec["services"]["iseg-app"]["networks"]
+    )
+    assert (
+        _DEFAULT_BACKEND_NETWORK_NAME
+        in parsed_compose_spec["services"]["iseg-web"]["networks"]
+    )