🐛 Add execution timeout to tutorial tests (#148)

* update workflow before publishing python package

* fix dependency issue and bump version

* point to website in project description

* fix broken dependency

* improve doc

* add github token to download artifacts

* ensure only read-access @wvangeit

* yet another attempt at downloading artifacts

* make sure to use repo that ran the trigger wf

* another attempt at fixing

* change owner

* allow publishing to testpypi also when pr

* minor change

* revert minor (but breaking) change

* minor fix

* add debug messages

* another debug message

* hopefully the final version

* final fix

* minor fix

* move master and tag to individual jobs

* add debug messages

* dev->post

* add python script for determining semantic version

* minor changes

* minor changes

* improve error handling and add version file to artifacts

* check if release

* minor fix

* ensure to enter venv

* also when tagging

* source venv in publishin workflow

* ensure only master

* add script for testing 'pure' semver

* adapt workflows to new python script

* minor change

* attempt to evaluate expressions correctly

* several fixes to fix tests

* ensure repo is checked out in publish workflow

* several small fixes

* cleanup

* debug

* minor cleanup

* mionr changes

* add debug message

* minor change

* minor change

* yet another try

* minor change

* minor change

* minor change

* mionr change

* minor changes

* correct workflow run id

* cosmetic change

* avoid using gh

* change to a single job for publishing

* minor cleanup

* swap loops in clean up jobs

* correction

* update server compatibility to new url

* minor change to trigger ci

* 20min execution timeout for tutorial notebooks

* small cleanup

Author: bisgaard-itis

clients/python/client/osparc/_solvers_api.py

@@ -1,16 +1,25 @@
-from typing import List, Optional
+from typing import Any, List, Optional
 
 import httpx
 from osparc_client import OnePageSolverPort, SolverPort
 from osparc_client import SolversApi as _SolversApi
 
 from . import ApiClient
-from ._utils import PaginationGenerator, dev_features_enabled
+from ._utils import PaginationGenerator, dev_feature, dev_features_enabled
 
 
 class SolversApi(_SolversApi):
     """Class for interacting with solvers"""
 
+    _dev_features = [
+        "get_jobs_page",
+    ]
+
+    def __getattribute__(self, name: str) -> Any:
+        if (name in SolversApi._dev_features) and (not dev_features_enabled()):
+            raise NotImplementedError(f"SolversApi.{name} is still under development")
+        return super().__getattribute__(name)
+
     def __init__(self, api_client: Optional[ApiClient] = None):
         """Construct object
 
@@ -33,36 +42,31 @@ def list_solver_ports(self, solver_key: str, version: str) -> List[SolverPort]:
         )  # type: ignore
         return page.items if page.items else []
 
-    if dev_features_enabled():
-
-        def get_jobs_page(self, solver_key: str, version: str) -> None:
-            """Method only for internal use"""
-            raise NotImplementedError("This method is only for internal use")
-
-        def jobs(self, solver_key: str, version: str) -> PaginationGenerator:
-            """Returns an iterator through which one can iterate over
-            all Jobs submitted to the solver
-
-            Args:
-                solver_key (str): The solver key
-                version (str): The solver version
-                limit (int, optional): the limit of a single page
-                offset (int, optional): the offset of the first element to return
+    @dev_feature
+    def jobs(self, solver_key: str, version: str) -> PaginationGenerator:
+        """Returns an iterator through which one can iterate over
+        all Jobs submitted to the solver
 
-            Returns:
-                PaginationGenerator: A generator whose elements are the Jobs submitted
-                to the solver and the total number of jobs the iterator can yield
-                (its "length")
-            """
+        Args:
+            solver_key (str): The solver key
+            version (str): The solver version
+            limit (int, optional): the limit of a single page
+            offset (int, optional): the offset of the first element to return
 
-            def pagination_method():
-                return super(SolversApi, self).get_jobs_page(
-                    solver_key=solver_key, version=version, limit=20, offset=0
-                )
+        Returns:
+            PaginationGenerator: A generator whose elements are the Jobs submitted
+            to the solver and the total number of jobs the iterator can yield
+            (its "length")
+        """
 
-            return PaginationGenerator(
-                first_page_callback=pagination_method,
-                api_client=self.api_client,
-                base_url=self.api_client.configuration.host,
-                auth=self._auth,
+        def pagination_method():
+            return super(SolversApi, self).get_jobs_page(
+                solver_key=solver_key, version=version, limit=20, offset=0
             )
+
+        return PaginationGenerator(
+            first_page_callback=pagination_method,
+            api_client=self.api_client,
+            base_url=self.api_client.configuration.host,
+            auth=self._auth,
+        )

clients/python/test/e2e/test_notebooks.py

@@ -1,13 +1,14 @@
 import shutil
 import sys
 from pathlib import Path
-from typing import Any, Dict, List
+from typing import Any, Dict, Final, List
 
 import osparc
 import papermill as pm
 import pytest
 from packaging.version import Version
 
+_NOTEBOOK_EXECUTION_TIMEOUT_SECONDS: Final[int] = 60 * 20  # 20min
 docs_dir: Path = Path(__file__).parent.parent.parent / "docs"
 all_notebooks: List[Path] = list(docs_dir.rglob("*.ipynb"))
 min_version_reqs: Dict[str, Version] = {
@@ -60,4 +61,5 @@ def test_run_notebooks(tmp_path: Path, notebook: Path, params: dict[str, Any] =
         output_path=output,
         kernel_name="python3",
         parameters=params,
+        execution_timeout=_NOTEBOOK_EXECUTION_TIMEOUT_SECONDS,
     )