tests-s3-image.yml

name: S3 Image Integration Tests

on:
  push:
    paths:
      - .github/workflows/tests-s3-image.yml
      - localstack/aws/*.py
      - localstack/aws/handlers/*¨
      - localstack/aws/protocol/**
      - localstack/aws/serving/**
      - localstack/aws/api/s3/**
      - localstack/http/**
      - localstack/runtime/**
      - localstack/services/s3/**
      - localstack/*.py
      - tests/aws/services/s3/**
      - Dockerfile.s3
      - requirements-*.txt
      - setup.cfg
      - Makefile
    branches:
      - master
  pull_request:
    paths:
      - .github/workflows/tests-s3-image.yml
      - localstack/aws/*.py
      - localstack/aws/handlers/*¨
      - localstack/aws/protocol/**
      - localstack/aws/serving/**
      - localstack/aws/api/s3/**
      - localstack/http/**
      - localstack/runtime/**
      - localstack/services/s3/**
      - localstack/*.py
      - tests/aws/services/s3/**
      - Dockerfile.s3
      - requirements-*.txt
      - setup.cfg
      - Makefile
  workflow_dispatch:
    inputs:
      publishDockerImage:
        description: 'Publish S3-only images on Dockerhub'
        required: false
        type: boolean
        default: false
      PYTEST_LOGLEVEL:
        type: choice
        description: Loglevel for PyTest
        options:
        - DEBUG
        - INFO
        - WARNING
        - ERROR
        - CRITICAL
        default: WARNING

# Only one pull-request triggered run should be executed at a time
# (head_ref is only set for PR events, otherwise fallback to run_id which differs for every run).
concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

env:
  # Configure PyTest log level
  PYTEST_LOGLEVEL: "${{ inputs.PYTEST_LOGLEVEL || 'WARNING' }}"
  # Set non-job-specific environment variables for pytest-tinybird
  TINYBIRD_URL: https://api.tinybird.co
  TINYBIRD_DATASOURCE: community_tests_s3_image
  TINYBIRD_TOKEN: ${{ secrets.TINYBIRD_CI_TOKEN }}
  CI_COMMIT_BRANCH: ${{ github.head_ref || github.ref_name }}
  CI_COMMIT_SHA: ${{ github.sha }}
  CI_JOB_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/attempts/${{ github.run_attempt }}
  # report to tinybird if executed on master
  TINYBIRD_PYTEST_ARGS: "${{ github.ref == 'refs/heads/master' && '--report-to-tinybird ' || '' }}"


jobs:
  build-test-s3:
    strategy:
      matrix:
        include:
          - arch: amd64
            runner: ubuntu-latest
          - arch: arm64
            runner: buildjet-2vcpu-ubuntu-2204-arm
    name: "Build and Test S3 image"
    env:
      IMAGE_NAME: "localstack-s3-${{ matrix.arch }}"
      # Set job-specific environment variables for pytest-tinybird
      CI_JOB_NAME: ${{ github.job }}
      CI_JOB_ID: ${{ github.job }}
    runs-on: ${{ matrix.runner }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Login to Docker Hub
        uses: docker/login-action@v3
        # If this is triggered by a pull_request, make sure the PR head repo name is the same as the target repo name
        # (i.e. do not execute job for workflows coming from forks)
        if: >-
          (
            github.event_name != 'pull_request' ||
            github.event.pull_request.head.repo.full_name == github.repository
          )
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_PASSWORD }}

      - name: Build S3 Docker Image
        env:
          PLATFORM: ${{ matrix.arch }}
          DOCKERFILE: "./Dockerfile.s3"
        run: make docker-build

      - name: Run S3 Image tests
        timeout-minutes: 10
        env:
          PYTEST_ARGS: "${{ env.TINYBIRD_PYTEST_ARGS }}-o junit_family=legacy --junitxml=target/pytest-junit-s3-image-${{ matrix.arch }}.xml"
          TEST_PATH: "tests/aws/services/s3"
          DEBUG: 1
        run: |
          mkdir target
          make docker-run-tests-s3-only

      - name: Archive Test Results
        uses: actions/upload-artifact@v4
        if: success() || failure()
        with:
          name: test-results-s3-image-${{ matrix.arch }}
          path: target/pytest-junit-s3-image-${{ matrix.arch }}.xml
          retention-days: 30

      - name: Save the S3 image
        run: docker save ${{ env.IMAGE_NAME }} | gzip > ${{ env.IMAGE_NAME }}.tar.gz

      - name: Store Docker image as artifact
        uses: actions/upload-artifact@v4
        with:
          name: ${{ env.IMAGE_NAME }}
          path: ${{ env.IMAGE_NAME }}.tar.gz
          retention-days: 1

  publish-test-results:
    name: "Publish S3 Image Test Results"
    needs: build-test-s3
    runs-on: ubuntu-latest
    permissions:
      checks: write
      pull-requests: write
      contents: read
      issues: read
    # If this is triggered by a pull_request, make sure the PR head repo name is the same as the target repo name
    # (i.e. do not execute job for workflows coming from forks)
    if: >-
      (success() || failure()) && (
        github.event_name != 'pull_request' ||
        github.event.pull_request.head.repo.full_name == github.repository
      )
    steps:
      - name: Download AMD64 Results
        uses: actions/download-artifact@v4
        with:
          name: test-results-s3-image-amd64

      - name: Download ARM64 Results
        uses: actions/download-artifact@v4
        with:
          name: test-results-s3-image-arm64

      - name: Publish S3 Image Test Results
        uses: EnricoMi/publish-unit-test-result-action@v2
        with:
          files: pytest-junit-*.xml
          check_name: "S3 Image Test Results (AMD64 / ARM64)"
          action_fail_on_inconclusive: true

  push-s3-image:
    name: "Push S3 images and manifest"
    runs-on: ubuntu-latest
    needs:
      - build-test-s3
    if: inputs.publishDockerImage
    env:
      LOCAL_IMAGE_NAME: "localstack-s3"
      DOCKERHUB_IMAGE_NAME: "localstack/localstack:s3-latest"
    steps:
      - name: Login to Docker Hub
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_PASSWORD }}

      - name: Download AMD64 image
        uses: actions/download-artifact@v4
        with:
          name: ${{ env.LOCAL_IMAGE_NAME }}-amd64

      - name: Download ARM64 image
        uses: actions/download-artifact@v4
        with:
          name: ${{ env.LOCAL_IMAGE_NAME }}-arm64

      - name: Load AMD64 image
        run: docker load --input ${{ env.LOCAL_IMAGE_NAME }}-amd64.tar.gz

      - name: Push AMD64 image
        run: |
          docker tag ${{ env.LOCAL_IMAGE_NAME }}-amd64 ${{ env.DOCKERHUB_IMAGE_NAME }}-amd64
          docker push ${{ env.DOCKERHUB_IMAGE_NAME }}-amd64

      - name: Load ARM64 image
        run: docker load --input ${{ env.LOCAL_IMAGE_NAME }}-arm64.tar.gz

      - name: Push ARM64 image
        run: |
          docker tag ${{ env.LOCAL_IMAGE_NAME }}-arm64 ${{ env.DOCKERHUB_IMAGE_NAME }}-arm64
          docker push ${{ env.DOCKERHUB_IMAGE_NAME }}-arm64

      - name: Create and push manifest
        run: |
          docker manifest create ${{ env.DOCKERHUB_IMAGE_NAME }} \
            --amend ${{ env.DOCKERHUB_IMAGE_NAME }}-arm64 \
            --amend ${{ env.DOCKERHUB_IMAGE_NAME }}-amd64
          docker manifest push ${{ env.DOCKERHUB_IMAGE_NAME }}

  cleanup:
    name: "Clean up"
    runs-on: ubuntu-latest
    if: success()
    needs: push-s3-image
    steps:
      - uses: geekyeggo/delete-artifact@v5
        with:
          name: localstack-s3-*
          failOnError: false

  push-to-tinybird:
    if: always() && github.ref == 'refs/heads/master'
    runs-on: ubuntu-latest
    needs: push-s3-image
    steps:
      - name: Push to Tinybird
        uses: localstack/tinybird-workflow-push@v3
        with:
          workflow_id: "tests_s3_image"
          tinybird_token: ${{ secrets.TINYBIRD_CI_TOKEN }}
          github_token: ${{ secrets.GITHUB_TOKEN }}
          tinybird_datasource: "ci_workflows"