tests.yml

name: Tests

on:
  workflow_dispatch:
  workflow_call:
  pull_request:
    branches: [main]
    paths-ignore: ["**/*.md", "**/*.rst"]

env:
  PYTHON_VERSION: 3.9
  # Disable tokenizers parallelism because this doesn't help, and can cause issues in distributed tests.
  TOKENIZERS_PARALLELISM: "false"
  # Disable multithreading with OMP because this can lead to dead-locks in distributed tests.
  OMP_NUM_THREADS: "1"
  # See https://github.com/pytorch/pytorch/issues/37377#issuecomment-677851112.
  MKL_THREADING_LAYER: "GNU"

jobs:
  changes:
    name: Check for Python file changes
    runs-on: self-hosted
    if: ${{ !github.event.pull_request.draft }}
    outputs:
      python: ${{steps.filter.outputs.python}}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3
      - uses: dorny/paths-filter@v2
        id: filter
        with:
          filters: |
            python:
              - '**/*.py'
              - 'storage/fixtures/**/*'
              - 'pyproject.toml'
              - 'poetry.lock'
              - '.github/workflows/tests.yml'

  python:
    name: Run Python test suite
    defaults:
      run:
        shell: bash

    runs-on: self-hosted
    needs: [changes]
    if: ${{needs.changes.outputs.python == 'true' && !github.event.pull_request.draft }}
    steps:
      - name: Checkout the repository
        uses: actions/checkout@v3

      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: Install Poetry
        uses: snok/install-poetry@v1

      - name: Install PoethePoet
        run: poetry self add 'poethepoet[poetry_plugin]'

      - name: Configure GitHub to download private repos
        env:
          PAT: ${{ secrets.PAT }}
        run: |
          git config --global url."https://${PAT}@github.com/".insteadOf "https://github.com/"

      - name: Load cached Python
        uses: tespkg/actions-cache@v1
        id: python-cache
        with:
          path: ~/.cache/pypoetry/virtualenvs
          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}-${{ hashFiles('pyproject.toml') }}
          bucket: ${{ secrets.AWS_S3_BUCKET_NAME }}
          accessKey: ${{ secrets.AWS_ACCESS_KEY_ID }}
          secretKey: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

      - name: Install dependencies
        run: |
          poetry install --all-extras

      - name: Run test suite
        run: |
          poetry run poe test-everything | tee pytest-coverage.txt

      - name: Comment the coverage
        if: ${{ always() && github.event_name == 'pull_request' && github.actor != 'dependabot[bot]' }}
        uses: MishaKav/pytest-coverage-comment@main
        with:
          pytest-coverage-path: ./pytest-coverage.txt
          junitxml-path: ./pytest.xml