name: Pytest/Test Workflow

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

permissions:
  contents: read

concurrency:
  group: pytest-test-${{ github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
  build-pkg:
    name: Build this Package
    uses: ./.github/workflows/build-package.yml
    with:
      # only run link check on PRs from the same repo
      link-check: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }}

  run-tests:
    name: Import Test and Pytest Run
    # needs: build  # todo: consider using this build package for testing
    timeout-minutes: 10
    strategy:
      fail-fast: false
      matrix:
        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
        python-version: ["3.10", "3.11", "3.12", "3.13"]
    runs-on: ${{ matrix.os }}
    steps:
      - name: 📥 Checkout the repository
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

      - name: 🐍 Install uv and set Python version ${{ matrix.python-version }}
        uses: astral-sh/setup-uv@d31148d669074a8d0a63714ba94f3201e7020bc3 # v8.3.0
        with:
          python-version: ${{ matrix.python-version }}
          activate-environment: true

      - name: 🚀 Install Packages
        run: uv sync --frozen --group dev --extra metrics

      - name: 📦 Run the Import test
        run: python -c "import supervision; from supervision import assets; from supervision import metrics; print(supervision.__version__)"

      - name: 🧪 Run the Test
        run: pytest src/ tests/ --cov=supervision --cov-report=xml

      - name: Generate Coverage Report
        run: |
          coverage xml
          coverage report

      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v7
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          files: "coverage.xml"
          flags: cpu,${{ runner.os }},python${{ matrix.python-version }}
          env_vars: OS,PYTHON
          name: codecov-umbrella
          fail_ci_if_error: false

      - name: Minimize uv cache
        run: uv cache prune --ci

  testing-guardian:
    runs-on: ubuntu-latest
    needs: run-tests
    if: always()
    steps:
      - name: 📋 Display test result
        run: echo "${{ needs.run-tests.result }}"
      - name: ❌ Fail guardian on test failure
        if: needs.run-tests.result == 'failure'
        run: exit 1
      # Ensure that cancelled or skipped test runs still cause this guardian job to fail,
      # using an explicit exit code instead of relying on timeout behavior.
      - name: ⚠️ cancelled or skipped...
        if: contains(fromJSON('["cancelled", "skipped"]'), needs.run-tests.result)
        run: |
          echo "run-tests job result is '${{ needs.run-tests.result }}'; failing explicitly."
          exit 1
      - name: ✅ tests succeeded
        if: needs.run-tests.result == 'success'
        run: echo "All tests completed successfully in job 'run-tests'."