digitalhub 0.9.0b0__tar.gz → 0.9.0b2__tar.gz

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: digitalhub
-Version: 0.9.0b0
+Version: 0.9.0b2
 Summary: Python SDK for Digitalhub
 Author-email: Fondazione Bruno Kessler <dslab@fbk.eu>, Matteo Martini <mmartini@fbk.eu>
 License:                               Apache License

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub/client/dhcore/client.py

@@ -12,7 +12,7 @@ from requests.exceptions import HTTPError, JSONDecodeError, RequestException
 
 from digitalhub.client._base.client import Client
 from digitalhub.client.dhcore.api_builder import ClientDHCoreApiBuilder
-from digitalhub.client.dhcore.enums import AuthType, EnvVar
+from digitalhub.client.dhcore.enums import AuthType, DhcoreEnvVar
 from digitalhub.client.dhcore.env import ENV_FILE, FALLBACK_USER, LIB_VERSION, MAX_API_LEVEL, MIN_API_LEVEL
 from digitalhub.client.dhcore.models import BasicAuth, OAuth2TokenAuth
 from digitalhub.utils.exceptions import (
@@ -520,7 +520,6 @@ class ClientDHCore(Client):
         -------
         None
         """
-
         self._get_endpoints_from_env()
 
         if config is not None:
@@ -558,12 +557,12 @@ class ClientDHCore(Client):
         Exception
             If the endpoint of DHCore is not set in the env variables.
         """
-        core_endpt = os.getenv(EnvVar.ENDPOINT.value)
+        core_endpt = os.getenv(DhcoreEnvVar.ENDPOINT.value)
         if core_endpt is None:
             raise BackendError("Endpoint not set as environment variables.")
         self._endpoint_core = self._sanitize_endpoint(core_endpt)
 
-        issr_endpt = os.getenv(EnvVar.ISSUER.value)
+        issr_endpt = os.getenv(DhcoreEnvVar.ISSUER.value)
         if issr_endpt is not None:
             self._endpoint_issuer = self._sanitize_endpoint(issr_endpt)
 
@@ -589,17 +588,17 @@ class ClientDHCore(Client):
         -------
         None
         """
-        self._user = os.getenv(EnvVar.USER.value, FALLBACK_USER)
-        self._refresh_token = os.getenv(EnvVar.REFRESH_TOKEN.value)
-        self._client_id = os.getenv(EnvVar.CLIENT_ID.value)
+        self._user = os.getenv(DhcoreEnvVar.USER.value, FALLBACK_USER)
+        self._refresh_token = os.getenv(DhcoreEnvVar.REFRESH_TOKEN.value)
+        self._client_id = os.getenv(DhcoreEnvVar.CLIENT_ID.value)
 
-        token = os.getenv(EnvVar.ACCESS_TOKEN.value)
+        token = os.getenv(DhcoreEnvVar.ACCESS_TOKEN.value)
         if token is not None and token != "":
             self._auth_type = AuthType.OAUTH2.value
             self._access_token = token
             return
 
-        password = os.getenv(EnvVar.PASSWORD.value)
+        password = os.getenv(DhcoreEnvVar.PASSWORD.value)
         if self._user is not None and password is not None:
             self._auth_type = AuthType.BASIC.value
             self._password = password
@@ -619,12 +618,12 @@ class ClientDHCore(Client):
 
         # Call refresh token endpoint
         # Try token from env
-        refresh_token = os.getenv(EnvVar.REFRESH_TOKEN.value)
+        refresh_token = os.getenv(DhcoreEnvVar.REFRESH_TOKEN.value)
         response = self._call_refresh_token_endpoint(url, refresh_token)
 
         # Otherwise try token from file
         if response.status_code in (400, 401, 403):
-            refresh_token = get_key(ENV_FILE, EnvVar.REFRESH_TOKEN.value)
+            refresh_token = get_key(ENV_FILE, DhcoreEnvVar.REFRESH_TOKEN.value)
             response = self._call_refresh_token_endpoint(url, refresh_token)
 
         response.raise_for_status()
@@ -694,9 +693,9 @@ class ClientDHCore(Client):
         """
         keys = {}
         if self._access_token is not None:
-            keys[EnvVar.ACCESS_TOKEN.value] = self._access_token
+            keys[DhcoreEnvVar.ACCESS_TOKEN.value] = self._access_token
         if self._refresh_token is not None:
-            keys[EnvVar.REFRESH_TOKEN.value] = self._refresh_token
+            keys[DhcoreEnvVar.REFRESH_TOKEN.value] = self._refresh_token
 
         for k, v in keys.items():
             set_key(dotenv_path=ENV_FILE, key_to_set=k, value_to_set=v)

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub/client/dhcore/enums.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from enum import Enum
 
 
-class EnvVar(Enum):
+class DhcoreEnvVar(Enum):
     """
     Environment variables.
     """
@@ -15,6 +15,7 @@ class EnvVar(Enum):
     CLIENT_ID = "DHCORE_CLIENT_ID"
     ACCESS_TOKEN = "DHCORE_ACCESS_TOKEN"
     REFRESH_TOKEN = "DHCORE_REFRESH_TOKEN"
+    WORKFLOW_IMAGE = "DHCORE_WORKFLOW_IMAGE"
 
 
 class AuthType(Enum):

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub/client/dhcore/utils.py

@@ -4,7 +4,7 @@ import os
 import typing
 
 from digitalhub.client.api import get_client
-from digitalhub.client.dhcore.enums import AuthType, EnvVar
+from digitalhub.client.dhcore.enums import AuthType, DhcoreEnvVar
 
 if typing.TYPE_CHECKING:
     from digitalhub.client.dhcore.client import ClientDHCore
@@ -44,17 +44,17 @@ def set_dhcore_env(
     None
     """
     if endpoint is not None:
-        os.environ[EnvVar.ENDPOINT.value] = endpoint
+        os.environ[DhcoreEnvVar.ENDPOINT.value] = endpoint
     if user is not None:
-        os.environ[EnvVar.USER.value] = user
+        os.environ[DhcoreEnvVar.USER.value] = user
     if password is not None:
-        os.environ[EnvVar.PASSWORD.value] = password
+        os.environ[DhcoreEnvVar.PASSWORD.value] = password
     if access_token is not None:
-        os.environ[EnvVar.ACCESS_TOKEN.value] = access_token
+        os.environ[DhcoreEnvVar.ACCESS_TOKEN.value] = access_token
     if refresh_token is not None:
-        os.environ[EnvVar.REFRESH_TOKEN.value] = refresh_token
+        os.environ[DhcoreEnvVar.REFRESH_TOKEN.value] = refresh_token
     if client_id is not None:
-        os.environ[EnvVar.CLIENT_ID.value] = client_id
+        os.environ[DhcoreEnvVar.CLIENT_ID.value] = client_id
 
     update_client_from_env()
 
@@ -70,16 +70,16 @@ def update_client_from_env() -> None:
     client: ClientDHCore = get_client(local=False)
 
     # Update endpoint
-    endpoint = os.getenv(EnvVar.ENDPOINT.value)
+    endpoint = os.getenv(DhcoreEnvVar.ENDPOINT.value)
     if endpoint is not None:
         client._endpoint_core = endpoint
 
     # Update auth
 
     # If token is set, it will override the other auth options
-    access_token = os.getenv(EnvVar.ACCESS_TOKEN.value)
-    refresh_token = os.getenv(EnvVar.REFRESH_TOKEN.value)
-    client_id = os.getenv(EnvVar.CLIENT_ID.value)
+    access_token = os.getenv(DhcoreEnvVar.ACCESS_TOKEN.value)
+    refresh_token = os.getenv(DhcoreEnvVar.REFRESH_TOKEN.value)
+    client_id = os.getenv(DhcoreEnvVar.CLIENT_ID.value)
 
     if access_token is not None:
         if refresh_token is not None:
@@ -91,8 +91,8 @@ def update_client_from_env() -> None:
         return
 
     # Otherwise, if user and password are set, basic auth will be used
-    username = os.getenv(EnvVar.USER.value)
-    password = os.getenv(EnvVar.PASSWORD.value)
+    username = os.getenv(DhcoreEnvVar.USER.value)
+    password = os.getenv(DhcoreEnvVar.PASSWORD.value)
     if username is not None and password is not None:
         client._user = username
         client._password = password

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub/entities/_base/entity/metadata.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from pydantic import BaseModel, Field, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 
 from digitalhub.entities._base._base.entity import Base
 from digitalhub.entities._commons.enums import Relationship

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub/entities/_operations/processor.py

@@ -538,7 +538,10 @@ class OperationsProcessor:
         new_obj = self._create_context_entity(context, obj.ENTITY_TYPE, obj.to_dict())
         return build_entity_from_dict(new_obj)
 
-    def log_material_entity(self, **kwargs,) -> MaterialEntity:
+    def log_material_entity(
+        self,
+        **kwargs,
+    ) -> MaterialEntity:
         """
         Create object in backend and upload file.
 

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub/entities/function/_base/entity.py

@@ -79,11 +79,11 @@ class Function(ExecutableEntity):
         task = self._get_or_create_task(task_kind)
 
         # Run function from task
-        run = task.run(run_kind, local_execution, **kwargs)
+        run = task.run(run_kind, save=False, local_execution=local_execution, **kwargs)
 
         # Set as run's parent
         run.add_relationship(Relationship.RUN_OF.value, run.key + ":" + run.id, self.key)
-        run.save(update=True)
+        run.save()
 
         # If execution is done by DHCore backend, return the object
         if not local_execution:

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub/entities/run/_base/spec.py

@@ -21,6 +21,8 @@ class RunSpec(Spec):
         envs: list[dict] | None = None,
         secrets: list[str] | None = None,
         profile: str | None = None,
+        runtime_class: str | None = None,
+        priority_class: str | None = None,
         **kwargs,
     ) -> None:
         self.task = task
@@ -35,6 +37,8 @@ class RunSpec(Spec):
         self.envs = envs
         self.secrets = secrets
         self.profile = profile
+        self.runtime_class = runtime_class
+        self.priority_class = priority_class
 
 
 class RunValidator(SpecValidator, K8s):

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub/entities/task/_base/entity.py

@@ -4,8 +4,8 @@ import typing
 
 from digitalhub.entities._base.unversioned.entity import UnversionedEntity
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities.run.crud import delete_run, get_run, new_run
-from digitalhub.factory.api import get_entity_type_from_kind, get_executable_kind
+from digitalhub.entities._operations.processor import processor
+from digitalhub.factory.api import build_entity_from_params, get_entity_type_from_kind, get_executable_kind
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -42,6 +42,7 @@ class Task(UnversionedEntity):
     def run(
         self,
         run_kind: str,
+        save: bool = True,
         local_execution: bool = False,
         **kwargs,
     ) -> Run:
@@ -66,6 +67,7 @@ class Task(UnversionedEntity):
         exec_type = get_entity_type_from_kind(exec_kind)
         kwargs[exec_type] = getattr(self.spec, exec_type)
         return self.new_run(
+            save=save,
             project=self.project,
             task=self._get_task_string(),
             kind=run_kind,
@@ -88,21 +90,25 @@ class Task(UnversionedEntity):
     # CRUD Methods for Run
     ##############################
 
-    def new_run(self, **kwargs) -> Run:
+    def new_run(self, save: bool = True, **kwargs) -> Run:
         """
         Create a new run.
 
         Parameters
         ----------
+        save : bool
+            Flag to indicate save.
         **kwargs : dict
-            Keyword arguments.
+            Keyword arguments to build run. See new_run().
 
         Returns
         -------
         Run
             Run object.
         """
-        return new_run(**kwargs)
+        if save:
+            return processor.create_context_entity(**kwargs)
+        return build_entity_from_params(**kwargs)
 
     def get_run(self, entity_key: str) -> Run:
         """
@@ -118,9 +124,9 @@ class Task(UnversionedEntity):
         Run
             Run object.
         """
-        return get_run(entity_key)
+        return processor.read_context_entity(entity_key)
 
-    def delete_run(self, entity_key: str) -> None:
+    def delete_run(self, entity_key: str) -> dict:
         """
         Delete run.
 
@@ -131,6 +137,7 @@ class Task(UnversionedEntity):
 
         Returns
         -------
-        None
+        dict
+            Response from backend.
         """
-        delete_run(entity_key)
+        return processor.delete_context_entity(entity_key)

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub/entities/task/_base/models.py

@@ -210,6 +210,12 @@ class K8s(BaseModel):
     profile: str = None
     """Profile template."""
 
+    runtime_class: str = None
+    """Runtime class name."""
+
+    priority_class: str = None
+    """Priority class."""
+
 
 class CorePort(BaseModel):
     """

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub/entities/task/_base/spec.py

@@ -22,6 +22,8 @@ class TaskSpecFunction(TaskSpec):
         envs: list[dict] | None = None,
         secrets: list[str] | None = None,
         profile: str | None = None,
+        runtime_class: str | None = None,
+        priority_class: str | None = None,
         **kwargs,
     ) -> None:
         self.function = function
@@ -33,6 +35,8 @@ class TaskSpecFunction(TaskSpec):
         self.envs = envs
         self.secrets = secrets
         self.profile = profile
+        self.runtime_class = runtime_class
+        self.priority_class = priority_class
 
 
 class TaskSpecWorkflow(TaskSpec):
@@ -49,6 +53,8 @@ class TaskSpecWorkflow(TaskSpec):
         envs: list[dict] | None = None,
         secrets: list[str] | None = None,
         profile: str | None = None,
+        runtime_class: str | None = None,
+        priority_class: str | None = None,
         **kwargs,
     ) -> None:
         self.workflow = workflow

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub/entities/workflow/_base/entity.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.executable.entity import ExecutableEntity
-from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._commons.enums import EntityTypes, Relationship
 from digitalhub.factory.api import get_run_kind, get_task_kind_from_action
 from digitalhub.utils.exceptions import BackendError
 
@@ -76,7 +76,12 @@ class Workflow(ExecutableEntity):
             raise BackendError("Cannot run workflow with local backend.")
 
         # Run task
-        run = task.run(run_kind, local_execution=False, **kwargs)
+        run = task.run(run_kind, save=False, local_execution=False, **kwargs)
+
+        # Set as run's parent
+        run.add_relationship(Relationship.RUN_OF.value, run.key + ":" + run.id, self.key)
+        run.save()
+
         if wait:
             return run.wait(log_info=log_info)
         return run

digitalhub-0.9.0b2/digitalhub/runtimes/enums.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class RuntimeEnvVar(Enum):
+    """
+    Environment variables.
+    """
+
+    PROJECT = "PROJECT_NAME"
+    RUN_ID = "RUN_ID"

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: digitalhub
-Version: 0.9.0b0
+Version: 0.9.0b2
 Summary: Python SDK for Digitalhub
 Author-email: Fondazione Bruno Kessler <dslab@fbk.eu>, Matteo Martini <mmartini@fbk.eu>
 License:                               Apache License

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/digitalhub.egg-info/SOURCES.txt

@@ -197,6 +197,7 @@ digitalhub/readers/pandas/reader.py
 digitalhub/runtimes/__init__.py
 digitalhub/runtimes/_base.py
 digitalhub/runtimes/builder.py
+digitalhub/runtimes/enums.py
 digitalhub/stores/__init__.py
 digitalhub/stores/api.py
 digitalhub/stores/builder.py
@@ -228,4 +229,5 @@ test/testkfp_pipeline.py
 test/local/CRUD/test_artifacts.py
 test/local/CRUD/test_dataitems.py
 test/local/CRUD/test_models.py
-test/local/imports/test_imports.py
+test/local/imports/test_imports.py
+test/local/instances/test_validate.py

{digitalhub-0.9.0b0 → digitalhub-0.9.0b2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "digitalhub"
-version = "0.9.0b0"
+version = "0.9.0b2"
 description = "Python SDK for Digitalhub"
 readme = "README.md"
 authors = [
@@ -77,7 +77,7 @@ line-length = 120
 convention = "numpy"
 
 [tool.bumpver]
-current_version = "0.9.0b0"
+current_version = "0.9.0b2"
 version_pattern = "MAJOR.MINOR.PATCH[PYTAGNUM]"
 commit_message  = "Bump version {old_version} -> {new_version}"
 commit          = false

digitalhub-0.9.0b2/test/local/instances/test_validate.py

@@ -0,0 +1,55 @@
+import os
+import pytest
+from glob import glob
+from pathlib import Path
+import json
+from jsonschema import validate
+from digitalhub.factory.factory import factory
+
+entities_path = "test/local/instances/entities"
+schemas_path = "test/local/instances/schemas"
+
+# Build dict: kind -> path to schema file
+schemas = {}
+for path_to_schema in glob(f"{schemas_path}/**/*.json", recursive=True):
+    kind = Path(path_to_schema).stem
+    schemas[kind] = path_to_schema
+
+# Build dict: name of file to validate -> full path to file
+entity_paths = {}
+for path_to_file in glob(f"{entities_path}/**/*.json", recursive=True):
+    file_name = os.path.basename(path_to_file)
+
+    # If a file in a nested directory causes a name collision, use its full path as name 
+    if file_name in entity_paths:
+        file_name = path_to_file
+
+    entity_paths[file_name] = path_to_file
+
+# Build object from JSON file using factory
+def build_obj(entity_file_path):
+    with open(entity_file_path) as f:
+        entity = json.load(f)
+        
+    kind = entity["kind"]
+    spec = entity["spec"]
+
+    built = factory.build_spec(kind, **spec)
+    return built.to_dict(), kind
+
+# Validate built object against its kind's schema
+def is_valid(built, kind):
+    with open(schemas[kind]) as schema_file:
+        schema = json.load(schema_file)
+
+    validate(instance=built, schema=schema)
+    return True
+
+# Tests that each JSON file contained in the specified path can successfully be
+# used to generate an object through the factory, and that each generated object,
+# when exported to dict, validates (through jsonschema) against its kind's schema.
+class TestValidate:
+    @pytest.mark.parametrize('file_name', list(entity_paths.keys()))
+    def test_validate(self, file_name):
+        built, kind = build_obj(f"{entity_paths[file_name]}")
+        assert is_valid(built, kind)