digitalhub 0.11.0b7__py3-none-any.whl → 0.13.0__py3-none-any.whl

digitalhub/stores/credentials/configurator.py

@@ -0,0 +1,210 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from abc import abstractmethod
+
+from digitalhub.stores.credentials.enums import CredsOrigin
+from digitalhub.stores.credentials.handler import creds_handler
+from digitalhub.utils.exceptions import ConfigError
+
+
+class Configurator:
+    """
+    Base configurator for credentials management.
+
+    Attributes
+    ----------
+    keys : list of str
+        List of credential keys to manage.
+    required_keys : list of str
+        List of required credential keys.
+    _env : str
+        Environment origin identifier.
+    _file : str
+        File origin identifier.
+    _creds_handler : object
+        Credentials handler instance.
+    """
+
+    # Must be set in implementing class
+    keys: list[str] = []
+    required_keys: list[str] = []
+
+    # Origin of the credentials
+    _env = CredsOrigin.ENV.value
+    _file = CredsOrigin.FILE.value
+
+    # Credentials handler
+    _creds_handler = creds_handler
+
+    def __init__(self):
+        self._current_profile = self._creds_handler.get_current_profile()
+        self.load_configs()
+        self._changed_origin = False
+        self._origin = self.set_origin()
+
+    ##############################
+    # Configuration
+    ##############################
+
+    def load_configs(self) -> None:
+        """
+        Load the configuration from both environment and file sources.
+
+        Returns
+        -------
+        None
+        """
+        self.load_env_vars()
+        self.load_file_vars()
+
+    @abstractmethod
+    def load_env_vars(self) -> None:
+        ...
+
+    @abstractmethod
+    def load_file_vars(self) -> None:
+        ...
+
+    def check_config(self) -> None:
+        """
+        Check if the current profile has changed and reload
+        the file credentials if needed.
+
+        Returns
+        -------
+        None
+        """
+        if (current := self._creds_handler.get_current_profile()) != self._current_profile:
+            self.load_file_vars()
+            self._current_profile = current
+
+    def set_origin(self) -> str:
+        """
+        Determine the default origin for credentials (env or file).
+
+        Returns
+        -------
+        str
+            The selected origin ('env' or 'file').
+
+        Raises
+        ------
+        ConfigError
+            If required credentials are missing in both sources.
+        """
+        origin = self._env
+
+        env_creds = self._creds_handler.get_credentials(self._env)
+        missing_env = self._check_credentials(env_creds)
+
+        file_creds = self._creds_handler.get_credentials(self._file)
+        missing_file = self._check_credentials(file_creds)
+
+        msg = ""
+        if missing_env:
+            msg = f"Missing required vars in env: {', '.join(missing_env)}"
+            origin = self._file
+            self._changed_origin = True
+        elif missing_file:
+            msg += f"Missing required vars in .dhcore.ini file: {', '.join(missing_file)}"
+
+        if missing_env and missing_file:
+            raise ConfigError(msg)
+
+        return origin
+
+    def eval_change_origin(self) -> None:
+        """
+        Attempt to change the origin of credentials.
+        Raise error if already evaluated.
+
+        Returns
+        -------
+        None
+        """
+        try:
+            self.change_origin()
+        except ConfigError:
+            raise ConfigError("Credentials origin already evaluated. Please check your credentials.")
+
+    def change_origin(self) -> None:
+        """
+        Change the origin of credentials from env to file or vice versa.
+
+        Returns
+        -------
+        None
+        """
+        if self._changed_origin:
+            raise ConfigError("Origin has already been changed.")
+        if self._origin == self._env:
+            self.change_to_file()
+        self.change_to_env()
+
+    def change_to_file(self) -> None:
+        """
+        Set the credentials origin to file.
+
+        Returns
+        -------
+        None
+        """
+        if self._origin == self._env:
+            self._changed_origin = True
+        self._origin = CredsOrigin.FILE.value
+
+    def change_to_env(self) -> None:
+        """
+        Set the credentials origin to environment.
+
+        Returns
+        -------
+        None
+        """
+        if self._origin == self._file:
+            self._changed_origin = True
+        self._origin = CredsOrigin.ENV.value
+
+    ##############################
+    # Credentials
+    ##############################
+
+    def get_credentials(self, origin: str) -> dict:
+        """
+        Retrieve credentials for the specified origin.
+
+        Parameters
+        ----------
+        origin : str
+            The origin to retrieve credentials from ('env' or 'file').
+
+        Returns
+        -------
+        dict
+            Dictionary of credentials.
+        """
+        return self._creds_handler.get_credentials(origin)
+
+    def _check_credentials(self, creds: dict) -> list[str]:
+        """
+        Check for missing required credentials in a dictionary.
+
+        Parameters
+        ----------
+        creds : dict
+            Dictionary of credentials to check.
+
+        Returns
+        -------
+        list of str
+            List of missing required credential keys.
+        """
+        missing_keys = []
+        for k, v in creds.items():
+            if v is None and k in self.required_keys:
+                missing_keys.append(k)
+        return missing_keys

digitalhub/stores/credentials/enums.py

@@ -0,0 +1,68 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CredsOrigin(Enum):
+    """
+    Credential origins for configuration.
+
+    Attributes
+    ----------
+    ENV : str
+        Credentials from environment variables.
+    FILE : str
+        Credentials from configuration file.
+    """
+
+    ENV = "env"
+    FILE = "file"
+
+
+class SetCreds(Enum):
+    """
+    Supported credential environments.
+    """
+
+    DEFAULT = "__default"
+    DH_PROFILE = "DH_NAME"
+
+
+class CredsEnvVar(Enum):
+    """
+    Supported credential environment variables.
+    """
+
+    # S3
+    S3_ENDPOINT_URL = "AWS_ENDPOINT_URL"
+    S3_ACCESS_KEY_ID = "AWS_ACCESS_KEY_ID"
+    S3_SECRET_ACCESS_KEY = "AWS_SECRET_ACCESS_KEY"
+    S3_SESSION_TOKEN = "AWS_SESSION_TOKEN"
+    S3_REGION = "AWS_REGION"
+    S3_SIGNATURE_VERSION = "S3_SIGNATURE_VERSION"
+    S3_CREDENTIALS_EXPIRATION = "AWS_CREDENTIALS_EXPIRATION"
+    S3_PATH_STYLE = "S3_PATH_STYLE"
+
+    # SQL
+    DB_HOST = "DB_HOST"
+    DB_PORT = "DB_PORT"
+    DB_USERNAME = "DB_USERNAME"
+    DB_PASSWORD = "DB_PASSWORD"
+    DB_DATABASE = "DB_DATABASE"
+    DB_PLATFORM = "DB_PLATFORM"
+    DB_PG_SCHEMA = "DB_SCHEMA"
+
+    # DHCORE
+    DHCORE_ENDPOINT = "DHCORE_ENDPOINT"
+    DHCORE_ISSUER = "DHCORE_ISSUER"
+    DHCORE_USER = "DHCORE_USER"
+    DHCORE_PASSWORD = "DHCORE_PASSWORD"
+    DHCORE_CLIENT_ID = "DHCORE_CLIENT_ID"
+    DHCORE_ACCESS_TOKEN = "DHCORE_ACCESS_TOKEN"
+    DHCORE_REFRESH_TOKEN = "DHCORE_REFRESH_TOKEN"
+    DHCORE_PERSONAL_ACCESS_TOKEN = "DHCORE_PERSONAL_ACCESS_TOKEN"
+    DHCORE_WORKFLOW_IMAGE = "DHCORE_WORKFLOW_IMAGE"

digitalhub/stores/credentials/handler.py

@@ -0,0 +1,176 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+import os
+
+from digitalhub.stores.credentials.enums import SetCreds
+from digitalhub.stores.credentials.ini_module import (
+    load_file,
+    load_key,
+    load_profile,
+    set_current_profile,
+    write_config,
+)
+from digitalhub.stores.credentials.store import CredentialsStore
+
+
+class CredentialHandler:
+    """
+    Handler for configuring clients and managing credentials.
+
+    Attributes
+    ----------
+    _creds_store : CredentialsStore
+        Store for credentials.
+    _profile : str
+        Current credentials profile name.
+    """
+
+    def __init__(self) -> None:
+        self._creds_store = CredentialsStore()
+        self._profile = self._read_current_profile()
+
+    @staticmethod
+    def _read_current_profile() -> str:
+        """
+        Read the current credentials profile name.
+
+        Returns
+        -------
+        str
+            Name of the credentials profile.
+        """
+        profile = os.getenv(SetCreds.DH_PROFILE.value)
+        if profile is not None:
+            return profile
+        file = load_file()
+        profile = load_profile(file)
+        if profile is not None:
+            return profile
+        return SetCreds.DEFAULT.value
+
+    ##############################
+    # Public methods
+    ##############################
+
+    def set_current_profile(self, creds_set: str) -> None:
+        """
+        Set the current credentials profile name.
+
+        Parameters
+        ----------
+        creds_set : str
+            Name of the credentials profile to set.
+
+        Returns
+        -------
+        None
+        """
+        self._profile = creds_set
+        set_current_profile(creds_set)
+
+    def get_current_profile(self) -> str:
+        """
+        Get the current credentials profile name.
+
+        Returns
+        -------
+        str
+            Name of the current credentials profile.
+        """
+        return self._profile
+
+    def load_from_env(self, vars: list[str]) -> dict:
+        """
+        Load variables from environment.
+
+        Parameters
+        ----------
+        vars : list of str
+            List of environment variable names to load.
+
+        Returns
+        -------
+        dict
+            Dictionary of environment variable values.
+        """
+        return {var: os.getenv(var) for var in vars}
+
+    def load_from_file(self, vars: list[str]) -> dict:
+        """
+        Load variables from credentials config file.
+
+        Parameters
+        ----------
+        vars : list of str
+            List of variable names to load from file.
+
+        Returns
+        -------
+        dict
+            Dictionary of variable values from file.
+        """
+        file = load_file()
+        profile = load_profile(file)
+        if profile is not None:
+            self._profile = profile
+        return {var: load_key(file, self._profile, var) for var in vars}
+
+    def write_env(self, creds: dict) -> None:
+        """
+        Write credentials to the .dhcore file for the current profile.
+
+        Parameters
+        ----------
+        creds : dict
+            Credentials to write.
+
+        Returns
+        -------
+        None
+        """
+        write_config(creds, self._profile)
+
+    ##############################
+    # Credentials store methods
+    ##############################
+
+    def set_credentials(self, origin: str, creds: dict) -> None:
+        """
+        Set credentials for the current profile and origin.
+
+        Parameters
+        ----------
+        origin : str
+            The origin of the credentials ('env' or 'file').
+        creds : dict
+            Credentials to set.
+
+        Returns
+        -------
+        None
+        """
+        self._creds_store.set_credentials(self._profile, origin, creds)
+
+    def get_credentials(self, origin: str) -> dict:
+        """
+        Get credentials for the current profile from the specified origin.
+
+        Parameters
+        ----------
+        origin : str
+            The origin to get credentials from ('env' or 'file').
+
+        Returns
+        -------
+        dict
+            Dictionary of credentials.
+        """
+        return self._creds_store.get_credentials(self._profile, origin)
+
+
+# Define global credential handler
+creds_handler = CredentialHandler()

digitalhub/stores/credentials/ini_module.py

@@ -0,0 +1,164 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from configparser import ConfigParser
+from pathlib import Path
+
+from digitalhub.utils.exceptions import ClientError
+
+# File where to write credementials
+ENV_FILE = Path.home() / ".dhcore.ini"
+
+
+def load_file() -> ConfigParser:
+    """
+    Load the credentials configuration from the .dhcore.ini file.
+
+    Returns
+    -------
+    ConfigParser
+        Parsed configuration file object.
+
+    Raises
+    ------
+    ClientError
+        If the file cannot be read.
+    """
+    try:
+        file = ConfigParser()
+        file.read(ENV_FILE)
+        return file
+    except Exception as e:
+        raise ClientError(f"Failed to read env file: {e}")
+
+
+def load_profile(file: ConfigParser) -> str | None:
+    """
+    Load the current credentials profile name from the .dhcore.ini file.
+
+    Parameters
+    ----------
+    file : ConfigParser
+        Parsed configuration file object.
+
+    Returns
+    -------
+    str or None
+        Name of the credentials profile, or None if not found.
+    """
+    try:
+        return file["DEFAULT"]["current_environment"]
+    except KeyError:
+        return
+
+
+def load_key(file: ConfigParser, profile: str, key: str) -> str | None:
+    """
+    Load a specific key value from the credentials profile in the
+    .dhcore.ini file.
+
+    Parameters
+    ----------
+    file : ConfigParser
+        Parsed configuration file object.
+    profile : str
+        Name of the credentials profile.
+    key : str
+        Name of the key to retrieve.
+
+    Returns
+    -------
+    str or None
+        Value of the key, or None if not found.
+    """
+    try:
+        return file[profile][key]
+    except KeyError:
+        return
+
+
+def write_config(creds: dict, environment: str) -> None:
+    """
+    Write credentials to the .dhcore.ini file for the specified environment.
+    Overwrites any existing values for that environment.
+
+    Parameters
+    ----------
+    creds : dict
+        Dictionary of credentials to write.
+    environment : str
+        Name of the credentials profile/environment.
+
+    Returns
+    -------
+    None
+
+    Raises
+    ------
+    ClientError
+        If the file cannot be written.
+    """
+    try:
+        cfg = load_file()
+
+        sections = cfg.sections()
+        if environment not in sections:
+            cfg.add_section(environment)
+
+        cfg["DEFAULT"]["current_environment"] = environment
+        for k, v in creds.items():
+            cfg[environment][k] = str(v)
+
+        ENV_FILE.touch(exist_ok=True)
+        with open(ENV_FILE, "w") as inifile:
+            cfg.write(inifile)
+
+    except Exception as e:
+        raise ClientError(f"Failed to write env file: {e}")
+
+
+def set_current_profile(environment: str) -> None:
+    """
+    Set the current credentials profile in the .dhcore.ini file.
+
+    Parameters
+    ----------
+    environment : str
+        Name of the credentials profile to set as current.
+
+    Returns
+    -------
+    None
+
+    Raises
+    ------
+    ClientError
+        If the file cannot be written.
+    """
+    try:
+        cfg = load_file()
+        cfg["DEFAULT"]["current_environment"] = environment
+        with open(ENV_FILE, "w") as inifile:
+            cfg.write(inifile)
+
+    except Exception as e:
+        raise ClientError(f"Failed to write env file: {e}")
+
+
+def read_env_from_file() -> str | None:
+    """
+    Read the current credentials profile name from the .dhcore.ini file.
+
+    Returns
+    -------
+    str or None
+        Name of the current credentials profile, or None if not found.
+    """
+    try:
+        cfg = load_file()
+        return cfg["DEFAULT"]["current_environment"]
+    except Exception:
+        return None

digitalhub/stores/credentials/store.py

@@ -0,0 +1,81 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Any
+
+from digitalhub.stores.credentials.enums import CredsOrigin
+
+
+class CredentialsStore:
+    """
+    Store and retrieve credentials for different profiles and origins.
+
+    Attributes
+    ----------
+    _file_creds : dict of str to dict
+        Credentials stored by profile from file origin.
+    _env_creds : dict of str to Any
+        Credentials stored from environment origin.
+    """
+
+    def __init__(self) -> None:
+        self._file_creds: dict[str, dict[str, Any]] = {}
+        self._env_creds: dict[str, Any] = {}
+
+    def set_credentials(
+        self,
+        profile: str,
+        origin: str,
+        credentials: dict[str, Any],
+    ) -> None:
+        """
+        Set all credentials for a given profile and origin.
+
+        Parameters
+        ----------
+        profile : str
+            Name of the credentials profile.
+        origin : str
+            Origin of the credentials ('env' or 'file').
+        credentials : dict of str to Any
+            Dictionary of credentials to set.
+
+        Returns
+        -------
+        None
+        """
+        if origin == CredsOrigin.ENV.value:
+            for key, value in credentials.items():
+                self._env_creds[key] = value
+            return
+        if profile not in self._file_creds:
+            self._file_creds[profile] = {}
+        for key, value in credentials.items():
+            self._file_creds[profile][key] = value
+
+    def get_credentials(
+        self,
+        profile: str,
+        origin: str,
+    ) -> dict[str, Any]:
+        """
+        Get all credentials for a given profile and origin.
+
+        Parameters
+        ----------
+        profile : str
+            Name of the credentials profile.
+        origin : str
+            Origin of the credentials ('env' or 'file').
+
+        Returns
+        -------
+        dict of str to Any
+            Dictionary of credentials for the profile and origin.
+        """
+        if origin == CredsOrigin.ENV.value:
+            return self._env_creds
+        return self._file_creds[profile]

digitalhub/stores/data/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/stores/data/_base/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0