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

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

@@ -1,17 +1,30 @@
 import click
 
-from vantage6.cli.server.attach import cli_server_attach
-from vantage6.cli.server.files import cli_server_files
-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
+from vantage6.cli.algorithm.create import cli_algorithm_create
+from vantage6.cli.algorithm.generate_algorithm_json import (
+    cli_algorithm_generate_algorithm_json,
+)
+from vantage6.cli.algorithm.update import cli_algorithm_update
+from vantage6.cli.algostore.attach import cli_algo_store_attach
+from vantage6.cli.algostore.files import cli_algo_store_files
+from vantage6.cli.algostore.list import cli_algo_store_configuration_list
+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.clean import cli_node_clean
 from vantage6.cli.node.create_private_key import cli_node_create_private_key
 from vantage6.cli.node.files import cli_node_files
 from vantage6.cli.node.list import cli_node_list
@@ -22,29 +35,25 @@ from vantage6.cli.node.set_api_key import cli_node_set_api_key
 from vantage6.cli.node.start import cli_node_start
 from vantage6.cli.node.stop import cli_node_stop
 from vantage6.cli.node.version import cli_node_version
-from vantage6.cli.algorithm.create import cli_algorithm_create
-from vantage6.cli.algorithm.update import cli_algorithm_update
-from vantage6.cli.algorithm.generate_algorithm_json import (
-    cli_algorithm_generate_algorithm_json,
-)
+from vantage6.cli.server.attach import cli_server_attach
+from vantage6.cli.server.files import cli_server_files
+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.start import cli_server_start
+from vantage6.cli.server.stop import cli_server_stop
+from vantage6.cli.server.version import cli_server_version
 
 # from vantage6.cli.test.client_script import cli_test_client_script
-from vantage6.cli.test.feature_tester import cli_test_features
-
 # from vantage6.cli.test.integration_test import cli_test_integration
-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
-from vantage6.cli.algostore.remove import cli_algo_store_remove
+from vantage6.cli.test.feature_tester import cli_test_features
 from vantage6.cli.use.context import cli_use_context
 from vantage6.cli.use.namespace import cli_use_namespace
 
 
 # Define the server group
-@click.group(name="server")
+@click.group(name=CLICommandName.SERVER.value)
 def cli_server() -> None:
     """
     Manage your vantage6 server instances.
@@ -58,14 +67,13 @@ 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")
 
 
 # Define the node group
-@click.group(name="node")
+@click.group(name=CLICommandName.NODE.value)
 def cli_node() -> None:
     """
     Manage your vantage6 node instances.
@@ -74,7 +82,6 @@ def cli_node() -> None:
 
 # Define the commands for the node group
 cli_node.add_command(cli_node_attach, name="attach")
-cli_node.add_command(cli_node_clean, name="clean")
 cli_node.add_command(cli_node_create_private_key, name="create-private-key")
 cli_node.add_command(cli_node_files, name="files")
 cli_node.add_command(cli_node_list, name="list")
@@ -88,20 +95,24 @@ cli_node.add_command(cli_node_version, name="version")
 
 
 # Define the dev group
-@click.group(name="dev")
+@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
-@click.group(name="algorithm")
+@click.group(name=CLICommandName.ALGORITHM.value)
 def cli_algorithm() -> None:
     """
     Manage your vantage6 algorithms.
@@ -117,7 +128,7 @@ cli_algorithm.add_command(
 
 
 # Define the test group
-@click.group(name="test")
+@click.group(name=CLICommandName.TEST.value)
 def cli_test() -> None:
     """
     Execute tests on your vantage6 infrastructure.
@@ -131,7 +142,7 @@ cli_test.add_command(cli_test_features, name="feature-test")
 
 
 # Define the algorithm-store group
-@click.group(name="algorithm-store")
+@click.group(name=CLICommandName.ALGORITHM_STORE.value)
 def cli_algo_store() -> None:
     """
     Manage your vantage6 algorithm store server instances.
@@ -148,8 +159,26 @@ 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="use")
+@click.group(name=CLICommandName.USE.value)
 def cli_use() -> None:
     """
     Manage Kubernetes context and namespace.
@@ -180,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/new.py

@@ -11,8 +11,31 @@ from vantage6.cli.utils import check_config_name_allowed, prompt_config_name
 
 
 def new(
-    name: str, system_folders: bool, namespace: str, context: str, type_: InstanceType
-):
+    questionnaire_function: callable,
+    name: str,
+    system_folders: bool,
+    namespace: str,
+    context: str,
+    type_: InstanceType,
+) -> None:
+    """
+    Create a new configuration.
+
+    Parameters
+    ----------
+    questionnaire_function : callable
+        Function to generate the configuration
+    name : str
+        Name of the configuration
+    system_folders : bool
+        Whether to store the configuration in the system folders
+    namespace : str
+        Namespace to use
+    context : str
+        Context to use
+    type_ : InstanceType
+        Type of the configuration (node, server, algorithm store, etc)
+    """
     cli_config = CliConfig()
     context, namespace = cli_config.compare_changes_config(
         context=context,
@@ -47,7 +70,9 @@ def new(
 
     # create config in ctx location
     try:
-        cfg_file = configuration_wizard(type_, name, system_folders)
+        cfg_file = configuration_wizard(
+            questionnaire_function, type_, name, system_folders
+        )
     except KeyboardInterrupt:
         error("Configuration creation aborted.")
         exit(1)

vantage6/cli/common/remove.py

@@ -0,0 +1,54 @@
+import itertools
+from pathlib import Path
+from shutil import rmtree
+
+import questionary as q
+
+from vantage6.common import (
+    error,
+    info,
+)
+from vantage6.common.context import AppContext
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.utils import check_running
+from vantage6.cli.globals import InfraComponentName
+from vantage6.cli.utils import remove_file
+
+
+def execute_remove(
+    ctx: AppContext,
+    instance_type: InstanceType,
+    infra_component: InfraComponentName,
+    name: str,
+    system_folders: bool,
+    force: bool,
+) -> None:
+    if check_running(ctx.helm_release_name, instance_type, name, system_folders):
+        error(
+            f"The {infra_component.value} {name} is still running! Please stop the "
+            f"{infra_component.value} before deleting it."
+        )
+        exit(1)
+
+    if not force:
+        if not q.confirm(
+            f"This {infra_component.value} will be deleted permanently including its "
+            "configuration. Are you sure?",
+            default=False,
+        ).ask():
+            info(f"The {infra_component.value} {name} will not be deleted")
+            exit(0)
+
+    # remove the config file
+    remove_file(ctx.config_file, "configuration")
+
+    # ensure log files are closed before removing
+    log_dir = Path(ctx.log_file.parent)
+    if log_dir.exists():
+        info(f"Removing log directory: {log_dir}")
+        for handler in itertools.chain(ctx.log.handlers, ctx.log.root.handlers):
+            handler.close()
+        # remove the whole folder with all the log files. This may also still contain
+        # other files like (for the server) RabbitMQ configuration etc
+        rmtree(log_dir)

vantage6/cli/common/start.py

@@ -10,6 +10,7 @@ import docker
 from docker.client import DockerClient
 
 from vantage6.common import error, info, warning
+from vantage6.common.context import AppContext
 from vantage6.common.docker.addons import pull_image
 from vantage6.common.globals import (
     DEFAULT_ALGO_STORE_IMAGE,
@@ -21,8 +22,36 @@ from vantage6.common.globals import (
     InstanceType,
 )
 
+from vantage6.cli.common.utils import (
+    check_running,
+    select_context_and_namespace,
+)
 from vantage6.cli.globals import ChartName
-from vantage6.cli.utils import validate_input_cmd_args
+from vantage6.cli.utils import check_config_name_allowed, validate_input_cmd_args
+
+
+def prestart_checks(
+    ctx: AppContext,
+    instance_type: InstanceType,
+    name: str,
+    system_folders: bool,
+    context: str,
+    namespace: str,
+) -> None:
+    """
+    Run pre-start checks for an instance.
+    """
+
+    check_config_name_allowed(ctx.name)
+
+    if check_running(ctx.helm_release_name, instance_type, name, system_folders):
+        error(f"Instance '{name}' is already running.")
+        exit(1)
+
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
 
 
 def pull_infra_image(
@@ -171,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/stop.py

@@ -2,11 +2,89 @@ from __future__ import annotations
 
 import subprocess
 
-from vantage6.common import error, info, warning
+from colorama import Fore, Style
 
+from vantage6.common import error, info, warning
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.utils import (
+    find_running_service_names,
+    select_context_and_namespace,
+    select_running_service,
+)
+from vantage6.cli.context import get_context
+from vantage6.cli.globals import InfraComponentName
 from vantage6.cli.utils import validate_input_cmd_args
 
 
+def execute_stop(
+    stop_function: callable,
+    instance_type: InstanceType,
+    infra_component: InfraComponentName,
+    stop_all: bool,
+    to_stop: str | None,
+    namespace: str,
+    context: str,
+    system_folders: bool,
+):
+    """
+    Execute the stop function for a given instance type and infra component.
+
+    Parameters
+    ----------
+    stop_function : callable
+        The function to stop the service.
+    instance_type : InstanceType
+        The instance type of the service.
+    infra_component : InfraComponentName
+        The infra component of the service.
+    stop_all : bool
+        Whether to stop all services.
+    to_stop : str | None
+        The name of the service to stop.
+    namespace : str
+        The namespace of the service.
+    context : str
+        The context of the service.
+    system_folders : bool
+        Whether to use system folders.
+    """
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
+
+    running_services = find_running_service_names(
+        instance_type=instance_type,
+        only_system_folders=system_folders,
+        only_user_folders=not system_folders,
+        context=context,
+        namespace=namespace,
+    )
+
+    if not running_services:
+        error(f"No running {infra_component.value}s found.")
+        return
+
+    if stop_all:
+        for service in running_services:
+            stop_function(service, namespace, context)
+    else:
+        if not to_stop:
+            helm_name = select_running_service(running_services, instance_type)
+        else:
+            ctx = get_context(instance_type, to_stop, system_folders)
+            helm_name = ctx.helm_release_name
+
+        if helm_name in running_services:
+            stop_function(helm_name, namespace, context)
+            info(
+                f"Stopped the {Fore.GREEN}{helm_name}{Style.RESET_ALL} {infra_component.value}."
+            )
+        else:
+            error(f"{Fore.RED}{to_stop}{Style.RESET_ALL} is not running?!")
+
+
 def stop_port_forward(service_name: str) -> None:
     """
     Stop the port forwarding process for a given service name.

vantage6/cli/common/utils.py

@@ -14,6 +14,7 @@ from vantage6.common.globals import APPNAME, STRING_ENCODING, InstanceType
 
 from vantage6.cli.config import CliConfig
 from vantage6.cli.context import select_context_class
+from vantage6.cli.globals import CLICommandName
 from vantage6.cli.utils import validate_input_cmd_args
 
 
@@ -173,7 +174,7 @@ def select_running_service(
     """
     try:
         name = q.select(
-            f"Select the {instance_type.value} you wish to inspect:",
+            f"Select a {instance_type.value}:",
             choices=running_services,
         ).unsafe_ask()
     except KeyboardInterrupt:
@@ -340,6 +341,16 @@ def get_name_from_container_name(container_name: str) -> str:
     return "-".join(container_name.split("-")[1:-1])
 
 
+def get_config_name_from_service_name(service_name: str) -> str:
+    """
+    Get the config name from a service name.
+    """
+    # helm release name is structured as:
+    # f"{APPNAME}-{name}-{scope}-{instance_type}"
+    # we want to get the name from the service name
+    return "-".join(service_name.split("-")[1:-2])
+
+
 def attach_logs(*labels: list[str]) -> None:
     """
     Attach to the logs of the given labels.
@@ -364,10 +375,42 @@ def get_main_cli_command_name(instance_type: InstanceType) -> str:
         The type of instance to get the main CLI command name for
     """
     if instance_type == InstanceType.SERVER:
-        return "server"
+        return CLICommandName.SERVER.value
     elif instance_type == InstanceType.ALGORITHM_STORE:
-        return "algorithm-store"
+        return CLICommandName.ALGORITHM_STORE.value
     elif instance_type == InstanceType.NODE:
-        return "node"
+        return CLICommandName.NODE.value
+    elif instance_type == InstanceType.AUTH:
+        return CLICommandName.AUTH.value
     else:
         raise ValueError(f"Invalid instance type: {instance_type}")
+
+
+def check_running(
+    helm_release_name: str, instance_type: InstanceType, name: str, system_folders: bool
+) -> bool:
+    """
+    Check if the instance is already running.
+
+    Parameters
+    ----------
+    helm_release_name : str
+        The name of the Helm release.
+    instance_type : InstanceType
+        The type of instance to check
+    name : str
+        The name of the instance to check
+    system_folders : bool
+        Whether to use system folders or not
+
+    Returns
+    -------
+    bool
+        True if the instance is already running, False otherwise
+    """
+    running_services = find_running_service_names(
+        instance_type=instance_type,
+        only_system_folders=system_folders,
+        only_user_folders=not system_folders,
+    )
+    return helm_release_name in running_services

vantage6/cli/configuration_manager.py

@@ -1,10 +1,15 @@
 from typing import Self
 
-from schema import And, Optional, Or, Use
+from schema import And, Use
 
 from vantage6.common.configuration_manager import Configuration, ConfigurationManager
 
-from vantage6.cli.globals import ALGO_STORE_TEMPLATE_FILE, SERVER_TEMPLATE_FILE
+from vantage6.cli.globals import (
+    ALGO_STORE_TEMPLATE_FILE,
+    AUTH_TEMPLATE_FILE,
+    NODE_TEMPLATE_FILE,
+    SERVER_TEMPLATE_FILE,
+)
 
 LOGGING_VALIDATORS = {
     "level": And(
@@ -43,21 +48,30 @@ 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 = {
-        "server_url": Use(str),
-        "port": Or(Use(int), None),
-        "task_dir": Use(str),
-        # TODO: remove `dict` validation from databases
-        "api_path": Use(str),
-        "logging": LOGGING_VALIDATORS,
-        "encryption": {"enabled": bool, Optional("private_key"): Use(str)},
-        Optional("node_extra_env"): dict,
-        Optional("node_extra_mounts"): [str],
-        Optional("node_extra_hosts"): dict,
-        Optional("share_algorithm_logs"): Use(bool),
+        # # TODO enable validators for node. To see if it works, use v6 node list
+        # "node": {
+        #     "server_url": Use(str),
+        #     "port": Or(Use(int), None),
+        #     "task_dir": Use(str),
+        #     # TODO: remove `dict` validation from databases
+        #     "api_path": Use(str),
+        #     "logging": LOGGING_VALIDATORS,
+        #     "encryption": {"enabled": bool, Optional("private_key"): Use(str)},
+        #     Optional("node_extra_env"): dict,
+        #     Optional("node_extra_mounts"): [str],
+        #     Optional("node_extra_hosts"): dict,
+        #     Optional("share_algorithm_logs"): Use(bool),
+        # }
     }
 
 
+class AuthConfiguration(Configuration):
+    VALIDATORS = {}
+
+
 class TestConfiguration(Configuration):
     VALIDATORS = {}
 
@@ -93,6 +107,12 @@ class NodeConfigurationManager(ConfigurationManager):
         """
         return super().from_file(path, conf_class=NodeConfiguration)
 
+    def get_config_template(self) -> str:
+        """
+        Get the configuration template for the node.
+        """
+        return super()._get_config_template(NODE_TEMPLATE_FILE)
+
 
 class ServerConfigurationManager(ConfigurationManager):
     """
@@ -180,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)