add snapshot tests (#292)

Co-authored-by: Konstantin <konstantin.klein+github@hochfrequenz.de>

Author: hf-kklein

pyproject.toml

@@ -49,7 +49,8 @@ spellcheck = [
     "codespell==2.3.0"
 ]
 tests = [
-    "pytest==8.3.3"
+    "pytest==8.3.3",
+    "syrupy==4.7.2"
 ]
 type_check = [
     "mypy==1.13.0",
@@ -110,3 +111,6 @@ sources = ["src"]
 # build-backend = "setuptools.build_meta"
 
 # [tool.setuptools_scm]
+[tool.pytest.ini_options]
+pythonpath = ["."]
+markers = ["snapshot: mark a test as a snapshot test"]

tox.ini

@@ -19,6 +19,14 @@ deps =
 setenv = PYTHONPATH = {toxinidir}/src
 commands = python -m pytest --basetemp={envtmpdir} {posargs}
 
+[testenv:snapshots]
+# the tests environment is called by the Github action that runs the unit tests
+deps =
+    -r requirements.txt
+    .[tests]
+setenv = PYTHONPATH = {toxinidir}/src
+commands = python -m pytest -m snapshot --basetemp={envtmpdir} {posargs} --snapshot-update
+
 [testenv:linting]
 # the linting environment is called by the Github Action that runs the linter
 deps =