e2e-main.yaml

#
# Copyright (C) 2025 Red Hat, Inc.
#
# 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
#
# http://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.
#
# SPDX-License-Identifier: Apache-2.0

name: e2e-tests-main

on:
  workflow_run:
    workflows: ["CI"]
    types:
      - completed
  workflow_dispatch:
    inputs:
      organization:
        default: 'redhat-developer'
        description: 'Organization of the Developer Sandbox repository'
        type: string
        required: true
      repositoryName:
        default: 'podman-desktop-sandbox-ext'
        description: 'Podman Desktop Developer Sandbox Extension repository name'
        type: string
        required: true
      branch:
        default: 'main'
        description: Developer Sandbox repo branch'
        type: string
        required: true
      mode:
        description: 'Build mode for Podman Desktop'
        type: choice
        options:
          - production

jobs:
  e2e-tests:
    name: Developer Sandbox Extension E2E tests
    runs-on: ubuntu-24.04
    env: 
      MODE: ${{ inputs.mode || 'production' }}
      REPO: ${{ inputs.repositoryName || 'podman-desktop-sandbox-ext' }}
      ORGANIZATION: ${{ inputs.organization || 'redhat-developer' }}
      BRANCH: ${{ inputs.branch || 'main' }}
    steps:
      - uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98 # v6.0.1
        if: github.event_name == 'workflow_dispatch' || github.event_name == 'workflow_run'
        with:
          repository: ${{ env.ORGANIZATION }}/${{ env.REPO }}
          ref: ${{ env.BRANCH }}
          path: ${{ env.REPO }}

      - uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98 # v6.0.1
        if: github.event_name == 'push'
        with: 
          path: podman-desktop-sandbox-ext

      - name: Setup default repository name
        env: 
          EVENT: ${{ github.event_name }}
        run: |
          repository=podman-desktop-sandbox-ext
          if [[ "$EVENT" == 'workflow_dispatch' || "$EVENT" == 'workflow_run' ]]; then
            repository=${{ env.REPO }}
          fi
          echo "REPOSITORY=$repository" >> $GITHUB_ENV

      # Checkout podman desktop
      - uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98 # v6.0.1
        with:
          repository: podman-desktop/podman-desktop
          ref: main
          path: podman-desktop

      - uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v4.1.0
        name: Install pnpm
        with:
          run_install: false
          package_json_file: ./podman-desktop/package.json

      - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.0.0
        with:
          node-version: 24

      - name: Update podman v. 5.x
        run: |
          echo "ubuntu version from kubic repository to install podman we need (v5)"
          ubuntu_version='23.10'
          echo "Add unstable kubic repo into list of available sources and get the repo key"
          sudo sh -c "echo 'deb https://download.opensuse.org/repositories/devel:/kubic:/libcontainers:/unstable/xUbuntu_${ubuntu_version}/ /' > /etc/apt/sources.list.d/devel:kubic:libcontainers:unstable.list"
          curl -L "https://download.opensuse.org/repositories/devel:/kubic:/libcontainers:/unstable/xUbuntu_${ubuntu_version}/Release.key" | sudo apt-key add -
          echo "Updating database of packages..."
          sudo apt-get update -qq
          echo "install necessary dependencies for criu package which is not part of ${ubuntu_version}"
          sudo apt-get install -qq libprotobuf32t64 python3-protobuf libnet1
          echo "install criu manually from static location"
          curl -sLO http://archive.ubuntu.com/ubuntu/pool/universe/c/criu/criu_3.16.1-2_amd64.deb && sudo dpkg -i criu_3.16.1-2_amd64.deb
          echo "installing/update podman package..."
          sudo apt-get -qq -y install podman || { echo "Start fallback steps for podman nightly installation from a static mirror" && \
            sudo sh -c "echo 'deb http://ftp.lysator.liu.se/pub/opensuse/repositories/devel:/kubic:/libcontainers:/unstable/xUbuntu_${ubuntu_version}/ /' > /etc/apt/sources.list.d/devel:kubic:libcontainers:unstable.list" && \
            curl -L "http://ftp.lysator.liu.se/pub/opensuse/repositories/devel:/kubic:/libcontainers:/unstable/xUbuntu_${ubuntu_version}/Release.key" | sudo apt-key add - && \
            sudo apt-get update && \
            sudo apt-get -y install podman; }
          podman version

      - name: Set default browser desktop app and handlers
        run: |
          xdg-settings set default-web-browser firefox.desktop
          xdg-mime default firefox.desktop x-scheme-handler/https
          xdg-mime default firefox.desktop x-scheme-handler/http
          xvfb-run xdg-open 'https://developers.redhat.com/articles/faqs-no-cost-red-hat-enterprise-linux#general' & sleep 5; pkill Xvfb

      # Install dbus-x11 package to allow dbus session for user for particular display (xvfb-maybe used in e2e test)
      # for reference, similar issue: https://github.com/actions/runner-images/issues/12127
      - name: Install dbus-x11 package
        run: sudo apt-get install dbus-x11

      - name: Revert unprivileged user namespace restrictions in Ubuntu 24.04
        run: |
          # allow unprivileged user namespace
          sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0

      - name: Set Chromium policy for Podman Desktop app redirection from browser
        run: |
          echo '{"URLAllowlist": ["podman-desktop:*"]}' > url_allow_list.json
          sudo mkdir -p /etc/chromium/policies/managed
          sudo cp url_allow_list.json /etc/chromium/policies/managed/url_allow_list.json

      - name: Build Podman Desktop for E2E tests Production Mode
        working-directory: ./podman-desktop
        if: ${{ env.MODE == 'production' }} 
        env:
          ELECTRON_ENABLE_INSPECT: true
        run: |
          pnpm install --frozen-lockfile
          pnpm compile:current --linux dir
          path=$(realpath ./dist/linux-unpacked/podman-desktop)
          echo "Podman Desktop built binary: $path"
          echo "PODMAN_DESKTOP_BINARY_PATH=$path" >> $GITHUB_ENV

      - name: Execute pnpm in Developer Sandbox Extension
        working-directory: ${{ env.REPOSITORY }}
        run: |
          # workaround for https://github.com/containers/podman-desktop-extension-bootc/issues/712
          version=$(npm view @podman-desktop/tests-playwright@next version)
          echo "Version of @podman-desktop/tests-playwright to be used: $version"
          jq --arg version "$version" '.devDependencies."@podman-desktop/tests-playwright" = $version' package.json > package.json_tmp && mv package.json_tmp package.json
          pnpm install --no-frozen-lockfile

      - name: Run All E2E tests in Developer Sandbox Extension in Production mode
        working-directory: ${{ env.REPOSITORY }}
        if: ${{ env.MODE == 'production' }}
        env:
          PODMAN_DESKTOP_BINARY: ${{ env.PODMAN_DESKTOP_BINARY_PATH }}
          DVLPR_USERNAME: ${{ secrets.DVLPR_USERNAME }}
          DVLPR_PASSWORD: ${{ secrets.DVLPR_PASSWORD }}
          AUTH_E2E_TESTS: true
        run: |
          export $(dbus-launch)
          pnpm test:e2e

      - name: Publish Test Report
        uses: mikepenz/action-junit-report@49b2ca06f62aa7ef83ae6769a2179271e160d8e4 # v6.3.1
        if: always() # always run even if the previous step fails
        with:
          fail_on_failure: true
          include_passed: true
          annotate_only: true
          detailed_summary: true
          require_tests:  true
          report_paths: '**/*results.xml'

      - name: Upload test artifacts
        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
        if: always()
        with:
          name: e2e-tests
          path: ./**/tests/**/output/