vantage6 5.0.0a0__tar.gz → 5.0.0a7__tar.gz

{vantage6-5.0.0a0 → vantage6-5.0.0a7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vantage6
-Version: 5.0.0a0
+Version: 5.0.0a7
 Summary: vantage6 command line interface
 Home-page: https://github.com/vantage6/vantage6
 Requires-Python: >=3.10

{vantage6-5.0.0a0 → vantage6-5.0.0a7}/setup.py

@@ -38,12 +38,12 @@ setup(
         "copier==9.2.0",
         "docker==7.1.0",
         "ipython==8.10.0",
-        "jinja2==3.1.4",
+        "jinja2==3.1.5",
         "pandas>=1.5.3",
         "questionary==1.10.0",
         "rich==13.5.2",
         "schema==0.7.5",
-        "SQLAlchemy==1.4.46",
+        "sqlalchemy==2.0.37",
         f'vantage6-common == {version_ns["__version__"]}',
         f'vantage6-client == {version_ns["__version__"]}',
     ],

{vantage6-5.0.0a0 → vantage6-5.0.0a7}/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,6 +277,24 @@ class NodeCLITest(unittest.TestCase):
 
         self.assertEqual(result.exit_code, 0)
 
+    @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")
+    @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()
+        with runner.isolated_filesystem():
+            result = runner.invoke(cli_node_restart, ["--name", "iknl"])
+        self.assertEqual(result.exit_code, 0)
+
     @patch("vantage6.cli.node.attach.time")
     @patch("vantage6.cli.node.attach.print_log_worker")
     @patch("docker.DockerClient.containers")

{vantage6-5.0.0a0 → vantage6-5.0.0a7}/tests_cli/test_server_cli.py

@@ -112,7 +112,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."""

{vantage6-5.0.0a0 → vantage6-5.0.0a7}/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-5.0.0a7/vantage6/cli/__build__

@@ -0,0 +1 @@
+7

vantage6-5.0.0a7/vantage6/cli/__init__.py

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

{vantage6-5.0.0a0 → vantage6-5.0.0a7}/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-5.0.0a0 → vantage6-5.0.0a7}/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-5.0.0a7/vantage6/cli/algostore/attach.py

@@ -0,0 +1,49 @@
+import click
+import docker
+import questionary as q
+
+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.start import attach_logs
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
+
+
+@click.command()
+@click.option("-n", "--name", default=None, help="configuration name")
+@click.option("--system", "system_folders", flag_value=True)
+@click.option(
+    "--user", "system_folders", flag_value=False, default=DEFAULT_SERVER_SYSTEM_FOLDERS
+)
+def cli_algo_store_attach(name: str, system_folders: bool) -> None:
+    """
+    Show the server 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 not name:
+        try:
+            name = q.select(
+                "Select the algorithm store you wish to attach:",
+                choices=running_server_names,
+            ).unsafe_ask()
+        except KeyboardInterrupt:
+            error("Aborted by user!")
+            return
+    else:
+        post_fix = "system" if system_folders else "user"
+        name = f"{APPNAME}-{name}-{post_fix}-{InstanceType.ALGORITHM_STORE}"
+
+    if name in running_server_names:
+        container = client.containers.get(name)
+        attach_logs(container, InstanceType.ALGORITHM_STORE)
+    else:
+        error(f"{Fore.RED}{name}{Style.RESET_ALL} is not running!")

{vantage6-5.0.0a0 → vantage6-5.0.0a7}/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-5.0.0a0 → vantage6-5.0.0a7}/vantage6/cli/cli.py

@@ -17,6 +17,7 @@ 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
@@ -75,6 +76,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")

{vantage6-5.0.0a0 → vantage6-5.0.0a7}/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-5.0.0a0 → vantage6-5.0.0a7}/vantage6/cli/common/utils.py

@@ -38,10 +38,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 +139,22 @@ 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])