test.yml

name: test

on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - master

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  STABLE_PYTHON_VERSION: "3.11"
  PYTEST_ADDOPTS: --color=yes

jobs:
  lint:
    name: Lint

    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: 3

      - name: Install Hatch
        run: pip install --upgrade hatch

      - # TODO: Fix lints before enabling this
        name: Lint
        run: echo hatch run lint

  test:
    name: >-
      Python ${{ matrix.python-version }}
      on ${{ matrix.os }}

    runs-on: ${{ matrix.os }}
    continue-on-error: ${{ matrix.experimental }}

    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
        python-version: ["3.8", "3.9", "3.10", "3.11"]
        experimental: [false]
        include:
          - # Run tests against the next Python version, but no need for the full list of OSes.
            os: ubuntu-latest
            python-version: "3.12-dev"
            experimental: true

    steps:
      - uses: actions/checkout@v4

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

      - name: Install Hatch
        run: pip install --upgrade hatch

      - name: Run tests and track code coverage
        run: hatch run test

  example:
    name: Example

    runs-on: ubuntu-latest
    services:
      broker:
        image: pactfoundation/pact-broker:latest
        ports:
          - "9292:9292"
        env:
          # Basic auth credentials for the Broker
          PACT_BROKER_ALLOW_PUBLIC_READ: "true"
          PACT_BROKER_BASIC_AUTH_USERNAME: pactbroker
          PACT_BROKER_BASIC_AUTH_PASSWORD: pactbroker
          # Database
          PACT_BROKER_DATABASE_URL: sqlite:////tmp/pact_broker.sqlite
        options: >-
          --health-cmd "curl -sSf http://pactbroker:pactbroker@localhost:9292/diagnostic/status/heartbeat"
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5

    steps:
      - name: Check broker is live
        run: |
          curl -sSf http://pactbroker:pactbroker@localhost:9292/diagnostic/status/heartbeat || exit 1

      - uses: actions/checkout@v4

      - name: Set up Python 3
        uses: actions/setup-python@v4
        with:
          python-version: 3

      - name: Install Hatch
        run: pip install --upgrade hatch

      - name: Examples
        run: >
          hatch run example
            --capture=no
            --broker-url=http://pactbroker:pactbroker@broker:9292

      - name: Run tests and track code coverage
        run: hatch run test