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

vantage6/cli/configuration_wizard.py

@@ -1,7 +1,7 @@
-import questionary as q
-
 from pathlib import Path
 
+import questionary as q
+
 from vantage6.common import generate_apikey
 from vantage6.common.globals import (
     DATABASE_TYPES,
@@ -36,7 +36,7 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
     dict
         Dictionary with the new node configuration
     """
-    config = q.prompt(
+    config = q.unsafe_prompt(
         [
             {"type": "text", "name": "api_key", "message": "Enter given api-key:"},
             {
@@ -57,7 +57,7 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
         else str(Ports.DEV_SERVER.value)
     )
 
-    config = config | q.prompt(
+    config = config | q.unsafe_prompt(
         [
             {
                 "type": "text",
@@ -81,8 +81,8 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
     )
 
     config["databases"] = list()
-    while q.confirm("Do you want to add a database?").ask():
-        db_label = q.prompt(
+    while q.confirm("Do you want to add a database?").unsafe_ask():
+        db_label = q.unsafe_prompt(
             [
                 {
                     "type": "text",
@@ -92,10 +92,10 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
                 }
             ]
         )
-        db_path = q.prompt(
+        db_path = q.unsafe_prompt(
             [{"type": "text", "name": "uri", "message": "Database URI:"}]
         )
-        db_type = q.select("Database type:", choices=DATABASE_TYPES).ask()
+        db_type = q.select("Database type:", choices=DATABASE_TYPES).unsafe_ask()
 
         config["databases"].append(
             {"label": db_label.get("label"), "uri": db_path.get("uri"), "type": db_type}
@@ -103,18 +103,18 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
 
     is_add_vpn = q.confirm(
         "Do you want to connect to a VPN server?", default=False
-    ).ask()
+    ).unsafe_ask()
     if is_add_vpn:
         config["vpn_subnet"] = q.text(
             message="Subnet of the VPN server you want to connect to:",
             default="10.76.0.0/16",
-        ).ask()
+        ).unsafe_ask()
 
     is_policies = q.confirm(
         "Do you want to limit the algorithms allowed to run on your node? This "
         "should always be done for production scenarios.",
         default=True,
-    ).ask()
+    ).unsafe_ask()
     policies = {}
     if is_policies:
         info(
@@ -124,12 +124,12 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
         )
         ask_single_algorithms = q.confirm(
             "Do you want to enter a list of allowed algorithms?"
-        ).ask()
+        ).unsafe_ask()
         if ask_single_algorithms:
             policies[NodePolicy.ALLOWED_ALGORITHMS.value] = _get_allowed_algorithms()
         ask_algorithm_stores = q.confirm(
             "Do you want to allow algorithms from specific algorithm stores?"
-        ).ask()
+        ).unsafe_ask()
         if ask_algorithm_stores:
             policies[NodePolicy.ALLOWED_ALGORITHM_STORES.value] = (
                 _get_allowed_algorithm_stores()
@@ -141,7 +141,7 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
                 "stores? If not, algorithms will be allowed if they are in either the "
                 "list of allowed algorithms or one of the allowed algorithm stores.",
                 default=True,
-            ).ask()
+            ).unsafe_ask()
             policies["allow_either_whitelist_or_store"] = not require_both_whitelists
     if policies:
         config["policies"] = policies
@@ -149,7 +149,7 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
     res = q.select(
         "Which level of logging would you like?",
         choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL", "NOTSET"],
-    ).ask()
+    ).unsafe_ask()
 
     config["logging"] = {
         "level": res,
@@ -178,7 +178,7 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
             "If you continue, you should provide your collaboration "
             "settings manually."
         )
-        if q.confirm("Do you want to abort?", default=True).ask():
+        if q.confirm("Do you want to abort?", default=True).unsafe_ask():
             exit(0)
 
     if client.whoami is not None:
@@ -190,11 +190,13 @@ def node_configuration_questionaire(dirs: dict, instance_name: str) -> dict:
             f"Encryption is {'enabled' if encryption else 'disabled'}"
             f" for this collaboration. Accept?",
             default=True,
-        ).ask()
+        ).unsafe_ask()
     else:
-        encryption = q.confirm("Enable encryption?", default=True).ask()
+        encryption = q.confirm("Enable encryption?", default=True).unsafe_ask()
 
-    private_key = "" if not encryption else q.text("Path to private key file:").ask()
+    private_key = (
+        "" if not encryption else q.text("Path to private key file:").unsafe_ask()
+    )
 
     config["encryption"] = {
         "enabled": encryption is True or encryption == "true",
@@ -219,24 +221,22 @@ def _get_allowed_algorithms() -> list[str]:
         "use strings to provide one algorithm at a time."
     )
     info("Examples:")
-    # pylint: disable=W1401
-    # flake8: noqa: W605
-    info("^harbor2\.vantage6\.ai/demo/average$    Allow the demo average algorithm")
+    info(r"^harbor2\.vantage6\.ai/demo/average$    Allow the demo average algorithm")
     info(
-        "^harbor2\.vantage6\.ai/algorithms/.*   Allow all algorithms from "
+        r"^harbor2\.vantage6\.ai/algorithms/.*   Allow all algorithms from "
         "harbor2.vantage6.ai/algorithms"
     )
     info(
-        "^harbor2\.vantage6\.ai/demo/average@sha256:82becede...$    Allow a "
+        r"^harbor2\.vantage6\.ai/demo/average@sha256:82becede...$    Allow a "
         "specific hash of average algorithm"
     )
     allowed_algorithms = []
     while True:
-        algo = q.text(message="Enter your algorithm expression:").ask()
+        algo = q.text(message="Enter your algorithm expression:").unsafe_ask()
         allowed_algorithms.append(algo)
         if not q.confirm(
             "Do you want to add another algorithm expression?", default=True
-        ).ask():
+        ).unsafe_ask():
             break
     return allowed_algorithms
 
@@ -261,16 +261,16 @@ def _get_allowed_algorithm_stores() -> list[str]:
         "community store"
     )
     info(
-        "^https://*\.vantage6\.ai$               Allow all algorithms from any "
+        r"^https://*\.vantage6\.ai$               Allow all algorithms from any "
         "store hosted on vantage6.ai"
     )
     allowed_algorithm_stores = []
     while True:
-        store = q.text(message="Enter the URL of the algorithm store:").ask()
+        store = q.text(message="Enter the URL of the algorithm store:").unsafe_ask()
         allowed_algorithm_stores.append(store)
         if not q.confirm(
             "Do you want to add another algorithm store?", default=True
-        ).ask():
+        ).unsafe_ask():
             break
     return allowed_algorithm_stores
 
@@ -292,7 +292,7 @@ def _get_common_server_config(instance_type: InstanceType, instance_name: str) -
     dict
         Dictionary with new (partial) server configuration
     """
-    config = q.prompt(
+    config = q.unsafe_prompt(
         [
             {
                 "type": "text",
@@ -315,7 +315,7 @@ def _get_common_server_config(instance_type: InstanceType, instance_name: str) -
     )
 
     config.update(
-        q.prompt(
+        q.unsafe_prompt(
             [
                 {
                     "type": "text",
@@ -336,7 +336,7 @@ def _get_common_server_config(instance_type: InstanceType, instance_name: str) -
     res = q.select(
         "Which level of logging would you like?",
         choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL", "NOTSET"],
-    ).ask()
+    ).unsafe_ask()
 
     config["logging"] = {
         "level": res,
@@ -378,11 +378,11 @@ def server_configuration_questionaire(instance_name: str) -> dict:
 
     config = _get_common_server_config(InstanceType.SERVER, instance_name)
 
-    constant_jwt_secret = q.confirm("Do you want a constant JWT secret?").ask()
+    constant_jwt_secret = q.confirm("Do you want a constant JWT secret?").unsafe_ask()
     if constant_jwt_secret:
         config["jwt_secret_key"] = generate_apikey()
 
-    is_mfa = q.confirm("Do you want to enforce two-factor authentication?").ask()
+    is_mfa = q.confirm("Do you want to enforce two-factor authentication?").unsafe_ask()
     if is_mfa:
         config["two_factor_auth"] = is_mfa
 
@@ -393,11 +393,13 @@ def server_configuration_questionaire(instance_name: str) -> dict:
         "server url. If you are running a production server, this is the "
         "url that users will connect to.",
         default=current_server_url,
-    ).ask()
+    ).unsafe_ask()
 
-    is_add_vpn = q.confirm("Do you want to add a VPN server?", default=False).ask()
+    is_add_vpn = q.confirm(
+        "Do you want to add a VPN server?", default=False
+    ).unsafe_ask()
     if is_add_vpn:
-        vpn_config = q.prompt(
+        vpn_config = q.unsafe_prompt(
             [
                 {
                     "type": "text",
@@ -434,12 +436,14 @@ def server_configuration_questionaire(instance_name: str) -> dict:
         )
         config["vpn_server"] = vpn_config
 
-    is_add_rabbitmq = q.confirm("Do you want to add a RabbitMQ message queue?").ask()
+    is_add_rabbitmq = q.confirm(
+        "Do you want to add a RabbitMQ message queue?"
+    ).unsafe_ask()
     if is_add_rabbitmq:
-        rabbit_uri = q.text(message="Enter the URI for your RabbitMQ:").ask()
+        rabbit_uri = q.text(message="Enter the URI for your RabbitMQ:").unsafe_ask()
         run_rabbit_locally = q.confirm(
             "Do you want to run RabbitMQ locally? (Use only for testing)"
-        ).ask()
+        ).unsafe_ask()
         config["rabbitmq"] = {
             "uri": rabbit_uri,
             "start_with_server": run_rabbit_locally,
@@ -449,7 +453,7 @@ def server_configuration_questionaire(instance_name: str) -> dict:
     is_add_community_store = q.confirm(
         "Do you want to make the algorithms from the community algorithm store "
         "available to your users?"
-    ).ask()
+    ).unsafe_ask()
     algorithm_stores = []
     if is_add_community_store:
         algorithm_stores.append(
@@ -457,14 +461,14 @@ def server_configuration_questionaire(instance_name: str) -> dict:
         )
     add_more_stores = q.confirm(
         "Do you want to add more algorithm stores?", default=False
-    ).ask()
+    ).unsafe_ask()
     while add_more_stores:
-        store_name = q.text(message="Enter the name of the store:").ask()
-        store_url = q.text(message="Enter the URL of the store:").ask()
+        store_name = q.text(message="Enter the name of the store:").unsafe_ask()
+        store_url = q.text(message="Enter the URL of the store:").unsafe_ask()
         algorithm_stores.append({"name": store_name, "url": store_url})
         add_more_stores = q.confirm(
             "Do you want to add more algorithm stores?", default=False
-        ).ask()
+        ).unsafe_ask()
     config["algorithm_stores"] = algorithm_stores
 
     return config
@@ -487,19 +491,21 @@ def algo_store_configuration_questionaire(instance_name: str) -> dict:
     """
     config = _get_common_server_config(InstanceType.ALGORITHM_STORE, instance_name)
 
-    default_v6_server_uri = f"http://localhost:{Ports.DEV_SERVER.value}/api"
+    default_v6_server_uri = (
+        f"http://localhost:{Ports.DEV_SERVER.value}{DEFAULT_API_PATH}"
+    )
     default_root_username = "root"
 
     v6_server_uri = q.text(
         "What is the Vantage6 server linked to the algorithm store? "
         "Provide the link to the server endpoint.",
         default=default_v6_server_uri,
-    ).ask()
+    ).unsafe_ask()
 
     root_username = q.text(
         "What is the username of the root user?",
         default=default_root_username,
-    ).ask()
+    ).unsafe_ask()
 
     config["root_user"] = {
         "v6_server_uri": v6_server_uri,
@@ -512,7 +518,7 @@ def algo_store_configuration_questionaire(instance_name: str) -> dict:
         "Do you want to open the algorithm store to the public? This will allow anyone "
         "to view the algorithms, but they cannot modify them.",
         default=False,
-    ).ask()
+    ).unsafe_ask()
     if is_open:
         open_algos_policy = "public"
     else:
@@ -521,7 +527,7 @@ def algo_store_configuration_questionaire(instance_name: str) -> dict:
             "the algorithms in the store? If not allowing this, you will have to assign"
             " the appropriate permissions to each user individually.",
             default=True,
-        ).ask()
+        ).unsafe_ask()
         open_algos_policy = "whitelisted" if is_open_to_whitelist else "private"
     config["policies"]["algorithm_view"] = open_algos_policy
 
@@ -610,4 +616,10 @@ def select_configuration_questionaire(type_: InstanceType, system_folders: bool)
         raise Exception("No configurations could be found!")
 
     # pop the question
-    return q.select("Select the configuration you want to use:", choices=choices).ask()
+    try:
+        return q.select(
+            "Select the configuration you want to use:", choices=choices
+        ).unsafe_ask()
+    except KeyboardInterrupt:
+        error("Aborted by user!")
+        exit(1)

vantage6/cli/context/node.py

@@ -1,11 +1,12 @@
 from __future__ import annotations
 
+import hashlib
 import os.path
 
 from pathlib import Path
 
 from vantage6.common.context import AppContext
-from vantage6.common.globals import APPNAME, InstanceType
+from vantage6.common.globals import APPNAME, STRING_ENCODING, InstanceType
 from vantage6.cli.configuration_manager import NodeConfigurationManager
 from vantage6.cli.globals import DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL
 from vantage6.cli._version import __version__
@@ -39,6 +40,7 @@ class NodeContext(AppContext):
         system_folders: bool = N_FOL,
         config_file: str = None,
         print_log_header: bool = True,
+        logger_prefix: str = "",
     ):
         super().__init__(
             InstanceType.NODE,
@@ -46,9 +48,11 @@ class NodeContext(AppContext):
             system_folders,
             config_file,
             print_log_header,
+            logger_prefix,
         )
         if print_log_header:
             self.log.info("vantage6 version '%s'", __version__)
+        self.identifier = self.__create_node_identifier()
 
     @classmethod
     def from_external_config_file(
@@ -245,3 +249,16 @@ class NodeContext(AppContext):
             URI to the database
         """
         return self.config["databases"][label]
+
+    def __create_node_identifier(self) -> str:
+        """
+        Create a unique identifier for the node.
+
+        Returns
+        -------
+        str
+            Unique identifier for the node
+        """
+        return hashlib.sha256(
+            self.config.get("api_key").encode(STRING_ENCODING)
+        ).hexdigest()[:16]

vantage6/cli/dev/create.py

@@ -485,8 +485,9 @@ def demo_network(
     "--server-url",
     type=str,
     default="http://host.docker.internal",
-    help="Server URL to point to. If you are using Docker Desktop, "
-    "the default http://host.docker.internal should not be changed.",
+    help="Server URL to point to. If you are using Docker Desktop, the default "
+    "http://host.docker.internal should not be changed. If you are using Linux without"
+    " Docker Desktop, you should set this to http://172.17.0.1",
 )
 @click.option(
     "-p",

vantage6/cli/dev/start.py

@@ -67,7 +67,7 @@ def start_demo_network(
     cmd = ["v6", "algorithm-store", "start", "--name", f"{ctx.name}_store", "--user"]
     if store_image:
         cmd.extend(["--image", store_image])
-    subprocess.run(cmd)
+    subprocess.run(cmd, check=True)
 
     # run all nodes that belong to this server
     configs, _ = NodeContext.available_configurations(system_folders=False)
@@ -78,7 +78,7 @@ def start_demo_network(
         cmd = ["v6", "node", "start", "--name", name]
         if node_image:
             cmd.extend(["--image", node_image])
-        subprocess.run(cmd)
+        subprocess.run(cmd, check=True)
 
     # now that both server and store have been started, couple them
     info("Linking local algorithm store to server...")

vantage6/cli/node/attach.py

@@ -45,9 +45,13 @@ 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()
+        try:
+            name = q.select(
+                "Select the node you wish to attach:", 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/node/clean.py

@@ -26,8 +26,12 @@ def cli_node_clean() -> None:
             msg += volume.name + ","
     info(msg)
 
-    confirm = q.confirm("Are you sure?")
-    if confirm.ask():
+    try:
+        confirm = q.confirm("Are you sure?").unsafe_ask()
+    except KeyboardInterrupt:
+        confirm = False
+
+    if confirm:
         for volume in candidates:
             try:
                 volume.remove()

vantage6/cli/node/common/__init__.py

@@ -38,7 +38,9 @@ def create_client(ctx: NodeContext) -> UserClient:
     return UserClient(host, port, api_path, log_level="warn")
 
 
-def create_client_and_authenticate(ctx: NodeContext) -> UserClient:
+def create_client_and_authenticate(
+    ctx: NodeContext, ask_mfa: bool = False
+) -> UserClient:
     """
     Generate a client and authenticate with the server.
 
@@ -46,6 +48,8 @@ def create_client_and_authenticate(ctx: NodeContext) -> UserClient:
     ----------
     ctx : NodeContext
         Context of the node loaded from the configuration file
+    ask_mfa : bool, optional
+        Whether to ask for MFA code, by default False
 
     Returns
     -------
@@ -54,11 +58,14 @@ def create_client_and_authenticate(ctx: NodeContext) -> UserClient:
     """
     client = create_client(ctx)
 
-    username = q.text("Username:").ask()
-    password = q.password("Password:").ask()
+    try:
+        username, password, mfa_code = _get_auth_data()
+    except KeyboardInterrupt:
+        error("Authentication aborted.")
+        exit(1)
 
     try:
-        client.authenticate(username, password)
+        client.authenticate(username, password, mfa_code=mfa_code)
 
     except Exception as exc:
         error("Could not authenticate with server!")
@@ -68,6 +75,21 @@ def create_client_and_authenticate(ctx: NodeContext) -> UserClient:
     return client
 
 
+def _get_auth_data() -> tuple[str, str, str]:
+    """
+    Get authentication data from the user.
+
+    Returns
+    -------
+    tuple[str, str, str]
+        Tuple containing username, password and MFA code
+    """
+    username = q.text("Username:").unsafe_ask()
+    password = q.password("Password:").unsafe_ask()
+    mfa_code = q.text("MFA code:").unsafe_ask()
+    return username, password, mfa_code
+
+
 def select_node(name: str, system_folders: bool) -> tuple[str, str]:
     """
     Let user select node through questionnaire if name is not given.

vantage6/cli/node/create_private_key.py

@@ -59,6 +59,13 @@ from vantage6.cli.node.common import select_node, create_client_and_authenticate
     default=False,
     help="Overwrite existing private key if present",
 )
+@click.option(
+    "--mfa",
+    "ask_mfa",
+    flag_value=True,
+    default=False,
+    help="Ask for multi-factor authentication code. Use this if MFA is enabled on the server.",
+)
 def cli_node_create_private_key(
     name: str,
     config: str,
@@ -66,6 +73,7 @@ def cli_node_create_private_key(
     upload: bool,
     organization_name: str,
     overwrite: bool,
+    ask_mfa: bool,
 ) -> None:
     """
     Create and upload a new private key
@@ -89,7 +97,7 @@ def cli_node_create_private_key(
     # Authenticate with the server to obtain organization name if it wasn't
     # provided
     if organization_name is None:
-        client = create_client_and_authenticate(ctx)
+        client = create_client_and_authenticate(ctx, ask_mfa)
         organization_name = client.whoami.organization_name
 
     # create directory where private key goes if it doesn't exist yet
@@ -103,7 +111,7 @@ def cli_node_create_private_key(
         warning(f"File '{Fore.CYAN}{file_}{Style.RESET_ALL}' exists!")
 
         if overwrite:
-            warning("'--override' specified, so it will be overwritten ...")
+            warning("'--overwrite' specified, so it will be overwritten ...")
 
     if file_.exists() and not overwrite:
         error("Could not create private key!")

vantage6/cli/node/new.py

@@ -1,7 +1,7 @@
 import click
 from colorama import Fore, Style
 
-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 configuration_wizard
@@ -41,13 +41,17 @@ def cli_node_new_configuration(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("Cannot write configuration file. Exiting...")
         exit(1)
 
     # create config in ctx location
     flag = "--system" if system_folders else ""
-    cfg_file = configuration_wizard(InstanceType.NODE, name, system_folders)
+    try:
+        cfg_file = configuration_wizard(InstanceType.NODE, 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"You can start the node by running "