ci.yml

name: CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install cqfd
        run: |
          git clone https://github.com/savoirfairelinux/cqfd.git /tmp/cqfd
          cd /tmp/cqfd
          sudo make install

      - name: Initialize cqfd container
        run: cqfd init

      - name: Check formatting
        run: cqfd -b check_format

      - name: Run flake8
        run: cqfd -b flake

  test:
    runs-on: ubuntu-24.04
    env:
      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
    steps:
      - uses: actions/checkout@v4
        with:
          # SonarCloud needs the full history to blame each line. Without
          # it, every line of a file the pull request touches counts as new
          # code, which drags pre-existing issues into the quality gate.
          fetch-depth: 0

      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Install system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y --no-install-recommends \
            qemu-system-x86 \
            libvirt-daemon-system \
            libvirt-dev \
            pkg-config

      - name: Start libvirtd and grant access
        run: |
          sudo systemctl start libvirtd
          sudo usermod -aG libvirt "$USER"

      - name: Install package with test deps
        # Editable on purpose: coverage instruments the vm_manager package in
        # the checkout, so the tests must import it from there. A regular
        # install copies it to site-packages, the tests import that copy, and
        # coverage reports 0% on every module.
        #
        # Constrained so a run does not pick up a new release on its own,
        # and restricted to wheels so no dependency gets to run a setup
        # script during the install. libvirt-python is the one exception:
        # it publishes no wheel and compiles against the system libvirt
        # headers, which is why libvirt-dev and pkg-config are installed
        # above. Naming it keeps the exception to that single package
        # instead of reopening source builds for the whole graph.
        run: |
          pip install -e ".[test]" -c requirements-ci.txt \
            --only-binary :all: --no-binary libvirt-python

      - name: Run tests
        run: |
          sg libvirt -c "pytest tests/ -v --tb=short \
            --cov --cov-report=term-missing --cov-report=xml --cov-report=html \
            --ignore=tests/test_vm_manager_cluster.py \
            --ignore=tests/test_vm_manager_cmd_cluster.py"

      - name: Add coverage to job summary
        if: always()
        run: |
          if [ -f .coverage ]; then
            echo '## Coverage' >> "$GITHUB_STEP_SUMMARY"
            python -m coverage report --format=markdown >> "$GITHUB_STEP_SUMMARY"
          fi

      - name: Upload coverage report
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: coverage-report
          path: |
            coverage.xml
            htmlcov/
          if-no-files-found: ignore

      # Automatic Analysis must stay off in the SonarCloud project
      # settings, otherwise SonarCloud rejects this analysis. Skipped when
      # SONAR_TOKEN is unavailable, which is the case for pull requests
      # opened from a fork.
      - name: SonarCloud analysis
        if: env.SONAR_TOKEN != ''
        uses: SonarSource/sonarqube-scan-action@22918119ff8e1ca75a623e15c8296b6ea4fbe28f # v8.2.1
        env:
          SONAR_HOST_URL: https://sonarcloud.io

      - name: Install documentation dependencies
        # Editable too, so this step adds the docs extra instead of
        # replacing the editable install made above by a copy. Sphinx and
        # sphinx-argparse both ship wheels, the exception below is still
        # needed because resolving the package pulls its runtime
        # dependencies, libvirt-python included.
        run: |
          pip install -e ".[docs]" -c requirements-ci.txt \
            --only-binary :all: --no-binary libvirt-python

      - name: Build documentation
        run: sphinx-build -b html docs/ docs/_build/html