vantage6 4.2.1__py3-none-any.whl → 4.3.0b3__py3-none-any.whl

vantage6/cli/node/attach.py

@@ -16,12 +16,20 @@ from vantage6.cli.node.common import find_running_node_names, print_log_worker
 
 @click.command()
 @click.option("-n", "--name", default=None, help="Configuration name")
-@click.option('--system', 'system_folders', flag_value=True,
-              help="Search for configuration in system folders rather than "
-                   "user folders")
-@click.option('--user', 'system_folders', flag_value=False, default=N_FOL,
-              help="Search for configuration in user folders rather than "
-                   "system folders. This is the default")
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    help="Search for configuration in system folders rather than " "user folders",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    default=N_FOL,
+    help="Search for configuration in user folders rather than "
+    "system folders. This is the default",
+)
 def cli_node_attach(name: str, system_folders: bool) -> None:
     """
     Show the node logs in the current console.
@@ -36,8 +44,9 @@ def cli_node_attach(name: str, system_folders: bool) -> None:
         return
 
     if not name:
-        name = q.select("Select the node you wish to inspect:",
-                        choices=running_node_names).ask()
+        name = q.select(
+            "Select the node you wish to inspect:", choices=running_node_names
+        ).ask()
     else:
         post_fix = "system" if system_folders else "user"
         name = f"{APPNAME}-{name}-{post_fix}"
@@ -51,8 +60,10 @@ def cli_node_attach(name: str, system_folders: bool) -> None:
                 time.sleep(1)
             except KeyboardInterrupt:
                 info("Closing log file. Keyboard Interrupt.")
-                info("Note that your node is still running! Shut it down with "
-                     f"'{Fore.RED}v6 node stop{Style.RESET_ALL}'")
+                info(
+                    "Note that your node is still running! Shut it down with "
+                    f"'{Fore.RED}v6 node stop{Style.RESET_ALL}'"
+                )
                 exit(0)
     else:
         error(f"{Fore.RED}{name}{Style.RESET_ALL} was not running!?")

vantage6/cli/node/clean.py

@@ -33,8 +33,10 @@ def cli_node_clean() -> None:
                 volume.remove()
                 # info(volume.name)
             except docker.errors.APIError as e:
-                error(f"Failed to remove volume {Fore.RED}'{volume.name}'"
-                      f"{Style.RESET_ALL}. Is it still in use?")
+                error(
+                    f"Failed to remove volume {Fore.RED}'{volume.name}'"
+                    f"{Style.RESET_ALL}. Is it still in use?"
+                )
                 debug(e)
                 exit(1)
     info("Done!")

vantage6/cli/node/common/__init__.py

@@ -8,10 +8,10 @@ import docker
 from colorama import Fore, Style
 
 from vantage6.common import error, info, debug
-from vantage6.common.globals import STRING_ENCODING, APPNAME
+from vantage6.common.globals import STRING_ENCODING, APPNAME, InstanceType
 from vantage6.client import UserClient
 
-from vantage6.cli.context import NodeContext
+from vantage6.cli.context.node import NodeContext
 from vantage6.cli.configuration_wizard import select_configuration_questionaire
 
 
@@ -42,15 +42,15 @@ def create_client(ctx: NodeContext) -> UserClient:
     UserClient
         vantage6 client
     """
-    host = ctx.config['server_url']
+    host = ctx.config["server_url"]
     # if the server is run locally, we need to use localhost here instead of
     # the host address of docker
-    if host in ['http://host.docker.internal', 'http://172.17.0.1']:
-        host = 'http://localhost'
-    port = ctx.config['port']
-    api_path = ctx.config['api_path']
+    if host in ["http://host.docker.internal", "http://172.17.0.1"]:
+        host = "http://localhost"
+    port = ctx.config["port"]
+    api_path = ctx.config["api_path"]
     info(f"Connecting to server at '{host}:{port}{api_path}'")
-    return UserClient(host, port, api_path, log_level='warn')
+    return UserClient(host, port, api_path, log_level="warn")
 
 
 def create_client_and_authenticate(ctx: NodeContext) -> UserClient:
@@ -92,8 +92,11 @@ def select_node(name: str, system_folders: bool) -> tuple[str, str]:
     str
         Name of the configuration file
     """
-    name = name if name else \
-        select_configuration_questionaire("node", system_folders)
+    name = (
+        name
+        if name
+        else select_configuration_questionaire(InstanceType.NODE, system_folders)
+    )
 
     # raise error if config could not be found
     if not NodeContext.config_exists(name, system_folders):
@@ -120,5 +123,6 @@ def find_running_node_names(client: docker.DockerClient) -> list[str]:
         List of names of running nodes
     """
     running_nodes = client.containers.list(
-        filters={"label": f"{APPNAME}-type=node"})
+        filters={"label": f"{APPNAME}-type={InstanceType.NODE}"}
+    )
     return [node.name for node in running_nodes]

vantage6/cli/node/create_private_key.py

@@ -3,39 +3,70 @@ import click
 from colorama import Fore, Style
 
 from vantage6.common import (
-    warning, error, info, debug, bytes_to_base64s,
+    warning,
+    error,
+    info,
+    debug,
+    bytes_to_base64s,
 )
 
 from vantage6.common.encryption import RSACryptor
-from vantage6.cli.context import NodeContext
-from vantage6.cli.globals import (
-    DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
-)
-from vantage6.cli.node.common import (
-    select_node, create_client_and_authenticate
-)
+from vantage6.cli.context.node import NodeContext
+from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
+from vantage6.cli.node.common import select_node, create_client_and_authenticate
 
 
 @click.command()
 @click.option("-n", "--name", default=None, help="Configuration name")
-@click.option("-c", "--config", default=None,
-              help='Absolute path to configuration-file; overrides NAME')
-@click.option('--system', 'system_folders', flag_value=True,
-              help="Search for configuration in system folders rather than "
-                   "user folders")
-@click.option('--user', 'system_folders', flag_value=False, default=N_FOL,
-              help="Search for configuration in user folders rather than "
-                   "system folders. This is the default")
-@click.option('--no-upload', 'upload', flag_value=False, default=True,
-              help="Don't upload the public key to the server")
-@click.option("-o", "--organization-name", default=None,
-              help="Organization name. Used in the filename of the private key"
-                   " so that it can easily be recognized again later")
-@click.option('--overwrite', 'overwrite', flag_value=True, default=False,
-              help="Overwrite existing private key if present")
+@click.option(
+    "-c",
+    "--config",
+    default=None,
+    help="Absolute path to configuration-file; overrides NAME",
+)
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    help="Search for configuration in system folders rather than " "user folders",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    default=N_FOL,
+    help="Search for configuration in user folders rather than "
+    "system folders. This is the default",
+)
+@click.option(
+    "--no-upload",
+    "upload",
+    flag_value=False,
+    default=True,
+    help="Don't upload the public key to the server",
+)
+@click.option(
+    "-o",
+    "--organization-name",
+    default=None,
+    help="Organization name. Used in the filename of the private key"
+    " so that it can easily be recognized again later",
+)
+@click.option(
+    "--overwrite",
+    "overwrite",
+    flag_value=True,
+    default=False,
+    help="Overwrite existing private key if present",
+)
 def cli_node_create_private_key(
-        name: str, config: str, system_folders: bool, upload: bool,
-        organization_name: str, overwrite: bool) -> None:
+    name: str,
+    config: str,
+    system_folders: bool,
+    upload: bool,
+    organization_name: str,
+    overwrite: bool,
+) -> None:
     """
     Create and upload a new private key
 
@@ -117,7 +148,7 @@ def cli_node_create_private_key(
             "This will overwrite any previously existing key!"
         )
 
-        if 'client' not in locals():
+        if "client" not in locals():
             client = create_client_and_authenticate(ctx)
 
         # TODO what happens if the user doesn't have permission to upload key?
@@ -126,7 +157,7 @@ def cli_node_create_private_key(
             client.request(
                 f"/organization/{client.whoami.organization_id}",
                 method="patch",
-                json={"public_key": bytes_to_base64s(public_key)}
+                json={"public_key": bytes_to_base64s(public_key)},
             )
 
         except Exception as e:

vantage6/cli/node/files.py

@@ -1,18 +1,26 @@
 import click
 
 from vantage6.common import info
-from vantage6.cli.context import NodeContext
+from vantage6.cli.context.node import NodeContext
 from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
 from vantage6.cli.node.common import select_node
 
 
 @click.command()
 @click.option("-n", "--name", default=None, help="Configuration name")
-@click.option('--system', 'system_folders', flag_value=True,
-              help="Search for the configuration in the system folders")
-@click.option('--user', 'system_folders', flag_value=False, default=N_FOL,
-              help="Search for the configuration in the user folders. This is "
-                   "the default")
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    help="Search for the configuration in the system folders",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    default=N_FOL,
+    help="Search for the configuration in the user folders. This is " "the default",
+)
 def cli_node_files(name: str, system_folders: bool) -> None:
     """
     Prints the location of important node files.

vantage6/cli/node/list.py

@@ -5,7 +5,7 @@ from colorama import Fore, Style
 from vantage6.common import warning
 from vantage6.common.globals import APPNAME
 from vantage6.common.docker.addons import check_docker_running
-from vantage6.cli.context import NodeContext
+from vantage6.cli.context.node import NodeContext
 from vantage6.cli.node.common import find_running_node_names
 
 
@@ -23,40 +23,34 @@ def cli_node_list() -> None:
 
     running_node_names = find_running_node_names(client)
 
-    header = \
-        "\nName"+(21*" ") + \
-        "Status"+(10*" ") + \
-        "System/User"
+    header = "\nName" + (21 * " ") + "Status" + (10 * " ") + "System/User"
 
     click.echo(header)
-    click.echo("-"*len(header))
+    click.echo("-" * len(header))
 
     running = Fore.GREEN + "Running" + Style.RESET_ALL
     stopped = Fore.RED + "Not running" + Style.RESET_ALL
 
     # system folders
-    configs, f1 = NodeContext.available_configurations(
-        system_folders=True)
+    configs, f1 = NodeContext.available_configurations(system_folders=True)
     for config in configs:
-        status = running if f"{APPNAME}-{config.name}-system" in \
-            running_node_names else stopped
-        click.echo(
-            f"{config.name:25}"
-            f"{status:25}System "
+        status = (
+            running
+            if f"{APPNAME}-{config.name}-system" in running_node_names
+            else stopped
         )
+        click.echo(f"{config.name:25}" f"{status:25}System ")
 
     # user folders
-    configs, f2 = NodeContext.available_configurations(
-        system_folders=False)
+    configs, f2 = NodeContext.available_configurations(system_folders=False)
     for config in configs:
-        status = running if f"{APPNAME}-{config.name}-user" in \
-            running_node_names else stopped
-        click.echo(
-            f"{config.name:25}"
-            f"{status:25}User   "
+        status = (
+            running
+            if f"{APPNAME}-{config.name}-user" in running_node_names
+            else stopped
         )
+        click.echo(f"{config.name:25}" f"{status:25}User   ")
 
-    click.echo("-"*53)
-    if len(f1)+len(f2):
-        warning(
-             f"{Fore.RED}Failed imports: {len(f1)+len(f2)}{Style.RESET_ALL}")
+    click.echo("-" * 53)
+    if len(f1) + len(f2):
+        warning(f"{Fore.RED}Failed imports: {len(f1)+len(f2)}{Style.RESET_ALL}")

vantage6/cli/node/new.py

@@ -2,21 +2,28 @@ import click
 from colorama import Fore, Style
 
 from vantage6.common import error, info, check_config_writeable
-from vantage6.cli.context import NodeContext
-from vantage6.cli.globals import (
-    DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
-)
+from vantage6.cli.context.node import NodeContext
+from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
 from vantage6.cli.configuration_wizard import configuration_wizard
 from vantage6.cli.utils import check_config_name_allowed, prompt_config_name
+from vantage6.common.globals import InstanceType
 
 
 @click.command()
 @click.option("-n", "--name", default=None, help="Configuration name")
-@click.option('--system', 'system_folders', flag_value=True,
-              help="Store this configuration in the system folders")
-@click.option('--user', 'system_folders', flag_value=False, default=N_FOL,
-              help="Store this configuration in the user folders. This is the "
-                   "default")
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    help="Store this configuration in the system folders",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    default=N_FOL,
+    help="Store this configuration in the user folders. This is the " "default",
+)
 def cli_node_new_configuration(name: str, system_folders: bool) -> None:
     """
     Create a new node configuration.
@@ -40,7 +47,9 @@ def cli_node_new_configuration(name: str, system_folders: bool) -> None:
 
     # create config in ctx location
     flag = "--system" if system_folders else ""
-    cfg_file = configuration_wizard("node", name, system_folders)
+    cfg_file = configuration_wizard(InstanceType.NODE, name, system_folders)
     info(f"New configuration created: {Fore.GREEN}{cfg_file}{Style.RESET_ALL}")
-    info(f"You can start the node by running "
-         f"{Fore.GREEN}v6 node start {flag}{Style.RESET_ALL}")
+    info(
+        f"You can start the node by running "
+        f"{Fore.GREEN}v6 node start {flag}{Style.RESET_ALL}"
+    )

vantage6/cli/node/remove.py

@@ -8,33 +8,40 @@ from pathlib import Path
 from shutil import rmtree
 
 from vantage6.common import (
-    error, info, debug,
+    error,
+    info,
+    debug,
 )
 from vantage6.common.globals import APPNAME
 
 from vantage6.common.globals import VPN_CONFIG_FILE
 
 
-from vantage6.cli.context import NodeContext
-from vantage6.cli.globals import (
-    DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
-)
-from vantage6.cli.utils import (
-    check_if_docker_daemon_is_running, remove_file
-)
+from vantage6.cli.context.node import NodeContext
+from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
+from vantage6.cli.utils import check_if_docker_daemon_is_running, remove_file
 from vantage6.cli.node.common import select_node, find_running_node_names
 
 
 @click.command()
 @click.option("-n", "--name", default=None, help="Configuration name")
-@click.option('--system', 'system_folders', flag_value=True,
-              help="Search for configuration in system folders rather than "
-                   "user folders")
-@click.option('--user', 'system_folders', flag_value=False, default=N_FOL,
-              help="Search for configuration in user folders rather than "
-                   "system folders. This is the default")
-@click.option('-f', "--force", type=bool, flag_value=True,
-              help='Don\'t ask for confirmation')
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    help="Search for configuration in system folders rather than " "user folders",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    default=N_FOL,
+    help="Search for configuration in user folders rather than "
+    "system folders. This is the default",
+)
+@click.option(
+    "-f", "--force", type=bool, flag_value=True, help="Don't ask for confirmation"
+)
 def cli_node_remove(name: str, system_folders: bool, force: bool) -> None:
     """
     Delete a node permanently.
@@ -54,14 +61,16 @@ def cli_node_remove(name: str, system_folders: bool, force: bool) -> None:
     post_fix = "system" if system_folders else "user"
     node_container_name = f"{APPNAME}-{name}-{post_fix}"
     if node_container_name in running_node_names:
-        error(f"Node {name} is still running! Please stop the node before "
-              "deleting it.")
+        error(
+            f"Node {name} is still running! Please stop the node before " "deleting it."
+        )
         exit(1)
 
     if not force:
         if not q.confirm(
             "This node will be deleted permanently including its "
-            "configuration. Are you sure?", default=False
+            "configuration. Are you sure?",
+            default=False,
         ).ask():
             info("Node will not be deleted")
             exit(0)
@@ -82,11 +91,11 @@ def cli_node_remove(name: str, system_folders: bool, force: bool) -> None:
             vol.remove()
 
     # remove the VPN configuration file
-    vpn_config_file = os.path.join(ctx.data_dir, 'vpn', VPN_CONFIG_FILE)
-    remove_file(vpn_config_file, 'VPN configuration')
+    vpn_config_file = os.path.join(ctx.data_dir, "vpn", VPN_CONFIG_FILE)
+    remove_file(vpn_config_file, "VPN configuration")
 
     # remove the config file
-    remove_file(ctx.config_file, 'configuration')
+    remove_file(ctx.config_file, "configuration")
 
     # remove the log file. As this process opens the log file above, the log
     # handlers need to be closed before deleting

vantage6/cli/node/set_api_key.py

@@ -2,7 +2,7 @@ import click
 import questionary as q
 
 from vantage6.common import error, info, check_config_writeable
-from vantage6.cli.context import NodeContext
+from vantage6.cli.context.node import NodeContext
 from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
 from vantage6.cli.configuration_wizard import NodeConfigurationManager
 from vantage6.cli.node.common import select_node
@@ -11,14 +11,21 @@ from vantage6.cli.node.common import select_node
 @click.command()
 @click.option("-n", "--name", default=None, help="Configuration name")
 @click.option("--api-key", default=None, help="New API key")
-@click.option('--system', 'system_folders', flag_value=True,
-              help="Search for configuration in system folders rather than "
-                   "user folders")
-@click.option('--user', 'system_folders', flag_value=False, default=N_FOL,
-              help="Search for configuration in user folders rather than "
-                   "system folders. This is the default")
-def cli_node_set_api_key(name: str, api_key: str,
-                         system_folders: bool) -> None:
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    help="Search for configuration in system folders rather than " "user folders",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    default=N_FOL,
+    help="Search for configuration in user folders rather than "
+    "system folders. This is the default",
+)
+def cli_node_set_api_key(name: str, api_key: str, system_folders: bool) -> None:
     """
     Put a new API key into the node configuration file
     """
@@ -38,8 +45,7 @@ def cli_node_set_api_key(name: str, api_key: str,
     conf_mgr = NodeConfigurationManager.from_file(ctx.config_file)
 
     # set new api key, and save the file
-    ctx.config['api_key'] = api_key
+    ctx.config["api_key"] = api_key
     conf_mgr.put(ctx.config)
     conf_mgr.save(ctx.config_file)
-    info("Your new API key has been uploaded to the config file "
-         f"{ctx.config_file}.")
+    info("Your new API key has been uploaded to the config file " f"{ctx.config_file}.")

vantage6/cli/node/start.py

@@ -16,6 +16,7 @@ from vantage6.common.globals import (
     DEFAULT_DOCKER_REGISTRY,
     DEFAULT_NODE_IMAGE,
     DEFAULT_NODE_IMAGE_WO_TAG,
+    InstanceType,
 )
 from vantage6.common.docker.addons import (
     pull_if_newer,
@@ -23,7 +24,7 @@ from vantage6.common.docker.addons import (
     check_docker_running,
 )
 
-from vantage6.cli.context import NodeContext
+from vantage6.cli.context.node import NodeContext
 from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
 from vantage6.cli.configuration_wizard import (
     configuration_wizard,
@@ -99,14 +100,14 @@ def cli_node_start(
     else:
         # in case no name is supplied, ask the user to select one
         if not name:
-            name = select_configuration_questionaire("node", system_folders)
+            name = select_configuration_questionaire(InstanceType.NODE, system_folders)
 
         # check that config exists, if not a questionaire will be invoked
         if not NodeContext.config_exists(name, system_folders):
             warning(f"Configuration {Fore.RED}{name}{Style.RESET_ALL} does not exist.")
 
             if q.confirm("Create this configuration now?").ask():
-                configuration_wizard("node", name, system_folders)
+                configuration_wizard(InstanceType.NODE, name, system_folders)
 
             else:
                 error("Config file couldn't be loaded")
@@ -119,7 +120,7 @@ def cli_node_start(
 
     # check that this node is not already running
     running_nodes = docker_client.containers.list(
-        filters={"label": f"{APPNAME}-type=node"}
+        filters={"label": f"{APPNAME}-type={InstanceType.NODE}"}
     )
 
     suffix = "system" if system_folders else "user"
@@ -266,12 +267,13 @@ def cli_node_start(
     info("Setting up databases")
     db_labels = [db["label"] for db in ctx.databases]
     for label in db_labels:
-
         # check that label contains only valid characters
         if not label.isidentifier():
-            error(f"Database label {Fore.RED}{label}{Style.RESET_ALL} contains"
-                  " invalid characters. Only letters, numbers, and underscores"
-                  " are allowed, and it cannot start with a number.")
+            error(
+                f"Database label {Fore.RED}{label}{Style.RESET_ALL} contains"
+                " invalid characters. Only letters, numbers, and underscores"
+                " are allowed, and it cannot start with a number."
+            )
             exit(1)
 
         db_config = get_database_config(ctx.databases, label)
@@ -308,22 +310,44 @@ def cli_node_start(
         f" --dockerized {system_folders_option}"
     )
 
-    info("Running Docker container")
     volumes = []
     for mount in mounts:
         volumes.append(f"{mount[1]}:{mount[0]}")
 
+    extra_mounts = ctx.config.get("node_extra_mounts", [])
+    for mount in extra_mounts:
+        volumes.append(mount)
+
+    extra_env = ctx.config.get("node_extra_env", {})
+    # all extra env var names should be valid identifiers
+    extra_env_invalid = [key for key in extra_env.keys() if not key.isidentifier()]
+    if extra_env_invalid:
+        error(
+            "Environment variable names should be valid identifiers. "
+            f"The following break this rule: {extra_env_invalid}"
+        )
+        exit(1)
+    # we won't accept overwrites of existing env vars
+    env_overwrites = extra_env.keys() & env.keys()
+    if env_overwrites:
+        error(
+            "Cannot overwrite existing node environment variables: " f"{env_overwrites}"
+        )
+        exit(1)
+    env.update(extra_env)
+
     remove_container_if_exists(
         docker_client=docker_client, name=ctx.docker_container_name
     )
 
+    info("Running Docker container")
     container = docker_client.containers.run(
         image,
         command=cmd,
         volumes=volumes,
         detach=True,
         labels={
-            f"{APPNAME}-type": "node",
+            f"{APPNAME}-type": InstanceType.NODE,
             "system": str(system_folders),
             "name": ctx.config_file_name,
         },
@@ -349,5 +373,7 @@ def cli_node_start(
                 )
                 exit(0)
     else:
-        info(f"To see the logs, run: {Fore.GREEN}v6 node attach --name "
-             f"{ctx.name}{Style.RESET_ALL}")
+        info(
+            f"To see the logs, run: {Fore.GREEN}v6 node attach --name "
+            f"{ctx.name}{Style.RESET_ALL}"
+        )