ci: add Codspeed benchmarking

geddy11 · Dec 27, 2024 · 9914d8a · 9914d8a
1 parent 0ba69e6
commit 9914d8a
Show file tree

Hide file tree

Showing 2 changed files with 122 additions and 116 deletions.
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
@@ -1,115 +1,121 @@
-name: ci-cd
-
-on: [push, pull_request]
-
-jobs:
-  ci:
-    # Set up operating system
-    runs-on: ubuntu-latest
-
-    # Define job steps
-    steps:
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.11"
-
-      - name: Check-out repository
-        uses: actions/checkout@v4
-
-      - name: Install Graphviz
-        run: sudo apt-get install graphviz -y
-
-      - name: Install poetry
-        uses: snok/install-poetry@v1
-
-      - name: Install package
-        run: poetry install
-
-      - name: Black linter
-        uses: psf/black@stable
-
-      - name: Test with pytest
-        run: poetry run pytest tests/ --cov=sysloss --cov-report=xml
-
-      - name: Run codacy-coverage-reporter
-        uses: codacy/[email protected]
-        with:
-          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
-          coverage-reports: coverage.xml
-
-      - name: Use Codecov to track coverage
-        uses: codecov/[email protected]
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          slug: geddy11/sysloss
-
-      - name: Install Jupyter-book
-        run: pip install jupyter-book==1.0.0 sphinx-autoapi matplotlib toml scipy rich rustworkx pandas numpy
-
-      - name: Create Sphinx configuration
-        run: jupyter-book config sphinx docs
-
-      - name: Build documentation
-        run: sphinx-build docs docs/_build/html -b html
-
-  cd:
-    permissions:
-      id-token: write
-      contents: write
-
-    # Only run this job if the "ci" job passes
-    needs: ci
-
-    # Only run this job if new work is pushed to "main"
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-
-    # Set up operating system
-    runs-on: ubuntu-latest
-
-    # Define job steps
-    steps:
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.11"
-
-      - name: Check-out repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          persist-credentials: false
-
-      - name: Use Python Semantic Release to prepare release
-        id: release
-        uses: python-semantic-release/[email protected]
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Publish to TestPyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        if: steps.release.outputs.released == 'true'
-        with:
-          repository-url: https://test.pypi.org/legacy/
-          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
-
-      - name: Test install from TestPyPI
-        if: steps.release.outputs.released == 'true'
-        run: |
-            pip install \
-            --index-url https://test.pypi.org/simple/ \
-            --extra-index-url https://pypi.org/simple \
-            sysloss
-
-      - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        if: steps.release.outputs.released == 'true'
-        with:
-          password: ${{ secrets.PYPI_API_TOKEN }}
-
-      - name: Publish package distributions to GitHub Releases
-        uses: python-semantic-release/upload-to-gh-release@main
-        if: steps.release.outputs.released == 'true'
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+name: ci-cd
+
+on: [push, pull_request]
+
+jobs:
+  ci:
+    # Set up operating system
+    runs-on: ubuntu-latest
+
+    # Define job steps
+    steps:
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Check-out repository
+        uses: actions/checkout@v4
+
+      - name: Install Graphviz
+        run: sudo apt-get install graphviz -y
+
+      - name: Install poetry
+        uses: snok/install-poetry@v1
+
+      - name: Install package
+        run: poetry install
+
+      - name: Black linter
+        uses: psf/black@stable
+
+      - name: Test with pytest
+        run: poetry run pytest tests/ --cov=sysloss --cov-report=xml
+
+      - name: Run codacy-coverage-reporter
+        uses: codacy/[email protected]
+        with:
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          coverage-reports: coverage.xml
+
+      - name: Use Codecov to track coverage
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: geddy11/sysloss
+
+      - name: Codspeed benchmark
+        uses: CodSpeedHQ/action@v3
+        with:
+          run: pytest tests/ --codspeed
+          token: ${{ secrets.CODSPEED_TOKEN }}
+
+      - name: Install Jupyter-book
+        run: pip install jupyter-book==1.0.0 sphinx-autoapi matplotlib toml scipy rich rustworkx pandas numpy
+
+      - name: Create Sphinx configuration
+        run: jupyter-book config sphinx docs
+
+      - name: Build documentation
+        run: sphinx-build docs docs/_build/html -b html
+
+  cd:
+    permissions:
+      id-token: write
+      contents: write
+
+    # Only run this job if the "ci" job passes
+    needs: ci
+
+    # Only run this job if new work is pushed to "main"
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+
+    # Set up operating system
+    runs-on: ubuntu-latest
+
+    # Define job steps
+    steps:
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Check-out repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Use Python Semantic Release to prepare release
+        id: release
+        uses: python-semantic-release/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: steps.release.outputs.released == 'true'
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+
+      - name: Test install from TestPyPI
+        if: steps.release.outputs.released == 'true'
+        run: |
+            pip install \
+            --index-url https://test.pypi.org/simple/ \
+            --extra-index-url https://pypi.org/simple \
+            sysloss
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: steps.release.outputs.released == 'true'
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Publish package distributions to GitHub Releases
+        uses: python-semantic-release/upload-to-gh-release@main
+        if: steps.release.outputs.released == 'true'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
 
diff --git a/tests/benchmark/test_bench.py b/tests/benchmark/test_bench.py
@@ -25,21 +25,21 @@
 from sysloss.components import *
 
 
+@pytest.mark.benchmark
 def test_sys1(sys1: System, benchmark):
     """Benchmark 1"""
 
     def run1():
         sys1.solve()
 
     benchmark(run1)
-    assert benchmark.stats["max"] < 0.1
 
 
+@pytest.mark.benchmark
 def test_sys2(sys2: System, benchmark):
     """Benchmark 2"""
 
     def run2():
         sys2.solve()
 
     benchmark(run2)
-    assert benchmark.stats["max"] < 0.5