♻️ clean up e2e testing (#128)

* 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

* reorganize

* several changes

* dont install in edit mode

* install in edit mode

* several minor changes

* clean up logging

* dont use relative paths

* ensure artifacts dir exists

* minor change

* make sure pandas gets all dependencies

* correct pandas dependency

* simplify client config

* clean up client config

* small correction

* sevaral minor changes

* minor fixes

* corrections

* add messages to debug

* correction

* minor correction

* add osparc as a dependency

* master -> latest_master

* bugfix

* cosmetic

* cosmetic

* create artifacts dir when creating pytest.ini

* use jobs fcn to iterate over jobs

* minor changes

* add method for getting logdir

* pip freeze

* python 3.9 compatible

* fix

* generate log dir early

* minor change

* dont install e2e in test mode

* ensure e2e is installed in editable mode

* dont install in editable mode

* install e2e in editable mode for pip freeze

* delete job directly instead of stopping it first

* clean up once for each server config

* expose RequestError

* split requirements into unit and 2e2 testing

* fix dev.txt requirements

* move dependencies to unit tests

* _data_classes.py -> _models.py @pcrespov

* config -> settings @pcrespov

* read -> create_from_file @pcrespov

* _warnings_and_errors.py -> _exceptions.py @pcrespov

Author: bisgaard-itis

.github/workflows/build-python-client.yml

@@ -89,7 +89,7 @@ jobs:
           python -m pip install pytest
           python -m pip install clients/python/artifacts/dist/${{needs.build.outputs.osparc}} --find-links=clients/python/artifacts/dist
           cd clients/python
-          make install-test
+          make install-unit-test
           pytest -v --ignore=/artifacts/client --ignore=test/e2e
 
   test-latest:
@@ -125,7 +125,7 @@ jobs:
           python -m pip install pytest
           python -m pip install clients/python/artifacts/dist/${{needs.build.outputs.osparc}} --find-links=clients/python/artifacts/dist
           cd clients/python
-          make install-test
+          make install-unit-test
           pytest -v --ignore=/artifacts/client --ignore=test/e2e
 
   publish:

clients/python/Makefile

@@ -106,9 +106,13 @@ _check_venv_active:
 install-dev: _check_venv_active ## install packages for development
 	pip install -r requirements/dev.txt
 
-.PHONY: install-test
-install-test: _check_venv_active install-dev ## install packages for testing client
-	pip install -r $(PYTHON_DIR)/requirements/test.txt
+.PHONY: install-unit-test
+install-unit-test: _check_venv_active ## install packages for unit testing client
+	pip install -r $(PYTHON_DIR)/requirements/unit-test.txt
+
+.PHONY: install-e2e-test
+install-e2e-test: _check_venv_active ## install packages for e2e testing client
+	pip install -r $(PYTHON_DIR)/requirements/e2e-test.txt
 
 .PHONY: install-doc
 install-doc: _check_venv_active install-dev ## install packages for generating documentation

clients/python/client/osparc/__init__.py

@@ -35,6 +35,7 @@
     __version__,
 )
 
+from ._exceptions import RequestError
 from ._files_api import FilesApi
 from ._info import openapi
 from ._solvers_api import SolversApi
@@ -88,4 +89,5 @@
     "SolverPort",
     "ErrorGet",
     "openapi",
+    "RequestError",
 )  # type: ignore

clients/python/client/osparc/_exceptions.py

@@ -0,0 +1,25 @@
+from functools import wraps
+
+from httpx import HTTPStatusError
+
+
+class VisibleDeprecationWarning(UserWarning):
+    """Visible deprecation warning.
+
+    Acknowledgement: Having this wrapper is borrowed from numpy
+    """
+
+
+class RequestError(Exception):
+    """For exceptions encountered when performing HTTP requests."""
+
+
+def handle_exceptions(func):
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        try:
+            return func(*args, **kwargs)
+        except HTTPStatusError as e:
+            raise RequestError(f"{e}") from e
+
+    return wrapper

clients/python/client/osparc/_utils.py

@@ -17,6 +17,8 @@
     Study,
 )
 
+from ._exceptions import RequestError
+
 _KB = 1024  # in bytes
 _MB = _KB * 1024  # in bytes
 _GB = _MB * 1024  # in bytes
@@ -61,8 +63,12 @@ def __iter__(self) -> Generator[T, None, None]:
             assert isinstance(page.total, int)
             yield from page.items
             if page.links.next is None:
-                break
+                return
             response: httpx.Response = self._client.get(page.links.next)
+            try:
+                response.raise_for_status()
+            except httpx.HTTPStatusError as e:
+                raise RequestError() from e
             page = self._api_client._ApiClient__deserialize(response.json(), type(page))
 
 

clients/python/client/osparc/_warnings_and_errors.py

@@ -3,7 +3,7 @@
 
 from osparc_client.api import FilesApi, MetaApi, SolversApi, UsersApi
 
-from ._warnings_and_errors import VisibleDeprecationWarning
+from ._exceptions import VisibleDeprecationWarning
 
 warning_msg: Final[str] = (
     "osparc.api has been deprecated. Instead functionality within this module "

clients/python/client/osparc/api.py

@@ -17,7 +17,7 @@
 from osparc_client.models import RunningState as TaskStates
 from osparc_client.models import Solver, UserRoleEnum, UsersGroup, ValidationError
 
-from ._warnings_and_errors import VisibleDeprecationWarning
+from ._exceptions import VisibleDeprecationWarning
 
 warning_msg: Final[str] = (
     "osparc.models has been deprecated. Instead functionality within this module "

clients/python/client/osparc/models.py

@@ -1,3 +1,4 @@
 -r ../../../requirements.txt
--r test.txt
+-r unit-test.txt
+-r e2e-test.txt
 pylint

clients/python/requirements/dev.txt

@@ -12,7 +12,5 @@ pydantic
 pytest
 pytest-env
 pytest-html
-typer
 packaging
-pipdeptree
-pipreqs
+-e test/e2e/ci/e2e