✨adds cli to list the content of state directories in dy-sidecar (ITISFoundation#3255)

* adds endpoint to list the path and content of the dy-sidecar
Co-authored-by: Andrei Neagu <[email protected]>

Author: GitHK

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/cli.py

@@ -52,6 +52,22 @@ def _print_highlight(message: str) -> None:
     typer.echo(typer.style(message, fg=typer.colors.MAGENTA))
 
 
+@main.command()
+def state_list_dirs():
+    """Lists files inside state directories"""
+
+    async def _async_state_list_dirs() -> None:
+        app = await _setup_app_for_task_execution()
+
+        mounted_volumes: MountedVolumes = app.state.mounted_volumes
+
+        for state_path in mounted_volumes.state_paths:
+            state_path_content = list(state_path.glob("*"))
+            typer.echo(f"Entries in {state_path}: {state_path_content}")
+
+    asyncio.run(_async_state_list_dirs())
+
+
 @main.command()
 def state_save():
     """Saves the state, usually workspace directory"""
@@ -67,15 +83,15 @@ async def _async_save_state() -> None:
             TaskProgress.create(), settings, mounted_volumes, rabbitmq
         )
 
-    asyncio.get_event_loop().run_until_complete(_async_save_state())
+    asyncio.run(_async_save_state())
     _print_highlight("state save finished successfully")
 
 
 @main.command()
 def outputs_push():
     """Pushes the output ports"""
 
-    async def _async_save_state() -> None:
+    async def _async_outputs_push() -> None:
         app = await _setup_app_for_task_execution()
 
         mounted_volumes: MountedVolumes = app.state.mounted_volumes
@@ -85,7 +101,7 @@ async def _async_save_state() -> None:
             TaskProgress.create(), None, mounted_volumes, rabbitmq
         )
 
-    asyncio.get_event_loop().run_until_complete(_async_save_state())
+    asyncio.run(_async_outputs_push())
     _print_highlight("output ports push finished successfully")
 
 

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

@@ -1,6 +1,8 @@
 # pylint: disable=unused-argument
 # pylint: disable=redefined-outer-name
 
+import os
+
 import pytest
 from pytest_mock.plugin import MockerFixture
 from pytest_simcore.helpers.typing_env import EnvVarsDict
@@ -39,17 +41,27 @@ def mock_nodeports(mocker: MockerFixture) -> None:
 # TESTS
 
 
+def test_list_state_dirs(
+    cli_runner: CliRunner, mock_rabbitmq: None, mock_data_manager: None
+):
+    result = cli_runner.invoke(main, ["state-list-dirs"])
+    assert result.exit_code == os.EX_OK, result.stdout
+    assert result.stdout.strip() == "\n".join(
+        [f"Entries in /data/state_dir{i}: []" for i in range(4)]
+    )
+
+
 def test_outputs_push_interface(
     cli_runner: CliRunner, mock_rabbitmq: None, mock_data_manager: None
 ):
     result = cli_runner.invoke(main, ["state-save"])
-    assert result.exit_code == 0
+    assert result.exit_code == os.EX_OK, result.stdout
     assert result.stdout == "state save finished successfully\n"
 
 
 def test_state_save_interface(
     cli_runner: CliRunner, mock_rabbitmq: None, mock_nodeports: None
 ):
     result = cli_runner.invoke(main, ["outputs-push"])
-    assert result.exit_code == 0
+    assert result.exit_code == os.EX_OK, result.stdout
     assert result.stdout == "output ports push finished successfully\n"