♻️ Enhances e2e testing (#162)

Author: pcrespov

clients/python/client/osparc/__init__.py

@@ -70,48 +70,48 @@
 dev_features: List[str] = []
 if dev_features_enabled():
     dev_features = [
-        "PaginationGenerator",
-        "StudyPort",
-        "Study",
+        "JobMetadata",
         "JobMetadataUpdate",
         "Links",
-        "JobMetadata",
         "OnePageStudyPort",
+        "PaginationGenerator",
+        "Study",
+        "StudyPort",
     ]
 
 __all__: Tuple[str, ...] = tuple(dev_features) + (
     "__version__",
-    "FilesApi",
-    "MetaApi",
-    "SolversApi",
-    "StudiesApi",
-    "UsersApi",
+    "ApiClient",
+    "ApiException",
+    "ApiKeyError",
+    "ApiTypeError",
+    "ApiValueError",
     "BodyUploadFileV0FilesContentPut",
+    "Configuration",
+    "ErrorGet",
     "File",
+    "FilesApi",
     "Groups",
     "HTTPValidationError",
     "Job",
     "JobInputs",
     "JobOutputs",
     "JobStatus",
     "Meta",
+    "MetaApi",
+    "OnePageSolverPort",
+    "openapi",
+    "OpenApiException",
     "Profile",
     "ProfileUpdate",
+    "RequestError",
     "Solver",
+    "SolverPort",
+    "SolversApi",
+    "StudiesApi",
     "TaskStates",
     "UserRoleEnum",
+    "UsersApi",
     "UsersGroup",
     "ValidationError",
-    "ApiClient",
-    "Configuration",
-    "OpenApiException",
-    "ApiTypeError",
-    "ApiValueError",
-    "ApiKeyError",
-    "ApiException",
-    "OnePageSolverPort",
-    "SolverPort",
-    "ErrorGet",
-    "openapi",
-    "RequestError",
 )  # type: ignore

clients/python/test/conftest.py

@@ -0,0 +1,74 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+
+import datetime
+import os
+
+import pytest
+
+# Dictionary to store start times of tests
+_test_start_times = {}
+
+
+def _utc_now():
+    return datetime.datetime.now(tz=datetime.timezone.utc)
+
+
+def _construct_graylog_url(api_host, start_time, end_time):
+    """
+    Construct a Graylog URL for the given time interval.
+    """
+    base_url = api_host.replace("api.", "monitoring.", 1).rstrip("/")
+    url = f"{base_url}/graylog/search"
+    start_time_str = start_time.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
+    end_time_str = end_time.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
+    query = f"from={start_time_str}&to={end_time_str}"
+    return f"{url}?{query}"
+
+
+def pytest_runtest_setup(item):
+    """
+    Hook to capture the start time of each test.
+    """
+    _test_start_times[item.name] = _utc_now()
+
+
+def pytest_runtest_makereport(item, call):
+    """
+    Hook to add extra information when a test fails.
+    """
+    if call.when == "call":
+
+        # Check if the test failed
+        if call.excinfo is not None:
+            test_name = item.name
+            test_location = item.location
+            api_host = os.environ.get("OSPARC_API_HOST", "")
+
+            diagnostics = {
+                "test_name": test_name,
+                "test_location": test_location,
+                "api_host": api_host,
+            }
+
+            # Get the start and end times of the test
+            start_time = _test_start_times.get(test_name)
+            end_time = _utc_now()
+
+            if start_time:
+                diagnostics["graylog_url"] = _construct_graylog_url(
+                    api_host, start_time, end_time
+                )
+
+            # Print the diagnostics
+            print(f"\nDiagnostics for {test_name}:")
+            for key, value in diagnostics.items():
+                print("  ", key, ":", value)
+
+
+@pytest.hookimpl(tryfirst=True)
+def pytest_configure(config):
+    config.pluginmanager.register(pytest_runtest_setup, "osparc_test_times_plugin")
+    config.pluginmanager.register(pytest_runtest_makereport, "osparc_makereport_plugin")

clients/python/test/e2e/ci/e2e/e2e/_models.py

@@ -4,7 +4,7 @@
 
 import osparc
 from packaging.version import InvalidVersion, Version
-from pydantic import BaseModel, field_validator
+from pydantic import BaseModel, field_validator, SecretStr
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
 # Holds classes for passing data around between scripts.
@@ -14,19 +14,19 @@ class ServerSettings(BaseSettings):
     """Holds data about server configuration"""
 
     host: str
-    key: str
-    secret: str
+    key: SecretStr
+    secret: SecretStr
 
     model_config = SettingsConfigDict(env_prefix="osparc_api_")
 
     def __hash__(self):
-        return hash(self.host + self.key + self.secret)
+        return hash(self.host + self.key.get_secret_value() + self.secret.get_secret_value())
 
     def __eq__(self, other):
         return (
             self.host == other.host
-            and self.key == other.key
-            and self.secret == other.secret
+            and self.key.get_secret_value() == other.key.get_secret_value()
+            and self.secret.get_secret_value() == other.secret.get_secret_value()
         )
 
 
@@ -43,15 +43,16 @@ class ClientSettings(BaseSettings):
     dev_features: bool = False
 
     @field_validator("version", mode="after")
-    def validate_client(cls, v):
+    @classmethod
+    def _validate_client(cls, v):
         if v not in {"latest_release", "latest_master"}:
             try:
                 version = Version(v)
                 assert version == Version(osparc.__version__)
-            except InvalidVersion:
-                raise ValueError(f"Received invalid semantic version: {v}")
-            except AssertionError:
-                raise ValueError(f"{v=} != {osparc.__version__=}")
+            except InvalidVersion as e:
+                raise ValueError(f"Received invalid semantic version: {v}") from e
+            except AssertionError as e:
+                raise ValueError(f"{v=} != {osparc.__version__=}") from e
         return v
 
     @property

clients/python/test/e2e/ci/e2e/e2e/postprocess.py

@@ -215,8 +215,8 @@ def clean_up_jobs(artifacts_dir: Path, retry_minutes: Optional[PositiveInt] = No
     for server_config in servers:
         config = osparc.Configuration(
             host=server_config.host,
-            username=server_config.key,
-            password=server_config.secret,
+            username=server_config.key.get_secret_value(),
+            password=server_config.secret.get_secret_value(),
         )
         msg = "Cleaning up jobs for user: "
         msg += f"\n{server_config.model_dump_json(indent=1)}"

clients/python/test/e2e/conftest.py

@@ -1,4 +1,8 @@
-import datetime
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+
 import logging
 import os
 from pathlib import Path
@@ -15,76 +19,12 @@
 _GB: ByteSize = ByteSize(_MB * 1024)  # in bytes
 
 
-# Dictionary to store start times of tests
-_test_start_times = {}
-
-
-def _utc_now():
-    return datetime.datetime.now(tz=datetime.timezone.utc)
-
-
-def _construct_graylog_url(api_host, start_time, end_time):
-    """
-    Construct a Graylog URL for the given time interval.
-    """
-    base_url = api_host.replace("api.", "monitoring.", 1).rstrip("/")
-    url = f"{base_url}/graylog/search"
-    start_time_str = start_time.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
-    end_time_str = end_time.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
-    query = f"from={start_time_str}&to={end_time_str}"
-    return f"{url}?{query}"
-
-
-def pytest_runtest_setup(item):
-    """
-    Hook to capture the start time of each test.
-    """
-    _test_start_times[item.name] = _utc_now()
-
-
-def pytest_runtest_makereport(item, call):
-    """
-    Hook to add extra information when a test fails.
-    """
-    if call.when == "call":
-
-        # Check if the test failed
-        if call.excinfo is not None:
-            test_name = item.name
-            test_location = item.location
-            api_host = os.environ.get("OSPARC_API_HOST", "")
-
-            diagnostics = {
-                "test_name": test_name,
-                "test_location": test_location,
-                "api_host": api_host,
-            }
-
-            # Get the start and end times of the test
-            start_time = _test_start_times.get(test_name)
-            end_time = _utc_now()
-
-            if start_time:
-                diagnostics["graylog_url"] = _construct_graylog_url(api_host, start_time, end_time)
-
-            # Print the diagnostics
-            print(f"\nDiagnostics for {test_name}:")
-            for key, value in diagnostics.items():
-                print("  ", key, ":", value)
-
-
-@pytest.hookimpl(tryfirst=True)
-def pytest_configure(config):
-    config.pluginmanager.register(pytest_runtest_setup, "osparc_test_times_plugin")
-    config.pluginmanager.register(pytest_runtest_makereport, "osparc_makereport_plugin")
-
-
 @pytest.fixture
-def configuration() -> Iterable[osparc.Configuration]:
+def configuration() -> osparc.Configuration:
     assert (host := os.environ.get("OSPARC_API_HOST"))
     assert (username := os.environ.get("OSPARC_API_KEY"))
     assert (password := os.environ.get("OSPARC_API_SECRET"))
-    yield osparc.Configuration(
+    return osparc.Configuration(
         host=host,
         username=username,
         password=password,
@@ -93,13 +33,13 @@ def configuration() -> Iterable[osparc.Configuration]:
 
 @pytest.fixture
 def api_client(configuration: osparc.Configuration) -> Iterable[osparc.ApiClient]:
-    with osparc.ApiClient(configuration=configuration) as api_client:
-        yield api_client
+    with osparc.ApiClient(configuration=configuration) as _api_client:
+        yield _api_client
 
 
 @pytest.fixture
-def async_client(configuration) -> Iterable[AsyncClient]:
-    yield AsyncClient(
+def async_client(configuration: osparc.Configuration) -> AsyncClient:
+    return AsyncClient(
         base_url=configuration.host,
         auth=BasicAuth(
             username=configuration.username, password=configuration.password
@@ -108,7 +48,7 @@ def async_client(configuration) -> Iterable[AsyncClient]:
 
 
 @pytest.fixture
-def tmp_file(tmp_path: Path, caplog) -> Path:
+def tmp_file(tmp_path: Path, caplog: pytest.LogCaptureFixture) -> Path:
     caplog.set_level(logging.INFO)
     byte_size: ByteSize = 1 * _GB
     tmp_file = tmp_path / "large_test_file.txt"

clients/python/test/e2e/test_notebooks.py

@@ -41,7 +41,7 @@ def test_notebook_config(tmp_path: Path):
 
 
 @pytest.mark.parametrize("notebook", all_notebooks, ids=lambda nb: nb.name)
-def test_run_notebooks(tmp_path: Path, notebook: Path, params: dict[str, Any] = {}):
+def test_run_notebooks(tmp_path: Path, notebook: Path, params: dict[str, Any]):
     """Run all notebooks in the documentation"""
     assert (
         notebook.is_file()
@@ -60,6 +60,6 @@ def test_run_notebooks(tmp_path: Path, notebook: Path, params: dict[str, Any] =
         input_path=tmp_nb,
         output_path=output,
         kernel_name="python3",
-        parameters=params,
+        parameters=params or {},
         execution_timeout=_NOTEBOOK_EXECUTION_TIMEOUT_SECONDS,
     )

clients/python/test/test_osparc/pytest.ini renamed to clients/python/test/pytest.ini

@@ -1,18 +1,16 @@
-from typing import Iterator
-
 import osparc
 import pytest
-
+from faker import Faker
 
 @pytest.fixture
-def cfg() -> Iterator[osparc.Configuration]:
-    yield osparc.Configuration(
-        host="https://1a52d8d7-9f9f-48e5-b2f0-a226e6b25f0b.com",
-        username="askjdg",
-        password="asdjbaskjdb",
+def cfg(faker: Faker) -> osparc.Configuration:
+    return osparc.Configuration(
+        host=f"https://api.{faker.safe_domain_name()}",
+        username=faker.user_name(),
+        password=faker.password(),
     )
 
 
 @pytest.fixture
-def enable_dev_mode(monkeypatch):
+def dev_mode_enabled(monkeypatch:pytest.MonkeyPatch):
     monkeypatch.setenv("OSPARC_DEV_FEATURES_ENABLED", "1")