🐛 dynamic-sidecar permission fixing (ITISFoundation#2847)

* fixed permissions

* fixes broken test

Co-authored-by: Andrei Neagu <[email protected]>

Author: GitHK

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

@@ -106,7 +106,10 @@ async def get_swarm_network(dynamic_sidecar_settings: DynamicSidecarSettings) ->
     ]
     if not networks or len(networks) > 1:
         raise DynamicSidecarError(
-            f"Swarm network name is not configured, found following networks: {networks}"
+            (
+                f"Swarm network name (searching for '*{network_name}*') is not configured."
+                f"Found following networks: {networks}"
+            )
         )
     return networks[0]
 

services/director-v2/tests/integration/02/test_dynamic_sidecar_nodeports_integration.py

@@ -904,6 +904,10 @@ async def test_nodeports_integration(
         dynamic_services_urls=dynamic_services_urls,
     )
 
+    # NOTE: Waits a bit for the DB to write the changes in
+    # comp_task for the upstream service.
+    await asyncio.sleep(2)
+
     await _assert_retrieve_completed(
         director_v2_client=async_client,
         service_uuid=services_node_uuids.dy_compose_spec,

services/director-v2/tests/unit/with_swarm/test_modules_dynamic_sidecar_docker_api.py

@@ -318,9 +318,9 @@ async def test_get_swarm_network_missing_network(
 ) -> None:
     with pytest.raises(DynamicSidecarError) as excinfo:
         await docker_api.get_swarm_network(dynamic_sidecar_settings)
-    assert (
-        str(excinfo.value)
-        == "Swarm network name is not configured, found following networks: []"
+    assert str(excinfo.value) == (
+        "Swarm network name (searching for '*test_network_name*') is not configured."
+        "Found following networks: []"
     )
 
 

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

@@ -14,7 +14,7 @@
 from .remote_debug import setup as remote_debug_setup
 from .settings import DynamicSidecarSettings
 from .shared_handlers import on_shutdown_handler
-from .utils import login_registry
+from .utils import login_registry, volumes_fix_permissions
 
 logger = logging.getLogger(__name__)
 
@@ -80,6 +80,8 @@ def assemble_application() -> FastAPI:
     def create_start_app_handler() -> Callable[[], Coroutine[Any, Any, None]]:
         async def on_startup() -> None:
             await login_registry(application.state.settings.REGISTRY_SETTINGS)
+            await volumes_fix_permissions()
+
             print(WELCOME_MSG, flush=True)
 
         return on_startup

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

@@ -23,10 +23,14 @@
 from tenacity.stop import stop_after_attempt
 from tenacity.wait import wait_fixed
 
+from ..modules.mounted_fs import MountedVolumes, get_mounted_volumes
+
 CommandResult = namedtuple("CommandResult", "finished_without_errors, decoded_stdout")
 
 TEMPLATE_SEARCH_PATTERN = r"%%(.*?)%%"
 
+HIDDEN_FILE_NAME = ".hidden_do_not_remove"
+
 logger = logging.getLogger(__name__)
 
 
@@ -156,3 +160,20 @@ def assemble_container_names(validated_compose_content: str) -> List[str]:
         service_data["container_name"]
         for service_data in parsed_compose_spec["services"].values()
     ]
+
+
+async def volumes_fix_permissions() -> None:
+    # NOTE: by creating a hidden file on all mounted volumes
+    # the same permissions are ensured and avoids
+    # issues when starting the services
+    mounted_volumes: MountedVolumes = get_mounted_volumes()
+    for volume_path in [
+        mounted_volumes.disk_inputs_path,
+        mounted_volumes.disk_outputs_path,
+    ] + list(mounted_volumes.disk_state_paths()):
+        hidden_file = volume_path / HIDDEN_FILE_NAME
+        hidden_file.write_text(
+            f"Directory must not be empty.\nCreated by {__file__}.\nRequired by "
+            "oSPARC internals to properly enforce permissions on this "
+            "directory and all its files"
+        )

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

@@ -24,7 +24,7 @@
 from simcore_service_dynamic_sidecar.core.shared_handlers import (
     write_file_and_run_command,
 )
-from simcore_service_dynamic_sidecar.core.utils import async_command
+from simcore_service_dynamic_sidecar.core.utils import HIDDEN_FILE_NAME, async_command
 from simcore_service_dynamic_sidecar.core.validation import parse_compose_spec
 from simcore_service_dynamic_sidecar.models.domains.shared_store import SharedStore
 from simcore_service_dynamic_sidecar.modules.mounted_fs import (
@@ -454,7 +454,13 @@ def _create_random_dir_in_inputs() -> int:
         mounted_volumes: MountedVolumes = get_mounted_volumes()
         dir_name = mounted_volumes.disk_outputs_path / f"{uuid4()}"
         dir_name.mkdir(parents=True)
-        dir_count = len([1 for x in mounted_volumes.disk_outputs_path.glob("*")])
+        dir_count = len(
+            [
+                1
+                for x in mounted_volumes.disk_outputs_path.glob("*")
+                if not f"{x}".endswith(HIDDEN_FILE_NAME)
+            ]
+        )
         return dir_count
 
     EVENTS_PER_DIR_CREATION = 2