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

vantage6/cli/node/restart.py

@@ -0,0 +1,128 @@
+import subprocess
+import click
+import questionary as q
+import docker
+
+from vantage6.common import warning, error
+from vantage6.common.docker.addons import check_docker_running
+from vantage6.cli.common.utils import get_name_from_container_name
+from vantage6.cli.node.stop import cli_node_stop
+from vantage6.cli.node.common import find_running_node_names
+from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
+
+
+@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 instead of " "user folders",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    default=N_FOL,
+    help="Search for configuration in the user folders instead of "
+    "system folders. This is the default.",
+)
+@click.option("-i", "--image", default=None, help="Node Docker image to use")
+@click.option(
+    "--keep/--auto-remove",
+    default=False,
+    help="Keep node container after finishing. Useful for debugging",
+)
+@click.option(
+    "--force-db-mount",
+    is_flag=True,
+    help="Always mount node databases; skip the check if they are existing files.",
+)
+@click.option(
+    "--attach/--detach",
+    default=False,
+    help="Show node logs on the current console after starting the " "node",
+)
+@click.option(
+    "--mount-src",
+    default="",
+    help="Override vantage6 source code in container with the source"
+    " code in this path",
+)
+@click.option("--all", "all_nodes", flag_value=True, help="Stop all running nodes")
+@click.option(
+    "--force",
+    "force",
+    flag_value=True,
+    help="Kill nodes instantly; don't wait for them to shut down",
+)
+@click.pass_context
+def cli_node_restart(
+    click_ctx: click.Context,
+    name: str,
+    system_folders: bool,
+    image: str,
+    keep: bool,
+    mount_src: str,
+    attach: bool,
+    force_db_mount: bool,
+    all_nodes: bool,
+    force: bool,
+) -> None:
+    """Restart the node"""
+    check_docker_running()
+    client = docker.from_env()
+
+    running_node_names = find_running_node_names(client)
+    if not running_node_names:
+        warning("No nodes are currently running. No action taken.")
+        return
+
+    if attach and all_nodes:
+        error(
+            "Cannot attach logs of all nodes at once. Please remove either the "
+            "'--all' or '--attach' option."
+        )
+        return
+
+    if all_nodes:
+        names = [
+            get_name_from_container_name(container_name)
+            for container_name in running_node_names
+        ]
+    else:
+        if not name:
+            try:
+                container_name = q.select(
+                    "Select the node you wish to restart:", choices=running_node_names
+                ).unsafe_ask()
+            except KeyboardInterrupt:
+                error("Aborted by user!")
+                return
+            names = [get_name_from_container_name(container_name)]
+        else:
+            names = [name]
+
+    for node_name in names:
+        click_ctx.invoke(
+            cli_node_stop,
+            name=node_name,
+            system_folders=system_folders,
+            all_nodes=False,
+            force=force,
+        )
+
+        cmd = ["v6", "node", "start", "--name", node_name]
+        if system_folders:
+            cmd.append("--system")
+        if image:
+            cmd.extend(["--image", image])
+        if keep:
+            cmd.append("--keep")
+        if mount_src:
+            cmd.extend(["--mount-src", mount_src])
+        if attach:
+            cmd.append("--attach")
+        if force_db_mount:
+            cmd.append("--force-db-mount")
+        subprocess.run(cmd, check=True)

vantage6/cli/node/set_api_key.py

@@ -1,7 +1,7 @@
 import click
 import questionary as q
 
-from vantage6.common import error, info, check_config_writeable
+from vantage6.common import error, info, ensure_config_dir_writable
 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
@@ -33,12 +33,16 @@ def cli_node_set_api_key(name: str, api_key: str, system_folders: bool) -> None:
     name = select_node(name, system_folders)
 
     # Check that we can write in the config 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")
         exit(1)
 
     if not api_key:
-        api_key = q.text("Please enter your new API key:").ask()
+        try:
+            api_key = q.text("Please enter your new API key:").unsafe_ask()
+        except KeyboardInterrupt:
+            error("API key input aborted.")
+            exit(1)
 
     # get configuration manager
     ctx = NodeContext(name, system_folders=system_folders)

vantage6/cli/node/start.py

@@ -177,7 +177,7 @@ def cli_node_start(
         if Path(fullpath).exists():
             mounts.append(("/mnt/private_key.pem", str(fullpath)))
         else:
-            warning(f"private key file provided {fullpath}, " "but does not exists")
+            warning(f"Private key file is provided {fullpath}, but does not exist")
 
     # Mount private keys for ssh tunnels
     ssh_tunnels = ctx.config.get("ssh-tunnels", [])
@@ -235,15 +235,23 @@ def cli_node_start(
         label_capitals = label.upper()
 
         try:
-            file_based = Path(uri).exists()
+            db_file_exists = Path(uri).exists()
         except Exception:
             # If the database uri cannot be parsed, it is definitely not a
             # file. In case of http servers or sql servers, checking the path
             # of the the uri will lead to an OS-dependent error, which is why
             # we catch all exceptions here.
-            file_based = False
+            db_file_exists = False
 
-        if not file_based and not force_db_mount:
+        if db_type in ["folder", "csv", "parquet", "excel"] and not db_file_exists:
+            error(
+                f"Database {Fore.RED}{uri}{Style.RESET_ALL} not found. Databases of "
+                f"type '{db_type}' must be present on the harddrive. Please update "
+                "your node configuration file."
+            )
+            exit(1)
+
+        if not db_file_exists and not force_db_mount:
             debug("  - non file-based database added")
             env[f"{label_capitals}_DATABASE_URI"] = uri
         else:

vantage6/cli/node/stop.py

@@ -69,9 +69,13 @@ def cli_node_stop(
             _stop_node(client, container_name, force, system_folders)
     else:
         if not name:
-            container_name = q.select(
-                "Select the node you wish to stop:", choices=running_node_names
-            ).ask()
+            try:
+                container_name = q.select(
+                    "Select the node you wish to stop:", choices=running_node_names
+                ).unsafe_ask()
+            except KeyboardInterrupt:
+                error("Aborted by user!")
+                return
         else:
             post_fix = "system" if system_folders else "user"
             container_name = f"{APPNAME}-{name}-{post_fix}"

vantage6/cli/node/version.py

@@ -42,9 +42,13 @@ def cli_node_version(name: str, system_folders: bool) -> None:
                 "nodes that are running"
             )
             exit(1)
-        name = q.select(
-            "Select the node you wish to inspect:", choices=running_node_names
-        ).ask()
+        try:
+            name = q.select(
+                "Select the node you wish to inspect:", choices=running_node_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}"

vantage6/cli/server/attach.py

@@ -1,59 +1,13 @@
-import time
-from threading import Thread
-
 import click
-import questionary as q
-import docker
-
-from colorama import Fore, Style
-
-from vantage6.common import info, error
-from vantage6.common.docker.addons import check_docker_running
-from vantage6.common.globals import APPNAME, InstanceType
 
-from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
-from vantage6.cli.common.utils import print_log_worker
+from vantage6.common import info
+from vantage6.cli.common.utils import attach_logs
 
 
 @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_server_attach(name: str, system_folders: bool) -> None:
+def cli_server_attach() -> 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.SERVER}"}
-    )
-    running_server_names = [node.name for node in running_servers]
-
-    if not name:
-        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}-{InstanceType.SERVER}"
-
-    if name in running_server_names:
-        container = client.containers.get(name)
-        logs = container.attach(stream=True, logs=True, stdout=True)
-        Thread(target=print_log_worker, args=(logs,), daemon=True).start()
-        while True:
-            try:
-                time.sleep(1)
-            except KeyboardInterrupt:
-                info("Closing log file. Keyboard Interrupt.")
-                info(
-                    "Note that your server is still running! Shut it down "
-                    f"with {Fore.RED}v6 server stop{Style.RESET_ALL}"
-                )
-                exit(0)
-    else:
-        error(f"{Fore.RED}{name}{Style.RESET_ALL} was not running!?")
+    info("Attaching to server logs...")
+    attach_logs("app=vantage6-server", "component=vantage6-server")

vantage6/cli/server/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.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
 from vantage6.cli.context.server import ServerContext
 from vantage6.cli.configuration_wizard import configuration_wizard
@@ -36,7 +36,7 @@ def cli_server_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 server new "
@@ -45,7 +45,11 @@ def cli_server_new(name: str, system_folders: bool) -> None:
         exit(1)
 
     # create config in ctx location
-    cfg_file = configuration_wizard(InstanceType.SERVER, name, system_folders)
+    try:
+        cfg_file = configuration_wizard(InstanceType.SERVER, name, system_folders)
+    except KeyboardInterrupt:
+        error("Configuration creation aborted.")
+        exit(1)
     info(f"New configuration created: {Fore.GREEN}{cfg_file}{Style.RESET_ALL}")
 
     # info(f"root user created.")

vantage6/cli/server/start.py

@@ -131,7 +131,7 @@ def cli_server_start(
         )
     else:
         warning(
-            "Message queue disabled! This means that the vantage6 server "
+            "Message queue is not set up! This means that the vantage6 server "
             "cannot be scaled horizontally!"
         )
 

vantage6/cli/server/stop.py

@@ -53,9 +53,13 @@ def cli_server_stop(name: str, system_folders: bool, all_servers: bool):
 
     # make sure we have a configuration name to work with
     if not name:
-        container_name = q.select(
-            "Select the server you wish to stop:", choices=running_server_names
-        ).ask()
+        try:
+            container_name = q.select(
+                "Select the server you wish to stop:", choices=running_server_names
+            ).unsafe_ask()
+        except KeyboardInterrupt:
+            error("Aborted by user!")
+            return
     else:
         post_fix = "system" if system_folders else "user"
         container_name = f"{APPNAME}-{name}-{post_fix}-{InstanceType.SERVER}"

vantage6/cli/template/node_config.j2

@@ -1,5 +1,5 @@
 api_key: {{ api_key }}
-api_path: /api
+api_path: {{ api_path }}
 databases:
   {% for label, path in databases.items() %}
   - label: {{ label }}
@@ -28,6 +28,8 @@ logging:
     name: docker.utils.config
   - level: warning
     name: docker.auth
+  - level: warning
+    name: kubernetes.client.rest
 port: {{ port }}
 server_url: {{ server_url }}
 task_dir: {{ task_dir}}

vantage6/cli/test/common/diagnostic_runner.py

@@ -97,9 +97,7 @@ class DiagnosticRunner:
             name="test",
             description="Basic Diagnostic test",
             image=DIAGNOSTICS_IMAGE,
-            input_={
-                "method": "base_features",
-            },
+            method="base_features",
             organizations=self.organization_ids,
             databases=[{"label": "default"}],
         )
@@ -123,8 +121,8 @@ class DiagnosticRunner:
             name="test",
             description="VPN Diagnostic test",
             image=DIAGNOSTICS_IMAGE,
+            method="vpn_features",
             input_={
-                "method": "vpn_features",
                 "kwargs": {"other_nodes": self.organization_ids},
             },
             organizations=self.organization_ids,

vantage6/cli/test/feature_tester.py

@@ -16,13 +16,13 @@ from vantage6.cli.test.common.diagnostic_runner import DiagnosticRunner
 @click.option(
     "--username",
     type=str,
-    default="root",
+    default="dev_admin",
     help="Username of vantage6 user account to create the task with",
 )
 @click.option(
     "--password",
     type=str,
-    default="root",
+    default="password",
     help="Password of vantage6 user account to create the task with",
 )
 @click.option(
@@ -56,6 +56,12 @@ from vantage6.cli.test.common.diagnostic_runner import DiagnosticRunner
     default=None,
     help="Path to the private key for end-to-end encryption",
 )
+@click.option(
+    "--mfa-code",
+    type=str,
+    help="Multi-factor authentication code. Use this if MFA is enabled on the "
+    "server.",
+)
 def cli_test_features(
     host: str,
     port: int,
@@ -68,6 +74,7 @@ def cli_test_features(
     online_only: bool,
     no_vpn: bool,
     private_key: str | None,
+    mfa_code: str | None,
 ) -> list[dict]:
     """
     Run diagnostic checks on an existing vantage6 network.
@@ -83,7 +90,7 @@ def cli_test_features(
         organizations = None
 
     client = UserClient(host=host, port=port, path=api_path, log_level="critical")
-    client.authenticate(username=username, password=password)
+    client.authenticate(username=username, password=password, mfa_code=mfa_code)
     client.setup_encryption(private_key)
     diagnose = DiagnosticRunner(client, collaboration, organizations, online_only)
     res = diagnose(base=True, vpn=not no_vpn)