python_tests.yml

name: Python Tests

on:
  push:
    paths-ignore:
      - 'docs/**'
      - '*.md'
      - 'examples/**'
      - 'benchmarks/**'
      - '.gitignore'
      - 'LICENSE'
      - '.github/copilot-instructions.md'
      - '.github/instructions/**'
    branches: [main, master]
  pull_request:
    paths-ignore:
      - 'docs/**'
      - '*.md'
      - 'examples/**'
      - 'benchmarks/**'
      - '.gitignore'
      - 'LICENSE'
      - '.github/copilot-instructions.md'
      - '.github/instructions/**'
    branches: [main, master]
  workflow_dispatch:

jobs:
  python-test:
    name: ${{ matrix.os }} / Python ${{ matrix.python-version }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - os: ubuntu-latest
            python-version: "3.11"
          - os: ubuntu-latest
            python-version: "3.12"
          - os: ubuntu-latest
            python-version: "3.13"
          - os: ubuntu-latest
            python-version: "3.14"
          - os: macos-26
            python-version: "3.12"
          - os: windows-latest
            python-version: "3.12"

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install OS specific dependencies
        if: matrix.os == 'macos-26'
        # Skip `brew update` and dependent upgrades: they pull formula versions
        # newer than the runner image ships, which then build from source.
        env:
          HOMEBREW_NO_AUTO_UPDATE: 1
          HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: 1
        run: brew install libomp

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install uv
        uses: astral-sh/setup-uv@v4
        with:
          enable-cache: true

      - name: Cache Cargo build
        uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            _rust/target
          key: ${{ runner.os }}-cargo-${{ hashFiles('_rust/Cargo.lock') }}

      - name: Create virtual environment with uv
        run: uv venv

      - name: Install maturin
        run: uv pip install maturin

      - name: Build Rust extension
        shell: bash
        working-directory: _rust
        run: |
          if [ "$RUNNER_OS" == "Windows" ]; then
            source ../.venv/Scripts/activate
          else
            source ../.venv/bin/activate
          fi
          maturin develop --release

      - name: Install project with test dependencies
        # `cpu` pins the CPU torch build: the runners have no GPU, and the
        # cu126 build would pull ~2.8 GB of nvidia wheels on every Linux job.
        run: uv sync --extra test --extra cpu --extra hardware

      - name: Run Python tests with coverage
        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
        shell: bash
        run: |
          source .venv/bin/activate
          pytest -v --cov=stratum --cov-config=pyproject.toml --cov-branch --cov-report=term-missing --cov-report=xml tests

      - name: Run Python tests
        if: matrix.os != 'ubuntu-latest' || matrix.python-version != '3.12'
        shell: bash
        run: |
          if [ "$RUNNER_OS" == "Windows" ]; then
            source .venv/Scripts/activate
          else
            source .venv/bin/activate
          fi
          pytest -v tests

      - name: Upload coverage to Codecov
        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
        uses: codecov/codecov-action@v4
        with:
          file: ./coverage.xml
          flags: unittests
          name: codecov-ubuntu-py3.12
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: false

      - name: Upload coverage artifact
        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
        uses: actions/upload-artifact@v4
        with:
          name: coverage-report
          path: ./coverage.xml
          retention-days: 1

  coverage-check:
    name: Coverage Threshold Check
    runs-on: ubuntu-latest
    needs: python-test
    if: needs.python-test.result == 'success'
    
    steps:
      - name: Download coverage artifact
        uses: actions/download-artifact@v4
        with:
          name: coverage-report

      - name: Check coverage threshold
        run: |
          python3 -c "
          import xml.etree.ElementTree as ET
          import sys
          
          tree = ET.parse('coverage.xml')
          root = tree.getroot()
          
          # Get coverage percentage from XML
          line_rate = float(root.get('line-rate', 0))
          branch_rate_str = root.get('branch-rate')
          
          if branch_rate_str is not None:
              branch_rate = float(branch_rate_str)
              coverage_percent = (line_rate + branch_rate) / 2 * 100
              print(f'Line coverage: {line_rate * 100:.2f}%')
              print(f'Branch coverage: {branch_rate * 100:.2f}%')
              print(f'Overall coverage: {coverage_percent:.2f}%')
          else:
              # Fallback to line coverage only if branch coverage not available
              coverage_percent = line_rate * 100
              print(f'Line coverage: {line_rate * 100:.2f}%')
              print(f'Branch coverage: Not available (use --cov-branch flag)')
              print(f'Overall coverage: {coverage_percent:.2f}% (line coverage only)')
          
          # Coverage threshold (adjust as needed)
          threshold = 80.0
          print(f'Threshold: {threshold}%')
          
          if coverage_percent < threshold:
              print(f'ERROR: Coverage {coverage_percent:.2f}% is below threshold {threshold}%')
              sys.exit(1)
          else:
              print(f'SUCCESS: Coverage {coverage_percent:.2f}% meets threshold {threshold}%')
          "