Add CodSpeed benchmark integration (#657)

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

Author: codspeed-hq[bot]

.github/workflows/codspeed.yml

@@ -0,0 +1,36 @@
+name: CodSpeed Benchmarks
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  benchmarks:
+    name: Run benchmarks
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install dependencies
+        run: uv pip install --system -e ".[test]" pytest-codspeed==4.3.0
+
+      - name: Run the benchmarks
+        uses: CodSpeedHQ/action@v4
+        with:
+          mode: simulation
+          run: pytest tests/benchmarks/ --codspeed

README.md

@@ -18,6 +18,10 @@
 <a href="https://pypi.org/project/ravyn" target="_blank">
     <img src="https://img.shields.io/pypi/pyversions/ravyn.svg?color=%2334D058" alt="Supported Python versions">
 </a>
+
+<a href="https://codspeed.io/dymmond/ravyn?utm_source=badge" target="_blank">
+    <img src="https://img.shields.io/endpoint?url=https://codspeed.io/badge/dymmond/ravyn" alt="CodSpeed">
+</a>
 </p>
 
 ---

tests/benchmarks/__init__.py

@@ -0,0 +1,113 @@
+"""Performance benchmarks for the Ravyn framework."""
+
+import pytest
+from lilya import status
+from pydantic import BaseModel
+
+from ravyn.routing.gateways import Gateway
+from ravyn.routing.handlers import get, post
+from ravyn.testclient import create_client
+
+# ---------------------------------------------------------------------------
+# Handlers used across benchmarks
+# ---------------------------------------------------------------------------
+
+
+@get("/")
+def homepage() -> dict:
+    return {"message": "welcome"}
+
+
+@get("/hello/{name}")
+def greet(name: str) -> dict:
+    return {"message": f"Hello, {name}!"}
+
+
+class Item(BaseModel):
+    name: str
+    price: float
+    quantity: int = 1
+
+
+@post("/items")
+def create_item(data: Item) -> dict:
+    return {"name": data.name, "total": data.price * data.quantity}
+
+
+@get("/users/{user_id}")
+def get_user(user_id: int) -> dict:
+    return {"id": user_id, "name": "test-user"}
+
+
+# ---------------------------------------------------------------------------
+# Benchmarks
+# ---------------------------------------------------------------------------
+
+
+@pytest.mark.benchmark
+def test_bench_app_creation():
+    """Measure the cost of creating a Ravyn application with routes."""
+    client = create_client(
+        routes=[
+            Gateway(handler=homepage),
+            Gateway(handler=greet),
+            Gateway(handler=create_item),
+            Gateway(handler=get_user),
+        ],
+        enable_openapi=False,
+    )
+    # Ensure the app is valid
+    assert client.app is not None
+
+
+@pytest.mark.benchmark
+def test_bench_simple_get_request():
+    """Measure a plain GET request through the full stack."""
+    with create_client(
+        routes=[Gateway(handler=homepage)],
+        enable_openapi=False,
+    ) as client:
+        response = client.get("/")
+        assert response.status_code == status.HTTP_200_OK
+
+
+@pytest.mark.benchmark
+def test_bench_parametrized_get_request():
+    """Measure a GET request with a path parameter."""
+    with create_client(
+        routes=[Gateway(handler=greet)],
+        enable_openapi=False,
+    ) as client:
+        response = client.get("/hello/world")
+        assert response.status_code == status.HTTP_200_OK
+
+
+@pytest.mark.benchmark
+def test_bench_post_request_with_validation():
+    """Measure a POST request with Pydantic model validation."""
+    with create_client(
+        routes=[Gateway(handler=create_item)],
+        enable_openapi=False,
+    ) as client:
+        response = client.post(
+            "/items",
+            json={"name": "widget", "price": 9.99, "quantity": 3},
+        )
+        assert response.status_code == 201
+
+
+@pytest.mark.benchmark
+def test_bench_multiple_routes():
+    """Measure routing resolution across several registered routes."""
+    with create_client(
+        routes=[
+            Gateway(handler=homepage),
+            Gateway(handler=greet),
+            Gateway(handler=create_item),
+            Gateway(handler=get_user),
+        ],
+        enable_openapi=False,
+    ) as client:
+        response = client.get("/users/42")
+        assert response.status_code == status.HTTP_200_OK
+        assert response.json() == {"id": 42, "name": "test-user"}