Codspeed - performance benchmarks

.github/workflows/tests.yml

@@ -10,6 +10,8 @@ on:
   pull_request:
     branches:
       - '**'
+  # `workflow_dispatch` allows CodSpeed to trigger backtest performance analysis in order to generate initial data.
+  workflow_dispatch:
 
 jobs:
   build:
@@ -51,6 +53,17 @@ jobs:
           COV_CORE_SOURCE: .
           COV_CORE_CONFIG: .coveragerc
           COV_CORE_DATAFILE: .coverage.eager
+
+      - name: Test with CodSpeed
+        uses: CodSpeedHQ/action@v3
+        with:
+           token: ${{ secrets.CODSPEED_TOKEN }}
+           run: poetry run py.test --cov=./ --cov-append --cov-report=xml --codspeed
+        env:
+          COV_CORE_SOURCE: .
+          COV_CORE_CONFIG: .coveragerc
+          COV_CORE_DATAFILE: .coverage.eager
+
       - uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

pyproject.toml

@@ -87,6 +87,7 @@ linkify-it-py = "*"
 ### Testing ###
 gp-libs = "*"
 pytest = "*"
+pytest-codspeed = "*"
 pytest-rerunfailures = "*"
 pytest-mock = "*"
 pytest-watcher = "*"
@@ -112,6 +113,10 @@ files = [
   "tests",
 ]
 
+[[tool.mypy.overrides]]
+module = "pytest_codspeed.plugin"
+ignore_missing_imports = true
+
 [tool.coverage.run]
 branch = true
 parallel = true

tests/sync/test_git.py

@@ -8,6 +8,7 @@
 import typing as t
 
 import pytest
+from pytest_codspeed.plugin import BenchmarkFixture
 from pytest_mock import MockerFixture
 
 from libvcs import exc
@@ -56,6 +57,7 @@ def test_repo_git_obtain_initial_commit_repo(
     tmp_path: pathlib.Path,
     constructor: ProjectTestFactory,
     lazy_constructor_options: ProjectTestFactoryLazyKwargs,
+    benchmark: BenchmarkFixture,
 ) -> None:
     """Initial commit repos return 'initial'.
 
@@ -69,7 +71,7 @@ def test_repo_git_obtain_initial_commit_repo(
     bare_dir = tmp_path / repo_name
     git_repo: GitSync = constructor(**lazy_constructor_options(**locals()))
 
-    git_repo.obtain()
+    benchmark(lambda: git_repo.obtain())
     assert git_repo.get_revision() == "initial"