test: add integration tests

.github/actions/build-test-push/action.yml

@@ -0,0 +1,87 @@
+name: Build Test Push
+description: Build, test and push Docker images for a given platform
+author: Julien Neuhart
+
+inputs:
+  github_token:
+    description: The GitHub token
+    required: true
+    default: ${{ github.token }}
+  docker_hub_username:
+    description: The Docker Hub username
+    required: true
+  docker_hub_password:
+    description: The Docker Hub password
+    required: true
+  platform:
+    description: linux/amd64, linux/386, linux/arm64, linux/arm/v7
+    required: true
+  version:
+    description: Gotenberg version
+    required: true
+  skip_integrations_tests:
+    description: Define whether to skip integration testing
+    default: false
+  alternate_repository:
+    description: Alternate repository to push the tags to
+  dry_run:
+    description: Dry run this action
+
+outputs:
+  tags:
+    description: Comma separated list of tag
+    value: ${{ steps.build.outputs.tags }}
+  tags_cloud_run:
+    description: Comma separated list of Cloud Run tags (linux/amd64 only)
+    value: ${{ steps.build.outputs.tags_cloud_run }}
+
+runs:
+  using: composite
+  steps:
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v3
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    - name: Check out code
+      uses: actions/checkout@v4
+
+    - name: Log in to Docker Hub
+      uses: docker/login-action@v3
+      with:
+        username: ${{ inputs.docker_hub_username }}
+        password: ${{ inputs.docker_hub_password }}
+
+    - name: Build ${{ inputs.platform }}
+      id: build
+      shell: bash
+      run: |
+        .github/actions/build-test-push/build.sh \
+          --version "${{ inputs.version }}" \
+          --platform "${{ inputs.platform }}" \
+          --alternate-repository "${{ inputs.alternate_repository }}" \
+          --dry-run "${{ inputs.dry_run }}"
+
+    - name: Run integration tests
+      if: ${{ inputs.skip_integrations_tests != 'true' }}
+      shell: bash
+      run: |
+        .github/actions/build-test-push/test.sh \
+          --version "${{ inputs.version }}" \
+          --platform "${{ inputs.platform }}" \
+          --alternate-repository "${{ inputs.alternate_repository }}" \
+          --dry-run "${{ inputs.dry_run }}"
+
+    - name: Push
+      shell: bash
+      run: |
+        .github/actions/build-test-push/push.sh \
+          --tags "${{ steps.build.outputs.tags }}" \
+          --dry-run "${{ inputs.dry_run }}"
+
+    - name: Outputs
+      shell: bash
+      run: |
+        echo "tags=${{ steps.build.outputs.tags }}"
+        echo "tags_cloud_run=${{ steps.build.outputs.tags_cloud_run }}"

.github/actions/build-test-push/build.sh

@@ -0,0 +1,167 @@
+#!/bin/bash
+
+# Exit early.
+# See: https://www.gnu.org/savannah-checkouts/gnu/bash/manual/bash.html#The-Set-Builtin.
+set -e
+
+# Source dot env file.
+source .env
+
+# Arguments.
+version=""
+platform=""
+alternate_repository=""
+dry_run=""
+
+while [[ $# -gt 0 ]]; do
+  case $1 in
+    --version)
+      version="${2//v/}"
+      shift 2
+      ;;
+    --platform)
+      platform="$2"
+      shift 2
+      ;;
+    --alternate-repository)
+      alternate_repository="$2"
+      shift 2
+      ;;
+    --dry-run)
+      dry_run="$2"
+      shift 2
+      ;;
+    *)
+      echo "Unknown option $1"
+      exit 1
+      ;;
+  esac
+done
+
+echo "Build and push 👷"
+echo
+
+echo "Gotenberg version: $version"
+echo "Target platform: $platform"
+
+if [ -n "$alternate_repository" ]; then
+  DOCKER_REPOSITORY=$alternate_repository
+  echo "⚠️ Using $alternate_repository for DOCKER_REPOSITORY"
+fi
+
+if [ "$dry_run" = "true" ]; then
+  echo "🚧 Dry run"
+fi
+
+# Build tags arrays.
+tags=()
+tags_cloud_run=()
+
+IFS='/' read -ra arch <<< "$platform"
+IFS='.' read -ra semver <<< "$version"
+
+if [ "${#semver[@]}" -eq 3 ]; then
+  echo
+  echo "Semver version detected"
+
+  major="${semver[0]}"
+  minor="${semver[1]}"
+  patch="${semver[2]}"
+
+  tags+=("$DOCKER_REGISTRY/$DOCKER_REPOSITORY:latest-${arch[1]}")
+  tags+=("$DOCKER_REGISTRY/$DOCKER_REPOSITORY:$major-${arch[1]}")
+  tags+=("$DOCKER_REGISTRY/$DOCKER_REPOSITORY:$major.$minor-${arch[1]}")
+  tags+=("$DOCKER_REGISTRY/$DOCKER_REPOSITORY:$major.$minor.$patch-${arch[1]}")
+
+  if [ "$platform" = "linux/amd64" ]; then
+    tags_cloud_run+=("$DOCKER_REGISTRY/$DOCKER_REPOSITORY:latest-cloudrun")
+    tags_cloud_run+=("$DOCKER_REGISTRY/$DOCKER_REPOSITORY:$major-cloudrun")
+    tags_cloud_run+=("$DOCKER_REGISTRY/$DOCKER_REPOSITORY:$major.$minor-cloudrun")
+    tags_cloud_run+=("$DOCKER_REGISTRY/$DOCKER_REPOSITORY:$major.$minor.$patch-cloudrun")
+  fi
+else
+  echo
+  echo "Non-semver version detected, fallback to $version"
+
+  tags+=("$DOCKER_REGISTRY/$DOCKER_REPOSITORY:$version-${arch[1]}")
+  if [ "$platform" = "linux/amd64" ]; then
+    tags_cloud_run+=("$DOCKER_REGISTRY/$DOCKER_REPOSITORY:$version-cloudrun")
+  fi
+fi
+
+tags_flags=()
+tags_cloud_run_flags=()
+
+echo "Will use the following tags:"
+for tag in "${tags[@]}"; do
+  tags_flags+=("-t" "$tag")
+  echo "- $tag"
+done
+for tag in "${tags_cloud_run[@]}"; do
+  tags_cloud_run_flags+=("-t" "$tag")
+  echo "- $tag"
+done
+echo
+
+# Build images.
+run_cmd() {
+  local cmd="$1"
+
+  if [ "$dry_run" = "true" ]; then
+    echo "🚧 Dry run - would run the following command:"
+    echo "$cmd"
+    echo
+  else
+    echo "⚙️ Running command:"
+    echo "$cmd"
+    eval "$cmd"
+    echo
+  fi
+}
+
+join() {
+  local delimiter="$1"
+  shift
+  local IFS="$delimiter"
+  echo "$*"
+}
+
+no_arch_tag="$DOCKER_REGISTRY/$DOCKER_REPOSITORY:$version"
+
+cmd="docker buildx build \
+    --build-arg GOLANG_VERSION=$GOLANG_VERSION \
+    --build-arg GOTENBERG_VERSION=$version \
+    --build-arg GOTENBERG_USER_GID=$GOTENBERG_USER_GID \
+    --build-arg GOTENBERG_USER_UID=$GOTENBERG_USER_UID \
+    --build-arg NOTO_COLOR_EMOJI_VERSION=$NOTO_COLOR_EMOJI_VERSION \
+    --build-arg PDFTK_VERSION=$PDFTK_VERSION \
+    --build-arg PDFCPU_VERSION=$PDFCPU_VERSION \
+    --platform $platform \
+    --load \
+    ${tags_flags[*]} \
+    -t $no_arch_tag \
+    -f $DOCKERFILE $DOCKER_BUILD_CONTEXT
+"
+run_cmd "$cmd"
+
+if [ "$platform" != "linux/amd64" ]; then
+  echo "⚠️ Skip Cloud Run variant(s)"
+  echo "✅ Done!"
+  echo "tags=$(join "," "${tags[@]}")" >> "$GITHUB_OUTPUT"
+  echo "tags_cloud_run=$(join "," "${tags_cloud_run[@]}")" >> "$GITHUB_OUTPUT"
+  exit 0
+fi
+
+cmd="docker build \
+    --build-arg DOCKER_REGISTRY=$DOCKER_REGISTRY \
+    --build-arg DOCKER_REPOSITORY=$DOCKER_REPOSITORY \
+    --build-arg GOTENBERG_VERSION=$version \
+    ${tags_cloud_run_flags[*]} \
+    -f $DOCKERFILE_CLOUDRUN $DOCKER_BUILD_CONTEXT
+"
+run_cmd "$cmd"
+
+echo "✅ Done!"
+echo "tags=$(join "," "${tags[@]}")" >> "$GITHUB_OUTPUT"
+echo "tags_cloud_run=$(join "," "${tags_cloud_run[@]}")" >> "$GITHUB_OUTPUT"
+exit 0

.github/actions/build-test-push/push.sh

@@ -0,0 +1,70 @@
+#!/bin/bash
+
+# Exit early.
+# See: https://www.gnu.org/savannah-checkouts/gnu/bash/manual/bash.html#The-Set-Builtin.
+set -e
+
+# Source dot env file.
+source .env
+
+# Arguments.
+tags=""
+dry_run=""
+
+while [[ $# -gt 0 ]]; do
+  case $1 in
+    --tags)
+      tags="$2"
+      shift 2
+      ;;
+    --dry-run)
+      dry_run=$2
+      shift 2
+      ;;
+    *)
+      echo "Unknown option $1"
+      exit 1
+      ;;
+  esac
+done
+
+echo "Push tag(s) 📦"
+echo
+
+echo "Tag(s) to push:"
+IFS=',' read -ra tags_to_push <<< "$tags"
+for tag in "${tags_to_push[@]}"; do
+  echo "- $tag"
+done
+
+if [ "$dry_run" = "true" ]; then
+  echo "🚧 Dry run"
+fi
+echo
+
+# Push tags.
+run_cmd() {
+  local cmd="$1"
+
+  if [ "$dry_run" = "true" ]; then
+    echo "🚧 Dry run - would run the following command:"
+    echo "$cmd"
+    echo
+  else
+    echo "⚙️ Running command:"
+    echo "$cmd"
+    eval "$cmd"
+    echo
+  fi
+}
+
+for tag in "${tags_to_push[@]}"; do
+  cmd="docker push $tag"
+  run_cmd "$cmd"
+
+  echo "➡️ $tag pushed"
+  echo
+done
+
+echo "✅ Done!"
+exit 0

.github/actions/build-test-push/test.sh

@@ -0,0 +1,79 @@
+#!/bin/bash
+
+# Exit early.
+# See: https://www.gnu.org/savannah-checkouts/gnu/bash/manual/bash.html#The-Set-Builtin.
+set -e
+
+# Source dot env file.
+source .env
+
+# Arguments.
+version=""
+platform=""
+alternate_repository=""
+dry_run=""
+
+while [[ $# -gt 0 ]]; do
+  case $1 in
+    --version)
+      version="${2//v/}"
+      shift 2
+      ;;
+    --platform)
+      platform="$2"
+      shift 2
+      ;;
+    --alternate-repository)
+      alternate_repository="$2"
+      shift 2
+      ;;
+    --dry-run)
+      dry_run="$2"
+      shift 2
+      ;;
+    *)
+      echo "Unknown option $1"
+      exit 1
+      ;;
+  esac
+done
+
+echo "Integration testing 🧪"
+echo
+
+echo "Gotenberg version: $version"
+echo "Target platform: $platform"
+
+repository=$DOCKER_REPOSITORY
+
+if [ -n "$alternate_repository" ]; then
+  echo "⚠️ Using $alternate_repository for DOCKER_REPOSITORY"
+  repository=$alternate_repository
+fi
+
+if [ "$dry_run" = "true" ]; then
+  echo "🚧 Dry run"
+fi
+echo
+
+# Test image.
+run_cmd() {
+  local cmd="$1"
+
+  if [ "$dry_run" = "true" ]; then
+    echo "🚧 Dry run - would run the following command:"
+    echo "$cmd"
+    echo
+  else
+    echo "⚙️ Running command:"
+    echo "$cmd"
+    eval "$cmd"
+    echo
+  fi
+}
+
+cmd="make test-integration DOCKER_REPOSITORY=$repository GOTENBERG_VERSION=$version PLATFORM=$platform"
+run_cmd "$cmd"
+
+echo "✅ Done!"
+exit 0