test_cpu.yml

name: Test CPU

on:
  pull_request:
    branches:
    - main
  push:
    branches:
    - main

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

jobs:
  test:
    name: Test ${{ matrix.name }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - os: ubuntu-latest
            environment: "full-cpu"
            name: "ubuntu all optional dependencies and doctests"
            pytest_args: "-n 2 --dist=loadgroup --doctest-modules"
          - os: ubuntu-latest
            environment: "test-cpu"
            name: "ubuntu no optional dependencies"
            pytest_args: "-n 2 --dist=loadgroup"
          - os: windows-latest
            environment: "full-cpu"
            name: "windows all optional dependencies"
            pytest_args: "-n 0 --dist=loadgroup" # n = 0 to avoid conflicts with pytest-xdist on windows
    env:
      DEEPINV_MOCK_TESTS: "True"
      DEEPINV_DOWNLOAD_VERBOSE: "False"
      # Persist deepinv's URL cache to a workspace-local folder so it can be
      # cached across CI runs (see actions/cache steps below). This avoids
      # re-downloading example images, models and datasets from HuggingFace
      # and prevents 429 rate-limit failures.
      DEEPINV_CACHE_DIR: ${{ github.workspace }}/.cache/deepinv
      CONDA_OVERRIDE_CUDA: "12.0" # mock cuda to fix non-GPU builds for optional dependencies

    steps:
      - uses: actions/checkout@v5

      # On PRs, restore the pixi.lock + .testmondata + .coverage triple solved on main as a
      # SINGLE cache entry, so it is restored atomically (no lock/testmondata
      # mismatch). pixi then installs the exact same package set that produced
      # .testmondata, keeping testmon's environment fingerprint stable
      # (otherwise an unpinned env re-solves every run, drifts, and forces a
      # full re-run). Restored *before* Setup Pixi so the action installs from
      # this lock. Not restored on push to main: main solves fresh to track
      # latest deps (and re-runs the full suite anyway).
      - name: Restore pixi.lock + .testmondata + .coverage
        if: github.event_name == 'pull_request'
        uses: actions/cache/restore@v4
        with:
          path: |
            pixi.lock
            .testmondata
            .coverage
          key: testmon-cpu-main-${{ matrix.environment }}-${{ matrix.os }}-${{ github.run_id }}
          restore-keys: |
            testmon-cpu-main-${{ matrix.environment }}-${{ matrix.os }}-

      - name: Setup Pixi
        uses: prefix-dev/setup-pixi@v0.9.3
        with:
          pixi-version: latest
          run-install: false  # we drive installation manually below

      # Install dependencies with pixi, using the restored lock if available. If the
      # lock is unavailable or fails to solve, fall back to a fresh solve. 
      - name: Install dependencies
        shell: bash
        run: |
          set -x
          if ! pixi install -e ${{ matrix.environment }} --locked --manifest-path pyproject.toml --color always; then
            echo "pixi install with --locked option failed, run install without lock"
            pixi install -e ${{ matrix.environment }} --manifest-path pyproject.toml --color always
          fi

          pixi list -e ${{ matrix.environment }} --manifest-path pyproject.toml --color always
          set +x

      - name: Restore deepinv URL cache # shared across matrix environments
        uses: actions/cache/restore@v4
        with:
          path: ${{ env.DEEPINV_CACHE_DIR }}
          key: deepinv-url-cache-${{ matrix.os }}-${{ github.run_id }}
          restore-keys: |
            deepinv-url-cache-${{ matrix.os }}-

      # On main, we never restore the cache, so .testmondata and .coverage never exist. We run the full suite to compute a base coverage for the main branch, we also run testmon to compute a base .testmondata for the main branch. 

      # On PRs, we restore the cache from main, so testmon skips unrelated tests and --cov-append updates coverage with respect to related changes. 
      # In case .coverage is not restored properly (for any reasons), but .testmondata is restored, we run pytest without testmon to compute full coverage results. This is a corner case that should not happen, but we handle it anyway.
      - name: Test with pytest
        shell: bash
        run: |
          TESTMON_FLAG="--testmon"
          if [ -f .testmondata ] && [ ! -f .coverage ]; then
            TESTMON_FLAG=""
          fi
          set -x
          pixi run -e ${{ matrix.environment }} pytest ${{ matrix.pytest_args }} --cov=deepinv --cov-report=xml:coverage-${{ matrix.environment }}.xml --cov-append $TESTMON_FLAG --durations=30 --junit-xml pytest_report_${{ matrix.environment }}.xml 
          set +x

      # Save the freshly-solved lock + .testmondata + .coverage as a single (atomic) cache
      # entry so PRs always restore a matching pair. Only on push to main.
      - name: Save pixi.lock + .testmondata + .coverage # only when pushed to main, not for PRs
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        uses: actions/cache/save@v4
        with:
          path: |
            pixi.lock
            .testmondata
            .coverage
          key: testmon-cpu-main-${{ matrix.environment }}-${{ matrix.os }}-${{ github.run_id }}

      - name: Save deepinv URL cache # only on push to main, mirrors testmondata
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        uses: actions/cache/save@v4
        with:
          path: ${{ env.DEEPINV_CACHE_DIR }}
          key: deepinv-url-cache-${{ matrix.os }}-${{ github.run_id }}

      - name: Upload coverage to Codecov
        if: runner.os == 'Linux' && matrix.environment == 'full-cpu'
        uses: codecov/codecov-action@v5
        with:
          fail_ci_if_error: true
          token: ${{ secrets.CODECOV_TOKEN }}
          files: ./coverage-${{ matrix.environment }}.xml
          flags: ${{ matrix.environment }}
          name: ${{ matrix.environment }}-coverage

      - name: Upload pytest report
        id: upload-artifact
        uses: actions/upload-artifact@v4
        with:
          name: pytest-report-${{ matrix.environment }}
          path: pytest_report_${{ matrix.environment }}.xml