vantage6 5.0.0a33__tar.gz → 5.0.0a34__tar.gz

{vantage6-5.0.0a33 → vantage6-5.0.0a34}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vantage6
-Version: 5.0.0a33
+Version: 5.0.0a34
 Summary: vantage6 command line interface
 Author: Vantage6 Team
 Maintainer-email: Frank Martin <f.martin@iknl.nl>, Bart van Beusekom <b.vanbeusekom@iknl.nl>
@@ -8,7 +8,7 @@ License: MIT
 Requires-Python: >=3.13
 Requires-Dist: click==8.1.3
 Requires-Dist: colorama==0.4.6
-Requires-Dist: copier==9.2.0
+Requires-Dist: copier==9.9.1
 Requires-Dist: docker==7.1.0
 Requires-Dist: ipython==8.10.0
 Requires-Dist: jinja2==3.1.6
@@ -18,8 +18,8 @@ Requires-Dist: questionary==1.10.0
 Requires-Dist: rich==13.5.2
 Requires-Dist: schema==0.7.5
 Requires-Dist: sqlalchemy==2.0.37
-Requires-Dist: vantage6-client==5.0.0a33
-Requires-Dist: vantage6-common==5.0.0a33
+Requires-Dist: vantage6-client==5.0.0a34
+Requires-Dist: vantage6-common==5.0.0a34
 Provides-Extra: dev
 Requires-Dist: black; extra == 'dev'
 Requires-Dist: coverage==7.10.2; extra == 'dev'

{vantage6-5.0.0a33 → vantage6-5.0.0a34}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "vantage6"
-version = "5.0.0a33"
+version = "5.0.0a34"
 description = "vantage6 command line interface"
 readme = "README.md"
 license = {text = "MIT"}
@@ -19,7 +19,7 @@ requires-python = ">=3.13"
 dependencies = [
     "click==8.1.3",
     "colorama==0.4.6",
-    "copier==9.2.0",
+    "copier==9.9.1",
     "docker==7.1.0",
     "ipython==8.10.0",
     "jinja2==3.1.6",
@@ -29,8 +29,8 @@ dependencies = [
     "rich==13.5.2",
     "schema==0.7.5",
     "sqlalchemy==2.0.37",
-    "vantage6-common==5.0.0a33",
-    "vantage6-client==5.0.0a33",
+    "vantage6-common==5.0.0a34",
+    "vantage6-client==5.0.0a34",
 ]
 
 [project.optional-dependencies]

{vantage6-5.0.0a33 → vantage6-5.0.0a34}/tests_cli/test_server_cli.py

@@ -134,7 +134,7 @@ class ServerCLITest(unittest.TestCase):
         """Stop server without errors."""
 
         container1 = MagicMock()
-        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER}"
+        container1.name = f"{APPNAME}-iknl-system-{InstanceType.SERVER.value}"
         containers.containers.list.return_value = [container1]
 
         runner = CliRunner()

{vantage6-5.0.0a33 → vantage6-5.0.0a34}/tests_cli/test_wizard.py

@@ -92,7 +92,7 @@ class WizardTest(unittest.TestCase):
                 False,
             ]
 
-            config = server_configuration_questionaire("vantage6")
+            config = server_configuration_questionaire()
 
             keys = [
                 "description",

vantage6-5.0.0a34/vantage6/cli/algostore/new.py

@@ -0,0 +1,39 @@
+import click
+
+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_algo_store_new(
+    name: str, system_folders: bool, namespace: str, context: str
+) -> None:
+    """
+    Create a new server configuration.
+    """
+
+    new(name, system_folders, namespace, context, InstanceType.ALGORITHM_STORE)

vantage6-5.0.0a34/vantage6/cli/algostore/start.py

@@ -0,0 +1,73 @@
+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,
+    start_port_forward,
+)
+from vantage6.cli.common.utils import (
+    attach_logs,
+    create_directory_if_not_exists,
+    select_context_and_namespace,
+)
+from vantage6.cli.context.algorithm_store import AlgorithmStoreContext
+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")
+@click.option(
+    "--attach/--detach",
+    default=False,
+    help="Print server logs to the console after start",
+)
+@click_insert_context(InstanceType.ALGORITHM_STORE)
+def cli_algo_store_start(
+    ctx: AlgorithmStoreContext,
+    context: str,
+    namespace: str,
+    ip: str,
+    port: int,
+    attach: bool,
+) -> None:
+    """
+    Start the algorithm store.
+    """
+    info("Starting algorithm store...")
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
+
+    create_directory_if_not_exists(ctx.log_dir)
+
+    helm_install(
+        release_name=ctx.helm_release_name,
+        chart_name=ChartName.ALGORITHM_STORE,
+        values_file=ctx.config_file,
+        context=context,
+        namespace=namespace,
+    )
+
+    # port forward for server
+    info("Port forwarding for algorithm store")
+    start_port_forward(
+        service_name=f"{ctx.helm_release_name}-vantage6-algorithm-store-service",
+        service_port=ctx.config["store"].get("port", Ports.DEV_ALGO_STORE.value),
+        port=port or ctx.config["store"].get("port", Ports.DEV_ALGO_STORE.value),
+        ip=ip,
+        context=context,
+        namespace=namespace,
+    )
+
+    if attach:
+        attach_logs("app=store", "component=store-server")

vantage6-5.0.0a34/vantage6/cli/algostore/stop.py

@@ -0,0 +1,96 @@
+import click
+from colorama import Fore, Style
+
+from vantage6.common import error, info
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli.common.stop import helm_uninstall, stop_port_forward
+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 DEFAULT_SERVER_SYSTEM_FOLDERS
+
+
+@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.",
+)
+@click.option("--all", "all_stores", flag_value=True, help="Stop all algorithm stores")
+def cli_algo_store_stop(
+    name: str,
+    context: str,
+    namespace: str,
+    system_folders: bool,
+    all_stores: bool,
+):
+    """
+    Stop one or all running algorithm store(s).
+    """
+    context, namespace = select_context_and_namespace(
+        context=context,
+        namespace=namespace,
+    )
+
+    running_stores = find_running_service_names(
+        instance_type=InstanceType.ALGORITHM_STORE,
+        only_system_folders=system_folders,
+        only_user_folders=not system_folders,
+        context=context,
+        namespace=namespace,
+    )
+
+    if not running_stores:
+        error("No running algorithm stores found.")
+        return
+
+    if all_stores:
+        for store in running_stores:
+            _stop_store(store["name"], namespace, context)
+    else:
+        if not name:
+            store_name = select_running_service(
+                running_stores, InstanceType.ALGORITHM_STORE
+            )
+        else:
+            ctx = get_context(InstanceType.ALGORITHM_STORE, name, system_folders)
+            store_name = ctx.helm_release_name
+
+        if store_name in running_stores:
+            _stop_store(store_name, namespace, context)
+            info(f"Stopped the {Fore.GREEN}{store_name}{Style.RESET_ALL} store.")
+        else:
+            error(f"{Fore.RED}{name}{Style.RESET_ALL} is not running?!")
+
+
+def _stop_store(store_name: str, namespace: str, context: str) -> None:
+    info(f"Stopping store {store_name}...")
+
+    # uninstall the helm release
+    helm_uninstall(
+        release_name=store_name,
+        context=context,
+        namespace=namespace,
+    )
+
+    stop_port_forward(
+        service_name=f"{store_name}-vantage6-algorithm-store-service",
+    )
+
+    info(f"Store {store_name} stopped successfully.")

{vantage6-5.0.0a33/vantage6/cli/server → vantage6-5.0.0a34/vantage6/cli/common}/new.py

@@ -1,39 +1,18 @@
-import click
 from colorama import Fore, Style
 
 from vantage6.common import ensure_config_dir_writable, error, info
 from vantage6.common.globals import InstanceType
 
+from vantage6.cli.common.utils import get_main_cli_command_name
 from vantage6.cli.config import CliConfig
 from vantage6.cli.configuration_wizard import configuration_wizard
-from vantage6.cli.context.server import ServerContext
-from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS
+from vantage6.cli.context import select_context_class
 from vantage6.cli.utils import check_config_name_allowed, prompt_config_name
 
 
-@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)
-@click.option(
-    "--user", "system_folders", flag_value=False, default=DEFAULT_SERVER_SYSTEM_FOLDERS
-)
-@click.option("--context", default=None, help="Kubernetes context to use")
-@click.option(
-    "--namespace",
-    default=None,
-    help="Kubernetes namespace to use",
-)
-def cli_server_new(
-    name: str,
-    system_folders: bool,
-    namespace: str,
-    context: str,
-) -> None:
-    """
-    Create a new server configuration.
-    """
+def new(
+    name: str, system_folders: bool, namespace: str, context: str, type_: InstanceType
+):
     cli_config = CliConfig()
     context, namespace = cli_config.compare_changes_config(
         context=context,
@@ -46,34 +25,36 @@ def cli_server_new(
     check_config_name_allowed(name)
 
     # check that this config does not exist
+    ctx_class = select_context_class(type_)
     try:
-        if ServerContext.config_exists(name, system_folders):
-            error(f"Configuration {Fore.RED}{name}{Style.RESET_ALL} already " "exists!")
+        if ctx_class.config_exists(name, system_folders):
+            error(f"Configuration {Fore.RED}{name}{Style.RESET_ALL} already exists!")
             exit(1)
     except Exception as e:
         error(e)
         exit(1)
 
+    command_name = get_main_cli_command_name(type_)
+
     # Check that we can write in this folder
     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 "
+            f"Create a new {command_name} using '{Fore.GREEN}v6 {command_name} new "
             f"--user{Style.RESET_ALL}' instead!"
         )
         exit(1)
 
     # create config in ctx location
     try:
-        cfg_file = configuration_wizard(InstanceType.SERVER, name, system_folders)
+        cfg_file = configuration_wizard(type_, 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.")
     flag = "" if system_folders else "--user"
     info(
-        f"You can start the server by running {Fore.GREEN}v6 server start "
-        f"{flag}{Style.RESET_ALL}"
+        f"You can start the {command_name} by running {Fore.GREEN}v6 {command_name} "
+        f"start {flag}{Style.RESET_ALL}"
     )

{vantage6-5.0.0a33 → vantage6-5.0.0a34}/vantage6/cli/common/start.py

@@ -1,25 +1,17 @@
 from __future__ import annotations
 
-import enum
-import os
 import re
 import subprocess
 import time
 from os import PathLike
 from pathlib import Path
-from threading import Thread
 
 import docker
-from colorama import Fore, Style
 from docker.client import DockerClient
-from docker.models.containers import Container
-from sqlalchemy.engine.url import make_url
 
 from vantage6.common import error, info, warning
-from vantage6.common.context import AppContext
-from vantage6.common.docker.addons import check_docker_running, pull_image
+from vantage6.common.docker.addons import pull_image
 from vantage6.common.globals import (
-    APPNAME,
     DEFAULT_ALGO_STORE_IMAGE,
     DEFAULT_CHART_REPO,
     DEFAULT_DOCKER_REGISTRY,
@@ -29,83 +21,8 @@ from vantage6.common.globals import (
     InstanceType,
 )
 
-from vantage6.cli.common.utils import print_log_worker
-from vantage6.cli.context import AlgorithmStoreContext, ServerContext
-from vantage6.cli.globals import AlgoStoreGlobals, ServerGlobals
-from vantage6.cli.utils import (
-    check_config_name_allowed,
-    validate_input_cmd_args,
-)
-
-
-def check_for_start(ctx: AppContext, type_: InstanceType) -> DockerClient:
-    """
-    Check if all requirements are met to start the instance.
-
-    Parameters
-    ----------
-    ctx : AppContext
-        The context object
-    type_ : InstanceType
-        The type of instance to check for
-
-    Returns
-    -------
-    DockerClient
-        A Docker client instance
-    """
-    # will print an error if not
-    check_docker_running()
-
-    info("Finding Docker daemon.")
-    docker_client = docker.from_env()
-
-    # check if name is allowed for docker volume, else exit
-    check_config_name_allowed(ctx.name)
-
-    # check that this server is not already running
-    running_servers = docker_client.containers.list(
-        filters={"label": f"{APPNAME}-type={type_}"}
-    )
-    for server in running_servers:
-        if server.name == f"{APPNAME}-{ctx.name}-{ctx.scope}-{type_}":
-            error(f"Server {Fore.RED}{ctx.name}{Style.RESET_ALL} is already running")
-            exit(1)
-    return docker_client
-
-
-def get_image(
-    image: str, ctx: AppContext, custom_image_key: str, default_image: str
-) -> str:
-    """
-    Get the image name for the given instance type.
-
-    Parameters
-    ----------
-    image : str | None
-        The image name to use if specified
-    ctx : AppContext
-        The context object
-    custom_image_key : str
-        The key to look for in the config file
-    default_image : str
-        The default image name
-
-    Returns
-    -------
-    str
-        The image name to use
-    """
-    # Determine image-name. First we check if the option --image has been used.
-    # Then we check if the image has been specified in the config file, and
-    # finally we use the default settings from the package.
-    if image is None:
-        custom_images: dict = ctx.config.get("images")
-        if custom_images:
-            image = custom_images.get(custom_image_key)
-        if not image:
-            image = f"{DEFAULT_DOCKER_REGISTRY}/{default_image}"
-    return image
+from vantage6.cli.globals import ChartName
+from vantage6.cli.utils import validate_input_cmd_args
 
 
 def pull_infra_image(
@@ -129,8 +46,8 @@ def pull_infra_image(
     try:
         pull_image(client, image, suppress_error=True)
     except docker.errors.APIError:
-        if not is_default_infra_image(image, instance_type):
-            if image_exists_locally(client, image):
+        if not _is_default_infra_image(image, instance_type):
+            if _image_exists_locally(client, image):
                 warning("Failed to pull infrastructure image! Will use local image...")
             else:
                 error("Failed to pull infrastructure image!")
@@ -141,7 +58,7 @@ def pull_infra_image(
             exit(1)
 
 
-def is_default_infra_image(image: str, instance_type: InstanceType) -> bool:
+def _is_default_infra_image(image: str, instance_type: InstanceType) -> bool:
     """
     Check if an infrastructure image is the default image.
 
@@ -167,7 +84,7 @@ def is_default_infra_image(image: str, instance_type: InstanceType) -> bool:
         return image == f"{DEFAULT_DOCKER_REGISTRY}/{DEFAULT_NODE_IMAGE}"
 
 
-def image_exists_locally(client: DockerClient, image: str) -> bool:
+def _image_exists_locally(client: DockerClient, image: str) -> bool:
     """
     Check if the image exists locally.
 
@@ -190,137 +107,9 @@ def image_exists_locally(client: DockerClient, image: str) -> bool:
     return True
 
 
-def mount_config_file(ctx: AppContext, config_file: str) -> list[docker.types.Mount]:
-    """
-    Mount the config file in the container.
-
-    Parameters
-    ----------
-    ctx : AppContext
-        The context object
-    config_file : str
-        The path to the config file
-
-    Returns
-    -------
-    list[docker.types.Mount]
-        The mounts to use
-    """
-    info("Creating mounts")
-    return [docker.types.Mount(config_file, str(ctx.config_file), type="bind")]
-
-
-def mount_source(mount_src: str) -> docker.types.Mount:
-    """
-    Mount the vantage6 source code in the container.
-
-    Parameters
-    ----------
-    mount_src : str
-        The path to the source code
-
-    Returns
-    -------
-    docker.types.Mount | None
-        The mount to use
-    """
-    if mount_src:
-        mount_src = os.path.abspath(mount_src)
-        return docker.types.Mount("/vantage6", mount_src, type="bind")
-
-
-def mount_database(
-    ctx: ServerContext | AlgorithmStoreContext, type_: InstanceType
-) -> tuple[docker.types.Mount, dict]:
-    """
-    Mount database in the container if it is file-based (e.g. a SQLite DB).
-
-    Parameters
-    ----------
-    ctx : AppContext
-        The context object
-    type_ : InstanceType
-        The type of instance to mount the database for
-
-    Returns
-    -------
-    docker.types.Mount | None
-        The mount to use
-    dict | None
-        The environment variables to use
-    """
-    # FIXME: code duplication with cli_server_import()
-    # try to mount database
-    uri = ctx.config["uri"]
-    url = make_url(uri)
-    environment_vars = {}
-    mount = None
-
-    # If host is None, we're dealing with a file-based DB, like SQLite
-    if url.host is None:
-        db_path = url.database
-
-        if not os.path.isabs(db_path):
-            # We're dealing with a relative path here -> make it absolute
-            db_path = ctx.data_dir / url.database
-
-        basename = os.path.basename(db_path)
-        dirname = os.path.dirname(db_path)
-        os.makedirs(dirname, exist_ok=True)
-
-        # we're mounting the entire folder that contains the database
-        mount = docker.types.Mount("/mnt/database/", dirname, type="bind")
-
-        if type_ == InstanceType.SERVER:
-            environment_vars = {
-                ServerGlobals.DB_URI_ENV_VAR.value: f"sqlite:////mnt/database/{basename}",
-                ServerGlobals.CONFIG_NAME_ENV_VAR.value: ctx.config_file_name,
-            }
-        elif type_ == InstanceType.ALGORITHM_STORE:
-            environment_vars = {
-                AlgoStoreGlobals.DB_URI_ENV_VAR.value: f"sqlite:////mnt/database/{basename}",
-                AlgoStoreGlobals.CONFIG_NAME_ENV_VAR.value: ctx.config_file_name,
-            }
-    else:
-        warning(
-            f"Database could not be transferred, make sure {url.host} "
-            "is reachable from the Docker container"
-        )
-        info("Consider using the docker-compose method to start a server")
-
-    return mount, environment_vars
-
-
-# TODO v5+ remove this function, it is replaced by the `attach_logs` function in
-# `vantage6.cli.common.utils`
-def attach_logs(container: Container, type_: InstanceType) -> None:
-    """
-    Attach container logs to the console if specified.
-
-    Parameters
-    ----------
-    container : Container
-        The container to attach the logs from
-    type_ : InstanceType
-        The type of instance to attach the logs for
-    """
-    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 {type_} stop{Style.RESET_ALL}"
-            )
-            exit(0)
-
-
 def helm_install(
     release_name: str,
-    chart_name: str,
+    chart_name: ChartName,
     values_file: str | PathLike | None = None,
     context: str | None = None,
     namespace: str | None = None,
@@ -361,6 +150,7 @@ def helm_install(
         chart_name,
         "--repo",
         DEFAULT_CHART_REPO,
+        # TODO v5+ remove this flag when we have a stable release
         "--devel",  # ensure using latest version including pre-releases
     ]
 
@@ -380,14 +170,18 @@ def helm_install(
             check=True,
         )
         info(
-            f"Successfully installed release '{release_name}' using chart '{chart_name}'."
+            f"Successfully installed release '{release_name}' using chart "
+            f"'{chart_name}'."
         )
-    except subprocess.CalledProcessError as e:
-        error(f"Failed to install release '{release_name}': {e.stderr}")
+    except subprocess.CalledProcessError:
+        error(f"Failed to install release '{release_name}'.")
+        exit(1)
     except FileNotFoundError:
         error(
-            "Helm command not found. Please ensure Helm is installed and available in the PATH."
+            "Helm command not found. Please ensure Helm is installed and available in "
+            "the PATH."
         )
+        exit(1)
 
 
 def start_port_forward(