feature: add support for uv

.coveragerc

@@ -1,13 +1,14 @@
 [run]
-include = */benchbuild/*
 omit =
+  ./venv/*
+  */bin/benchbuild*
   */benchbuild/lib/*
   */benchbuild/bin/*
+  .venv/*
 branch = True
 parallel = True
 
 [paths]
-data_file = ${BB_COVERAGE_PATH-default .}/.coverage
 source =
   benchbuild/
   */site-packages/benchbuild/

.github/actions/setup-runner/action.yml

@@ -0,0 +1,40 @@
+name: "Setup BenchBuild Runner Environment"
+description: "Install APT system depedcies"
+inputs:
+  python-version:
+    description: "The python version to use"
+    type: string
+    required: false
+    default: "3.14"
+runs:
+  using: "composite"
+  steps:
+    - name: Cache APT Packages
+      uses: actions/cache@v6
+      with:
+        path: /var/cache/apt/archives
+        key: ${{ runner.os }}-apt-${{ hashFiles('**/packages.list') }}
+        restore-keys: |
+          ${{ runner.os }}-apt-
+
+    - name: Install APT Dependencies
+      shell: bash
+      run: |
+        sudo apt update
+        sudo apt install -y \
+          podman \
+          clang \
+          time \
+          unionfs-fuse \
+          libfuse-dev \
+          libgit2-dev
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Install the project
+      shell: bash
+      run: |
+        uv sync --locked --all-extras --dev

.github/workflows/ci.yml

@@ -1,173 +1,41 @@
-name: ci
+name: Unittests
 on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+  workflow_call:
+    inputs:
+      python-version:
+        description: "The python version to use"
+        type: string
+        required: false
+        default: "3.14"
 
 jobs:
-  unittests:
+  test:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.9", "3.10"]
-
     steps:
-    - uses: actions/checkout@v3
-
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Install system dependencies for CI
-      run: |
-        sudo apt-get install time unionfs-fuse libfuse-dev clang
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip wheel
-        pip install .
-        pip install -r requirements.txt
-        pip install -r test-requirements.txt
-
-    - name: Run unittests
-      env:
-        # Avoid 50 char hard-limit of podman. These are enforced because of
-        # a kernel limit of 128-chars for socket paths.
-        BB_CONTAINER_RUNROOT: "/tmp"
-        BB_CONTAINER_ROOT: "/tmp"
-      run: |
-        git config --global protocol.file.allow always
-
-        pytest --cov-config=./.coveragerc --cov=benchbuild --ignore=tests/integration benchbuild tests
-        pytest --cov-config=./.coveragerc --cov=benchbuild tests/integration
-
-    - uses: actions/upload-artifact@master
-      with:
-        name: coverage-unittests-${{ matrix.python-version }}
-        path: ./.coverage
-
-
-  integration:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.9", "3.10"]
-        db_support: [true, false]
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Install system dependencies for CI
-      run: |
-        sudo apt-get install time unionfs-fuse libfuse-dev clang slurm-client
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip wheel
-        pip install .
-        pip install -r requirements.txt
-        pip install -r test-requirements.txt
-
-    - name: Run integration tests
-      env:
-        BB_DB_ENABLED: ${{ matrix.db_support }}
-        BB_DB_CONNECT_STRING: "sqlite://"
-        BB_COVERAGE_COLLECT: true
-        BB_COVERAGE_PATH: ${{ github.workspace }}
-        BB_COVERAGE_CONFIG: ${{ github.workspace }}/.coveragerc
-        BB_CONTAINER_ROOT: ${{ runner.temp }}
-        BB_CONTAINER_RUNROOT: ${{ runner.temp }}
-        BB_VERBOSITY: 5
-      run: |
-        coverage run -p `which benchbuild` bootstrap -s
-        coverage run -p `which benchbuild` config view
-        coverage run -p `which benchbuild` experiment view
-        coverage run -p `which benchbuild` project view
-        coverage run -p `which benchbuild` run --full test
-        coverage run -p `which benchbuild` slurm -E empty test
-        coverage run -p `which benchbuild` slurm -E raw bzip2/benchbuild -- container --runroot /foo/bar
-        coverage run -p `which benchbuild` run -E raw bzip2/benchbuild
-        coverage run -p `which benchbuild` container run -E raw bzip2/benchbuild
-        coverage run -p `which benchbuild` container bases --export -E raw bzip2/benchbuild
-        coverage run -p `which benchbuild` container bases --import -E raw bzip2/benchbuild
-        coverage run -p `which benchbuild` container rmi --with-projects -E raw bzip2/benchbuild
-        coverage combine
-        coverage report -m
-
-    - uses: actions/upload-artifact@master
-      with:
-        name: coverage-integration-${{ matrix.python-version }}
-        path: ./.coverage
-
-  upload_coverage:
-    needs: [unittests, integration]
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.10"]
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - uses: actions/download-artifact@master
-      with:
-        name: coverage-unittests-${{ matrix.python-version }}
-        path: ./.coverage.unittests
-
-    - uses: actions/download-artifact@master
-      with:
-        name: coverage-integration-${{ matrix.python-version }}
-        path: ./.coverage.integration
-
-    - run: |
-        ls -lah .
-        python -m pip install --upgrade pip wheel
-        pip install coverage
-        coverage combine -a ./.coverage.integration/.coverage ./.coverage.unittests/.coverage
-        coverage xml
-
-    - name: Upload coverage report
-      uses: codecov/codecov-action@v1
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
-        file: ./coverage.xml
-
-  docs:
-    needs: [unittests, integration]
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.10"]
-
-    steps:
-    - uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
-
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Setup a git user
-      run: |
-        git config user.name github-actions
-        git config user.email github-actions@github.com
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install .
-        pip install -r docs/requirements.txt
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - uses: ./.github/actions/setup-runner
+        with:
+          python-version: "${{ inputs.python-version }}"
+
+      - name: Run unittests
+        env:
+          # Avoid 50 char hard-limit of podman. These are enforced because of
+          # a kernel limit of 128-chars for socket paths.
+          BB_CONTAINER_RUNROOT: "/tmp"
+          BB_CONTAINER_ROOT: "/tmp"
+        run: |
+          git config --global protocol.file.allow always
+
+          uv run pytest --cov-config=./.coveragerc --cov=benchbuild --ignore=tests/integration benchbuild tests
+          uv run pytest --cov-config=./.coveragerc --cov=benchbuild tests/integration
+
+          find . -type f -iname '*.coverage*'
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: coverage-unittests-${{ inputs.python-version }}
+          path: ./.coverage
+          # Security: Careful with adding wildcard patterns above!
+          include-hidden-files: true

.github/workflows/coverage-upload.yml

@@ -0,0 +1,45 @@
+name: Combine coverage data.
+on:
+  workflow_call:
+    inputs:
+      python-version:
+        description: "The python version to use"
+        type: string
+        required: false
+        default: "3.14"
+
+jobs:
+  upload_coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v7
+
+    - uses: actions/download-artifact@master
+      with:
+        name: coverage-unittests-${{ inputs.python-version }}
+        path: ./.coverage.unittests
+
+    - uses: actions/download-artifact@master
+      with:
+        name: coverage-integration-${{ inputs.python-version }}
+        path: ./.coverage.integration
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9
+      with:
+        python-version: ${{ inputs.python-version }}
+        enable-cache: true
+
+    - run: |
+        uv sync --locked --all-extras --dev
+        uv pip install coverage
+        uv run coverage combine -a ./.coverage.integration/.coverage ./.coverage.unittests/.coverage
+        uv run coverage xml
+
+    - name: Upload coverage report
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        overwrite: true
+        file: ./coverage.xml

.github/workflows/docs.yml

@@ -1,6 +1,7 @@
-name: sphinx
-on: [push, pull_request]
-
+name: "Generate sphinx documentation"
+description: "Generate sphinx documentation and push to gh-pages"
+on:
+  workflow_call:
 env:
   DEFAULT_BRANCH: "master"
   #SPHINXOPTS: "-W --keep-going -T"
@@ -11,59 +12,23 @@ jobs:
     name: Build and gh-pages
     runs-on: ubuntu-latest
     steps:
-      # https://github.com/marketplace/actions/checkout
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0
           lfs: true
 
-      # https://github.com/marketplace/actions/setup-python
-      # ^-- This gives info on matrix testing.
-      - name: Install Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.10'
-
-      # https://docs.github.com/en/actions/guides/building-and-testing-python#caching-dependencies
-      # ^-- How to set up caching for pip on Ubuntu
-      - name: Cache pip
-        uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-            ${{ runner.os }}-
+      - name: Install uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9
 
-      # https://docs.github.com/en/actions/guides/building-and-testing-python#installing-dependencies
-      # ^-- This gives info on installing dependencies with pip
-      - name: Install dependencies
+      - name: Install the project
         run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install -r docs/requirements.txt
-          pip install .
-
-      - name: Debugging information
-        run: |
-          echo "github.ref:" ${{github.ref}}
-          echo "github.event_name:" ${{github.event_name}}
-          echo "github.head_ref:" ${{github.head_ref}}
-          echo "github.base_ref:" ${{github.base_ref}}
-          set -x
-          git rev-parse --abbrev-ref HEAD
-          git branch
-          git branch -a
-          git remote -v
-          python -V
-          pip list --not-required
-          pip list
+          uv sync --locked --all-extras --dev --group docs
 
       # Build
       - uses: ammaraskar/sphinx-problem-matcher@master
       - name: Build Sphinx docs
         run: |
-          make -Cdocs dirhtml
+          uv run make -Cdocs dirhtml
           # This fixes broken copy button icons, as explained in
           #   https://github.com/coderefinery/sphinx-lesson/issues/50
           #   https://github.com/executablebooks/sphinx-copybutton/issues/110