Add codspeed and first benchmark test (#766)

Author: edenhaus

.github/workflows/ci.yml

@@ -80,12 +80,43 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
 
       - name: Upload test results to Codecov
         if: ${{ !cancelled() }}
         uses: codecov/test-results-action@v1
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
+
+  benchmarks:
+    runs-on: "ubuntu-latest"
+    name: Run benchmarks
+    steps:
+      - name: ⤵️ Checkout repository
+        uses: actions/checkout@v4
+
+      - name: 🏗 Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: 🏗 Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install additional OS dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get -y install \
+            pkg-config \
+            liblzma-dev
+
+      - name: 🏗 Install the project
+        run: |
+          uv export --dev > requirements.txt
+          uv pip install -e . --system -r requirements.txt
+
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@main
+        with:
+          run: pytest tests/ --codspeed
+          token: ${{ secrets.CODSPEED_TOKEN }}

.gitignore

@@ -26,4 +26,6 @@ test.py
 /target
 
 # rust so
-*.cpython*.so
+*.cpython*.so
+
+.codspeed

pyproject.toml

@@ -65,6 +65,7 @@ dev-dependencies = [
     "types-pillow>=10.2.0.20240822",
     "maturin[patchelf]>=1.7.8",
     "maturin-import-hook>=0.2.0",
+    "pytest-codspeed>=3.1.2",
 ]
 
 [tool.maturin]

tests/test_rs.py

@@ -13,6 +13,8 @@
 if TYPE_CHECKING:
     from contextlib import AbstractContextManager
 
+    from pytest_codspeed import BenchmarkFixture
+
 
 @pytest.mark.parametrize(
     ("input", "expected"),
@@ -36,10 +38,16 @@
     ],
     ids=["1", "2", "3", "4"],
 )
-def test_decompress_7z_base64_data(input: str, expected: bytes) -> None:
+def test_decompress_7z_base64_data(
+    benchmark: BenchmarkFixture, input: str, expected: bytes
+) -> None:
     """Test decompress_7z_base64_data function."""
-    assert _decompress_7z_base64_data_python(input) == expected
-    assert decompress_7z_base64_data(input) == expected
+    # Benchmark only the production function
+    result = benchmark(decompress_7z_base64_data, input)
+    assert result == expected
+
+    # Verify that the old python function is producing the same result
+    assert _decompress_7z_base64_data_python(input) == result
 
 
 @pytest.mark.parametrize(