test.yaml

---
# This Test workflow uses pants
name: Test

on:
  push:
    branches:
      # only on merges to master branch
      - master
      # and version branches, which only include minor versions (eg: v3.4)
      - v[0-9]+.[0-9]+
    tags:
      # also version tags, which include bugfix releases (eg: v3.4.0)
      - v[0-9]+.[0-9]+.[0-9]+
  pull_request:
    type: [opened, reopened, edited]
    branches:
      # Only for PRs targeting those branches
      - master
      - v[0-9]+.[0-9]+
  #schedule:
  #  # run every night at midnight
  #  - cron:  '0 0 * * *'

jobs:
  test:
    name: '${{ matrix.name }} - Python ${{ matrix.python-version-short }}'
    runs-on: ubuntu-20.04
    strategy:
      fail-fast: false
      matrix:
        # NOTE: We need to use full Python version as part of Python deps cache key otherwise
        # setup virtualenv step will fail.
        include:
          - name: 'Test (pants runs: pytest)'
            python-version-short: '3.8'
            python-version: '3.8.10'
          - name: 'Test (pants runs: pytest)'
            python-version-short: '3.9'
            python-version: '3.9.14'

    services:
      mongo:
        image: mongo:4.4
        ports:
          - 27017:27017

      rabbitmq:
        image: rabbitmq:3.8-management
        options: >-
          --name rabbitmq
        ports:
          - 5671:5671/tcp   # AMQP SSL port
          - 5672:5672/tcp   # AMQP standard port
          - 15672:15672/tcp # Management: HTTP, CLI

      redis:
         # Docker Hub image
         image: redis
         # Set health checks to wait until redis has started
         options: >-
           --name "redis"
           --health-cmd "redis-cli ping"
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5
         ports:
           - 6379:6379/tcp

    env:
      COLUMNS: '120'

    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
        with:
          # a test uses a submodule, and pants needs access to it to calculate deps.
          submodules: 'true'

      - name: 'Set up Python (${{ matrix.python-version }})'
        uses: actions/setup-python@v2
        with:
          python-version: '${{ matrix.python-version }}'


      #- name: Cache APT Dependencies
      #  id: cache-apt-deps
      #  uses: actions/cache@v2
      #  with:
      #    path: |
      #      ~/apt_cache
      #    key: ${{ runner.os }}-apt-v7-${{ hashFiles('scripts/github/apt-packages.txt') }}
      #    restore-keys: |
      #      ${{ runner.os }}-apt-v7-
      - name: Install APT Depedencies
        env:
          CACHE_HIT: 'false' # cache doesn't work
          #CACHE_HIT: ${{steps.cache-apt-deps.outputs.cache-hit}}
        run: |
          # install dev dependencies for Python YAML and LDAP packages
          # https://github.com/StackStorm/st2-auth-ldap
          ./scripts/github/install-apt-packages-use-cache.sh

      - name: Initialize Pants and its GHA caches
        uses: pantsbuild/actions/init-pants@v6-scie-pants
        # This action adds an env var to make pants use both pants.ci.toml & pants.toml.
        # This action also creates 3 GHA caches (1 is optional).
        # - `pants-setup` has the bootsrapped pants install
        # - `pants-named-caches` has pip/wheel and PEX caches
        # - `pants-lmdb-store` has the fine-grained process cache.
        #   If we ever use a remote cache, then we can drop this.
        #   Otherwise, we may need an additional workflow or job to delete old caches
        #   if they are not expiring fast enough, and we hit the GHA 10GB per repo max.
        with:
          base-branch: master
          # To ignore a bad cache, bump the cache* integer.
          gha-cache-key: cache0-py${{ matrix.python-version }}
          # This hash should include all of our lockfiles so that the pip/pex caches
          # get invalidated on any transitive dependency update.
          named-caches-hash: ${{ hashFiles('requirements.txt') }}
          # enable the optional lmdb_store cache since we're not using remote caching.
          cache-lmdb-store: 'true'
          # install whatever version of python we need for our in-repo pants-plugins
          setup-python-for-plugins: 'true'

      - name: Test
        # We do not support running pytest everywhere yet. When we do it will be simply:
        #   pants test ::
        # Until then, we need to manually adjust this command line to test what we can.
        run: |
          pants test pylint_plugins/:: pants-plugins/::

      - name: Upload pants log
        uses: actions/upload-artifact@v2
        with:
          name: pants-log-py${{ matrix.python-version }}
          path: .pants.d/pants.log
        if: always()  # We want the log even on failures.