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

vantage6/cli/configuration_manager.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from typing import Self
 
 from schema import And, Use
@@ -6,6 +7,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 +49,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 +69,10 @@ class NodeConfiguration(Configuration):
     }
 
 
+class AuthConfiguration(Configuration):
+    VALIDATORS = {}
+
+
 class TestConfiguration(Configuration):
     VALIDATORS = {}
 
@@ -79,18 +87,18 @@ class NodeConfigurationManager(ConfigurationManager):
         Name of the configuration file.
     """
 
-    def __init__(self, name, *args, **kwargs) -> None:
-        super().__init__(conf_class=NodeConfiguration, name=name)
+    def __init__(self, name: str, is_sandbox: bool = False, *args, **kwargs) -> None:
+        super().__init__(conf_class=NodeConfiguration, name=name, is_sandbox=is_sandbox)
 
     @classmethod
-    def from_file(cls, path: str) -> Self:
+    def from_file(cls, path: Path | str, is_sandbox: bool = False) -> Self:
         """
         Create a new instance of the NodeConfigurationManager from a
         configuration file.
 
         Parameters
         ----------
-        path : str
+        path : str | Path
             Path to the configuration file.
 
         Returns
@@ -98,7 +106,9 @@ class NodeConfigurationManager(ConfigurationManager):
         NodeConfigurationManager
             A new instance of the NodeConfigurationManager.
         """
-        return super().from_file(path, conf_class=NodeConfiguration)
+        return super().from_file(
+            path, conf_class=NodeConfiguration, is_sandbox=is_sandbox
+        )
 
     def get_config_template(self) -> str:
         """
@@ -117,18 +127,20 @@ class ServerConfigurationManager(ConfigurationManager):
         Name of the configuration file.
     """
 
-    def __init__(self, name, *args, **kwargs) -> None:
-        super().__init__(conf_class=ServerConfiguration, name=name)
+    def __init__(self, name: str, is_sandbox: bool = False, *args, **kwargs) -> None:
+        super().__init__(
+            conf_class=ServerConfiguration, name=name, is_sandbox=is_sandbox
+        )
 
     @classmethod
-    def from_file(cls, path) -> Self:
+    def from_file(cls, path: Path | str, is_sandbox: bool = False) -> Self:
         """
         Create a new instance of the ServerConfigurationManager from a
         configuration file.
 
         Parameters
         ----------
-        path : str
+        path : str | Path
             Path to the configuration file.
 
         Returns
@@ -136,7 +148,9 @@ class ServerConfigurationManager(ConfigurationManager):
         ServerConfigurationManager
             A new instance of the ServerConfigurationManager.
         """
-        return super().from_file(path, conf_class=ServerConfiguration)
+        return super().from_file(
+            path, conf_class=ServerConfiguration, is_sandbox=is_sandbox
+        )
 
     def get_config_template(self) -> str:
         """
@@ -160,18 +174,20 @@ class AlgorithmStoreConfigurationManager(ConfigurationManager):
         Name of the configuration file.
     """
 
-    def __init__(self, name, *args, **kwargs) -> None:
-        super().__init__(conf_class=AlgorithmStoreConfiguration, name=name)
+    def __init__(self, name: str, is_sandbox: bool = False, *args, **kwargs) -> None:
+        super().__init__(
+            conf_class=AlgorithmStoreConfiguration, name=name, is_sandbox=is_sandbox
+        )
 
     @classmethod
-    def from_file(cls, path: str) -> Self:
+    def from_file(cls, path: Path | str, is_sandbox: bool = False) -> Self:
         """
         Create a new instance of the AlgorithmStoreConfigurationManager from a
         configuration file.
 
         Parameters
         ----------
-        path : str
+        path : str | Path
             Path to the configuration file.
 
         Returns
@@ -179,7 +195,9 @@ class AlgorithmStoreConfigurationManager(ConfigurationManager):
         AlgorithmStoreConfigurationManager
             A new instance of the AlgorithmStoreConfigurationManager.
         """
-        return super().from_file(path, conf_class=AlgorithmStoreConfiguration)
+        return super().from_file(
+            path, conf_class=AlgorithmStoreConfiguration, is_sandbox=is_sandbox
+        )
 
     def get_config_template(self) -> str:
         """
@@ -193,10 +211,72 @@ 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.
+    is_sandbox : bool, optional
+        Whether the configuration is a sandbox configuration, by default False
+    """
+
+    def __init__(self, name, is_sandbox: bool = False, *args, **kwargs):
+        super().__init__(conf_class=AuthConfiguration, name=name, is_sandbox=is_sandbox)
+
+    @classmethod
+    def from_file(cls, path: Path | str, is_sandbox: bool = False) -> Self:
+        """
+        Create a new instance of the AuthConfigurationManager from a
+        configuration file.
+
+        Parameters
+        ----------
+        path : str | Path
+            Path to the configuration file.
+        is_sandbox : bool, optional
+            Whether the configuration is a sandbox configuration, by default False
+
+        Returns
+        -------
+        AuthConfigurationManager
+            A new instance of the AuthConfigurationManager.
+        """
+        return super().from_file(
+            path, conf_class=AuthConfiguration, is_sandbox=is_sandbox
+        )
+
+    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)
 
     @classmethod
-    def from_file(cls, path):
-        return super().from_file(path, conf_class=TestConfiguration)
+    def from_file(cls, path: Path | str, is_sandbox: bool = False) -> Self:
+        """
+        Create a new instance of the TestingConfigurationManager from a
+        configuration file.
+
+        Parameters
+        ----------
+        path : str | Path
+            Path to the configuration file.
+        is_sandbox : bool, optional
+            Whether the configuration is a sandbox configuration, by default False
+
+        Returns
+        -------
+        TestingConfigurationManager
+            A new instance of the TestingConfigurationManager.
+        """
+        return super().from_file(
+            path, conf_class=TestConfiguration, is_sandbox=is_sandbox
+        )

vantage6/cli/context/__init__.py

@@ -14,13 +14,14 @@ 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
 
 
 def select_context_class(
     type_: InstanceType,
-) -> ServerContext | NodeContext | AlgorithmStoreContext:
+) -> ServerContext | NodeContext | AlgorithmStoreContext | AuthContext:
     """
     Select the context class based on the type of instance.
 
@@ -31,7 +32,7 @@ def select_context_class(
 
     Returns
     -------
-    ServerContext | NodeContext | AlgorithmStoreContext
+    ServerContext | NodeContext | AlgorithmStoreContext | AuthContext
         Specialized subclass of AppContext for the given instance type
 
     Raises
@@ -45,12 +46,14 @@ def select_context_class(
         return AlgorithmStoreContext
     elif type_ == InstanceType.NODE:
         return NodeContext
+    elif type_ == InstanceType.AUTH:
+        return AuthContext
     else:
         raise NotImplementedError
 
 
 def get_context(
-    type_: InstanceType, name: str, system_folders: bool
+    type_: InstanceType, name: str, system_folders: bool, is_sandbox: bool = False
 ) -> ServerContext | NodeContext | AlgorithmStoreContext:
     """
     Load the server context from the configuration file.
@@ -63,6 +66,8 @@ def get_context(
         Name of the instance
     system_folders : bool
         Wether to use system folders or if False, the user folders
+    is_sandbox : bool
+        Whether the configuration is a sandbox configuration, by default False
 
     Returns
     -------
@@ -70,7 +75,7 @@ def get_context(
         Specialized subclass context of AppContext for the given instance type
     """
     ctx_class = select_context_class(type_)
-    if not ctx_class.config_exists(name, system_folders):
+    if not ctx_class.config_exists(name, system_folders, is_sandbox=is_sandbox):
         scope = "system" if system_folders else "user"
         error(
             f"Configuration {Fore.RED}{name}{Style.RESET_ALL} does not "
@@ -83,6 +88,6 @@ def get_context(
     ctx_class.LOGGING_ENABLED = False
 
     # create server context, and initialize db
-    ctx = ctx_class(name, system_folders=system_folders)
+    ctx = ctx_class(name, system_folders=system_folders, is_sandbox=is_sandbox)
 
     return ctx

vantage6/cli/context/algorithm_store.py

@@ -26,11 +26,14 @@ class AlgorithmStoreContext(BaseServerContext):
 
     INST_CONFIG_MANAGER = AlgorithmStoreConfigurationManager
 
-    def __init__(self, instance_name: str, system_folders: bool = S_FOL):
+    def __init__(
+        self, instance_name: str, system_folders: bool = S_FOL, is_sandbox: bool = False
+    ):
         super().__init__(
             InstanceType.ALGORITHM_STORE,
             instance_name,
             system_folders=system_folders,
+            is_sandbox=is_sandbox,
         )
         self.log.info("vantage6 version '%s'", __version__)
 
@@ -88,7 +91,9 @@ class AlgorithmStoreContext(BaseServerContext):
         )
 
     @classmethod
-    def config_exists(cls, instance_name: str, system_folders: bool = S_FOL) -> bool:
+    def config_exists(
+        cls, instance_name: str, system_folders: bool = S_FOL, is_sandbox: bool = False
+    ) -> bool:
         """
         Check if a configuration file exists.
 
@@ -99,14 +104,15 @@ class AlgorithmStoreContext(BaseServerContext):
             of the configuration file.
         system_folders : bool, optional
             System wide or user configuration, by default S_FOL
-
+        is_sandbox : bool, optional
+            Whether the configuration is a sandbox configuration, by default False
         Returns
         -------
         bool
             Whether the configuration file exists or not
         """
-        return super().config_exists(
-            InstanceType.ALGORITHM_STORE, instance_name, system_folders
+        return super().base_config_exists(
+            InstanceType.ALGORITHM_STORE, instance_name, system_folders, is_sandbox
         )
 
     @classmethod

vantage6/cli/context/auth.py

@@ -0,0 +1,125 @@
+from __future__ import annotations
+
+from vantage6.common.context import AppContext
+from vantage6.common.globals import InstanceType
+
+from vantage6.cli import __version__
+from vantage6.cli.configuration_manager import AuthConfigurationManager
+from vantage6.cli.globals import DEFAULT_SERVER_SYSTEM_FOLDERS as S_FOL
+
+
+class AuthContext(AppContext):
+    """
+    Context class for the keycloak authentication server.
+
+    Parameters
+    ----------
+    instance_name : str
+        Name of the configuration instance, corresponds to the filename
+        of the configuration file.
+    system_folders : bool, optional
+        System wide or user configuration, by default S_FOL
+    is_sandbox : bool, optional
+        Whether the configuration is a sandbox configuration, by default False
+    """
+
+    # The auth configuration manager is aware of the structure of the auth
+    # configuration file and makes sure only valid configuration can be loaded.
+    INST_CONFIG_MANAGER = AuthConfigurationManager
+
+    def __init__(
+        self,
+        instance_name: str,
+        system_folders: bool = S_FOL,
+        is_sandbox: bool = False,
+    ):
+        super().__init__(
+            InstanceType.AUTH,
+            instance_name,
+            system_folders=system_folders,
+            is_sandbox=is_sandbox,
+        )
+        self.log.info("vantage6 version '%s'", __version__)
+
+    @classmethod
+    def from_external_config_file(
+        cls, path: str, system_folders: bool = S_FOL
+    ) -> AuthContext:
+        """
+        Create a server context from an external configuration file. External
+        means that the configuration file is not located in the default folders
+        but its location is specified by the user.
+
+        Parameters
+        ----------
+        path : str
+            Path of the configuration file
+        system_folders : bool, optional
+            System wide or user configuration, by default S_FOL
+
+        Returns
+        -------
+        ServerContext
+            Server context object
+        """
+        return super().from_external_config_file(
+            path,
+            InstanceType.AUTH,
+            system_folders,
+        )
+
+    @classmethod
+    def config_exists(
+        cls,
+        instance_name: str,
+        system_folders: bool = S_FOL,
+        is_sandbox: bool = False,
+    ) -> bool:
+        """
+        Check if a configuration file exists.
+
+        Parameters
+        ----------
+        instance_name : str
+            Name of the configuration instance, corresponds to the filename
+            of the configuration file.
+        system_folders : bool, optional
+            System wide or user configuration, by default S_FOL
+        is_sandbox : bool, optional
+            Whether the configuration is a sandbox configuration, by default False
+
+        Returns
+        -------
+        bool
+            Whether the configuration file exists or not
+        """
+        return super().base_config_exists(
+            InstanceType.AUTH,
+            instance_name,
+            system_folders=system_folders,
+            is_sandbox=is_sandbox,
+        )
+
+    @classmethod
+    def available_configurations(
+        cls, system_folders: bool = S_FOL, is_sandbox: bool = False
+    ) -> tuple[list, list]:
+        """
+        Find all available auth configurations in the default folders.
+
+        Parameters
+        ----------
+        system_folders : bool, optional
+            System wide or user configuration, by default S_FOL
+        is_sandbox : bool, optional
+            Whether the configuration is a sandbox configuration, by default False
+
+        Returns
+        -------
+        tuple[list, list]
+            The first list contains validated configuration files, the second
+            list contains invalid configuration files.
+        """
+        return super().available_configurations(
+            InstanceType.AUTH, system_folders, is_sandbox
+        )

vantage6/cli/context/base_server.py

@@ -1,9 +1,5 @@
 from __future__ import annotations
 
-import os.path
-
-from sqlalchemy.engine.url import make_url
-
 from vantage6.common.context import AppContext
 
 from vantage6.cli.globals import (

vantage6/cli/context/node.py

@@ -27,6 +27,8 @@ class NodeContext(AppContext):
         _description_, by default None
     in_container : bool, optional
         Whether the application is running inside a container, by default False
+    is_sandbox : bool, optional
+        Whether the configuration is a sandbox configuration, by default False
     """
 
     # The server configuration manager is aware of the structure of the server
@@ -41,6 +43,7 @@ class NodeContext(AppContext):
         print_log_header: bool = True,
         logger_prefix: str = "",
         in_container: bool = False,
+        is_sandbox: bool = False,
     ):
         super().__init__(
             InstanceType.NODE,
@@ -50,6 +53,7 @@ class NodeContext(AppContext):
             print_log_header=print_log_header,
             logger_prefix=logger_prefix,
             in_container=in_container,
+            is_sandbox=is_sandbox,
         )
         if print_log_header:
             self.log.info("vantage6 version '%s'", __version__)
@@ -57,7 +61,7 @@ class NodeContext(AppContext):
 
     @classmethod
     def from_external_config_file(
-        cls, path: str, system_folders: bool = N_FOL
+        cls, path: str, system_folders: bool = N_FOL, is_sandbox: bool = False
     ) -> NodeContext:
         """
         Create a node context from an external configuration file. External
@@ -77,11 +81,16 @@ class NodeContext(AppContext):
             Node context object
         """
         return super().from_external_config_file(
-            Path(path).resolve(), InstanceType.NODE, system_folders
+            Path(path).resolve(),
+            InstanceType.NODE,
+            system_folders,
+            is_sandbox=is_sandbox,
         )
 
     @classmethod
-    def config_exists(cls, instance_name: str, system_folders: bool = N_FOL) -> bool:
+    def config_exists(
+        cls, instance_name: str, system_folders: bool = N_FOL, is_sandbox: bool = False
+    ) -> bool:
         """
         Check if a configuration file exists.
 
@@ -92,19 +101,23 @@ class NodeContext(AppContext):
             of the configuration file.
         system_folders : bool, optional
             System wide or user configuration, by default N_FOL
-
+        is_sandbox : bool, optional
+            Whether the configuration is a sandbox configuration, by default False
         Returns
         -------
         bool
             Whether the configuration file exists or not
         """
-        return super().config_exists(
-            InstanceType.NODE, instance_name, system_folders=system_folders
+        return super().base_config_exists(
+            InstanceType.NODE,
+            instance_name,
+            system_folders=system_folders,
+            is_sandbox=is_sandbox,
         )
 
     @classmethod
     def available_configurations(
-        cls, system_folders: bool = N_FOL
+        cls, system_folders: bool = N_FOL, is_sandbox: bool = False
     ) -> tuple[list, list]:
         """
         Find all available server configurations in the default folders.
@@ -113,6 +126,8 @@ class NodeContext(AppContext):
         ----------
         system_folders : bool, optional
             System wide or user configuration, by default N_FOL
+        is_sandbox : bool, optional
+            Whether the configuration is a sandbox configuration, by default False
 
         Returns
         -------
@@ -120,7 +135,9 @@ class NodeContext(AppContext):
             The first list contains validated configuration files, the second
             list contains invalid configuration files.
         """
-        return super().available_configurations(InstanceType.NODE, system_folders)
+        return super().available_configurations(
+            InstanceType.NODE, system_folders, is_sandbox
+        )
 
     @staticmethod
     def type_data_folder(system_folders: bool = N_FOL) -> Path:

vantage6/cli/context/server.py

@@ -36,12 +36,14 @@ class ServerContext(BaseServerContext):
         instance_name: str,
         system_folders: bool = S_FOL,
         in_container: bool = False,
+        is_sandbox: bool = False,
     ):
         super().__init__(
             InstanceType.SERVER,
             instance_name,
             system_folders=system_folders,
             in_container=in_container,
+            is_sandbox=is_sandbox,
         )
         self.log.info("vantage6 version '%s'", __version__)
 
@@ -123,7 +125,9 @@ class ServerContext(BaseServerContext):
         )
 
     @classmethod
-    def config_exists(cls, instance_name: str, system_folders: bool = S_FOL) -> bool:
+    def config_exists(
+        cls, instance_name: str, system_folders: bool = S_FOL, is_sandbox: bool = False
+    ) -> bool:
         """
         Check if a configuration file exists.
 
@@ -134,19 +138,23 @@ class ServerContext(BaseServerContext):
             of the configuration file.
         system_folders : bool, optional
             System wide or user configuration, by default S_FOL
-
+        is_sandbox : bool, optional
+            Whether the configuration is a sandbox configuration, by default False
         Returns
         -------
         bool
             Whether the configuration file exists or not
         """
-        return super().config_exists(
-            InstanceType.SERVER, instance_name, system_folders=system_folders
+        return super().base_config_exists(
+            InstanceType.SERVER,
+            instance_name,
+            system_folders=system_folders,
+            is_sandbox=is_sandbox,
         )
 
     @classmethod
     def available_configurations(
-        cls, system_folders: bool = S_FOL
+        cls, system_folders: bool = S_FOL, is_sandbox: bool = False
     ) -> tuple[list, list]:
         """
         Find all available server configurations in the default folders.
@@ -155,6 +163,8 @@ class ServerContext(BaseServerContext):
         ----------
         system_folders : bool, optional
             System wide or user configuration, by default S_FOL
+        is_sandbox : bool, optional
+            Whether the configuration is a sandbox configuration, by default False
 
         Returns
         -------
@@ -162,4 +172,6 @@ class ServerContext(BaseServerContext):
             The first list contains validated configuration files, the second
             list contains invalid configuration files.
         """
-        return super().available_configurations(InstanceType.SERVER, system_folders)
+        return super().available_configurations(
+            InstanceType.SERVER, system_folders, is_sandbox
+        )

vantage6/cli/dev/clean.py

@@ -0,0 +1,28 @@
+import subprocess
+import sys
+
+import click
+
+from vantage6.common import error, info
+
+from vantage6.cli.dev.common import check_devspace_installed
+
+
+@click.command()
+def cli_clean_dev_env():
+    """
+    Stops and cleans up the development environment.
+
+    Removes the kubernetes resources and local data (e.g. tasks data, database data).
+    This is useful when you want to start from scratch.
+    """
+    check_devspace_installed()
+
+    try:
+        info("🧹 Cleaning development environment with devspace...")
+        cmd = ["devspace", "run", "purge"]
+        subprocess.run(cmd, check=True, capture_output=False)
+        info("✅ Development environment cleaned successfully!")
+    except subprocess.CalledProcessError as e:
+        error(f"❌ Error cleaning development environment: {e}")
+        sys.exit(e.returncode)

vantage6/cli/dev/common.py

@@ -0,0 +1,34 @@
+import shutil
+import subprocess
+import sys
+
+from vantage6.common import error
+
+
+def check_devspace_installed() -> None:
+    """Check if devspace is installed. Exits if not."""
+    # Check if devspace command exists
+    if shutil.which("devspace") is None:
+        _message_devspace_not_installed()
+
+    try:
+        # Try to run devspace --version to verify it's working
+        result = subprocess.run(
+            ["devspace", "--version"], capture_output=True, text=True, timeout=10
+        )
+        if result.returncode != 0:
+            _message_devspace_not_installed()
+    except (
+        subprocess.TimeoutExpired,
+        subprocess.CalledProcessError,
+        FileNotFoundError,
+    ):
+        _message_devspace_not_installed()
+
+
+def _message_devspace_not_installed() -> None:
+    error(
+        "❌ DevSpace command not found. Please ensure devspace is installed and in "
+        "your PATH."
+    )
+    sys.exit(1)