package-coverage.yml

# This workflow runs tests and reports code coverage.

# We need a workflow name to be able to schedule it from Github UI
name: TestCoverage
on:
  # workflow_call is what makes it reusable!
  # we take the package path as the input
  workflow_call:
    inputs:
      target_path:
        description: "The path of the package"
        required: true
        type: string
      python_versions:
        description: "Python versions to run. Must be a JSON array. In PRs, the first version will be used to post a coverage comment"
        default: '["3.11", "3.9"]'
        type: string
      nightly:
        description: "If this is being executed nightly"
        default: false
        type: boolean
  # sadly, we have to duplicate the inputs for workflow_dispatch
  workflow_dispatch:
    inputs:
      target_path:
        description: "The path of the package"
        required: true
        type: string
      python_versions:
        description: 'Python versions to run, ["3.11", "3.9"]'
        default: '["3.11", "3.9"]'
        type: string
      nightly:
        description: "If this is being executed nightly"
        default: false
        type: boolean

concurrency:
  group: ${{ github.workflow }}-coverage-${{ github.ref }}-${{ inputs.target_path }}
  cancel-in-progress: true

jobs:
  # The job ID has to match repo settings for PR required checks
  TestCoverage:
    runs-on: ${{ matrix.os }}

    defaults:
      run:
        working-directory: ${{ github.workspace }}/${{ inputs.target_path }}

    # Run jobs for a couple of Python versions and OSes.
    strategy:
      matrix:
        os: ["ubuntu-latest"]
        python: ${{ fromJSON(inputs.python_versions) }}
        # Extend the matrix with a job that prints coverage.
        # Because { os: "ubuntu-latest", python: "3.11" } is already in the matrix,
        # print_coverage: true is added to that job.
        include:
          - os: "ubuntu-latest"
            python: ${{ fromJSON(inputs.python_versions)[0] }}
            print_coverage: true

    timeout-minutes: 25

    name: Coverage - Python ${{ matrix.python }} - ${{ matrix.os }}

    steps:
      - uses: actions/checkout@v4
        with:
          # Fetch depth 0 required to compare against `main`
          fetch-depth: 0

      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python }}
          architecture: x64
          cache: ${{ inputs.nightly == false && 'pip' || '' }}

      # Installation method (venv/system/etc) affects Ray behavior. We're
      # installing deps to a venv to align with the most common use case.
      # Hence, we'll need to ensure the venv is always activated. More info:
      # https://stackoverflow.com/questions/74668349/how-to-activate-a-virtualenv-in-a-github-action
      - name: Install deps
        shell: bash
        run: |
          python3 -m venv ./venv
          source ./venv/bin/activate
          make github_actions

      - name: Run pre-test setup
        shell: bash
        run: |
          source ./venv/bin/activate
          make pre-coverage

      - name: Run tests and gather coverage stats
        shell: bash
        run: |
          source ./venv/bin/activate
          make coverage

      - name: Upload coverage reports as artifacts
        uses: actions/upload-artifact@v4
        with:
          path: |
            .coverage
            coverage.xml
          name: coverage-reports-python${{ matrix.python }}

      - name: Comment with code coverage
        # Conditionally run this step to prevent multiple comments
        # Occasionally, multiple jobs could post at the same time.
        if: matrix.print_coverage
        uses: zapata-engineering/command-pr-comment@47141d48f14d33b89f8d689ebda1604fbc0bf4e0
        with:
          command: make PYTHON=./venv/bin/python github-actions-coverage-report
          template: "🚀 Code Coverage\n```%command%```"
          update-text: "🚀 Code Coverage"
          working-dir: ${{ inputs.target_path }}