digitalhub 0.8.0b0__py3-none-any.whl → 0.8.0b2__py3-none-any.whl

digitalhub/entities/secret/builder.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+from digitalhub.entities._builders.metadata import build_metadata
+from digitalhub.entities._builders.name import build_name
+from digitalhub.entities._builders.spec import build_spec
+from digitalhub.entities._builders.status import build_status
+from digitalhub.entities._builders.uuid import build_uuid
+from digitalhub.entities.secret.entity import Secret
+
+
+def secret_from_parameters(
+    project: str,
+    name: str,
+    kind: str,
+    uuid: str | None = None,
+    description: str | None = None,
+    labels: list[str] | None = None,
+    embedded: bool = True,
+    **kwargs,
+) -> Secret:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    name : str
+        Object name.
+    kind : str
+        Kind the object.
+    uuid : str
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+    labels : list[str]
+        List of labels.
+    description : str
+        Description of the object (human readable).
+    embedded : bool
+        Flag to determine if object spec must be embedded in project spec.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Secret
+        Object instance.
+    """
+    name = build_name(name)
+    uuid = build_uuid(uuid)
+    metadata = build_metadata(
+        kind,
+        project=project,
+        name=name,
+        version=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+    )
+    path = f"kubernetes://dhcore-proj-secrets-{project}/{name}"
+    provider = "kubernetes"
+    spec = build_spec(
+        kind,
+        path=path,
+        provider=provider,
+        **kwargs,
+    )
+    status = build_status(kind)
+    return Secret(
+        project=project,
+        name=name,
+        uuid=uuid,
+        kind=kind,
+        metadata=metadata,
+        spec=spec,
+        status=status,
+    )
+
+
+def secret_from_dict(obj: dict) -> Secret:
+    """
+    Create a new object from dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary to create object from.
+
+    Returns
+    -------
+    Secret
+        Object instance.
+    """
+    return Secret.from_dict(obj)

digitalhub/entities/secret/crud.py

@@ -0,0 +1,294 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.context.builder import check_context
+from digitalhub.entities._base.crud import (
+    delete_entity_api_ctx,
+    list_entity_api_ctx,
+    read_entity_api_ctx,
+    read_entity_api_ctx_versions,
+)
+from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.entities.secret.builder import secret_from_dict, secret_from_parameters
+from digitalhub.utils.exceptions import EntityAlreadyExistsError
+from digitalhub.utils.io_utils import read_yaml
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.secret.entity import Secret
+
+
+ENTITY_TYPE = EntityTypes.SECRET.value
+
+
+def new_secret(
+    project: str,
+    name: str,
+    uuid: str | None = None,
+    description: str | None = None,
+    labels: list[str] | None = None,
+    embedded: bool = True,
+    secret_value: str | None = None,
+    **kwargs,
+) -> Secret:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    name : str
+        Object name.
+    uuid : str
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+    description : str
+        Description of the object (human readable).
+    labels : list[str]
+        List of labels.
+    embedded : bool
+        Flag to determine if object spec must be embedded in project spec.
+    secret_value : str
+        Value of the secret.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Secret
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = new_secret(project="my-project",
+    >>>                  name="my-secret",
+    >>>                  secret_value="my-secret-value")
+    """
+    check_context(project)
+
+    if secret_value is None:
+        raise ValueError("secret_value must be provided.")
+
+    obj = secret_from_parameters(
+        project=project,
+        name=name,
+        kind="secret",
+        uuid=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+        **kwargs,
+    )
+    obj.save()
+    obj.set_secret_value(value=secret_value)
+    return obj
+
+
+def get_secret(
+    identifier: str,
+    project: str | None = None,
+    entity_id: str | None = None,
+    **kwargs,
+) -> Secret:
+    """
+    Get object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    entity_id : str
+        Entity ID.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    Secret
+        Object instance.
+
+    Examples
+    --------
+    Using entity key:
+    >>> obj = get_secret("store://my-secret-key")
+
+    Using entity name:
+    >>> obj = get_secret("my-secret-name"
+    >>>                  project="my-project",
+    >>>                  entity_id="my-secret-id")
+    """
+    obj = read_entity_api_ctx(
+        identifier,
+        ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        **kwargs,
+    )
+    return secret_from_dict(obj)
+
+
+def get_secret_versions(
+    identifier: str,
+    project: str | None = None,
+    **kwargs,
+) -> list[Secret]:
+    """
+    Get object versions from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[Secret]
+        List of object instances.
+
+    Examples
+    --------
+    Using entity key:
+    >>> objs = get_secret_versions("store://my-secret-key")
+
+    Using entity name:
+    >>> objs = get_secret_versions("my-secret-name",
+    >>>                            project="my-project")
+    """
+    obj = read_entity_api_ctx_versions(
+        identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        **kwargs,
+    )
+    return [secret_from_dict(o) for o in obj]
+
+
+def list_secrets(project: str, **kwargs) -> list[Secret]:
+    """
+    List all latest version objects from backend.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[Secret]
+        List of object instances.
+
+    Examples
+    --------
+    >>> objs = list_secrets(project="my-project")
+    """
+    objs = list_entity_api_ctx(
+        project=project,
+        entity_type=ENTITY_TYPE,
+        **kwargs,
+    )
+    return [secret_from_dict(obj) for obj in objs]
+
+
+def import_secret(file: str) -> Secret:
+    """
+    Import object from a YAML file.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    Secret
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = import_secret("my-secret.yaml")
+    """
+    dict_obj: dict = read_yaml(file)
+    obj = secret_from_dict(dict_obj)
+    try:
+        obj.save()
+    except EntityAlreadyExistsError:
+        pass
+    finally:
+        return obj
+
+
+def update_secret(entity: Secret) -> Secret:
+    """
+    Update object. Note that object spec are immutable.
+
+    Parameters
+    ----------
+    entity : Secret
+        Object to update.
+
+    Returns
+    -------
+    Secret
+        Entity updated.
+
+    Examples
+    --------
+    >>> obj = update_secret(obj)
+    """
+    return entity.save(update=True)
+
+
+def delete_secret(
+    identifier: str,
+    project: str | None = None,
+    entity_id: str | None = None,
+    delete_all_versions: bool = False,
+    **kwargs,
+) -> dict:
+    """
+    Delete object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    entity_id : str
+        Entity ID.
+    delete_all_versions : bool
+        Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    dict
+        Response from backend.
+
+    Examples
+    --------
+    If delete_all_versions is False:
+    >>> obj = delete_secret("store://my-secret-key")
+
+    Otherwise:
+    >>> obj = delete_secret("my-secret-name"
+    >>>                     project="my-project",
+    >>>                     delete_all_versions=True)
+    """
+    return delete_entity_api_ctx(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        delete_all_versions=delete_all_versions,
+        **kwargs,
+    )

digitalhub/entities/secret/entity.py

@@ -0,0 +1,73 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.crud import get_data_api, set_data_api
+from digitalhub.entities._base.entity.versioned import VersionedEntity
+from digitalhub.entities.entity_types import EntityTypes
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.metadata import Metadata
+    from digitalhub.entities.secret.spec import SecretSpec
+    from digitalhub.entities.secret.status import SecretStatus
+
+
+class Secret(VersionedEntity):
+    """
+    A class representing a secret.
+    """
+
+    ENTITY_TYPE = EntityTypes.SECRET.value
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: SecretSpec,
+        status: SecretStatus,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+        self.spec: SecretSpec
+        self.status: SecretStatus
+
+    ##############################
+    #  Secret methods
+    ##############################
+
+    def set_secret_value(self, value: str) -> None:
+        """
+        Update the secret value with a new one.
+
+        Parameters
+        ----------
+        value : str
+            Value of the secret.
+
+        Returns
+        -------
+        None
+        """
+        if self._context().local:
+            raise NotImplementedError("set_secret() is not implemented for local projects.")
+
+        obj = {self.name: value}
+        set_data_api(self.project, self.ENTITY_TYPE, obj)
+
+    def read_secret_value(self) -> dict:
+        """
+        Read the secret value from backend.
+
+        Returns
+        -------
+        str
+            Value of the secret.
+        """
+        if self._context().local:
+            raise NotImplementedError("read_secret() is not implemented for local projects.")
+
+        params = {"keys": self.name}
+        return get_data_api(self.project, self.ENTITY_TYPE, params=params)

digitalhub/entities/secret/spec.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.spec.base import Spec, SpecParams
+
+
+class SecretSpec(Spec):
+    """
+    Secret specifications.
+    """
+
+    def __init__(self, path: str | None = None, provider: str | None = None, **kwargs) -> None:
+        """
+        Constructor.
+
+        Parameters
+        ----------
+        path : str
+            Path to the secret.
+        provider : str
+            Provider of the secret.
+        """
+        self.path = path
+        self.provider = provider
+
+
+class SecretParams(SpecParams):
+    """
+    Secret parameters.
+    """
+
+    path: str = None
+    """Path to the secret."""
+
+    provider: str = None
+    """Provider of the secret."""

digitalhub/entities/secret/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.status.base import Status
+
+
+class SecretStatus(Status):
+    """
+    Status class for secret entities.
+    """

digitalhub/entities/task/builder.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+from digitalhub.entities._builders.metadata import build_metadata
+from digitalhub.entities._builders.spec import build_spec
+from digitalhub.entities._builders.status import build_status
+from digitalhub.entities._builders.uuid import build_uuid
+from digitalhub.entities.task.entity import Task
+
+
+def task_from_parameters(
+    project: str,
+    kind: str,
+    uuid: str | None = None,
+    labels: list[str] | None = None,
+    function: str | None = None,
+    **kwargs,
+) -> Task:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    kind : str
+        Kind the object.
+    uuid : str
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+    labels : list[str]
+        List of labels.
+    function : str
+        Name of the executable associated with the task.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Task
+        Object instance.
+    """
+    uuid = build_uuid(uuid)
+    metadata = build_metadata(
+        kind=kind,
+        project=project,
+        name=uuid,
+        labels=labels,
+    )
+    spec = build_spec(kind, function=function, **kwargs)
+    status = build_status(kind)
+    return Task(
+        project=project,
+        uuid=uuid,
+        kind=kind,
+        metadata=metadata,
+        spec=spec,
+        status=status,
+    )
+
+
+def task_from_dict(obj: dict) -> Task:
+    """
+    Create a new object from dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary representation of Task.
+
+    Returns
+    -------
+    Task
+        Object instance.
+    """
+    return Task.from_dict(obj)