e2e.yml

name: E2E

on:
  workflow_call:

env:
  TZ: UTC
  OC_ENV: ci
  NODE_ENV: test
  WEBSITE_URL: http://localhost:3000
  IMAGES_URL: http://localhost:3001
  PDF_SERVICE_URL: http://localhost:3002
  API_URL: http://localhost:3060
  API_KEY: dvl-1510egmf4a23d80342403fb599qd
  CI: true

  E2E_TEST: 1
  PGHOST: localhost
  PGUSER: postgres
  CYPRESS_RECORD: false
  CYPRESS_VIDEO: false
  CYPRESS_VIDEO_UPLOAD_ON_PASSES: false
  CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
  GITHUB_CLIENT_ID: ${{ secrets.GH_CLIENT_ID }}
  GITHUB_CLIENT_SECRET: ${{ secrets.GH_CLIENT_SECRET }}
  FRONTEND_FOLDER: /home/runner/work/opencollective-frontend/opencollective-frontend
  API_FOLDER: /home/runner/work/opencollective-frontend/opencollective-frontend/opencollective-api
  IMAGES_FOLDER: /home/runner/work/opencollective-frontend/opencollective-frontend/opencollective-images
  PDF_FOLDER: /home/runner/work/opencollective-frontend/opencollective-frontend/opencollective-pdf
  TERM: xterm
  STRIPE_WEBHOOK_KEY: ${{ secrets.STRIPE_WEBHOOK_KEY }}
  STRIPE_WEBHOOK_SIGNING_SECRET: ${{ secrets.STRIPE_WEBHOOK_SIGNING_SECRET }}
  AWS_KEY: ${{ secrets.AWS_KEY }}
  AWS_SECRET: ${{ secrets.AWS_SECRET }}

jobs:
  e2e:
    if: github.ref_name != 'i18n/crowdin'

    runs-on: ubuntu-24.04

    timeout-minutes: 30

    strategy:
      fail-fast: false
      matrix:
        files: ['0*.js', '1*.js', '2*.js', '3*.js', '4*.js']

    services:
      redis:
        image: redis
        ports:
          - 6379:6379
        options: --entrypoint redis-server
      postgres:
        image: postgres:15.10
        env:
          POSTGRES_USER: postgres
          POSTGRES_DB: postgres
          POSTGRES_HOST_AUTH_METHOD: trust
        ports:
          - 5432:5432
        # needed because the postgres container does not provide a healthcheck
        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5

    steps:
      - name: Update apt
        run: sudo apt-get update || exit 0

      - name: Install dependencies
        run: |
          sudo apt-get install \
          `# Cypress dependencies - see https://docs.cypress.io/app/get-started/install-cypress#UbuntuDebian` \
          libgtk2.0-0t64 libgtk-3-0t64 libgbm-dev libnotify-dev libnss3 libxss1 libasound2t64 libxtst6 xauth xvfb \
          `# Postgres client` \
          postgresql-client-16 \
          `# GraphicsMagick (not sure if needed)` \
          graphicsmagick

      - name: Install stripe-cli
        run: |
          sudo apt-get install -y wget
          wget https://github.com/stripe/stripe-cli/releases/download/v1.13.9/stripe_1.13.9_linux_x86_64.tar.gz -O /tmp/stripe_1.13.9_linux_x86_64.tar.gz
          sudo tar xzvf /tmp/stripe_1.13.9_linux_x86_64.tar.gz -C /bin/

      - name: Checkout (frontend)
        uses: actions/checkout@v4

      - name: Setup node
        uses: actions/setup-node@v4
        with:
          node-version-file: 'package.json'
          cache: 'npm'

      # Checkouts

      - name: Set REF in env, removing the `refs/` part
        run: |
          echo "MATCHING_BRANCH_REF=${GITHUB_HEAD_REF-${GITHUB_REF##*/}}" >> $GITHUB_ENV

      - name: Check matching branch (api)
        id: check-matching-branch
        uses: octokit/request-action@v2.x
        with:
          route: GET /repos/{owner}/{repo}/git/ref/{ref}
          owner: opencollective
          repo: opencollective-api
          ref: heads/${{ env.MATCHING_BRANCH_REF }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        continue-on-error: true

      - name: Checkout (api - matching branch)
        if: steps.check-matching-branch.outputs.status == 200
        uses: actions/checkout@v4
        with:
          repository: opencollective/opencollective-api
          path: opencollective-api
          ref: ${{ env.MATCHING_BRANCH_REF }}

      - name: Checkout (api - main)
        if: steps.check-matching-branch.outputs.status != 200
        uses: actions/checkout@v4
        with:
          repository: opencollective/opencollective-api
          path: opencollective-api

      - name: Checkout (images)
        uses: actions/checkout@v4
        with:
          repository: opencollective/opencollective-images
          path: opencollective-images

      - name: Checkout (PDF)
        uses: actions/checkout@v4
        with:
          repository: opencollective/opencollective-pdf
          path: opencollective-pdf

      # Prepare API

      - name: Restore node_modules (api)
        uses: actions/cache@v4
        id: api-node-modules
        with:
          path: opencollective-api/node_modules
          key: ${{ runner.os }}-api-node-modules-${{ hashFiles('opencollective-api/package-lock.json') }}

      - name: Install dependencies (api)
        working-directory: opencollective-api
        if: steps.api-node-modules.outputs.cache-hit != 'true'
        run: npm ci --prefer-offline --no-audit

      - name: Build (api)
        working-directory: opencollective-api
        run: npm run build

      # Prepare Images

      - name: Restore node_modules (images)
        uses: actions/cache@v4
        id: images-node-modules
        with:
          path: opencollective-images/node_modules
          key: ${{ runner.os }}-images-node-modules-${{ hashFiles('opencollective-images/package-lock.json') }}

      - name: Install dependencies (images)
        working-directory: opencollective-images
        if: steps.images-node-modules.outputs.cache-hit != 'true'
        run: npm ci --prefer-offline --no-audit

      - name: Build (images)
        working-directory: opencollective-images
        run: npm run build

      # Prepare PDF

      - name: Restore node_modules (pdf)
        uses: actions/cache@v4
        id: pdf-node-modules
        with:
          path: opencollective-pdf/node_modules
          key: ${{ runner.os }}-pdf-node-modules-${{ hashFiles('opencollective-pdf/package-lock.json') }}

      - name: Install dependencies (pdf)
        working-directory: opencollective-pdf
        if: steps.pdf-node-modules.outputs.cache-hit != 'true'
        run: npm ci --prefer-offline --no-audit

      - name: Build (pdf)
        working-directory: opencollective-pdf
        run: npm run build

      # Prepare Frontend

      - name: Restore node_modules (frontend)
        uses: actions/cache@v4
        id: node-modules
        with:
          path: node_modules
          key: ${{ runner.os }}-node-modules-${{ hashFiles('package-lock.json') }}-${{ secrets.CACHE_VERSION }}

      - name: Install dependencies (frontend)
        if: steps.node-modules.outputs.cache-hit != 'true'
        run: CYPRESS_INSTALL_BINARY=0 npm ci --prefer-offline --no-audit

      - name: Restore Cypress
        uses: actions/cache@v4
        id: cypress
        with:
          path: ~/.cache/Cypress
          key: ${{ runner.os }}-cypress-${{ hashFiles('node_modules/cypress/package.json') }}

      - name: Install Cypress
        if: steps.cypress.outputs.cache-hit != 'true'
        run: npx cypress install

      - name: Restore .next build (frontend)
        uses: actions/cache@v4
        id: next-build
        with:
          path: .next
          key: ${{ runner.os }}-next-build-${{ github.sha }}

      - name: Build (frontend)
        if: steps.next-build.outputs.cache-hit != 'true'
        run: npm run build

      # Seed DB

      - name: Setup DB
        run: ./scripts/setup_db.sh

      # Run tests

      - name: Run E2E with Cypress
        run: ./scripts/run_e2e_tests.sh
        env:
          CYPRESS_TEST_FILES: ${{ matrix.files }}

      - name: Archive test recordings
        uses: actions/upload-artifact@v4
        with:
          name: cypress-recordings-${{ github.run_id }}-${{ strategy.job-index }}
          path: |
            test/cypress/screenshots
            test/cypress/videos
        if: ${{ failure() }}

      - name: Archive download folder
        uses: actions/upload-artifact@v4
        with:
          name: downloads-${{ github.run_id }}-${{ strategy.job-index }}
          path: test/cypress/downloads
        if: ${{ failure() }}

      - name: Report coverage
        uses: codecov/codecov-action@v4
        with:
          token: ${{ secrets.CODECOV_TOKEN }}