e2e-functional.yml

name: Electron Playwright Tests

on:
  pull_request:
    types: [labeled]
  workflow_dispatch:
    inputs:
      version_name:
        type: string
        description: "Desktop Version. It can be a branch name or a tag or a commit SHA"
        required: true
      instance_details:
        type: string
        description: "JSON array of platform details"
        required: false
      MM_TEST_USER_NAME:
        description: "The admin username of the test instance"
        required: false
        type: string
      MM_TEST_PASSWORD:
        description: "The admin password of the test instance"
        required: false
        type: string
      MM_SERVER_VERSION:
        type: string
        description: "The server version to test against"
        required: true

jobs:
  update-initial-status-linux:
    runs-on: ubuntu-22.04
    steps:
      - uses: mattermost/actions/delivery/update-commit-status@main
        env:
          GITHUB_TOKEN: ${{ github.token }}
        with:
          repository_full_name: ${{ github.repository }}
          commit_sha: ${{ github.event.pull_request.head.sha }}
          context: e2e/linux
          description: E2E tests for Mattermost desktop app on Linux have started...
          status: pending

  update-initial-status-macos:
    runs-on: ubuntu-22.04
    steps:
      - uses: mattermost/actions/delivery/update-commit-status@main
        env:
          GITHUB_TOKEN: ${{ github.token }}
        with:
          repository_full_name: ${{ github.repository }}
          commit_sha: ${{ github.event.pull_request.head.sha }}
          context: e2e/macOS
          description: E2E tests for Mattermost desktop app on macOS have started...
          status: pending

  update-initial-status-windows:
    runs-on: ubuntu-22.04
    steps:
      - uses: mattermost/actions/delivery/update-commit-status@main
        env:
          GITHUB_TOKEN: ${{ github.token }}
        with:
          repository_full_name: ${{ github.repository }}
          commit_sha: ${{ github.event.pull_request.head.sha }}
          context: e2e/windows
          description: E2E tests for Mattermost desktop app on Windows have started...
          status: pending

  prepare-matrix:
    if: ${{ github.event_name == 'workflow_dispatch' && inputs.instance_details != '' }}
    runs-on: ubuntu-latest
    outputs:
      platforms: ${{ steps.generate.outputs.platforms }}
    steps:
      - id: generate
        run: |
          echo "platforms=$(echo '${{ inputs.instance_details }}' | jq -c)" >> $GITHUB_OUTPUT

  e2e-tests:
    needs: prepare-matrix
    strategy:
      matrix:
        include: ${{ fromJson(needs.prepare-matrix.outputs.platforms) }}
      fail-fast: false
    uses: ./.github/workflows/e2e-functional-template.yml
    with:
      runs-on: ${{ matrix.runner }}
      DESKTOP_VERSION: ${{ inputs.version_name }}
      MM_TEST_SERVER_URL: ${{ matrix.url }}
      MM_SERVER_VERSION: ${{ inputs.MM_SERVER_VERSION }}
      MM_TEST_USER_NAME: ${{ inputs.MM_TEST_USER_NAME }}
      MM_TEST_PASSWORD: ${{ inputs.MM_TEST_PASSWORD }}
    secrets: inherit

  update-final-status-linux:
    runs-on: ubuntu-22.04
    needs:
      - e2e-tests
    steps:
      - uses: mattermost/actions/delivery/update-commit-status@main
        env:
          GITHUB_TOKEN: ${{ github.token }}
        with:
          repository_full_name: ${{ github.repository }}
          commit_sha: ${{ github.event.pull_request.head.sha }}
          context: e2e/linux
          description: Completed with ${{ needs.e2e-tests.outputs.NEW_FAILURES_LINUX }} failures
          status: ${{ needs.e2e-tests.outputs.STATUS_LINUX }}
          target_url: ${{ needs.e2e-tests.outputs.REPORT_LINK_LINUX }}

  update-final-status-macos:
    runs-on: ubuntu-22.04
    needs:
      - e2e-tests
    steps:
      - uses: mattermost/actions/delivery/update-commit-status@main
        env:
          GITHUB_TOKEN: ${{ github.token }}
        with:
          repository_full_name: ${{ github.repository }}
          commit_sha: ${{ github.event.pull_request.head.sha }}
          context: e2e/macOS
          description: Completed with ${{ needs.e2e-tests.outputs.NEW_FAILURES_MACOS }} failures
          status: ${{ needs.e2e-tests.outputs.STATUS_MACOS }}
          target_url: ${{ needs.e2e-tests.outputs.REPORT_LINK_MACOS }}

  update-final-status-windows:
    runs-on: ubuntu-22.04
    needs:
      - e2e-tests
    steps:
      - uses: mattermost/actions/delivery/update-commit-status@main
        env:
          GITHUB_TOKEN: ${{ github.token }}
        with:
          repository_full_name: ${{ github.repository }}
          commit_sha: ${{ github.event.pull_request.head.sha }}
          context: e2e/windows
          description: Completed with ${{ needs.e2e-tests.outputs.NEW_FAILURES_WINDOWS }} failures
          status: ${{ needs.e2e-tests.outputs.STATUS_WINDOWS }}
          target_url: ${{ needs.e2e-tests.outputs.REPORT_LINK_WINDOWS }}

  e2e-remove-label:
    if: ${{ always() && contains(github.event.pull_request.labels.*.name, 'E2E/Run') }}
    needs: e2e-tests
    runs-on: ubuntu-22.04
    steps:
      - name: Remove E2E test label
        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
        continue-on-error: true # Label might have been removed manually
        with:
          script: |
            github.rest.issues.removeLabel({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              name: 'E2E/Run',
            });