vantage6 5.0.0a0__py3-none-any.whl → 5.0.0a9__py3-none-any.whl

tests_cli/test_node_cli.py

@@ -17,6 +17,7 @@ from vantage6.cli.node.list import cli_node_list
 from vantage6.cli.node.new import cli_node_new_configuration
 from vantage6.cli.node.files import cli_node_files
 from vantage6.cli.node.start import cli_node_start
+from vantage6.cli.node.restart import cli_node_restart
 from vantage6.cli.node.stop import cli_node_stop
 from vantage6.cli.node.attach import cli_node_attach
 from vantage6.cli.node.create_private_key import cli_node_create_private_key
@@ -85,7 +86,7 @@ class NodeCLITest(unittest.TestCase):
         )
 
     @patch("vantage6.cli.node.new.configuration_wizard")
-    @patch("vantage6.cli.node.new.check_config_writeable")
+    @patch("vantage6.cli.node.new.ensure_config_dir_writable")
     @patch("vantage6.cli.node.common.NodeContext")
     def test_new_config(self, context, permissions, wizard):
         """No error produced when creating new configuration."""
@@ -147,7 +148,7 @@ class NodeCLITest(unittest.TestCase):
         # check non-zero exit code
         self.assertEqual(result.exit_code, 1)
 
-    @patch("vantage6.cli.node.new.check_config_writeable")
+    @patch("vantage6.cli.node.new.ensure_config_dir_writable")
     @patch("vantage6.cli.node.common.NodeContext")
     def test_new_write_permissions(self, context, permissions):
         """User needs write permissions."""
@@ -243,19 +244,28 @@ class NodeCLITest(unittest.TestCase):
 
         runner = CliRunner()
 
+        # Should fail when starting node with non-existing database CSV file
         with runner.isolated_filesystem():
             result = runner.invoke(cli_node_start, ["--name", "some-name"])
+        self.assertEqual(result.exit_code, 1)
 
+        # now do it with a SQL database which doesn't have to be an existing file
+        ctx.databases = [{"label": "some_label", "uri": "data.db", "type": "sql"}]
+        with runner.isolated_filesystem():
+            result = runner.invoke(cli_node_start, ["--name", "some-name"])
         self.assertEqual(result.exit_code, 0)
 
+    def _setup_stop_test(self, containers):
+        container1 = MagicMock()
+        container1.name = f"{APPNAME}-iknl-user"
+        containers.list.return_value = [container1]
+
     @patch("docker.DockerClient.containers")
     @patch("vantage6.cli.node.stop.check_docker_running", return_value=True)
     @patch("vantage6.cli.node.stop.NodeContext")
     @patch("vantage6.cli.node.stop.delete_volume_if_exists")
     def test_stop(self, delete_volume, node_context, check_docker, containers):
-        container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-user"
-        containers.list.return_value = [container1]
+        self._setup_stop_test(containers)
 
         runner = CliRunner()
 
@@ -267,30 +277,31 @@ class NodeCLITest(unittest.TestCase):
 
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.node.attach.time")
-    @patch("vantage6.cli.node.attach.print_log_worker")
     @patch("docker.DockerClient.containers")
-    @patch("vantage6.cli.node.attach.check_docker_running", return_value=True)
-    def test_attach(self, check_docker, containers, log_worker, time_):
-        """Attach docker logs without errors."""
-        container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-user"
-        containers.list.return_value = [container1]
-
-        log_worker.return_value = ""
-        time_.sleep.side_effect = KeyboardInterrupt()
-
+    @patch("vantage6.cli.node.stop.check_docker_running", return_value=True)
+    @patch("vantage6.cli.node.stop.NodeContext")
+    @patch("vantage6.cli.node.stop.delete_volume_if_exists")
+    @patch("vantage6.cli.node.restart.subprocess.run")
+    def test_restart(
+        self, subprocess_run, delete_volume, node_context, check_docker, containers
+    ):
+        """Restart a node without errors."""
+        self._setup_stop_test(containers)
+        # The subprocess.run() function is called with the command to start the node.
+        # Unfortunately it is hard to test this, so we just return a successful run
+        subprocess_run.return_value = MagicMock(returncode=0)
         runner = CliRunner()
-        result = runner.invoke(cli_node_attach, ["--name", "iknl"])
-
-        self.assertEqual(
-            result.output,
-            "[info ] - Closing log file. Keyboard Interrupt.\n"
-            "[info ] - Note that your node is still running! Shut it down "
-            "with 'v6 node stop'\n",
-        )
+        with runner.isolated_filesystem():
+            result = runner.invoke(cli_node_restart, ["--name", "iknl"])
         self.assertEqual(result.exit_code, 0)
 
+    @patch("vantage6.cli.node.attach.attach_logs")
+    def test_attach(self, attach_logs):
+        """Attach docker logs without errors."""
+        runner = CliRunner()
+        runner.invoke(cli_node_attach)
+        attach_logs.assert_called_once_with("app=node")
+
     @patch("vantage6.cli.node.clean.q")
     @patch("docker.DockerClient.volumes")
     @patch("vantage6.cli.node.clean.check_docker_running", return_value=True)

tests_cli/test_server_cli.py

@@ -5,6 +5,7 @@ from pathlib import Path
 from click.testing import CliRunner
 
 from vantage6.common.globals import APPNAME, InstanceType
+from vantage6.cli.common.utils import attach_logs
 from vantage6.cli.server.start import cli_server_start
 from vantage6.cli.server.list import cli_server_configuration_list
 from vantage6.cli.server.files import cli_server_files
@@ -112,7 +113,7 @@ class ServerCLITest(unittest.TestCase):
         self.assertEqual(result.exit_code, 0)
 
     @patch("vantage6.cli.server.new.configuration_wizard")
-    @patch("vantage6.cli.server.new.check_config_writeable")
+    @patch("vantage6.cli.server.new.ensure_config_dir_writable")
     @patch("vantage6.cli.server.new.ServerContext")
     def test_new(self, context, permissions, wizard):
         """New configuration without errors."""
@@ -141,18 +142,38 @@ class ServerCLITest(unittest.TestCase):
         self.assertIsNone(result.exception)
         self.assertEqual(result.exit_code, 0)
 
-    @patch("vantage6.cli.server.attach.time.sleep")
-    @patch("docker.DockerClient.containers")
-    def test_attach(self, containers, sleep):
-        """Attach log to the console without errors."""
-        container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER}"
-        containers.list.return_value = [container1]
-
-        sleep.side_effect = KeyboardInterrupt("Boom!")
-
+    @patch("vantage6.cli.server.attach.attach_logs")
+    def test_attach(self, attach_logs):
+        """Attach logs to the console without errors."""
         runner = CliRunner()
-        result = runner.invoke(cli_server_attach, ["--name", "iknl"])
+        result = runner.invoke(cli_server_attach)
 
         self.assertIsNone(result.exception)
         self.assertEqual(result.exit_code, 0)
+        attach_logs.assert_called_once_with(
+            "app=vantage6-server", "component=vantage6-server"
+        )
+
+    @patch("vantage6.cli.common.utils.Popen")
+    def test_attach_logs(self, mock_popen):
+        # Mock the Popen instance and its methods
+        mock_process = mock_popen.return_value
+        mock_process.wait.return_value = None
+
+        # Call the function with a sample label
+        attach_logs("app=node", "env=dev")
+
+        # Construct the expected command
+        expected_command = [
+            "devspace",
+            "logs",
+            "--follow",
+            "--label-selector",
+            "app=node,env=dev",
+        ]
+
+        # Verify that Popen was called with the expected command
+        mock_popen.assert_called_once_with(expected_command, stdout=None, stderr=None)
+
+        # Verify that wait was called on the process
+        mock_process.wait.assert_called_once()

tests_cli/test_wizard.py

@@ -33,8 +33,8 @@ class WizardTest(unittest.TestCase):
         """An error is printed when docker is not running"""
 
         with patch(f"{module_path}.q") as q:
-            q.prompt.side_effect = self.prompts
-            q.confirm.return_value.ask.side_effect = [
+            q.unsafe_prompt.side_effect = self.prompts
+            q.confirm.return_value.unsafe_ask.side_effect = [
                 True,  # add a database
                 False,  # don't enable two-factor authentication
                 True,  # add VPN server
@@ -79,8 +79,8 @@ class WizardTest(unittest.TestCase):
 
     def test_server_wizard(self):
         with patch(f"{module_path}.q") as q:
-            q.prompt.side_effect = self.prompts
-            q.confirm.return_value.ask.side_effect = [
+            q.unsafe_prompt.side_effect = self.prompts
+            q.confirm.return_value.unsafe_ask.side_effect = [
                 True,
                 True,
                 True,
@@ -134,7 +134,7 @@ class WizardTest(unittest.TestCase):
         available_configurations.return_value = [[config], []]
 
         with patch(f"{module_path}.q") as q:
-            q.select.return_value.ask.return_value = "vtg6"
+            q.select.return_value.unsafe_ask.return_value = "vtg6"
             name = select_configuration_questionaire(InstanceType.NODE, True)
 
         self.assertEqual(name, "vtg6")

vantage6/cli/__build__

@@ -1 +1 @@
-0
+9

vantage6/cli/__init__.py

@@ -1,3 +1,3 @@
-""" Command line interface for the vantage6 infrastructure. """
+"""Command line interface for the vantage6 infrastructure."""
 
 from ._version import version_info, __version__  # noqa: F401

vantage6/cli/algorithm/create.py

@@ -33,14 +33,11 @@ def cli_algorithm_create(name: str, directory: str) -> dict:
     can be used to build an appropriate Docker image that can be used as a
     vantage6 algorithm.
     """
-    if not name:
-        name = q.text("Name of your new algorithm:").ask()
-
-    if not directory:
-        default_dir = str(Path(os.getcwd()) / name)
-        directory = q.text(
-            "Directory to put the algorithm in:", default=default_dir
-        ).ask()
+    try:
+        name, directory = _get_user_input(name, directory)
+    except KeyboardInterrupt:
+        info("Aborted by user!")
+        return
 
     # Create the template. The `unsafe` flag is used to allow running a Python script
     # after creating the template that cleans up some things.
@@ -49,3 +46,24 @@ def cli_algorithm_create(name: str, directory: str) -> dict:
     )
     info("Template created!")
     info(f"You can find your new algorithm in: {directory}")
+
+
+def _get_user_input(name: str, directory: str) -> None:
+    """Get user input for the algorithm creation
+
+    Parameters
+    ----------
+    name : str
+        Name for the new algorithm
+    directory : str
+        Directory to put the algorithm into
+    """
+    if not name:
+        name = q.text("Name of your new algorithm:").unsafe_ask()
+
+    if not directory:
+        default_dir = str(Path(os.getcwd()) / name)
+        directory = q.text(
+            "Directory to put the algorithm in:", default=default_dir
+        ).unsafe_ask()
+    return name, directory

vantage6/cli/algorithm/update.py

@@ -34,7 +34,11 @@ def cli_algorithm_update(directory: str, change_answers: bool) -> dict:
     """
     if not directory:
         default_dir = str(Path(os.getcwd()))
-        directory = q.text("Algorithm directory:", default=default_dir).ask()
+        try:
+            directory = q.text("Algorithm directory:", default=default_dir).unsafe_ask()
+        except KeyboardInterrupt:
+            info("Aborted by user!")
+            return
 
     info("Updating template...")
     try:

vantage6/cli/algostore/attach.py

@@ -1,32 +1,13 @@
 import click
-import docker
 
-from colorama import Fore, Style
-
-from vantage6.common import error
-from vantage6.common.docker.addons import check_docker_running
-from vantage6.common.globals import APPNAME, InstanceType
-from vantage6.cli.common.decorator import click_insert_context
-from vantage6.cli.common.start import attach_logs
-from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
+from vantage6.common import info
+from vantage6.cli.common.utils import attach_logs
 
 
 @click.command()
-@click_insert_context(InstanceType.ALGORITHM_STORE)
-def cli_algo_store_attach(ctx: AlgorithmStoreContext) -> None:
+def cli_algo_store_attach() -> None:
     """
-    Show the server logs in the current console.
+    Show the store logs in the current console.
     """
-    check_docker_running()
-    client = docker.from_env()
-
-    running_servers = client.containers.list(
-        filters={"label": f"{APPNAME}-type={InstanceType.ALGORITHM_STORE}"}
-    )
-    running_server_names = [container.name for container in running_servers]
-
-    if ctx.docker_container_name in running_server_names:
-        container = client.containers.get(ctx.docker_container_name)
-        attach_logs(container, InstanceType.ALGORITHM_STORE)
-    else:
-        error(f"{Fore.RED}{ctx.name}{Style.RESET_ALL} is not running!")
+    info("Attaching to store logs...")
+    attach_logs("app=store", "component=store-server")

vantage6/cli/algostore/new.py

@@ -1,7 +1,7 @@
 import click
 from colorama import Fore, Style
 
-from vantage6.common import info, error, check_config_writeable
+from vantage6.common import info, error, ensure_config_dir_writable
 from vantage6.common.globals import InstanceType
 from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
 from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
@@ -36,7 +36,7 @@ def cli_algo_store_new(name: str, system_folders: bool) -> None:
         exit(1)
 
     # Check that we can write in this folder
-    if not check_config_writeable(system_folders):
+    if not ensure_config_dir_writable(system_folders):
         error("Your user does not have write access to all folders. Exiting")
         info(
             f"Create a new server using '{Fore.GREEN}v6 algorithm-store new "
@@ -45,7 +45,13 @@ def cli_algo_store_new(name: str, system_folders: bool) -> None:
         exit(1)
 
     # create config in ctx location
-    cfg_file = configuration_wizard(InstanceType.ALGORITHM_STORE, name, system_folders)
+    try:
+        cfg_file = configuration_wizard(
+            InstanceType.ALGORITHM_STORE, name, system_folders
+        )
+    except KeyboardInterrupt:
+        error("Configuration creation aborted.")
+        exit(1)
     info(f"New configuration created: {Fore.GREEN}{cfg_file}{Style.RESET_ALL}")
 
     flag = "" if system_folders else "--user"

vantage6/cli/cli.py

@@ -17,18 +17,16 @@ from vantage6.cli.node.files import cli_node_files
 from vantage6.cli.node.list import cli_node_list
 from vantage6.cli.node.new import cli_node_new_configuration
 from vantage6.cli.node.remove import cli_node_remove
+from vantage6.cli.node.restart import cli_node_restart
 from vantage6.cli.node.set_api_key import cli_node_set_api_key
 from vantage6.cli.node.start import cli_node_start
 from vantage6.cli.node.stop import cli_node_stop
 from vantage6.cli.node.version import cli_node_version
-from vantage6.cli.dev.create import create_demo_network
-from vantage6.cli.dev.remove import remove_demo_network
-from vantage6.cli.dev.start import start_demo_network
-from vantage6.cli.dev.stop import stop_demo_network
 from vantage6.cli.algorithm.create import cli_algorithm_create
 from vantage6.cli.algorithm.update import cli_algorithm_update
 from vantage6.cli.test.feature_tester import cli_test_features
-from vantage6.cli.test.integration_test import cli_test_integration
+
+# from vantage6.cli.test.integration_test import cli_test_integration
 from vantage6.cli.algostore.attach import cli_algo_store_attach
 from vantage6.cli.algostore.new import cli_algo_store_new
 from vantage6.cli.algostore.start import cli_algo_store_start
@@ -75,6 +73,7 @@ cli_node.add_command(cli_node_files, name="files")
 cli_node.add_command(cli_node_list, name="list")
 cli_node.add_command(cli_node_new_configuration, name="new")
 cli_node.add_command(cli_node_remove, name="remove")
+cli_node.add_command(cli_node_restart, name="restart")
 cli_node.add_command(cli_node_set_api_key, name="set-api-key")
 cli_node.add_command(cli_node_start, name="start")
 cli_node.add_command(cli_node_stop, name="stop")
@@ -91,11 +90,7 @@ def cli_dev() -> None:
     """
 
 
-# Define the commands for the dev group
-cli_dev.add_command(create_demo_network, name="create-demo-network")
-cli_dev.add_command(remove_demo_network, name="remove-demo-network")
-cli_dev.add_command(start_demo_network, name="start-demo-network")
-cli_dev.add_command(stop_demo_network, name="stop-demo-network")
+# TODO add commands for the dev group
 
 
 # Define the algorithm group
@@ -121,7 +116,7 @@ def cli_test() -> None:
 
 # Define the commands for the test group
 cli_test.add_command(cli_test_features, name="feature-test")
-cli_test.add_command(cli_test_integration, name="integration-test")
+# cli_test.add_command(cli_test_integration, name="integration-test")
 
 
 # Define the algorithm-store group

vantage6/cli/common/start.py

@@ -241,7 +241,7 @@ def mount_database(
     # try to mount database
     uri = ctx.config["uri"]
     url = make_url(uri)
-    environment_vars = None
+    environment_vars = {}
     mount = None
 
     # If host is None, we're dealing with a file-based DB, like SQLite

vantage6/cli/common/utils.py

@@ -3,6 +3,7 @@ from colorama import Fore, Style
 import click
 from typing import Iterable
 import docker
+from subprocess import Popen
 
 
 from vantage6.common import warning, error
@@ -38,10 +39,14 @@ def get_server_name(
                 f"{instance_type}s that are running"
             )
             exit(1)
-        name = q.select(
-            f"Select the {instance_type} you wish to inspect:",
-            choices=running_server_names,
-        ).ask()
+        try:
+            name = q.select(
+                f"Select the {instance_type} you wish to inspect:",
+                choices=running_server_names,
+            ).unsafe_ask()
+        except KeyboardInterrupt:
+            error("Aborted by user!")
+            exit(1)
     else:
         post_fix = "system" if system_folders else "user"
         name = f"{APPNAME}-{name}-{post_fix}"
@@ -135,3 +140,36 @@ def print_log_worker(logs_stream: Iterable[bytes]) -> None:
                 "the container."
             )
             print(log)
+
+
+def get_name_from_container_name(container_name: str) -> str:
+    """
+    Get the node/server/store name from a container name.
+
+    Parameters
+    ----------
+    container_name : str
+        The name of the container
+
+    Returns
+    -------
+    str
+        The name of the node/server/store
+    """
+    # Container name is structured as: f"{APPNAME}-{name}-{post_fix}"
+    # Take into account that name can contain '-'
+    return "-".join(container_name.split("-")[1:-1])
+
+
+def attach_logs(*labels: list[str]) -> None:
+    """
+    Attach to the logs of the given labels.
+
+    Parameters
+    ----------
+    labels : list[str]
+        The labels to attach to
+    """
+    command = ["devspace", "logs", "--follow", "--label-selector", ",".join(labels)]
+    process = Popen(command, stdout=None, stderr=None)
+    process.wait()