SAM-232: Testing improvements - use docker compose to run 3rd party services

.github/workflows/manual.yml

@@ -0,0 +1,13 @@
+---
+name: Manual
+on:
+ workflow_dispatch:
+jobs:
+  test:
+    uses: ./.github/workflows/reusable_test-python.yml
+  build-push:
+    needs: test
+    uses: ./.github/workflows/reusable_build-push.yml
+    with:
+      name: '${{ github.repository }}'
+      tags: '${{ github.ref_name }}'

.github/workflows/pull-request-develop-merged.yml

@@ -0,0 +1,20 @@
+---
+name: PR to develop closed and merged
+on:
+  pull_request:
+    branches:
+      - develop
+    types:
+      - closed
+jobs:
+  test:
+    if: ${{ github.event.pull_request.merged }}
+    uses: ./.github/workflows/reusable_test-python.yml
+  build-push:
+    if: ${{ github.event.pull_request.merged }}
+    needs: test
+    uses: ./.github/workflows/reusable_build-push.yml
+    with:
+      name: '${{ github.event.repository.name }}-develop'
+      tags: latest
+    secrets: inherit

.github/workflows/pull-request-develop.yml

@@ -0,0 +1,16 @@
+---
+name: PR to develop opened
+on:
+  pull_request:
+    branches:
+      - develop
+    types:
+      - opened
+      - reopened
+      - synchronize
+jobs:
+  test:
+    uses: ./.github/workflows/reusable_test-python.yml
+  build:
+    needs: test
+    uses: ./.github/workflows/reusable_build.yml

.github/workflows/pull-request-main-merged.yml

@@ -0,0 +1,21 @@
+---
+name: PR To main (or master) merged
+on:
+  pull_request:
+    branches:
+      - main
+      - master
+    types:
+      - closed
+jobs:
+  test:
+    if: ${{ github.event.pull_request.merged }}
+    uses: ./.github/workflows/reusable_test-python.yml
+  build-push:
+    if: ${{ github.event.pull_request.merged }}
+    needs: test
+    uses: ./.github/workflows/reusable_build-push.yml
+    with:
+      name: '${{ github.event.repository.name }}'
+      tags: latest-rc
+    secrets: inherit

.github/workflows/pull-request-main-opened.yml

@@ -0,0 +1,19 @@
+---
+name: PR to main (or master) opened
+on:
+  pull_request:
+    branches:
+      - main
+      - master
+    types:
+      - opened
+jobs:
+  test:
+    uses: ./.github/workflows/reusable_test-python.yml
+  build-push:
+    needs: test
+    uses: ./.github/workflows/reusable_build-push.yml
+    with:
+      name: '${{ github.event.repository.name }}'
+      tags: pr${{ github.event.number }}
+    secrets: inherit

.github/workflows/release-main.yml

@@ -0,0 +1,23 @@
+---
+name: Release - Test, Build & Push Image
+on:
+  release:
+    branches:
+      - main
+      - master
+    types: [ published ]
+jobs:
+  validate-release-tag:
+    uses: ./.github/workflows/reusable_validate-release-tag.yml
+    with:
+      release_tag: '${{ github.event.release.tag_name }}'
+  test:
+    needs: validate-release-tag
+    uses: ./.github/workflows/reusable_test-python.yml
+  build-push:
+    needs: test
+    uses: ./.github/workflows/reusable_build-push.yml
+    with:
+      name: '${{ github.event.repository.name }}'
+      tags: '${{ github.event.release.tag_name }},latest'
+    secrets: inherit

.github/workflows/reusable_build-push.yml

@@ -0,0 +1,61 @@
+---
+name: Build & Push Image to GHCR
+on:
+  workflow_call:
+    inputs:
+      name:
+        description: The image name
+        required: true
+        type: string
+      tags:
+        description: The image tags
+        required: true
+        type: string
+jobs:
+  build-push-image:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out GitHub Repo
+        uses: actions/checkout@v2
+
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date -u +'%Y-%m-%dT%H:%M:%SZ')"
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to GHCR
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          # note that the calling workflow must set `secrets: inherit`
+          username: '${{ secrets.GHCR_USERNAME }}'
+          password: '${{ secrets.GHCR_TOKEN }}'
+
+      - name: Create github action tags from image tags
+        id: tags
+        uses: actions/github-script@v6
+        with:
+          result-encoding: string
+          script: |
+            const tags = '${{ inputs.tags }}'.split(',');
+            const username = '${{ github.event.repository.owner.login }}';
+            const repoName = '${{ inputs.name }}';
+            return tags.map((tag) => {
+              return `ghcr.io/${username}/${repoName}:${tag}`;
+            }).join(',');
+
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          pull: true
+          push: true
+          build-args: |
+            BUILD_DATE=${{ steps.date.outputs.date }}
+            VCS_REF=${{ github.sha }}
+            BRANCH='${{ github.ref }}'
+            TAG='${{ github.ref }}'
+          tags: '${{ steps.tags.outputs.result }}'

.github/workflows/reusable_build.yml

@@ -0,0 +1,21 @@
+---
+name: Build Image without pushing
+on:
+  workflow_call:
+jobs:
+  build-image:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out GitHub Repo
+        uses: actions/checkout@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Build without push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          pull: true
+          push: false

.github/workflows/reusable_test-python.yml

@@ -0,0 +1,33 @@
+---
+name: Test (unit, integration)
+on:
+  workflow_call:
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out GitHub Repo
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-python@v3
+        with:
+          python-version: '3.7'
+
+      - name: Install pipenv
+        run: pip install -r requirements.txt
+
+      - name: Install test dependencies and config
+        run: make test-setup
+
+      # Run tests
+      - name: Run all tests
+        run: make test
+
+      # Display a coverage report for inspection in the workflow logs
+      - name: Coverage summary
+        run: make coverage-summary
+
+      - name: Send to Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          files: ./cov_profile.lcov

.github/workflows/reusable_validate-release-tag.yml

@@ -0,0 +1,20 @@
+---
+name: Ensure release tag is semantic version
+on:
+  workflow_call:
+    inputs:
+      release_tag:
+        required: true
+        type: string
+jobs:
+  ensure-semver:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Validate that release tag as a proper semantic version
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const releaseTag = '${{ inputs.release_tag }}';
+            if (!/^[0-9]+\.[0-9]+\.[0-9]+$/.test(releaseTag)) {
+              core.setFailed(`Release version must follow semantic version naming (e.g. 1.0.2) but is "${releaseTag}"`)
+            }