Add CodSpeed performance benchmarks and CI workflow (#167)

Co-authored-by: codspeed-hq[bot] <117304815+codspeed-hq[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: codspeed-hq[bot]

.github/workflows/codspeed.yaml

@@ -0,0 +1,37 @@
+name: CodSpeed
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  # `workflow_dispatch` allows CodSpeed to trigger backtest
+  # performance analysis in order to generate initial data.
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  benchmarks:
+    name: Run benchmarks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install 3.13
+
+      - name: Install dependencies
+        run: uv sync --group dev --frozen
+
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@v4
+        with:
+          mode: simulation
+          run: uv run pytest -m benchmark --codspeed

README.md

@@ -9,6 +9,7 @@
   <a href="https://results.pre-commit.ci/latest/github/Kilo59/ruff-sync/main"><img src="https://results.pre-commit.ci/badge/github/Kilo59/ruff-sync/main.svg" alt="pre-commit.ci status"></a>
   <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
   <a href="https://wily.readthedocs.io/"><img src="https://img.shields.io/badge/%F0%9F%A6%8A%20wily-passing-brightgreen.svg" alt="Wily"></a>
+  <a href="https://codspeed.io/Kilo59/ruff-sync?utm_source=badge"><img src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" alt="CodSpeed"/></a>
 </p>
 
 # ruff-sync

pyproject.toml

@@ -54,6 +54,7 @@ dev = [
     "pyfakefs>=5.4.1",
     "pytest>=8.0.0",
     "pytest-asyncio>=0.23.5",
+    "pytest-codspeed>=4.3.0",
     "pytest-icdiff>=0.9",
     "pytest-textual-snapshot>=1.0.0",
     "respx>=0.21.1",
@@ -250,3 +251,6 @@ include = ["src/ruff_sync/*.py"]
 
 [tool.pytest]
 log_level = "INFO"
+markers = [
+    "benchmark: marks performance benchmarks (run separately for CodSpeed)",
+]

tests/conftest.py

@@ -3,7 +3,10 @@
 import logging
 import os
 import sys
-from typing import Literal, Protocol, runtime_checkable
+from typing import TYPE_CHECKING, Literal, Protocol, runtime_checkable
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
 
 import pytest
 from typing_extensions import override
@@ -38,7 +41,7 @@ def emit(self, record):
 
 
 @pytest.fixture
-def configure_logging():
+def configure_logging() -> Generator[logging.Logger, None, None]:
     """Configure ruff_sync logger for tests to ensure capsys can capture log output."""
     logger = logging.getLogger("ruff_sync")
     old_handlers = logger.handlers[:]
@@ -62,7 +65,7 @@ def configure_logging():
 
 
 @pytest.fixture
-def clear_ruff_sync_caches():
+def clear_ruff_sync_caches() -> None:
     """Clear all lru_caches in ruff_sync."""
     ruff_sync.get_config.cache_clear()
     ruff_sync.Arguments.fields.cache_clear()