vantage6 4.3.0b3__py3-none-any.whl → 4.3.0b5__py3-none-any.whl

tests_cli/test_server_cli.py

@@ -19,7 +19,7 @@ class ServerCLITest(unittest.TestCase):
     @patch("vantage6.cli.server.start.docker.types.Mount")
     @patch("os.makedirs")
     @patch("vantage6.cli.common.start.pull_if_newer")
-    @patch("vantage6.cli.server.common.ServerContext")
+    @patch("vantage6.cli.common.decorator.get_context")
     @patch("vantage6.cli.server.start.docker.from_env")
     @patch("vantage6.cli.common.start.check_docker_running", return_value=True)
     def test_start(
@@ -73,7 +73,7 @@ class ServerCLITest(unittest.TestCase):
         self.assertEqual(result.exit_code, 0)
         self.assertIsNone(result.exception)
 
-    @patch("vantage6.cli.server.common.ServerContext")
+    @patch("vantage6.cli.common.decorator.get_context")
     def test_files(self, context):
         """Configuration files without errors."""
 
@@ -92,7 +92,7 @@ class ServerCLITest(unittest.TestCase):
     @patch("vantage6.cli.server.import_.print_log_worker")
     @patch("vantage6.cli.server.import_.click.Path")
     @patch("vantage6.cli.server.import_.check_docker_running", return_value=True)
-    @patch("vantage6.cli.server.common.ServerContext")
+    @patch("vantage6.cli.common.decorator.get_context")
     def test_import(self, context, docker_check, click_path, log, containers):
         """Import entities without errors."""
         click_path.return_value = MagicMock()

vantage6/cli/__build__

@@ -1 +1 @@
-3
+5

vantage6/cli/algostore/attach.py

@@ -6,13 +6,13 @@ 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 insert_context
+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
 
 
 @click.command()
-@insert_context(InstanceType.ALGORITHM_STORE)
+@click_insert_context(InstanceType.ALGORITHM_STORE)
 def cli_algo_store_attach(ctx: AlgorithmStoreContext) -> None:
     """
     Show the server logs in the current console.

vantage6/cli/algostore/files.py

@@ -0,0 +1,17 @@
+import click
+
+from vantage6.common import info
+from vantage6.cli.context.server import ServerContext
+from vantage6.cli.common.decorator import click_insert_context
+from vantage6.common.globals import InstanceType
+
+
+@click.command()
+@click_insert_context(type_=InstanceType.ALGORITHM_STORE)
+def cli_algo_store_files(ctx: ServerContext) -> None:
+    """
+    List files that belong to a particular server instance.
+    """
+    info(f"Configuration file = {ctx.config_file}")
+    info(f"Log file           = {ctx.log_file}")
+    info(f"Database           = {ctx.get_database_uri()}")

vantage6/cli/algostore/list.py

@@ -0,0 +1,15 @@
+import click
+
+from vantage6.common.docker.addons import check_docker_running
+from vantage6.common.globals import InstanceType
+from vantage6.cli.common.utils import get_server_configuration_list
+
+
+@click.command()
+def cli_algo_store_configuration_list() -> None:
+    """
+    Print the available server configurations.
+    """
+    check_docker_running()
+
+    get_server_configuration_list(InstanceType.ALGORITHM_STORE)

vantage6/cli/algostore/start.py

@@ -13,7 +13,7 @@ from vantage6.cli.common.start import (
 )
 from vantage6.cli.globals import AlgoStoreGlobals
 from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
-from vantage6.cli.common.decorator import insert_context
+from vantage6.cli.common.decorator import click_insert_context
 
 
 @click.command()
@@ -36,7 +36,7 @@ from vantage6.cli.common.decorator import insert_context
     default=False,
     help="Print server logs to the console after start",
 )
-@insert_context(InstanceType.ALGORITHM_STORE)
+@click_insert_context(InstanceType.ALGORITHM_STORE)
 def cli_algo_store_start(
     ctx: AlgorithmStoreContext,
     ip: str,

vantage6/cli/algostore/stop.py

@@ -8,12 +8,12 @@ from vantage6.common.docker.addons import (
     remove_container_if_exists,
 )
 from vantage6.common.globals import APPNAME, InstanceType
-from vantage6.cli.common.decorator import insert_context
+from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
 
 
 @click.command()
-@insert_context(InstanceType.ALGORITHM_STORE)
+@click_insert_context(InstanceType.ALGORITHM_STORE)
 @click.option("--all", "all_servers", flag_value=True, help="Stop all servers")
 def cli_algo_store_stop(ctx: AlgorithmStoreContext, all_servers: bool):
     """

vantage6/cli/cli.py

@@ -33,6 +33,8 @@ 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
 from vantage6.cli.algostore.stop import cli_algo_store_stop
+from vantage6.cli.algostore.files import cli_algo_store_files
+from vantage6.cli.algostore.list import cli_algo_store_configuration_list
 
 
 # Define the server group
@@ -134,6 +136,8 @@ cli_algo_store.add_command(cli_algo_store_attach, name="attach")
 cli_algo_store.add_command(cli_algo_store_new, name="new")
 cli_algo_store.add_command(cli_algo_store_start, name="start")
 cli_algo_store.add_command(cli_algo_store_stop, name="stop")
+cli_algo_store.add_command(cli_algo_store_files, name="files")
+cli_algo_store.add_command(cli_algo_store_configuration_list, name="list")
 
 
 # Define the overall group

vantage6/cli/common/decorator.py

@@ -10,7 +10,7 @@ from vantage6.cli.context import select_context_class, get_context
 
 # TODO to make this decorator usable by nodes as well, we should make the
 # default for --user/--system configurable
-def insert_context(type_: InstanceType) -> callable:
+def click_insert_context(type_: InstanceType) -> callable:
     """
     Supply the Click function with an additional context parameter. The context
     is passed to the function as the first argument.
@@ -27,7 +27,7 @@ def insert_context(type_: InstanceType) -> callable:
 
     Examples
     --------
-    >>> @insert_context(InstanceType.SERVER)
+    >>> @click_insert_context(InstanceType.SERVER)
     >>> def cli_server_start(ctx: ServerContext, *args, **kwargs) -> None:
     >>>     pass
     """

vantage6/cli/common/utils.py

@@ -0,0 +1,116 @@
+import questionary as q
+import docker
+import click
+
+from colorama import Fore, Style
+
+from vantage6.common import warning, error
+from vantage6.common.globals import APPNAME, InstanceType
+from vantage6.cli.context import select_context_class
+
+
+def get_server_name(
+    name: str,
+    system_folders: bool,
+    running_server_names: list[str],
+    instance_type: InstanceType,
+) -> str:
+    """
+    Get the version of a running server.
+
+    Parameters
+    ----------
+    name : str
+        Name of the server to get the version from
+    system_folders : bool
+        Whether to use system folders or not
+    running_server_names : list[str]
+        The names of the running servers
+    instance_type : InstanceType
+        The type of instance to get the running servers from
+    """
+
+    if not name:
+        if not running_server_names:
+            error(
+                f"No {instance_type}s are running! You can only check the version for "
+                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()
+    else:
+        post_fix = "system" if system_folders else "user"
+        name = f"{APPNAME}-{name}-{post_fix}"
+    return name
+
+
+def get_running_servers(
+    client: docker.DockerClient, instance_type: InstanceType
+) -> list[str]:
+    """Get the running servers of a certain type.
+
+    Parameters
+    ----------
+    client : docker.DockerClient
+        The docker client to use
+    instance_type : InstanceType
+        The type of instance to get the running servers from
+
+    Returns
+    -------
+    list[str]
+        The names of the running servers
+    """
+    running_servers = client.containers.list(
+        filters={"label": f"{APPNAME}-type={instance_type}"}
+    )
+    return [server.name for server in running_servers]
+
+
+def get_server_configuration_list(instance_type: InstanceType.SERVER) -> None:
+    """
+    Print list of available server configurations.
+
+    Parameters
+    ----------
+    instance_type : InstanceType
+        The type of instance to get the configurations for
+    """
+    client = docker.from_env()
+    ctx_class = select_context_class(instance_type)
+
+    running_server_names = get_running_servers(client, instance_type)
+    header = "\nName" + (21 * " ") + "Status" + (10 * " ") + "System/User"
+
+    click.echo(header)
+    click.echo("-" * len(header))
+
+    running = Fore.GREEN + "Running" + Style.RESET_ALL
+    stopped = Fore.RED + "Not running" + Style.RESET_ALL
+
+    # system folders
+    configs, f1 = ctx_class.available_configurations(system_folders=True)
+    for config in configs:
+        status = (
+            running
+            if f"{APPNAME}-{config.name}-system-{instance_type}" in running_server_names
+            else stopped
+        )
+        click.echo(f"{config.name:25}" f"{status:25} System ")
+
+    # user folders
+    configs, f2 = ctx_class.available_configurations(system_folders=False)
+    for config in configs:
+        status = (
+            running
+            if f"{APPNAME}-{config.name}-user-{instance_type}" in running_server_names
+            else stopped
+        )
+        click.echo(f"{config.name:25}" f"{status:25} User   ")
+
+    click.echo("-" * 85)
+    if len(f1) + len(f2):
+        warning(f"{Fore.RED}Failed imports: {len(f1)+len(f2)}{Style.RESET_ALL}")

vantage6/cli/configuration_manager.py

@@ -24,7 +24,7 @@ class ServerConfiguration(Configuration):
         "description": Use(str),
         "ip": Use(str),
         "port": Use(int),
-        "api_path": Use(str),
+        Optional("api_path"): str,
         "uri": Use(str),
         "allow_drop_all": Use(bool),
         "logging": {**LOGGING_VALIDATORS, "file": Use(str)},

vantage6/cli/configuration_wizard.py

@@ -141,7 +141,10 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
 
     private_key = "" if not encryption else q.text("Path to private key file:").ask()
 
-    config["encryption"] = {"enabled": encryption == "true", "private_key": private_key}
+    config["encryption"] = {
+        "enabled": encryption is True or encryption == "true",
+        "private_key": private_key,
+    }
 
     return config
 
@@ -276,6 +279,15 @@ def server_configuration_questionaire(instance_name: str) -> dict:
     if is_mfa:
         config["two_factor_auth"] = is_mfa
 
+    current_server_url = f"http://localhost:{config['port']}{config['api_path']}"
+    config["server_url"] = q.text(
+        "What is the server url exposed to the users? If you are running a"
+        " development server running locally, this is the same as the "
+        "server url. If you are running a production server, this is the "
+        "url that users will connect to.",
+        default=current_server_url,
+    ).ask()
+
     is_add_vpn = q.confirm("Do you want to add a VPN server?", default=False).ask()
     if is_add_vpn:
         vpn_config = q.prompt(

vantage6/cli/context/__init__.py

@@ -7,6 +7,7 @@ All classes are derived from the abstract AppContext class and provide the
 vantage6 applications with naming conventions, standard file locations, and
 more.
 """
+
 from colorama import Fore, Style
 
 from vantage6.common.globals import InstanceType

vantage6/cli/dev/create.py

@@ -431,12 +431,10 @@ def create_demo_network(
             f"{Style.RESET_ALL}."
         )
     else:
-        error(
-            f"Configuration {Fore.RED}{server_name}{Style.RESET_ALL} " "already exists!"
-        )
+        error(f"Configuration {Fore.RED}{server_name}{Style.RESET_ALL} already exists!")
         exit(1)
     (node_config, server_import_config, server_config) = demo
-    ctx = get_server_context(server_name, True)
+    ctx = get_server_context(server_name, True, ServerContext)
     click_ctx.invoke(
         cli_server_import,
         ctx=ctx,

vantage6/cli/dev/remove.py

@@ -8,14 +8,14 @@ import click
 from vantage6.common import info
 from vantage6.cli.context.server import ServerContext
 from vantage6.cli.context.node import NodeContext
-from vantage6.cli.server.common import click_insert_context
+from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.server.remove import cli_server_remove
 from vantage6.cli.utils import remove_file
 from vantage6.common.globals import InstanceType
 
 
 @click.command()
-@click_insert_context
+@click_insert_context(type_="server")
 @click.pass_context
 def remove_demo_network(click_ctx: click.Context, ctx: ServerContext) -> None:
     """Remove all related demo network files and folders.

vantage6/cli/dev/start.py

@@ -3,12 +3,12 @@ import click
 
 from vantage6.cli.context.server import ServerContext
 from vantage6.cli.context.node import NodeContext
-from vantage6.cli.server.common import click_insert_context
+from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.server.start import cli_server_start
 
 
 @click.command()
-@click_insert_context
+@click_insert_context(type_="server")
 @click.option(
     "--server-image", type=str, default=None, help="Server Docker image to use"
 )

vantage6/cli/dev/stop.py

@@ -2,13 +2,13 @@ import click
 
 from vantage6.cli.context.server import ServerContext
 from vantage6.cli.context.node import NodeContext
-from vantage6.cli.server.common import click_insert_context
+from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.server.stop import cli_server_stop
 from vantage6.cli.node.stop import cli_node_stop
 
 
 @click.command()
-@click_insert_context
+@click_insert_context(type_="server")
 @click.pass_context
 def stop_demo_network(click_ctx: click.Context, ctx: ServerContext) -> None:
     """Stops a demo network's server and nodes.

vantage6/cli/globals.py

@@ -1,6 +1,7 @@
 """
 This module contains global variables that are used throughout the CLI.
 """
+
 from enum import Enum
 from pathlib import Path
 from vantage6.common.globals import APPNAME

vantage6/cli/node/common/__init__.py

@@ -1,6 +1,7 @@
 """
 Common functions that are used in node CLI commands
 """
+
 from typing import Iterable
 
 import questionary as q

vantage6/cli/node/start.py

@@ -198,7 +198,7 @@ def cli_node_start(
     # FIXME: should obtain mount points from DockerNodeContext
     mounts = [
         # (target, source)
-        (f"/mnt/log/{name}", str(ctx.log_dir)),
+        ("/mnt/log", str(ctx.log_dir)),
         ("/mnt/data", data_volume.name),
         ("/mnt/vpn", vpn_volume.name),
         ("/mnt/ssh", ssh_volume.name),

vantage6/cli/server/common/__init__.py

@@ -1,96 +1,19 @@
 from typing import Iterable
-from functools import wraps
 
 from docker.client import DockerClient
-import click
 from colorama import Fore, Style
 
 from vantage6.common import error, info
-from vantage6.common.globals import STRING_ENCODING, APPNAME, InstanceType
+from vantage6.common.globals import STRING_ENCODING, APPNAME
 from vantage6.common.docker.addons import remove_container, get_container
+from vantage6.common.context import AppContext
 
-from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
 from vantage6.cli.context.server import ServerContext
-from vantage6.cli.configuration_wizard import select_configuration_questionaire
 
 
-def click_insert_context(func: callable) -> callable:
-    """
-    Supply the Click function with additional context parameters. The context
-    is then passed to the function as the first argument.
-
-    Parameters
-    ----------
-    func : Callable
-        function you want the context to be passed to
-
-    Returns
-    -------
-    Callable
-        Click function with context
-    """
-
-    @click.option(
-        "-n", "--name", default=None, help="Name of the configuration you want to use."
-    )
-    @click.option(
-        "-c",
-        "--config",
-        default=None,
-        help="Absolute path to configuration-file; overrides NAME",
-    )
-    @click.option(
-        "--system",
-        "system_folders",
-        flag_value=True,
-        help="Use system folders instead of user folders. This is " "the default",
-    )
-    @click.option(
-        "--user",
-        "system_folders",
-        flag_value=False,
-        default=DEFAULT_SERVER_SYSTEM_FOLDERS,
-        help="Use user folders instead of system folders",
-    )
-    @wraps(func)
-    def func_with_context(
-        name: str, config: str, system_folders: bool, *args, **kwargs
-    ) -> callable:
-        """
-        Decorator function that adds the context to the function.
-
-        Returns
-        -------
-        Callable
-            Decorated function
-        """
-        # path to configuration file always overrides name
-        if config:
-            ctx = ServerContext.from_external_config_file(config, system_folders)
-        elif "ctx" in kwargs:
-            # if ctx is already in kwargs (typically when one click command
-            # calls another internally), use that existing ctx
-            ctx = kwargs.pop("ctx")
-        else:
-            # in case no name, ctx or config file is supplied, ask the user to
-            # select an existing config by name
-            if not name:
-                try:
-                    # select configuration if none supplied
-                    name = select_configuration_questionaire(
-                        InstanceType.SERVER, system_folders
-                    )
-                except Exception:
-                    error("No configurations could be found!")
-                    exit(1)
-
-            ctx = get_server_context(name, system_folders)
-        return func(ctx, *args, **kwargs)
-
-    return func_with_context
-
-
-def get_server_context(name: str, system_folders: bool) -> ServerContext:
+def get_server_context(
+    name: str, system_folders: bool, ctx_class: AppContext
+) -> AppContext:
     """
     Load the server context from the configuration file.
 
@@ -100,13 +23,15 @@ def get_server_context(name: str, system_folders: bool) -> ServerContext:
         Name of the server to inspect
     system_folders : bool
         Wether to use system folders or if False, the user folders
+    ctx_class : AppContext
+        Context class to be used. Derivative of AppContext class
 
     Returns
     -------
     ServerContext
         Server context object
     """
-    if not ServerContext.config_exists(name, system_folders):
+    if not ctx_class.config_exists(name, system_folders):
         scope = "system" if system_folders else "user"
         error(
             f"Configuration {Fore.RED}{name}{Style.RESET_ALL} does not "
@@ -116,10 +41,10 @@ def get_server_context(name: str, system_folders: bool) -> ServerContext:
 
     # We do not want to log this here, we do this in the container and not on
     # the host. We only want CLI logging here.
-    ServerContext.LOGGING_ENABLED = False
+    ctx_class.LOGGING_ENABLED = False
 
     # create server context, and initialize db
-    ctx = ServerContext(name, system_folders=system_folders)
+    ctx = ctx_class(name, system_folders=system_folders)
 
     return ctx
 

vantage6/cli/server/files.py

@@ -2,11 +2,11 @@ import click
 
 from vantage6.common import info
 from vantage6.cli.context.server import ServerContext
-from vantage6.cli.server.common import click_insert_context
+from vantage6.cli.common.decorator import click_insert_context
 
 
 @click.command()
-@click_insert_context
+@click_insert_context(type_="server")
 def cli_server_files(ctx: ServerContext) -> None:
     """
     List files that belong to a particular server instance.

vantage6/cli/server/import_.py

@@ -16,7 +16,8 @@ from vantage6.common.globals import (
 )
 from vantage6.cli.context.server import ServerContext
 from vantage6.cli.utils import check_config_name_allowed
-from vantage6.cli.server.common import click_insert_context, print_log_worker
+from vantage6.cli.common.decorator import click_insert_context
+from vantage6.cli.server.common import print_log_worker
 
 
 # TODO this method has a lot of duplicated code from `start`
@@ -41,7 +42,7 @@ from vantage6.cli.server.common import click_insert_context, print_log_worker
     help="Keep image after finishing. Useful for debugging",
 )
 @click.option("--wait", default=False, help="Wait for the import to finish")
-@click_insert_context
+@click_insert_context(type_="server")
 def cli_server_import(
     ctx: ServerContext,
     file: str,

vantage6/cli/server/list.py

@@ -1,12 +1,8 @@
 import click
-import docker
 
-from colorama import Fore, Style
-
-from vantage6.common import warning
 from vantage6.common.docker.addons import check_docker_running
-from vantage6.common.globals import APPNAME, InstanceType
-from vantage6.cli.context.server import ServerContext
+from vantage6.common.globals import InstanceType
+from vantage6.cli.common.utils import get_server_configuration_list
 
 
 @click.command()
@@ -15,45 +11,5 @@ def cli_server_configuration_list() -> None:
     Print the available server configurations.
     """
     check_docker_running()
-    client = docker.from_env()
-
-    running_server = client.containers.list(
-        filters={"label": f"{APPNAME}-type={InstanceType.SERVER}"}
-    )
-    running_node_names = []
-    for node in running_server:
-        running_node_names.append(node.name)
-
-    header = "\nName" + (21 * " ") + "Status" + (10 * " ") + "System/User"
-
-    click.echo(header)
-    click.echo("-" * len(header))
-
-    running = Fore.GREEN + "Running" + Style.RESET_ALL
-    stopped = Fore.RED + "Not running" + Style.RESET_ALL
-
-    # system folders
-    configs, f1 = ServerContext.available_configurations(system_folders=True)
-    for config in configs:
-        status = (
-            running
-            if f"{APPNAME}-{config.name}-system-{InstanceType.SERVER}"
-            in running_node_names
-            else stopped
-        )
-        click.echo(f"{config.name:25}" f"{status:25} System ")
-
-    # user folders
-    configs, f2 = ServerContext.available_configurations(system_folders=False)
-    for config in configs:
-        status = (
-            running
-            if f"{APPNAME}-{config.name}-user-{InstanceType.SERVER}"
-            in running_node_names
-            else stopped
-        )
-        click.echo(f"{config.name:25}" f"{status:25} User   ")
 
-    click.echo("-" * 85)
-    if len(f1) + len(f2):
-        warning(f"{Fore.RED}Failed imports: {len(f1)+len(f2)}{Style.RESET_ALL}")
+    get_server_configuration_list(InstanceType.SERVER)

vantage6/cli/server/remove.py

@@ -4,13 +4,13 @@ import questionary as q
 
 from vantage6.common import info
 from vantage6.common.docker.addons import check_docker_running
-from vantage6.cli.server.common import click_insert_context
+from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.context import ServerContext
 from vantage6.cli.utils import remove_file
 
 
 @click.command()
-@click_insert_context
+@click_insert_context(type_="server")
 @click.option("-f", "--force", "force", flag_value=True)
 def cli_server_remove(ctx: ServerContext, force: bool) -> None:
     """

vantage6/cli/server/shell.py

@@ -8,11 +8,11 @@ from vantage6.common import info, error, debug as debug_msg
 from vantage6.common.docker.addons import check_docker_running
 from vantage6.common.globals import APPNAME, InstanceType
 from vantage6.cli.context.server import ServerContext
-from vantage6.cli.server.common import click_insert_context
+from vantage6.cli.common.decorator import click_insert_context
 
 
 @click.command()
-@click_insert_context
+@click_insert_context(type_="server")
 def cli_server_shell(ctx: ServerContext) -> None:
     """
     Run an iPython shell within a running server. This can be used to modify

vantage6/cli/server/start.py

@@ -14,7 +14,8 @@ from vantage6.common.globals import (
 from vantage6.cli.globals import DEFAULT_UI_PORT, ServerGlobals
 from vantage6.cli.context.server import ServerContext
 from vantage6.cli.rabbitmq.queue_manager import RabbitMQManager
-from vantage6.cli.server.common import click_insert_context, stop_ui
+from vantage6.cli.server.common import stop_ui
+from vantage6.cli.common.decorator import click_insert_context
 from vantage6.cli.common.start import (
     attach_logs,
     check_for_start,
@@ -64,7 +65,7 @@ from vantage6.cli.common.start import (
     default=False,
     help="Print server logs to the console after start",
 )
-@click_insert_context
+@click_insert_context(type_="server")
 def cli_server_start(
     ctx: ServerContext,
     ip: str,

vantage6/cli/server/stop.py

@@ -17,7 +17,7 @@ from vantage6.common.docker.addons import (
 )
 from vantage6.common.globals import APPNAME, InstanceType
 from vantage6.cli.rabbitmq import split_rabbitmq_uri
-
+from vantage6.cli.context.server import ServerContext
 from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
 from vantage6.cli.server.common import get_server_context, stop_ui
 
@@ -91,7 +91,7 @@ def _stop_server_containers(
     scope = "system" if system_folders else "user"
     config_name = get_server_config_name(container_name, scope)
 
-    ctx = get_server_context(config_name, system_folders)
+    ctx = get_server_context(config_name, system_folders, ServerContext)
 
     # kill the UI container (if it exists)
     stop_ui(client, ctx)

vantage6/cli/server/version.py

@@ -1,10 +1,10 @@
 import click
-import questionary as q
 import docker
 
 from vantage6.common import error
 from vantage6.common.docker.addons import check_docker_running
-from vantage6.common.globals import APPNAME, InstanceType
+from vantage6.common.globals import InstanceType
+from vantage6.cli.common.utils import get_server_name, get_running_servers
 from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
 from vantage6.cli import __version__
 
@@ -22,24 +22,11 @@ def cli_server_version(name: str, system_folders: bool) -> None:
     check_docker_running()
     client = docker.from_env()
 
-    running_servers = client.containers.list(
-        filters={"label": f"{APPNAME}-type={InstanceType.SERVER}"}
-    )
-    running_server_names = [server.name for server in running_servers]
+    running_server_names = get_running_servers(client, InstanceType.SERVER)
 
-    if not name:
-        if not running_server_names:
-            error(
-                "No servers are running! You can only check the version for "
-                "servers that are running"
-            )
-            exit(1)
-        name = q.select(
-            "Select the server you wish to inspect:", choices=running_server_names
-        ).ask()
-    else:
-        post_fix = "system" if system_folders else "user"
-        name = f"{APPNAME}-{name}-{post_fix}"
+    name = get_server_name(
+        name, system_folders, running_server_names, InstanceType.SERVER
+    )
 
     if name in running_server_names:
         container = client.containers.get(name)

vantage6/cli/test/feature_tester.py

@@ -47,6 +47,12 @@ from vantage6.cli.test.common.diagnostic_runner import DiagnosticRunner
     help="Run the diagnostic test on only nodes that are online",
 )
 @click.option("--no-vpn", is_flag=True, help="Don't execute VPN tests")
+@click.option(
+    "--private-key",
+    type=str,
+    default=None,
+    help="Path to the private key for end-to-end encryption",
+)
 def cli_test_features(
     host: str,
     port: int,
@@ -58,6 +64,7 @@ def cli_test_features(
     all_nodes: bool,
     online_only: bool,
     no_vpn: bool,
+    private_key: str | None,
 ) -> list[dict]:
     """
     Run diagnostic checks on an existing vantage6 network.
@@ -74,7 +81,7 @@ def cli_test_features(
 
     client = UserClient(host=host, port=port, path=api_path, log_level="critical")
     client.authenticate(username=username, password=password)
-    client.setup_encryption(None)
+    client.setup_encryption(private_key)
     diagnose = DiagnosticRunner(client, collaboration, organizations, online_only)
     res = diagnose(base=True, vpn=not no_vpn)
     return res

vantage6/cli/utils.py

@@ -1,6 +1,7 @@
 """
 Utility functions for the CLI
 """
+
 from __future__ import annotations
 
 import re

{vantage6-4.3.0b3.dist-info → vantage6-4.3.0b5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vantage6
-Version: 4.3.0b3
+Version: 4.3.0b5
 Summary: vantage6 command line interface
 Home-page: https://github.com/vantage6/vantage6
 Requires-Python: >=3.10
@@ -15,8 +15,8 @@ Requires-Dist: questionary ==1.10.0
 Requires-Dist: rich ==13.5.2
 Requires-Dist: schema ==0.7.5
 Requires-Dist: SQLAlchemy ==1.4.46
-Requires-Dist: vantage6-common ==4.3.0b3
-Requires-Dist: vantage6-client ==4.3.0b3
+Requires-Dist: vantage6-common ==4.3.0b5
+Requires-Dist: vantage6-client ==4.3.0b5
 Provides-Extra: dev
 Requires-Dist: coverage ==6.4.4 ; extra == 'dev'
 Requires-Dist: black ; extra == 'dev'

{vantage6-4.3.0b3.dist-info → vantage6-4.3.0b5.dist-info}/RECORD

@@ -1,33 +1,36 @@
 tests_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests_cli/test_example.py,sha256=0fw_v-lgZEacshWSDwLNyLMA1_xc48bKUGM3ll-n1L0,146
 tests_cli/test_node_cli.py,sha256=FpK6MXQL_0i42k1hf4enfoLamCZ0Clv2cNLBryS-rEs,15758
-tests_cli/test_server_cli.py,sha256=gfbwp_JFsEv0MZlKZuemNhdNkU4sxCARHy4gTDCdZp0,5798
+tests_cli/test_server_cli.py,sha256=eGJx_XHzfcYlJC6ytc8tHu6nxkr9FqKws-lovp2WFks,5801
 tests_cli/test_wizard.py,sha256=ntYuXm3SWKvPgcE7wGVPM9ReWoPNMu9_UbDL6KAE1wU,3772
-vantage6/cli/__build__,sha256=TgdAhWK-24tgzgXB3s_jrRa3IjCWfeAfZAt-Rym0n84,1
+vantage6/cli/__build__,sha256=7y0SfeN7lCuq0GFF5UsMYZofIjJ7LrvPvsePVWSv450,1
 vantage6/cli/__init__.py,sha256=dEbhLHe9VfU3otY3CQkMVrj39uPGWjqzAvHW2B2Flgs,62
 vantage6/cli/_version.py,sha256=KQrzTJZVe-_U7oqr-s8Cgd2NFSkskimnkIIKa_7yXcc,695
-vantage6/cli/cli.py,sha256=OO--_SGHTFKM_SzuVu2WMfsOpeI5-r3ElM2H2xxVpI8,5630
-vantage6/cli/configuration_manager.py,sha256=gN-FINxV74Sj58FeSgwlDX-ZpWoOCw-e2l-1a0Bysu0,3501
-vantage6/cli/configuration_wizard.py,sha256=ig8oJumGbSB5PQY1Q8b0zV4R8v2xEzIvkeFqVu1x9PU,13818
-vantage6/cli/globals.py,sha256=ioATsNh41iWvupVPxpN85CrCZaasExptDFPfzzxD_MU,1641
-vantage6/cli/utils.py,sha256=J-LesedzLquJ5lWe4kOaPe2G6WmBorU-Dj_P_WiqZaU,2364
+vantage6/cli/cli.py,sha256=G7qpHK-LTOjwZOQxVL_BNONekTBSsS9U4ZD1oweGp48,5904
+vantage6/cli/configuration_manager.py,sha256=wxQYhRqjCMgXuk7ycN5AHnD1R6Hi7S2kl7dpCAUHNOc,3506
+vantage6/cli/configuration_wizard.py,sha256=pzKJJvg5idk9kc0sPFTo-Q9VFltm4L5vhSuQDPJV5KM,14295
+vantage6/cli/globals.py,sha256=-d-y-ASioIMhvzVxNATyFOs5cKXGkiWf_75gqiT2B-M,1642
+vantage6/cli/utils.py,sha256=8_PZeihjopYXQU10gMwIKr87yDAq-_z2LKi0BcdhNEc,2365
 vantage6/cli/algorithm/create.py,sha256=xdQGVhpIdqkOXLaVBB8Jc1Q9SbsWtR8KiYIfqH8ww0I,1453
 vantage6/cli/algorithm/update.py,sha256=t2JgJZohYBoVRsIx9er2tKO1yQnzanEJkIEm65XaQqc,800
-vantage6/cli/algostore/attach.py,sha256=KsoYPE3Ukv8dTs-cNY8kJJJ-xeCQxbOMhjbEukZJ4iU,1123
+vantage6/cli/algostore/attach.py,sha256=Gr5Zb320cMdAOOpNbhx459M1YlI9qaCjt8YlSm-wMOQ,1135
+vantage6/cli/algostore/files.py,sha256=r89VRixK_K-c44qseq58Aa2Dqf1wEf8yompQRN5AVu4,580
+vantage6/cli/algostore/list.py,sha256=owBrU52ANp8oE68Rk1Hhd6yNYqWX-7uREtmCok_wndg,417
 vantage6/cli/algostore/new.py,sha256=9CMYBjHyXPIhOx7wtkFf99-6EHSTG70MRdg8m8VtMUg,2009
-vantage6/cli/algostore/start.py,sha256=iuo6eOvNvRk9SrJUg5X8IdETIXlyWszwgrm0dhDhz4A,3087
-vantage6/cli/algostore/stop.py,sha256=M3_nb4f0TZiJODKiBuxGgvfrZEdgRTh5qohDoqZeCQw,1814
-vantage6/cli/common/decorator.py,sha256=F0tDTQz6wVH9R-jOfhA1Vx7nJZ1u30V4Sez8NuKV2g4,3222
+vantage6/cli/algostore/start.py,sha256=UTtw6Q8fNXn4x_JtH2cdQ2V78afSxsQxFtAL9EmAVZA,3099
+vantage6/cli/algostore/stop.py,sha256=q1bkATwB8cdNAgWxGBr9C6o4wSUaKKQky4Oa_f-FFj8,1826
+vantage6/cli/common/decorator.py,sha256=vPAJex_8aEAYgv64l34tupQuU31JOwLkL-jLRaQ96Zs,3234
 vantage6/cli/common/start.py,sha256=P9qXwdEzSL_wPyvsSiF4rcX-aVsO_AwbYPYhXIIh4Cs,7029
-vantage6/cli/context/__init__.py,sha256=u3f5LjsIjb_DhAL86jwa5V_9CpJjgbF4wwhxpostLvI,2682
+vantage6/cli/common/utils.py,sha256=EfY0cO2nnM-RLhfb7mVUOMwt8S66ZNAHLV5vxZJWjo0,3408
+vantage6/cli/context/__init__.py,sha256=e8rfY2tCyu6_SLQ-rbVzEHkDtmbnGCZRHFN_HH-2bnA,2683
 vantage6/cli/context/algorithm_store.py,sha256=IyQ8MaaAPI3V73R0NBp3XMJSqYwc0RF83EeILmvuZhY,4063
 vantage6/cli/context/base_server.py,sha256=paKSzNrKWD-J6eakHAtGELk2cD05A8NqoCAuQfF7c2s,2972
 vantage6/cli/context/node.py,sha256=kOSUCEGik4eVIeY2YzUhPI1LwZrmaq1HuXREvBFRFKY,7236
 vantage6/cli/context/server.py,sha256=f19cAc_rjrNctzllrsozZ2O7k2pTS94_oDqzLMsgPj8,4071
-vantage6/cli/dev/create.py,sha256=Arw2KuI9vJ60I96X6ND9n72Ng2lScq4MXb0MvEbwvRM,13408
-vantage6/cli/dev/remove.py,sha256=5jPjKaYnStCZkVIrn36A3yM_Hea8f6wtjOSiq865sv4,2204
-vantage6/cli/dev/start.py,sha256=eVT2-v_tfzjGuKYbnl2ltZmSQa3KdRl5D1nNB62lfQ4,1648
-vantage6/cli/dev/stop.py,sha256=YHsTBRvIWcA7Nmv6tNwpIsxkUeTyieXAPTTQGh_Dj1w,1033
+vantage6/cli/dev/create.py,sha256=65iOMsp3SqHYBwMQhpK3FL2bbf58yPIjd34fO_lexU4,13398
+vantage6/cli/dev/remove.py,sha256=-qPWY9VTpB11QqxznJWhjkobFMP-gxz8EAZyjfZDP5g,2223
+vantage6/cli/dev/start.py,sha256=uIxSJGmqUqOVvMmACaGEO-9q9nAmviyv6g4H-SjdMKk,1667
+vantage6/cli/dev/stop.py,sha256=hZhNXNe4I0Vfq9GFTYZ1vSJCJxSPkpVlud48klmLkwk,1052
 vantage6/cli/node/attach.py,sha256=uWKoP8N__yJZj1QX_xRWHGnBJnEP0peGAH22SpwVXdo,2167
 vantage6/cli/node/clean.py,sha256=9W9PaVILx8SnmB2lymw23KJeQmH5nFcX79QHcEOvo0A,1124
 vantage6/cli/node/create_private_key.py,sha256=ojzwis_EW5AaBHc7gK9LmGhFxZTAkuBUQpEpjYcnC74,4997
@@ -36,33 +39,33 @@ vantage6/cli/node/list.py,sha256=_WZ8EBIEUlzFhVp3cR2MK5FUuQicMEZHhD8npMwKSpM,166
 vantage6/cli/node/new.py,sha256=C-ZHQOiOtslOy6mF-G-MuR5E_65GKJW7L4FxxrKojUg,1923
 vantage6/cli/node/remove.py,sha256=9pBWKF1YtvT6j7fDOKAEkGeT57JpJQgHa3uLorA5e4s,3553
 vantage6/cli/node/set_api_key.py,sha256=IX07QwpTGefRC92lqm34HX9xThRVcXl5DcWSLt1Ro6w,1747
-vantage6/cli/node/start.py,sha256=HsoI4Mf_Ue4_an1PMzm2OTgcaD-2YLnpZ4mzX2CnD4Y,13326
+vantage6/cli/node/start.py,sha256=0UxIImtDxcYkjUFz2KzIORhsmsVnE3M2Uz4s-JDZzNs,13318
 vantage6/cli/node/stop.py,sha256=NfXlSCQ6VcC15iVhgiMklIq-inv6aPnoHrjnvbFpAHc,2678
 vantage6/cli/node/version.py,sha256=eYJ4ayQsEsHPL00V88UY1LhmlnQCzF-Te4lrw4SFbHQ,1836
-vantage6/cli/node/common/__init__.py,sha256=IOHza2H0e-igJg4iWFqE4Pqs8czafq_8GPT_pWYoJD8,3238
+vantage6/cli/node/common/__init__.py,sha256=blcX0xvTnFvWITdt7d250CxtjxrXbA-xmL6m4G0g8GA,3239
 vantage6/cli/rabbitmq/__init__.py,sha256=Kb8pTiIAoRchbwLznM6-c4j6mkKAKXAparpYbjjajHU,737
 vantage6/cli/rabbitmq/definitions.py,sha256=CcS9jG7ZGB6LjzHQqZ2FliDurPItUvNSjHrOYptORZg,637
 vantage6/cli/rabbitmq/queue_manager.py,sha256=QurvkbgtRUUBSv_XggnLEpvi33oeFuwB7abPe_QSRtA,7543
 vantage6/cli/rabbitmq/rabbitmq.config,sha256=LYAQAEoXaF472XeJDYXc9JfWSETIzPRIR2W-JB2i7fU,136
 vantage6/cli/server/attach.py,sha256=5FhopXz0b25EnL4Pu8auqFKOrSHsTTuNmrmgZ6HS0xs,2004
-vantage6/cli/server/files.py,sha256=lYqr5ZjEPbd6hd2b1_M2AEKgHuNAwDoyDll88Obe33Q,488
-vantage6/cli/server/import_.py,sha256=PGG5VLc_NIoXTVlGqCHHCjd4l-aytEWHkr57wDF9nyg,4611
-vantage6/cli/server/list.py,sha256=3MlnirengkcWCmSJOfvFNClU5I-OVSXvEQy_-qhHjGU,1797
+vantage6/cli/server/files.py,sha256=LJhFyYHcEnCgFhVAM-lX6_EnfhMJ7YPdN21kVIpmwkc,507
+vantage6/cli/server/import_.py,sha256=CA0Y2VoyCO8Vg9pkPse9tifalh7meTcXi-cS2tEj38Y,4668
+vantage6/cli/server/list.py,sha256=qxBaUFmkP2tNNo9cuZB5OsVg3KD_c9KJDSTC4cxuUOM,404
 vantage6/cli/server/new.py,sha256=SGOQXQDNg9ihnPpmJCDTQ-Yn2GkDhEu84dtsQ3v5Pq4,1978
-vantage6/cli/server/remove.py,sha256=bXT4fk4Chfk1029gc4RiZlxGdpeo7H8Ua3BKYJLlw_4,1195
-vantage6/cli/server/shell.py,sha256=NfbBKmzTcA6fLcLO_tj_BecbzMScoAkmC00sDhYa9Sw,1564
-vantage6/cli/server/start.py,sha256=T93mEm5T2OiBUifqkizyD5Eu8edZG80mTWgvx1k70oc,7593
-vantage6/cli/server/stop.py,sha256=Go94ch1yzjWjwNbDqqobc2koGqVX3bK5My-nQxL17C0,3950
-vantage6/cli/server/version.py,sha256=Q6xeXECONdhutMMAsqSvTqSGQm4rObP-gbmP03ugY7I,1738
-vantage6/cli/server/common/__init__.py,sha256=TTB7BoOw0YL483Vt5-wseaEUq2Er9DKyNWxJFNBFeko,4835
+vantage6/cli/server/remove.py,sha256=2Zjs8Aq3XYNpeaGr5eSJmPCnxbYlyyEQPKSdPaJnAF4,1214
+vantage6/cli/server/shell.py,sha256=9b_koFmBQRQYIK57usm75hZAaIF4msicLTu55dYHlzM,1583
+vantage6/cli/server/start.py,sha256=1060ZBES8MQwLOsPb664q-wv-wNtWycNtKn-TrO5G54,7650
+vantage6/cli/server/stop.py,sha256=A3io-Gopm4vjOfOZYYFze8LQKFtvZBaHx99C_ULnPRk,4018
+vantage6/cli/server/version.py,sha256=AUYp0CJBnYF8tD3HXqE7kM0RycXipjOYEDkraswUlaA,1306
+vantage6/cli/server/common/__init__.py,sha256=q79uqZ4v-biPJcp4-g4_n_voAdYo1HnTgQJtvkAfqzU,2443
 vantage6/cli/template/node_config.j2,sha256=ebTifJuRlfUhjtI8jm9A2SWXGpUcg8L-XUBInSwAppA,522
 vantage6/cli/template/server_config.j2,sha256=rKXMky8rA7Lnf5USlPx0Es9AskwmL4bILWfACPvygv4,394
 vantage6/cli/template/server_import_config.j2,sha256=PRB0ym_FYjx9vhkmY9C0xzlv_85Y5kBfWdUYs089bNQ,1844
-vantage6/cli/test/feature_tester.py,sha256=2fyzcksj2mandORn3j814PXyhWE7huaKuIHyxhlUX0Y,2329
+vantage6/cli/test/feature_tester.py,sha256=vTmJrqjA6J_GFWvZDmin4Nx1AO2Mhy21YacTr2vZi2U,2497
 vantage6/cli/test/integration_test.py,sha256=DT3qjl1lq7nVBflT5ed1Yu2aNT1cwHCqh8_hafi4e2k,3802
 vantage6/cli/test/common/diagnostic_runner.py,sha256=x_4ikihgoSTKI914pqlgVziBSg5LpV6MheO6O_GBCeA,6657
-vantage6-4.3.0b3.dist-info/METADATA,sha256=nUUf7FkPF13CyWBWNL2QiPD-Cy-duMnSNTz0GxoYZtg,9845
-vantage6-4.3.0b3.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-vantage6-4.3.0b3.dist-info/entry_points.txt,sha256=YFBvwjxoeAGxYyPC-YevEgOBBYRGaXkS6jiOGGCLNy0,157
-vantage6-4.3.0b3.dist-info/top_level.txt,sha256=CYDIBS8jEfFq5YCs_Fuit54K9-3wdosZppTrsymIoUk,19
-vantage6-4.3.0b3.dist-info/RECORD,,
+vantage6-4.3.0b5.dist-info/METADATA,sha256=5eXTgHfu7EM1-pN3CHeb8iHeckzhV5_Etxaq3LOJ4Yk,9845
+vantage6-4.3.0b5.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+vantage6-4.3.0b5.dist-info/entry_points.txt,sha256=YFBvwjxoeAGxYyPC-YevEgOBBYRGaXkS6jiOGGCLNy0,157
+vantage6-4.3.0b5.dist-info/top_level.txt,sha256=CYDIBS8jEfFq5YCs_Fuit54K9-3wdosZppTrsymIoUk,19
+vantage6-4.3.0b5.dist-info/RECORD,,