test.yml

name: Core Repo Tests

on:
  push:
    branches-ignore:
    - 'release/*'
  pull_request:
env:
  # Set variable to 'main' if your change will not affect Contrib.
  # Otherwise, set variable to the commit of your branch on
  # opentelemetry-python-contrib which is compatible with these Core repo
  # changes.
  CONTRIB_REPO_SHA: main

  # This is needed because we do not clone the core repo in contrib builds anymore.
  # When running contrib builds as part of core builds, we use actions/checkout@v4 which
  # does not set an environment variable (simply just runs tox), which is different when
  # contrib builds are run directly from contrib (since test.yml is executed, which sets CORE_REPO_SHA)
  # The solution is to include CORE_REPO_SHA as part of THIS environment so it can be accessed
  # from within the contrib build.
  CORE_REPO_SHA: ${{ github.sha }}

  # See #3879 and https://pip.pypa.io/en/stable/cli/pip/#exists-action-option
  PIP_EXISTS_ACTION: w

jobs:
  build:
    env:
      # We use these variables to convert between tox and GHA version literals
      py38: 3.8
      py39: 3.9
      py310: "3.10"
      py311: "3.11"
      py312: "3.12"
      pypy3: pypy-3.8
      RUN_MATRIX_COMBINATION: ${{ matrix.python-version }}-${{ matrix.package }}-${{
        matrix.os }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false  # ensures the entire test matrix is run, even if one permutation fails
      matrix:
        python-version: [py38, py39, py310, py311, py312, pypy3]
        package:
          - "api"
          - "sdk"
          - "semantic-conventions"
          - "getting-started"
          - "opentracing-shim"
          - "opencensus-shim"
          - "exporter-opencensus"
          - "exporter-otlp-proto-common"
          - "exporter-otlp-combined"
          - "exporter-otlp-proto-grpc"
          - "exporter-otlp-proto-http"
          - "exporter-prometheus"
          - "exporter-zipkin-combined"
          - "exporter-zipkin-proto-http"
          - "exporter-zipkin-json"
          - "proto"
          - "propagator-b3"
          - "propagator-jaeger"
        os: [ubuntu-20.04, windows-2019]
        exclude:
          - python-version: pypy3
            package: "opencensus-shim"
          - python-version: pypy3
            package: "exporter-opencensus"
          - python-version: pypy3
            package: "exporter-otlp-combined"
          - python-version: pypy3
            package: "exporter-otlp-proto-grpc"
          - python-version: pypy3
            package: "getting-started"

    steps:
    - name: Checkout Core Repo @ SHA - ${{ github.sha }}
      uses: actions/checkout@v4
    - name: Set up Python ${{ env[matrix.python-version] }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ env[matrix.python-version] }}
        architecture: 'x64'
    - name: Install tox
      run: pip install tox
    - name: Cache tox environment
        # Preserves .tox directory between runs for faster installs
      uses: actions/cache@v4
      with:
        path: |
          .tox
          ~/.cache/pip
        key: v4-tox-cache-${{ env.RUN_MATRIX_COMBINATION }}-${{ hashFiles('tox.ini',
          'dev-requirements.txt') }}-core
    - name: Windows does not let git check out files with long names
      if: ${{ matrix.os == 'windows-2019'}}
      run: git config --system core.longpaths true
    - name: run tox
      run: tox -f ${{ matrix.python-version }}-${{ matrix.package }} -- -ra
  misc:
    strategy:
      fail-fast: false
      matrix:
        tox-environment: ["docker-tests-proto3", "docker-tests-proto4", "spellcheck",
          "docs", "mypy", "mypyinstalled", "tracecontext"]
    name: ${{ matrix.tox-environment }}
    runs-on: ubuntu-20.04
    steps:
    - name: Checkout Core Repo @ SHA - ${{ github.sha }}
      uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.10'
        architecture: 'x64'
    - name: Install tox
      run: pip install tox
    - name: Cache tox environment
        # Preserves .tox directory between runs for faster installs
      uses: actions/cache@v4
      with:
        path: |
          .tox
          ~/.cache/pip
        key: v4-tox-cache-${{ matrix.tox-environment }}-${{ hashFiles('tox.ini', 'dev-requirements.txt')
          }}-core
    - name: run tox
      run: tox -e ${{ matrix.tox-environment }}

  # Contrib unit test suite in order to ensure changes in core do not break anything in contrib.
  # We only run contrib unit tests on the oldest supported Python version (3.8) as running the same tests
  # on all versions is somewhat redundant.
  contrib-build:
    env:
      # We use these variables to convert between tox and GHA version literals
      py38: 3.8
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false  # ensures the entire test matrix is run, even if one permutation fails
      matrix:
        python-version: [py38]
        package:
          - "aiohttp-client"
          - "aiohttp-server"
          - "aiopg"
          - "aio-pika"
          - "asgi"
          - "asyncpg"
          - "aws-lambda"
          - "boto"
          - "boto3sqs"
          - "botocore"
          - "cassandra"
          - "celery"
          - "confluent-kafka"
          - "dbapi"
          - "django"
          - "elasticsearch"
          - "falcon"
          - "fastapi"
          - "flask"
          - "grpc"
          - "httpx"
          - "jinja2"
          - "kafka-python"
          - "logging"
          - "mysql"
          - "mysqlclient"
          - "pika"
          - "psycopg2"
          - "pymemcache"
          - "pymongo"
          - "pymysql"
          - "pyramid"
          - "redis"
          - "remoulade"
          - "requests"
          - "sqlalchemy"
          - "sqlite3"
          - "starlette"
          - "system-metrics"
          - "tornado"
          - "tortoiseorm"
          - "urllib"
          - "urllib3"
          - "wsgi"
          - "prometheus-remote-write"
          - "richconsole"
        os: [ubuntu-20.04]
    steps:
    - name: Checkout Contrib Repo @ SHA - ${{ env.CONTRIB_REPO_SHA }}
      uses: actions/checkout@v4
      with:
        repository: open-telemetry/opentelemetry-python-contrib
        ref: ${{ env.CONTRIB_REPO_SHA }}
    - name: Checkout Core Repo @ SHA ${{ github.sha }}
      uses: actions/checkout@v4
      with:
        repository: open-telemetry/opentelemetry-python
        path: opentelemetry-python-core
    - name: Set up Python ${{ env[matrix.python-version] }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ env[matrix.python-version] }}
        architecture: 'x64'
    - name: Install tox
      run: pip install tox
    - name: Cache tox environment
        # Preserves .tox directory between runs for faster installs
      uses: actions/cache@v4
      with:
        path: |
          .tox
          ~/.cache/pip
        key: v3-tox-cache-${{ matrix.python-version }}-${{ matrix.package }}-${{ matrix.os
          }}-${{ hashFiles('tox.ini', 'dev-requirements.txt') }}-contrib
    - name: run tox
      run: tox -f ${{ matrix.python-version }}-${{ matrix.package }} -- -ra