e2e_tests.yml

name: "🎳 End2end"
on:
  pull_request:
    types: [ labeled, opened, synchronize, reopened ]
    branches:
      - master
      - release_3_*
  workflow_dispatch:
  repository_dispatch:
    types: [ run-e2e-branches ]

jobs:
  end2end:
    # The first condition is triggered when we set the new label
    # The second one when we update the PR with new commits without changing labels
    # The third one when external workflow
    # The fourth one is for the manual button
    if: |
      github.event.label.name == 'run end2end' ||
      contains(github.event.pull_request.labels.*.name, 'run end2end') ||
      github.event_name == 'repository_dispatch' ||
      github.event_name == 'workflow_dispatch'
    name: "End-to-end"
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: tests
    env:
      CYPRESS_CI: TRUE
      PLAYWRIGHT_FORCE_TTY: true
      PLAYWRIGHT_LIST_PRINT_STEPS: true
      FORCE_COLOR: true
      # For testing only
      # PHP_VERSION: 8.3
      # LZMPOSTGISVERSION: 16-3
      # LZMQGSRVVERSION: 3.34

    steps:

#      - name: Debug
#        working-directory: .
#        run: |
#            echo ${{ github.event.pull_request.head.sha }}
#            echo ${{ github.head_ref }}
#            echo ${{ github.ref_name }}

      - name: Define branch name from env for the checkout
        working-directory: .
        run: |
          if ${{ github.event_name == 'repository_dispatch' }}
          then
            # repository_dispatch is from an external workflow, for instance a cron workflow
            echo "Set branch from manual input: ${{ github.event.client_payload.branch }}"
            BRANCH="${{ github.event.client_payload.branch }}"
          elif ${{ github.event_name == 'workflow_dispatch' }}
          then
            # workflow_dispatch is the the button in UI
            echo "Set branch from default value: ${{ github.ref }}"
            BRANCH="${{ github.ref }}"
          else
            # From a PR
            echo "Event type ${{ github.event_name }}"
            echo "Set branch from default value : ${{ github.event.pull_request.head.sha }} "
            BRANCH="${{ github.event.pull_request.head.sha }}"
          fi
          echo "BRANCH=${BRANCH}" >> $GITHUB_ENV

      - name: Checkout
        uses: actions/checkout@v4
        with:
          ref: ${{ env.BRANCH }}
          token: ${{ secrets.BOT_HUB_TOKEN || github.token  }}  # Important to launch CI on a commit from a bot

      - name: Branch name
        run: echo running on branch ${GITHUB_REF##*/} with CYPRESS = ${CYPRESS_CI}

      - name: Make environment and show Lizmap versions
        run: |
          make env
          cat .env

      - name: Read environment file and set variables
        uses: cosq-network/dotenv-loader@v1.0.2
        with:
          # Somehow, the working-directory is not taken into account
          env-file: tests/.env

       # For testing only
#      - name: Update projects
#        run: |
#          make upgrade-projects
#          git status

      - name: Install QGIS server plugins
        run: make build-plugins

      - name: Show QGIS server environment
        run: |
          make show-qgis-server-versions

      - name: Pull docker images
        run: ./run-docker pull

      - name: Build and start docker images
        run: ./run-docker up --build -d

      - name: Wait 30 secondes for docker images to be ready
        run: |
          sleep 30

      - name: Install Lizmap
        run: |
          ./lizmap-ctl install

      - name: Wait and check about QGIS Server status
        run: |
          curl \
            --user 'admin:admin' \
            --retry 30 \
            --retry-delay 5 \
            -N \
            "http://localhost:8130/index.php/view/app/metadata" \
            -o /tmp/test-qgis-server.json
          cat /tmp/test-qgis-server.json | jq .qgis_server_info
          qgis_info=$(cat /tmp/test-qgis-server.json | jq --raw-output '.qgis_server_info.error')
          echo $qgis_info
          if [[ "$qgis_info" != "null" ]]; then
              echo "QGIS Server is not well configured"
              echo "::warning QGIS Server was not up"
          else
              echo "JSON metadata OK about QGIS Server"
          fi

      - name: Check about updated files after a build (PHP or JS)
        run: |
          if [[ -z $(git status --porcelain -uno) ]]; then
              echo "No updated files"
          else
              echo "Updated files"
              git status
              echo "::warning Git status is not clean"
          fi

      - name: Load SQL data
        run: |
          cd qgis-projects/tests
          ./load_sql.sh

      - name: Add hosts to /etc/hosts
        run: |
            sudo echo "127.0.0.1 othersite.local" | sudo tee -a /etc/hosts

      # Playwright
      - uses: actions/setup-node@v4
        with:
          node-version: 21

      - name: Install dependencies
        run: |
          cd end2end
          npm ci

      - name: Install Playwright
        run: |
          cd end2end
          npx playwright install --with-deps chromium

      - name: Run Playwright tests read-only
        id: test-playwright-read-only
        run: |
          cd end2end
          npx playwright test --grep @readonly --project=end2end

      - name: Run Playwright tests not tagged read-only
        id: test-playwright-not-read-only
        if: success() || steps.test-playwright-not-read-only.conclusion == 'failure'
        run: |
          cd end2end
          npx playwright test --workers 1 --grep-invert @readonly --project=end2end

#      - name: Generate PG dump from Playwright
#        if: failure()
#        run: |
#          ./lizmap-ctl dump-pgsql
#
#      - name: Check the database diff from Playwright
#        if: failure()
#        run: |
#          git diff qgis-projects/tests/tests_dataset.sql
#          git restore qgis-projects/tests/tests_dataset.sql

      - name: Notify in case of playwright failure, from mainstream branches only
        uses: peter-evans/commit-comment@v3
        if: github.repository == '3liz/lizmap-web-client' && failure() && steps.test-playwright.outcome != 'success' && github.event_name == 'repository_dispatch'
        with:
          token: ${{ secrets.BOT_HUB_TOKEN }}
          body: |
            The latest **weekly** run of end2end "playwright" tests failed with this latest commit on the branch **${{ env.BRANCH }}** 😣

            CC @nboisteault and @Gustry, please have a look to the logs. Maybe it's a false positive ?

            Visit ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}

      - name: Upload test results
        if: failure()
        uses: actions/upload-artifact@v4.5.0
        with:
          name: playwright-report
          path: tests/end2end/playwright-report

      # Install NPM dependencies, cache them correctly
      # and run all Cypress tests
      - name: Cypress run
        id: test-cypress
        # Always run, even if playwright has failed
        if: success() || steps.test-playwright-not-read-only.conclusion == 'failure' || steps.test-playwright-not-read-only.conclusion == 'failure'
        uses: cypress-io/github-action@v6.7.8
        with:
          browser: chrome
          headed: true
          working-directory: tests/end2end
          spec: cypress/integration/*-ghaction.js
          wait-on: http://localhost:8130

      - name: Export some logs to files
        if: always()
        run: |
          mkdir -p /tmp/e2e/lwc
          mkdir -p /tmp/e2e/docker
          docker logs lizmap${{ env.LZMBRANCH }}_test_qgis &> /tmp/e2e/docker/qgis-server.log | true
          docker logs lizmap${{ env.LZMBRANCH }}_test_php &> /tmp/e2e/docker/php.log | true
          docker logs lizmap${{ env.LZMBRANCH }}_test_nginx &> /tmp/e2e/docker/nginx.log | true
          cp -r ../lizmap/var/log /tmp/e2e/lwc/

      - name: Upload all logs as artifact
        uses: actions/upload-artifact@v4.5.0
        if: always()
        with:
          name: E2E-all-logs
          path: |
            /tmp/e2e/

      - name: Notify in case of cypress failure, from mainstream branches only
        uses: peter-evans/commit-comment@v3
        if: github.repository == '3liz/lizmap-web-client' && failure() && steps.test-cypress.outcome != 'success' && github.event_name == 'repository_dispatch'
        with:
          token: ${{ secrets.BOT_HUB_TOKEN }}
          body: |
            The latest **weekly** run of end2end "cypress" tests failed with this latest commit on the branch **${{ env.BRANCH }}** 😣

            CC @nboisteault and @Gustry, please have a look to the logs. Maybe it's a false positive ?

            Visit ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}

      - name: Save screenshots as artifacts if a test fails to ease debug
        uses: actions/upload-artifact@v4.5.0
        if: failure()
        with:
          name: cypress-screenshots
          path: |
            tests/end2end/cypress/screenshots
            tests/end2end/cypress/downloads

#      - name: Generate PG dump from Cypress
#        if: failure()
#        run: |
#          ./lizmap-ctl dump-pgsql
#
#      - name: Check the database diff from Cypress
#        if: failure()
#        run: |
#          git diff qgis-projects/tests/tests_dataset.sql
#          git restore qgis-projects/tests/tests_dataset.sql

#          [[ -z $(git status --porcelain -uno) ]]
#          exit $?

#  debug:
#    name: "Debug"
#    runs-on: ubuntu-latest
#    steps:
#      - name: Dump GitHub context
#        env:
#          GITHUB_CONTEXT: ${{ toJson(github) }}
#        run: |
#          echo "$GITHUB_CONTEXT"