Add a benchmark and the codspeed integration (#201)

nathanjmcdougall · web-flow · commit 4a157bb8108c · 2025-01-16T11:03:58.000+13:00
* Add a benchmark and the codspeed integration

* Only run the benchmarks on one strategy. Restore subprocess tests into test_tool.py file
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -40,6 +40,13 @@ jobs:
       - name: Run pytest
         uses: pavelzw/pytest-action@510c5e90c360a185039bea56ce8b3e7e51a16507 # v2.2.0
 
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@513a19673a831f139e8717bf45ead67e47f00044 # v3.2.0
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13' && matrix.resolution == 'highest'
+        with:
+          token: ${{ secrets.CODSPEED_TOKEN }}
+          run: pytest --codspeed
+
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
diff --git a/pyproject.toml b/pyproject.toml
@@ -57,6 +57,7 @@ test = [
   "coverage[toml]>=7.6.3",
   "gitpython>=3.1.43",
   "pytest>=8.3.2",
+  "pytest-codspeed>=3.1.2",
   "pytest-cov>=5.0.0",
   "pytest-emoji>=0.2.0",
   "pytest-md>=0.2.0",
diff --git a/tests/usethis/_interface/test_tool.py b/tests/usethis/_interface/test_tool.py
@@ -1,8 +1,10 @@
 from pathlib import Path
 
 import pytest
+from typer.testing import CliRunner
 
 from usethis._config import usethis_config
+from usethis._interface.tool import app
 from usethis._subprocess import SubprocessFailedError, call_subprocess
 from usethis._test import change_cwd
 
@@ -54,3 +56,27 @@ def test_cli(self, uv_init_dir: Path):
                 call_subprocess(["usethis", "tool", "ruff"])
             else:
                 call_subprocess(["usethis", "tool", "ruff", "--offline"])
+
+
+class TestPytest:
+    def test_add(self, tmp_path: Path):
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["pytest"])
+
+        # Assert
+        assert result.exit_code == 0
+
+
+@pytest.mark.benchmark
+def test_several_tools_add_and_remove(tmp_path: Path):
+    runner = CliRunner()
+    with change_cwd(tmp_path):
+        runner.invoke(app, ["pytest"])
+        runner.invoke(app, ["ruff"])
+        runner.invoke(app, ["deptry"])
+        runner.invoke(app, ["pre-commit"])
+        runner.invoke(app, ["ruff", "--remove"])
+        runner.invoke(app, ["pyproject-fmt"])
+        runner.invoke(app, ["pytest", "--remove"])
diff --git a/uv.lock b/uv.lock
