tests.yml

name: Tests

on:
    push:
        branches: [main]
    pull_request:
        branches: [main, "release/*"]

jobs:
    tests:
        name: ${{ matrix.session }} ${{ matrix.python }} / ${{ matrix.os }}
        runs-on: ${{ matrix.os }}
        strategy:
            fail-fast: false
            matrix:
                include:
                    - { python: "3.9", os: "ubuntu-latest", session: "pre-commit" }
                    - { python: "3.9", os: "ubuntu-latest", session: "mypy" }
                    - { python: "3.9", os: "ubuntu-latest", session: "tests_not_slow" }
                    - { python: "3.9", os: "ubuntu-latest", session: "xdoctest" }
                    - { python: "3.9", os: "ubuntu-latest", session: "docs-build" }
                    # - { python: "3.9", os: "macos-latest", session: "tests_not_slow" }
                    # - { python: "3.9", os: "windows-latest", session: "tests_not_slow" }
                    # - { python: "3.9", os: "ubuntu-latest", session: "safety" }
                    # - { python: "3.9", os: "ubuntu-latest", session: "typeguard" }

        env:
            NOXSESSION: ${{ matrix.session }}
            FORCE_COLOR: "1"
            PRE_COMMIT_COLOR: "always"

        steps:
            - name: Check out the repository
              uses: actions/checkout@v4

            - name: Set up Python ${{ matrix.python }}
              uses: actions/setup-python@v5
              with:
                  python-version: ${{ matrix.python }}
                  #   cache: pip
                  #   cache-dependency-path: poetry.lock

            - name: Upgrade pip
              run: |
                  pip install --constraint=.github/workflows/constraints.txt pip
                  pip --version
            - name: Upgrade pip in virtual environments
              shell: python
              run: |
                  import os
                  import pip
                  with open(os.environ["GITHUB_ENV"], mode="a") as io:
                      print(f"VIRTUALENV_PIP={pip.__version__}", file=io)
            - name: Install Poetry
              run: |
                  pipx install --verbose --pip-args=--constraint=.github/workflows/constraints.txt poetry
                  poetry --version
            - name: Install Nox
              run: |
                  pipx install --pip-args=--constraint=.github/workflows/constraints.txt nox
                  pipx inject --pip-args=--constraint=.github/workflows/constraints.txt nox nox-poetry
                  nox --version
            - name: Compute pre-commit cache key
              if: matrix.session == 'pre-commit'
              id: pre-commit-cache
              shell: python
              run: |
                  import hashlib
                  import sys
                  python = "py{}.{}".format(*sys.version_info[:2])
                  payload = sys.version.encode() + sys.executable.encode()
                  digest = hashlib.sha256(payload).hexdigest()
                  result = "${{ runner.os }}-{}-{}-pre-commit".format(python, digest[:8])
                  print("::set-output name=result::{}".format(result))
            - name: Restore pre-commit cache
              uses: actions/cache@v2.1.7
              if: matrix.session == 'pre-commit'
              with:
                  path: ~/.cache/pre-commit
                  key: ${{ steps.pre-commit-cache.outputs.result }}-${{ hashFiles('.pre-commit-config.yaml') }}
                  restore-keys: |
                      ${{ steps.pre-commit-cache.outputs.result }}-
            - name: Run Nox
              run: |
                  nox --python=${{ matrix.python }}
            - name: Upload coverage data
              if: always() && matrix.session == 'tests_not_slow'
              uses: "actions/upload-artifact@v2.3.1"
              with:
                  name: coverage-data
                  path: ".coverage.*"

            - name: Upload documentation
              if: matrix.session == 'docs-build'
              uses: actions/upload-artifact@v2.3.1
              with:
                  name: docs
                  path: docs/_build

    coverage:
        runs-on: ubuntu-latest
        needs: tests
        steps:
            - name: Check out the repository
              uses: actions/checkout@v2.4.0

            - name: Set up Python
              uses: actions/setup-python@v2.3.2
              with:
                  python-version: "3.9"

            - name: Upgrade pip
              run: |
                  pip install --constraint=.github/workflows/constraints.txt pip
                  pip --version
            - name: Install Poetry
              run: |
                  pipx install --pip-args=--constraint=.github/workflows/constraints.txt poetry
                  poetry --version
            - name: Install Nox
              run: |
                  pipx install --pip-args=--constraint=.github/workflows/constraints.txt nox
                  pipx inject --pip-args=--constraint=.github/workflows/constraints.txt nox nox-poetry
                  nox --version
            - name: Download coverage data
              uses: actions/download-artifact@v2.1.0
              with:
                  name: coverage-data

            - name: Combine coverage data and display human readable report
              run: |
                  nox --session=coverage
            - name: Create coverage report
              run: |
                  nox --session=coverage -- xml
            - name: Upload coverage report
              uses: codecov/codecov-action@v2.1.0