vantage6 5.0.0a35__py3-none-any.whl → 5.0.0a36__py3-none-any.whl

vantage6/cli/algorithm/generate_algorithm_json.py

@@ -276,23 +276,23 @@ class Function:
         else:
             type_ = param.annotation
 
-        if type_ == str:
+        if type_ is str:
             return AlgorithmArgumentType.STRING
-        elif type_ == dict:
+        elif type_ is dict:
             return AlgorithmArgumentType.JSON
-        elif type_ == int:
+        elif type_ is int:
             return AlgorithmArgumentType.INTEGER
-        elif type_ == float:
+        elif type_ is float:
             return AlgorithmArgumentType.FLOAT
-        elif type_ == bool:
+        elif type_ is bool:
             return AlgorithmArgumentType.BOOLEAN
-        elif type_ == list:
+        elif type_ is list:
             return AlgorithmArgumentType.STRINGS
-        elif type_ == list[str]:
+        elif type_ is list[str]:
             return AlgorithmArgumentType.STRINGS
-        elif type_ == list[int]:
+        elif type_ is list[int]:
             return AlgorithmArgumentType.INTEGERS
-        elif type_ == list[float]:
+        elif type_ is list[float]:
             return AlgorithmArgumentType.FLOATS
         else:
             warning(

vantage6/cli/algorithm/update.py

@@ -2,9 +2,9 @@ import os
 from pathlib import Path
 
 import click
+import copier.errors
 import questionary as q
 from copier import run_update
-import copier.errors
 
 from vantage6.common import info, warning
 

vantage6/cli/algostore/attach.py

@@ -1,6 +1,7 @@
 import click
 
 from vantage6.common import info
+
 from vantage6.cli.common.utils import attach_logs
 
 

vantage6/cli/algostore/files.py

@@ -1,10 +1,11 @@
 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
 
+from vantage6.cli.common.decorator import click_insert_context
+from vantage6.cli.context.server import ServerContext
+
 
 @click.command()
 @click_insert_context(type_=InstanceType.ALGORITHM_STORE)

vantage6/cli/algostore/list.py

@@ -1,6 +1,5 @@
 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
@@ -11,6 +10,4 @@ def cli_algo_store_configuration_list() -> None:
     """
     Print the available server configurations.
     """
-    check_docker_running()
-
     get_server_configuration_list(InstanceType.ALGORITHM_STORE)

vantage6/cli/auth/attach.py

@@ -0,0 +1,60 @@
+import click
+
+from vantage6.common import error, info
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.utils import (
+    attach_logs,
+    find_running_service_names,
+    select_context_and_namespace,
+    select_running_service,
+)
+
+
+@click.command()
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option("--namespace", default=None, help="Kubernetes namespace to use")
+@click.option(
+    "-n", "--name", default=None, help="Name of the auth service to attach to"
+)
+def cli_auth_attach(context: str, namespace: str, name: str) -> None:
+    """
+    Show the server logs in the current console.
+    """
+    info("Attaching to auth logs...")
+
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
+
+    running_services = find_running_service_names(
+        instance_type=InstanceType.AUTH,
+        only_system_folders=False,
+        only_user_folders=False,
+        context=context,
+        namespace=namespace,
+    )
+
+    if not running_services:
+        error("No running auth services found.")
+        return
+
+    if name:
+        # search for a running auth service started up either in user or system folders
+        svc_name_options = [
+            f"vantage6-{name}-user-auth",
+            f"vantage6-{name}-system-auth",
+        ]
+        helm_name = next(
+            (svc for svc in svc_name_options if svc in running_services), None
+        )
+        if not helm_name:
+            error(f"No running auth service found for {name}.")
+            return
+    else:
+        helm_name = select_running_service(running_services, InstanceType.AUTH)
+
+    attach_logs(
+        f"app.kubernetes.io/instance={helm_name}",
+    )

vantage6/cli/auth/files.py

@@ -0,0 +1,16 @@
+import click
+
+from vantage6.common import info
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.decorator import click_insert_context
+from vantage6.cli.context.auth import AuthContext
+
+
+@click.command()
+@click_insert_context(type_=InstanceType.AUTH)
+def cli_auth_files(ctx: AuthContext) -> None:
+    """
+    List files that belong to a particular auth instance.
+    """
+    info(f"Configuration file = {ctx.config_file}")

vantage6/cli/auth/list.py

@@ -0,0 +1,13 @@
+import click
+
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.utils import get_server_configuration_list
+
+
+@click.command()
+def cli_auth_configuration_list() -> None:
+    """
+    Print the available auth configurations.
+    """
+    get_server_configuration_list(InstanceType.AUTH)

vantage6/cli/auth/new.py

@@ -0,0 +1,80 @@
+from typing import Any
+
+import click
+import questionary as q
+
+from vantage6.common.globals import (
+    InstanceType,
+)
+
+from vantage6.cli.common.new import new
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
+
+
+@click.command()
+@click.option(
+    "-n", "--name", default=None, help="name of the configuration you want to use."
+)
+@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",
+)
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option(
+    "--namespace",
+    default=None,
+    help="Kubernetes namespace to use",
+)
+def cli_auth_new(
+    name: str,
+    system_folders: bool,
+    namespace: str,
+    context: str,
+) -> None:
+    """
+    Create a new server configuration.
+    """
+    new(
+        questionnaire_function=auth_configuration_questionaire,
+        name=name,
+        system_folders=system_folders,
+        namespace=namespace,
+        context=context,
+        type_=InstanceType.AUTH,
+    )
+
+
+def auth_configuration_questionaire(instance_name: str) -> dict[str, Any]:
+    """
+    Kubernetes-specific questionnaire to generate Helm values for the Keycloak helm
+    chart.
+    """
+    config = {"keycloak": {}}
+
+    is_production = q.confirm(
+        "Do you want to use production settings? If not, the service will be configured"
+        " to be more suitable for development or testing purposes.",
+        default=True,
+    ).unsafe_ask()
+
+    config["keycloak"]["production"] = is_production
+
+    if is_production:
+        ui_url = q.text(
+            "Please provide the URL of the UI. This is the URL that users will use to "
+            "log in to the service.",
+            default="https://ui.vantage6.ai",
+        ).unsafe_ask()
+        # add http://localhost:7681 as that is used by the Python client
+        config["keycloak"]["redirectUris"] = [ui_url, "http://localhost:7681"]
+
+    return config

vantage6/cli/auth/remove.py

@@ -0,0 +1,31 @@
+import click
+
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.decorator import click_insert_context
+from vantage6.cli.common.remove import execute_remove
+from vantage6.cli.context.auth import AuthContext
+from vantage6.cli.globals import InfraComponentName
+
+
+@click.command()
+@click_insert_context(
+    type_=InstanceType.AUTH, include_name=True, include_system_folders=True
+)
+@click.option("-f", "--force", "force", flag_value=True)
+def cli_auth_remove(
+    ctx: AuthContext, name: str, system_folders: bool, force: bool
+) -> None:
+    """
+    Function to remove a server.
+
+    Parameters
+    ----------
+    ctx : ServerContext
+        Server context object
+    force : bool
+        Whether to ask for confirmation before removing or not
+    """
+    execute_remove(
+        ctx, InstanceType.AUTH, InfraComponentName.AUTH, name, system_folders, force
+    )

vantage6/cli/auth/start.py

@@ -0,0 +1,80 @@
+import click
+
+from vantage6.common import info
+from vantage6.common.globals import InstanceType, Ports
+
+from vantage6.cli.common.decorator import click_insert_context
+from vantage6.cli.common.start import (
+    helm_install,
+    prestart_checks,
+    start_port_forward,
+)
+from vantage6.cli.common.utils import (
+    attach_logs,
+)
+from vantage6.cli.context.auth import AuthContext
+from vantage6.cli.globals import ChartName
+
+
+@click.command()
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option("--namespace", default=None, help="Kubernetes namespace to use")
+@click.option("--ip", default=None, help="IP address to listen on")
+@click.option(
+    "-p",
+    "--port",
+    default=None,
+    type=int,
+    help="Port to listen on for the auth service",
+)
+@click.option(
+    "--attach/--detach",
+    default=False,
+    help="Print server logs to the console after start",
+)
+@click_insert_context(
+    type_=InstanceType.AUTH, include_name=True, include_system_folders=True
+)
+def cli_auth_start(
+    ctx: AuthContext,
+    name: str,
+    system_folders: bool,
+    context: str,
+    namespace: str,
+    ip: str,
+    port: int,
+    attach: bool,
+) -> None:
+    """
+    Start the auth service.
+    """
+    info("Starting authentication service...")
+
+    prestart_checks(ctx, InstanceType.AUTH, name, system_folders, context, namespace)
+
+    # TODO: re-enable when we save the auth logs
+    # create_directory_if_not_exists(ctx.log_dir)
+
+    helm_install(
+        release_name=ctx.helm_release_name,
+        chart_name=ChartName.AUTH,
+        values_file=ctx.config_file,
+        context=context,
+        namespace=namespace,
+    )
+
+    # port forward for auth service
+    info("Port forwarding for auth service")
+    start_port_forward(
+        service_name=f"{ctx.helm_release_name}-keycloak",
+        service_port=Ports.HTTP.value,
+        port=port or Ports.DEV_AUTH.value,
+        ip=ip,
+        context=context,
+        namespace=namespace,
+    )
+
+    if attach:
+        attach_logs(
+            f"app.kubernetes.io/instance={ctx.helm_release_name}",
+        )

vantage6/cli/auth/stop.py

@@ -0,0 +1,64 @@
+import click
+
+from vantage6.common import info
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.stop import execute_stop, helm_uninstall, stop_port_forward
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS, InfraComponentName
+
+
+@click.command()
+@click.option("-n", "--name", default=None, help="Configuration name")
+@click.option("--context", default=None, help="Kubernetes context to use")
+@click.option("--namespace", default=None, help="Kubernetes namespace to use")
+@click.option(
+    "--system",
+    "system_folders",
+    flag_value=True,
+    default=DEFAULT_SERVER_SYSTEM_FOLDERS,
+    help="Search for configuration in system folders instead of user folders. "
+    "This is the default.",
+)
+@click.option(
+    "--user",
+    "system_folders",
+    flag_value=False,
+    help="Search for configuration in the user folders instead of system folders.",
+)
+def cli_auth_stop(
+    name: str,
+    context: str,
+    namespace: str,
+    system_folders: bool,
+):
+    """
+    Stop a running auth service.
+    """
+    execute_stop(
+        stop_function=_stop_auth,
+        instance_type=InstanceType.AUTH,
+        infra_component=InfraComponentName.AUTH,
+        stop_all=False,
+        to_stop=name,
+        namespace=namespace,
+        context=context,
+        system_folders=system_folders,
+    )
+
+
+def _stop_auth(auth_name: str, namespace: str, context: str) -> None:
+    info(f"Stopping auth {auth_name}...")
+
+    # uninstall the helm release
+    helm_uninstall(
+        release_name=auth_name,
+        context=context,
+        namespace=namespace,
+    )
+
+    # stop the port forwarding for auth service
+    stop_port_forward(
+        service_name=f"{auth_name}-keycloak",
+    )
+
+    info(f"Auth {auth_name} stopped successfully.")

vantage6/cli/cli.py

@@ -12,6 +12,17 @@ from vantage6.cli.algostore.new import cli_algo_store_new
 from vantage6.cli.algostore.remove import cli_algo_store_remove
 from vantage6.cli.algostore.start import cli_algo_store_start
 from vantage6.cli.algostore.stop import cli_algo_store_stop
+from vantage6.cli.auth.attach import cli_auth_attach
+from vantage6.cli.auth.files import cli_auth_files
+from vantage6.cli.auth.list import cli_auth_configuration_list
+from vantage6.cli.auth.new import cli_auth_new
+from vantage6.cli.auth.remove import cli_auth_remove
+from vantage6.cli.auth.start import cli_auth_start
+from vantage6.cli.auth.stop import cli_auth_stop
+from vantage6.cli.dev.clean import cli_clean_dev_env
+from vantage6.cli.dev.rebuild import cli_rebuild_dev_env
+from vantage6.cli.dev.start import cli_start_dev_env
+from vantage6.cli.dev.stop import cli_stop_dev_env
 from vantage6.cli.globals import CLICommandName
 from vantage6.cli.node.attach import cli_node_attach
 from vantage6.cli.node.create_private_key import cli_node_create_private_key
@@ -30,7 +41,6 @@ from vantage6.cli.server.import_ import cli_server_import
 from vantage6.cli.server.list import cli_server_configuration_list
 from vantage6.cli.server.new import cli_server_new
 from vantage6.cli.server.remove import cli_server_remove
-from vantage6.cli.server.shell import cli_server_shell
 from vantage6.cli.server.start import cli_server_start
 from vantage6.cli.server.stop import cli_server_stop
 from vantage6.cli.server.version import cli_server_version
@@ -57,7 +67,6 @@ cli_server.add_command(cli_server_import, name="import")
 cli_server.add_command(cli_server_configuration_list, name="list")
 cli_server.add_command(cli_server_new, name="new")
 cli_server.add_command(cli_server_remove, name="remove")
-cli_server.add_command(cli_server_shell, name="shell")
 cli_server.add_command(cli_server_start, name="start")
 cli_server.add_command(cli_server_stop, name="stop")
 cli_server.add_command(cli_server_version, name="version")
@@ -89,13 +98,17 @@ cli_node.add_command(cli_node_version, name="version")
 @click.group(name=CLICommandName.DEV.value)
 def cli_dev() -> None:
     """
-    Quickly manage a test network with a server and several nodes.
+    Spin up a local development network.
 
-    These commands are helpful for local testing of your vantage6 environment.
+    In this environment, any code changes you make will be reflected in the running
+    services.
     """
 
 
-# TODO add commands for the dev group
+cli_dev.add_command(cli_start_dev_env, name="start")
+cli_dev.add_command(cli_stop_dev_env, name="stop")
+cli_dev.add_command(cli_rebuild_dev_env, name="rebuild")
+cli_dev.add_command(cli_clean_dev_env, name="clean")
 
 
 # Define the algorithm group
@@ -146,6 +159,24 @@ cli_algo_store.add_command(cli_algo_store_configuration_list, name="list")
 cli_algo_store.add_command(cli_algo_store_remove, name="remove")
 
 
+# Define the auth group
+@click.group(name=CLICommandName.AUTH.value)
+def cli_auth() -> None:
+    """
+    Manage your vantage6 authentication server instances.
+    """
+
+
+# Define the commands for the auth group
+cli_auth.add_command(cli_auth_new, name="new")
+cli_auth.add_command(cli_auth_start, name="start")
+cli_auth.add_command(cli_auth_stop, name="stop")
+cli_auth.add_command(cli_auth_attach, name="attach")
+cli_auth.add_command(cli_auth_files, name="files")
+cli_auth.add_command(cli_auth_configuration_list, name="list")
+cli_auth.add_command(cli_auth_remove, name="remove")
+
+
 # Add the use group
 @click.group(name=CLICommandName.USE.value)
 def cli_use() -> None:
@@ -178,3 +209,4 @@ cli_complete.add_command(cli_algorithm)
 cli_complete.add_command(cli_test)
 cli_complete.add_command(cli_algo_store)
 cli_complete.add_command(cli_use)
+cli_complete.add_command(cli_auth)

vantage6/cli/common/start.py

@@ -200,7 +200,7 @@ def helm_install(
         )
         info(
             f"Successfully installed release '{release_name}' using chart "
-            f"'{chart_name}'."
+            f"'{chart_name.value}'."
         )
     except subprocess.CalledProcessError:
         error(f"Failed to install release '{release_name}'.")

vantage6/cli/common/utils.py

@@ -380,6 +380,8 @@ def get_main_cli_command_name(instance_type: InstanceType) -> str:
         return CLICommandName.ALGORITHM_STORE.value
     elif instance_type == InstanceType.NODE:
         return CLICommandName.NODE.value
+    elif instance_type == InstanceType.AUTH:
+        return CLICommandName.AUTH.value
     else:
         raise ValueError(f"Invalid instance type: {instance_type}")
 

vantage6/cli/configuration_manager.py

@@ -6,6 +6,7 @@ from vantage6.common.configuration_manager import Configuration, ConfigurationMa
 
 from vantage6.cli.globals import (
     ALGO_STORE_TEMPLATE_FILE,
+    AUTH_TEMPLATE_FILE,
     NODE_TEMPLATE_FILE,
     SERVER_TEMPLATE_FILE,
 )
@@ -47,6 +48,8 @@ class NodeConfiguration(Configuration):
     validators.
     """
 
+    # TODO perhaps we can remove these classes and do validation of the configuration
+    # file more easily with helm values.yaml checks.
     VALIDATORS = {
         # # TODO enable validators for node. To see if it works, use v6 node list
         # "node": {
@@ -65,6 +68,10 @@ class NodeConfiguration(Configuration):
     }
 
 
+class AuthConfiguration(Configuration):
+    VALIDATORS = {}
+
+
 class TestConfiguration(Configuration):
     VALIDATORS = {}
 
@@ -193,6 +200,30 @@ class AlgorithmStoreConfigurationManager(ConfigurationManager):
         return super()._get_config_template(ALGO_STORE_TEMPLATE_FILE)
 
 
+class AuthConfigurationManager(ConfigurationManager):
+    """
+    Maintains the auth's configuration.
+
+    Parameters
+    ----------
+    name : str
+        Name of the configuration file.
+    """
+
+    def __init__(self, name, *args, **kwargs):
+        super().__init__(conf_class=AuthConfiguration, name=name)
+
+    @classmethod
+    def from_file(cls, path: str) -> Self:
+        return super().from_file(path, conf_class=AuthConfiguration)
+
+    def get_config_template(self) -> str:
+        """
+        Get the configuration template for the auth.
+        """
+        return super()._get_config_template(AUTH_TEMPLATE_FILE)
+
+
 class TestingConfigurationManager(ConfigurationManager):
     def __init__(self, name, *args, **kwargs):
         super().__init__(conf_class=TestConfiguration, name=name)

vantage6/cli/configuration_wizard.py

@@ -12,6 +12,7 @@ from vantage6.common.globals import (
 
 from vantage6.cli.configuration_manager import (
     AlgorithmStoreConfigurationManager,
+    AuthConfigurationManager,
     NodeConfigurationManager,
     ServerConfigurationManager,
 )
@@ -167,8 +168,12 @@ def configuration_wizard(
         conf_manager = NodeConfigurationManager
     elif type_ == InstanceType.SERVER:
         conf_manager = ServerConfigurationManager
-    else:
+    elif type_ == InstanceType.ALGORITHM_STORE:
         conf_manager = AlgorithmStoreConfigurationManager
+    elif type_ == InstanceType.AUTH:
+        conf_manager = AuthConfigurationManager
+    else:
+        raise ValueError(f"Invalid instance type: {type_}")
 
     if Path(config_file).exists():
         config_manager = conf_manager.from_file(config_file)

vantage6/cli/context/__init__.py

@@ -14,6 +14,7 @@ from vantage6.common import error
 from vantage6.common.globals import InstanceType
 
 from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
+from vantage6.cli.context.auth import AuthContext
 from vantage6.cli.context.node import NodeContext
 from vantage6.cli.context.server import ServerContext
 
@@ -45,6 +46,8 @@ def select_context_class(
         return AlgorithmStoreContext
     elif type_ == InstanceType.NODE:
         return NodeContext
+    elif type_ == InstanceType.AUTH:
+        return AuthContext
     else:
         raise NotImplementedError