prbuild.yml

name: Pull Request Build

on:
  pull_request:
    branches:
      - main

# Actions Used (please keep this documented here as added)
#  https://github.com/marketplace/actions/checkout
#  https://github.com/marketplace/actions/setup-python
#  https://github.com/marketplace/actions/trufflehog-oss
#  https://github.com/marketplace/actions/cache

jobs:
  build:
    # Default access (restricted) - https://docs.github.com/en/actions/security-guides/automatic-token-authentication
    permissions:
      contents: read

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [ '3.7', '3.8', '3.9', '3.10', '3.11', '3.12' ]

    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: TruffleHog OSS
        uses: trufflesecurity/trufflehog@v3.70.2
        with:
          path: ./
          base: ${{ github.event.repository.default_branch }}
          head: HEAD
          extra_args: --debug --only-verified

      - name: Restore Localstack Image Cache if it exists
        id: cache-docker-localstack
        uses: actions/cache@v4
        with:
          path: ci/cache/docker/localstack
          key: cache-docker-localstack-2.1

      - name: Update Localstack Image Cache if cache miss
        if: steps.cache-docker-localstack.outputs.cache-hit != 'true'
        run: docker pull public.ecr.aws/localstack/localstack:2.1 && mkdir -p ci/cache/docker/localstack && docker image save public.ecr.aws/localstack/localstack:2.1 --output ./ci/cache/docker/localstack/localstack-2.1.tar

      - name: Use Localstack Image Cache if cache hit
        if: steps.cache-docker-localstack.outputs.cache-hit == 'true'
        run: docker image load --input ./ci/cache/docker/localstack/localstack-2.1.tar

      - name: Set up compose stack
        run: |
          docker-compose -f docker-compose.yml up -d

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

      - name: Install dependencies
        run: |
          make install all

      - name: Lint and code formatting
        run: |
          make check

      - name: Run test suite
        run: |
          make test

      - name: Tear down compose stack
        run: |
          docker-compose -f docker-compose.yml down