Merge branch 'fixed_dependencies' into 'master'

[CI] Introduce maintenance tests to prevent regular developers from encountering pipeline errors unrelated to their merge requests

See merge request ogs/ogs!5387

Author: bilke

.pre-commit-config.yaml

@@ -9,6 +9,7 @@ repos:
         exclude: "^Tests/Data/.*|^Tests/Python/res/test_docu_scripts/|^web/static|^Documentation/.vale/.*|.*\\.patch"
       - id: check-added-large-files
         args: [--maxkb 1024]
+        exclude: "^Tests/Data/uv.lock"
       - id: check-merge-conflict
       - id: check-xml
         exclude: '^Tests/Data/.*\.xml'

Tests/Data/README.md

@@ -0,0 +1,53 @@
+## Notebook-based tests
+
+Environment for notebook-based tests is defined in this directory's `pyproject.toml` and managed via [`uv`](https://github.com/astral-sh/uv).
+
+3 dependency groups which select the used `ogs` wheel:
+
+- `ogs-local`: Builds ogs locally from source
+- `ogs-master` Downloads latest ogs wheel from master branch (requires `--upgrade-package ogs`-parameter)
+- `ogs-pypi` Downloads latest ogs release from PyPI
+
+```bash
+uv run --group ogs-local pytest
+
+uv run --group ogs-master --upgrade-package ogs pytest
+uv run --group ogs-pypi pytest
+
+uv run --group ogs-local Notebooks/testrunner.py --out /tmp Mechanics/Linear/SimpleMechanics.py
+```
+
+`uv` automatically manages a virtual environment in `./.venv`. It locks the environment according to a `uv.lock`-file. To update the file for all packages run `uv lock --upgrade`. To update only a specific package, e.g. on `ogstools`-release run `uv lock --upgrade-package ogstools`.
+
+## Regression and maintenance testing
+
+| | Regression test| Maintenance test |
+| ------ | ------ | ------ |
+| OGS       | **latest**        | stable (tip of master)       |
+| Environment       | stable (pinned via lock-file)       |  **latest** |
+| Trigger | Merge-request | scheduled or master-build |
+| Role | Developer | Maintainer |
+
+**latest** indicates the "object under test"
+
+Environment may be:
+
+- pip (from PyPI)
+- CPM (FindPackage, GIT_TAG / VERSION) - maintenance not implemented
+- Compiler version - maintenance not implemented
+- ...
+
+When to update a "stable" an environment:
+
+- MUST: Change of underlying stack (e.g. software update of `envinfX` test machines)
+- MUST: An MR with a change in the request environment (e.g. a new lib or a new version of an already used lib is needed)
+- OPTIONAL: On any other occasion (e.g. OGS release)
+
+Typical workflow to update:
+
+1. Trigger: Maintenance test fails
+2. Check latest updates of 3rd party packages and their influence (`uv lock --upgrade`)
+3. **MR: Quick fix**: Restrict versions in (open) dependencies, add/open ToDo
+4. Maintenance test succeeds (this allows other maintenance issues to be found)
+5. Investigation and fix of own software / report to 3rd party
+6. **MR: Fix** and reopen dependency

Tests/Data/pyproject.toml

@@ -0,0 +1,69 @@
+[project]
+name = "OGS-Test-Environment"
+version = "0.1.0"
+description = "Test environment for Notebook-based tests"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+  ### nb environment ###
+  # Use no-X11 version on Linux:
+  "gmsh==4.13.1.dev1; platform_system == 'Linux'",
+  "gmsh>=4.12.0; platform_system != 'Linux'",
+  "h5py>=3.8",
+  "heatsource-py @ git+https://github.com/joergbuchwald/heatsource_thm@bbd5bab17fc2ec228c773e087dc847e1ad5f9a4c",
+  "ipywidgets",
+  "jupyterlab>=3.4.8",
+  "matplotlib>=3.6",
+  "numpy",
+  "ogstools==0.7.0",
+  "pandas>=1.5",
+  # TODO: Implement fix for PyVista 0.46 in ogstools:
+  "pyvista[all]==0.45",
+  "seaborn>=0.12",
+  "VTUinterface>=0.704",
+  ### dev tools ###
+  "gcovr==6.0",
+  "jupytext>=1.14.5",
+  "nbconvert>=7.16.5",
+  "nbformat>=5.7.3",
+  "papermill>=2.6.0",
+  "pytest>=8.2.2",
+  "toml>=0.10.2",
+]
+
+# Usage:
+# uv run --group ogs-local pytest
+# uv run --group ogs-master --upgrade-package ogs pytest
+# uv run --group ogs-pypi --upgrade-package ogs pytest
+# --upgrade-package uses latest, ignoring version in lockfile
+[dependency-groups]
+ogs-local = ["ogs"]
+ogs-master = ["ogs>=6.5.6.dev0"] # Bump after release!
+ogs-pypi = ["ogs"]
+
+[tool.uv]
+conflicts = [
+  [
+    { group = "ogs-local" },
+    { group = "ogs-master" },
+    { group = "ogs-pypi" },
+  ],
+]
+
+[tool.uv.sources]
+gmsh = { index = "gmsh-nox", marker = "platform_system == 'Linux'" }
+ogs = [
+  { path = "../..", group = "ogs-local" },        # builds ogs from local source
+  { index = "ogs-gitlab", group = "ogs-master" }, # fetches last master wheel from GitLab
+  # ogs-pypi implicit
+]
+
+[[tool.uv.index]]
+name = "gmsh-nox"
+url = "https://gmsh.info/python-packages-dev-nox"
+explicit = true
+
+[[tool.uv.index]]
+name = "ogs-gitlab"
+url = "https://gitlab.opengeosys.org/api/v4/projects/120/packages/pypi/simple"
+explicit = true