integration.yaml

name: CI

on:
  push:
    paths-ignore:
      - 'docs/**'
      - '**/*.rst'
      - '**/*.md'
    branches:
      - master
      - '[0-9].[0-9]'
  pull_request:
    branches:
      - master
      - '[0-9].[0-9]'
  schedule:
    - cron: '0 1 * * *' # nightly build

concurrency:
  group: ${{ github.event.pull_request.number || github.ref }}-integration
  cancel-in-progress: true

permissions:
  contents: read  #  to fetch code (actions/checkout)

env:
  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
  # this speeds up coverage with Python 3.12: https://github.com/nedbat/coveragepy/issues/1665
  COVERAGE_CORE: sysmon
  REDIS_IMAGE: redis:latest
  REDIS_STACK_IMAGE: redis/redis-stack-server:latest

jobs:
  dependency-audit:
    name: Dependency audit
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: pypa/gh-action-pip-audit@v1.0.8
        with:
          inputs: requirements.txt dev_requirements.txt
          ignore-vulns: |
            GHSA-w596-4wvx-j9j6  # subversion related git pull, dependency for pytest. There is no impact here.

  lint:
    name: Code linters
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: 3.9
          cache: 'pip'
      - name: run code linters
        run: |
          pip install -r dev_requirements.txt
          invoke linters

  resp2-tests:
    runs-on: ubuntu-latest
    timeout-minutes: 60
    strategy:
      max-parallel: 15
      fail-fast: false
      matrix:
        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', 'pypy-3.9', 'pypy-3.10']
        test-type: ['standalone', 'cluster']
        connection-type: ['hiredis', 'plain']
    env:
      ACTIONS_ALLOW_UNSECURE_COMMANDS: true
    name: RESP2 ${{ matrix.python-version }} ${{matrix.test-type}}-${{matrix.connection-type}}
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'

      - name: Run tests
        run: |
          pip install -U setuptools wheel
          pip install -r requirements.txt
          pip install -r dev_requirements.txt
          if [ "${{matrix.connection-type}}" == "hiredis" ]; then
           pip install hiredis
          fi
          invoke devenv
          sleep 10 # time to settle
          invoke ${{matrix.test-type}}-tests
          ls -1

      - name: Run tests against hiredis < 3.0.0
        if: ${{ matrix.connection-type == 'hiredis' && matrix.python-version == '3.12'}}
        run: |
          pip uninstall hiredis -y
          pip install -U setuptools wheel
          pip install -r requirements.txt
          pip install -r dev_requirements.txt
          if [ "${{matrix.connection-type}}" == "hiredis" ]; then
           pip install "hiredis<3.0.0"
          fi
          invoke devenv
          sleep 10 # time to settle
          invoke ${{matrix.test-type}}-tests
          ls -1

      - name: Upload test results and profiling data
        uses: actions/upload-artifact@v4
        with:
          name: pytest-results-${{matrix.test-type}}-${{matrix.connection-type}}-${{matrix.python-version}}
          path: |
            ${{matrix.test-type}}*-results.xml
            prof/**
            profile_output*
          if-no-files-found: error
          retention-days: 10

      - name: Upload codecov coverage
        uses: codecov/codecov-action@v4
        with:
          fail_ci_if_error: false

  resp3-tests:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.8', '3.12']
        test-type: ['standalone', 'cluster']
        connection-type: ['hiredis', 'plain']
        event-loop: ['asyncio', 'uvloop']
        exclude:
          - test-type: 'cluster'
            connection-type: 'hiredis'
    env:
      ACTIONS_ALLOW_UNSECURE_COMMANDS: true
    name: RESP3 ${{ matrix.python-version }} ${{matrix.test-type}}-${{matrix.connection-type}}-${{matrix.event-loop}}
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'

      - name: Run tests
        run: |
          pip install -U setuptools wheel
          pip install -r requirements.txt
          pip install -r dev_requirements.txt
          if [ "${{matrix.connection-type}}" == "hiredis" ]; then
            pip install hiredis
          fi
          invoke devenv
          sleep 10 # time to settle
          if [ "${{matrix.event-loop}}" == "uvloop" ]; then
            invoke ${{matrix.test-type}}-tests --uvloop --protocol=3
          else
            invoke ${{matrix.test-type}}-tests --protocol=3
          fi

      - name: Run tests against hiredis < 3.0.0
        if: ${{ matrix.connection-type == 'hiredis' && matrix.python-version == '3.12'}}
        run: |
          pip uninstall hiredis -y
          pip install -U setuptools wheel
          pip install -r requirements.txt
          pip install -r dev_requirements.txt
          if [ "${{matrix.connection-type}}" == "hiredis" ]; then
            pip install "hiredis<3.0.0"
          fi
          invoke devenv
          sleep 10 # time to settle
          if [ "${{matrix.event-loop}}" == "uvloop" ]; then
            invoke ${{matrix.test-type}}-tests --uvloop --protocol=3
          else
            invoke ${{matrix.test-type}}-tests --protocol=3
          fi

      - name: Upload test results and profiling data
        uses: actions/upload-artifact@v4
        with:
          name: pytest-results-${{matrix.test-type}}-${{matrix.connection-type}}-${{matrix.python-version}}-${{matrix.event-loop}}-resp3
          path: |
            ${{matrix.test-type}}*-results.xml
            prof/**
            profile_output*
          if-no-files-found: error
          retention-days: 10

      - name: Upload codecov coverage
        uses: codecov/codecov-action@v4
        with:
          fail_ci_if_error: false

  build-and-test-package:
    name: Validate building and installing the package
    runs-on: ubuntu-latest
    needs: [resp2-tests, resp3-tests]
    strategy:
      fail-fast: false
      matrix:
        extension: ['tar.gz', 'whl']
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: 3.9
      - name: Run installed unit tests
        run: |
          bash .github/workflows/install_and_test.sh ${{ matrix.extension }}

  install-package-from-commit:
    name: Install package from commit hash
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', 'pypy-3.9', 'pypy-3.10']
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'
      - name: install from pip
        run: |
          pip install --quiet git+${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git@${GITHUB_SHA}