ocean-runner 0.2.2__tar.gz → 0.2.4__tar.gz

{ocean_runner-0.2.2 → ocean_runner-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ocean-runner
-Version: 0.2.2
+Version: 0.2.4
 Summary: A fluent API for OceanProtocol algorithms
 Project-URL: Homepage, https://github.com/AgrospAI/ocean-runner
 Project-URL: Issues, https://github.com/AgrospAI/ocean-runner/issues
@@ -26,6 +26,14 @@ Description-Content-Type: text/markdown
 Ocean Runner is a package that brings a fluent API for APP creation and running in the scope of OceanProtocol.
 
 
+## Installation
+
+```bash
+pip install ocean-runner
+# or
+uv add ocean-runner
+```
+
 ## Usage
 
 ### Minimal Example
@@ -126,6 +134,11 @@ Algorithm(
             """
             Random secret to use while testing.
             """
+
+            runtime: "dev",
+            """
+            Runtime mode. "dev" to run normally, "test" to run pytest
+            """
         )
         """
         Should not be needed in production algorithms, used to mock environment variables, defaults to using env.

{ocean_runner-0.2.2 → ocean_runner-0.2.4}/README.md

@@ -3,6 +3,14 @@
 Ocean Runner is a package that brings a fluent API for APP creation and running in the scope of OceanProtocol.
 
 
+## Installation
+
+```bash
+pip install ocean-runner
+# or
+uv add ocean-runner
+```
+
 ## Usage
 
 ### Minimal Example
@@ -103,6 +111,11 @@ Algorithm(
             """
             Random secret to use while testing.
             """
+
+            runtime: "dev",
+            """
+            Runtime mode. "dev" to run normally, "test" to run pytest
+            """
         )
         """
         Should not be needed in production algorithms, used to mock environment variables, defaults to using env.

{ocean_runner-0.2.2 → ocean_runner-0.2.4}/ocean_runner/config.py

@@ -1,28 +1,41 @@
+import os
 from dataclasses import asdict, dataclass, field
 from logging import Logger
-import os
 from pathlib import Path
-from typing import Callable, Iterable, TypeVar
+from typing import Callable, Iterable, Literal, TypeVar
 
 T = TypeVar("T")
 
 
-@dataclass(frozen=True)
+@dataclass
 class Environment:
     """Environment variables mock"""
 
-    base_dir: str | None = field(default=os.environ.get("BASE_DIR", None))
+    base_dir: str | None = field(
+        default_factory=lambda: os.environ.get("BASE_DIR", None),
+    )
     """Base data directory, defaults to '/data'"""
 
-    dids: str = field(default=os.environ.get("DIDS"))
+    dids: str = field(
+        default_factory=lambda: os.environ.get("DIDS"),
+    )
     """Datasets DID's, format: '["XXXX"]'"""
 
-    transformation_did: str = field(default=os.environ.get("TRANSFORMATION_DID"))
+    transformation_did: str = field(
+        default_factory=lambda: os.environ.get("TRANSFORMATION_DID"),
+    )
     """Transformation (algorithm) DID"""
 
-    secret: str = field(default=os.environ.get("SECRET"))
+    secret: str = field(
+        default_factory=lambda: os.environ.get("SECRET"),
+    )
     """Super secret secret"""
 
+    runtime: Literal["dev", "test"] = field(
+        default_factory=lambda: os.environ.get("RUNTIME", "dev").lower()
+    )
+    """Select runtime mode"""
+
     dict = asdict
 
 
@@ -44,5 +57,7 @@ class Config:
     )
     """Paths that should be included so the code executes correctly"""
 
-    environment: Environment = Environment()
+    environment: Environment = field(
+        default_factory=lambda: Environment(),
+    )
     """Mock of environment data"""

{ocean_runner-0.2.2 → ocean_runner-0.2.4}/ocean_runner/runner.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from dataclasses import InitVar, asdict, dataclass, field
 from logging import Logger
 from pathlib import Path
@@ -6,6 +8,7 @@ from typing import Callable, Generic, Self, TypeVar
 from oceanprotocol_job_details import JobDetails
 
 from ocean_runner.config import Config
+from ocean_runner.runtime_mode import RuntimeMode
 
 JobDetailsT = TypeVar(
     "JobDetailsT",
@@ -13,24 +16,37 @@ JobDetailsT = TypeVar(
 ResultT = TypeVar("ResultT")
 
 
-def default_error_callback(e: Exception) -> None:
+def default_error_callback(_: Algorithm, e: Exception) -> None:
     raise e
 
 
-def default_validation(algorithm: "Algorithm") -> None:
+def default_validation(algorithm: Algorithm) -> None:
     algorithm.logger.info("Validating input using default validation")
 
     assert algorithm.job_details.ddos, "DDOs missing"
     assert algorithm.job_details.files, "Files missing"
 
 
-def default_save(*, result: ResultT, base: Path, algorithm: "Algorithm") -> None:
+def default_save(*, result: ResultT, base: Path, algorithm: Algorithm) -> None:
     algorithm.logger.info("Saving results using default save")
 
     with open(base / "result.txt", "w+") as f:
         f.write(str(result))
 
 
+def default_test_run(algorithm: Algorithm) -> int:
+    import pytest
+
+    result = pytest.main()
+
+    if result == 0:
+        algorithm.logger.info("Passed all tests")
+    else:
+        algorithm.logger.error("Some tests failed")
+
+    return result
+
+
 @dataclass
 class Algorithm(Generic[JobDetailsT, ResultT]):
 
@@ -38,16 +54,18 @@ class Algorithm(Generic[JobDetailsT, ResultT]):
 
     # Load from config
     logger: Logger = field(init=False)
-    error_callback: Callable[[Exception], None] = field(init=False)
 
     _job_details: JobDetails[JobDetailsT] = field(init=False)
     _result: ResultT | None = field(default=None, init=False)
+    _runtime: RuntimeMode = field(default=RuntimeMode.DEV, init=False)
+
+    error_callback = default_error_callback
 
     def __post_init__(self, config: Config | None) -> None:
-        config = config or Config()
+        config: Config = config or Config()
 
-        # Use config or use a default implementation
-        self.error_callback = config.error_callback or default_error_callback
+        if config.error_callback:
+            self.error_callback = config.error_callback
 
         if config.logger:
             self.logger = config.logger
@@ -71,9 +89,14 @@ class Algorithm(Generic[JobDetailsT, ResultT]):
             sys.path.extend([str(path.absolute()) for path in config.source_paths])
             self.logger.debug(f"Added [{len(config.source_paths)}] entries to PATH")
 
+        self._runtime = RuntimeMode(config.environment.runtime) or self._runtime
+
         self._job_details = JobDetails.load(
-            config.custom_input,
-            **config.environment.dict(),
+            _type=config.custom_input,
+            base_dir=config.environment.base_dir,
+            dids=config.environment.dids,
+            transformation_did=config.environment.transformation_did,
+            secret=config.environment.secret,
         )
 
         self.logger.info("Loaded JobDetails")
@@ -103,8 +126,11 @@ class Algorithm(Generic[JobDetailsT, ResultT]):
         return self
 
     def run(self, callable: Callable[[Self], ResultT]) -> Self:
-        self.logger.info("Running algorithm ...")
+        self.logger.info("Running algorithm...")
         try:
+            if self._runtime == RuntimeMode.TEST:
+                callable = default_test_run
+
             self._result = callable(self)
         except Exception as e:
             self.error_callback(e)
@@ -113,7 +139,7 @@ class Algorithm(Generic[JobDetailsT, ResultT]):
 
     def save_results(
         self,
-        callable: Callable[[ResultT, Path, "Algorithm"], None] = default_save,
+        callable: Callable[[ResultT, Path, Algorithm], None] = default_save,
     ) -> None:
         self.logger.info("Saving results...")
         try:
@@ -124,3 +150,6 @@ class Algorithm(Generic[JobDetailsT, ResultT]):
             )
         except Exception as e:
             self.error_callback(e)
+
+
+__all__ = [Algorithm]

ocean_runner-0.2.4/ocean_runner/runtime_mode.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class RuntimeMode(Enum):
+    DEV = "dev"
+    TEST = "test"

{ocean_runner-0.2.2 → ocean_runner-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ocean-runner"
-version = "0.2.2"
+version = "0.2.4"
 description = "A fluent API for OceanProtocol algorithms"
 authors = [
     { name = "AgrospAI", email = "agrospai@udl.cat" },