WIP Start adding some basic benchmarking infrastructure

.github/workflows/main.yml

@@ -42,6 +42,7 @@ jobs:
         - windows: py311-online
         - macos: py310
         - linux: py310-oldestdeps
+        - linux: benchmarks
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 

dkist/tests/test_benchmarks.py

@@ -0,0 +1,17 @@
+import gzip
+from pathlib import Path
+
+from dkist import load_dataset
+from dkist.data.test import rootdir
+
+
+def load_asdf_from_gzip(tmp_path_factory):
+    vispdir = tmp_path_factory.mktemp("data")
+    with gzip.open(Path(rootdir) / "large_visp.asdf.gz", mode="rb") as gfo:
+        with open(vispdir / "test_visp.asdf", mode="wb") as afo:
+            afo.write(gfo.read())
+    ds = load_dataset(vispdir / "test_visp.asdf")
+
+
+def test_load_asdf(benchmark, tmp_path_factory):
+    benchmark(load_asdf_from_gzip, tmp_path_factory)

pyproject.toml

@@ -53,6 +53,7 @@ tests = [
   "pytest-mpl",
   "pytest-httpserver",
   "pytest-filter-subpackage",
+  "pytest-benchmark",
   "hypothesis",
   "tox",
   "pydot",

tox.ini

@@ -10,6 +10,7 @@ envlist =
     py310-oldestdeps
     build_docs{,-notebooks}
     codestyle
+    benchmarks
 
 [testenv]
 pypi_filter = https://raw.githubusercontent.com/sunpy/sunpy/main/.test_package_pins.txt
@@ -89,3 +90,8 @@ commands =
     !notebooks: sphinx-build -j 1 --color -W --keep-going -b html -d _build/.doctrees . _build/html -D nb_execution_mode=off {posargs}
     notebooks: sphinx-build -j 1 --color -W --keep-going -b html -d _build/.doctrees . _build/html {posargs}
     python -c 'import pathlib; print("Documentation available under file://\{0\}".format(pathlib.Path(r"{toxinidir}") / "docs" / "_build" / "index.html"))'
+
+[testenv:benchmarks]
+description = Run benchmarks against latest release to ensure there are no performance regressions
+commands =
+    {env:PYTEST_COMMAND} -k test_benchmarks --benchmark-autosave --benchmark-compare=0001