test-e2e.yml

# Copyright 2024 The Ground Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
name: End to End Test

on:
  workflow_dispatch:
  workflow_call:
    secrets:
      MAPS_API_KEY:
        required: true

permissions:
  contents: read

jobs:
  request-approval:
    runs-on: ubuntu-latest
    environment: e2e-approval
    steps:
      - run: echo "Approval granted"

  instrumentation-matrix:
    name: API ${{ matrix.api-level }}
    needs: request-approval
    runs-on: ubuntu-latest
    timeout-minutes: 30
    strategy:
      fail-fast: false
      matrix:
        include:
          - api-level: 30
            required: true
          - api-level: 24
            required: false
    continue-on-error: ${{ !matrix.required }}
    env:
      FIREBASE_CLI_EXPERIMENTS: webframeworks

    # See docs/e2e-testing-doc.md for details on how this is setup
    steps:
      - name: Setup JDK 21 for Firebase emulator
        uses: actions/setup-java@b843ebf9b913146b38da2eaa7aeddf76074ae1ad # v6.1.0
        with:
          distribution: 'temurin'
          java-version: 21

      - name: Start Firebase emulator
        uses: google/ground-platform/.github/actions/start-emulator@b1eeccf9af27205206e0ec7b87ceaf6d7264f4ba
        with:
          platform-repository: google/ground-platform

      - name: Checkout PR
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Run Android tests on e2eTest module
        uses: ./.github/actions/submit-test
        with:
          android-repository: google/ground-android
          upload-artifacts: true
          google-maps-key: ${{ secrets.MAPS_API_KEY }}
          api-level: ${{ matrix.api-level }}

  run-instrumentation-tests:
    needs: instrumentation-matrix
    if: always()
    runs-on: ubuntu-latest
    steps:
      - name: Check matrix results
        run: |
          if [ "${{ needs.instrumentation-matrix.result }}" != "success" ]; then
            echo "Required instrumentation tests failed"
            exit 1
          fi