Add Wayland to build matrix on GitHub actions

Add a compositor type build matrix entry for wayland, xwayland and x11.

There are a total of 6 combinations possible of GTK/compositor:

- GTK3 x11 (uses Xvfb)
- GTK3 Xwayland (uses xwayland under weston headless)
- GTK3 wayland (uses weston headless)
- GTK4 x11 (uses Xvfb)
- GTK4 Xwayland (uses xwayland under weston headless)
- GTK4 wayland (uses weston headless)

The most common use case is the current users who are GTK3 on x11,
possibly with xwayland under wayland compositor (e.g. KWin, mutter), or
using X directly with Xorg and xfwm4 or some other one. Traditionally
we have tested this use case with Xvfb which provides similar result.

For GTK4 the primary focus is Wayland with no X server involved.

Therefore, of the 6 possible combinations I have enabled only:

- GTK3 x11 (uses Xvfb)
- GTK4 wayland (uses weston headless)

Part of #2714

Author: jonahgraham

.github/workflows/build.yml

@@ -33,6 +33,11 @@ on:
         type: string
         required: false
         default: ""
+      compositor:
+        description: "(Required on Linux only) Compositor type to use (one of x11, xwayland, wayland)"
+        type: string
+        required: false
+        default: ""
 
 jobs:
   build:
@@ -55,6 +60,8 @@ jobs:
         sudo apt-get install -qq -y libgtk-3-dev freeglut3-dev webkit2gtk-driver
         # GTK4 dependencies
         sudo apt-get install -qq -y libgtk-4-dev freeglut3-dev libwebkitgtk-6.0-4
+        # Wayland runtimes
+        sudo apt-get install -qq -y xwayland-run
 
     - name: Disable AppArmor when testing WebKit on GTK4
       if: ${{ inputs.native == 'gtk.linux.x86_64' && inputs.gtk == 'gtk4' }}
@@ -84,8 +91,11 @@ jobs:
       env:
         GTK_XCFLAGS: '-Wno-deprecated-declarations'
         SWT_GTK4: "${{ inputs.gtk == 'gtk4' && '1' || '0' }}"
+        GDK_BACKEND: "${{ inputs.compositor == 'wayland' && 'wayland' || 'x11' }}"
       run: >-
-        ${{ contains(inputs.native, 'linux') && 'xvfb-run' || '' }}
+        ${{ inputs.compositor == 'x11' && 'xvfb-run' || '' }}
+        ${{ inputs.compositor == 'wayland' && 'wlheadless-run --width 1920 --height 1080 -- ' || '' }}
+        ${{ inputs.compositor == 'xwayland' && 'wlheadless-run --width 1920 --height 1080 -- xwayland-run -geometry 1920x1080  -- ' || '' }}
         mvn --batch-mode -V -U -e
         --threads 1C
         -DforkCount=1
@@ -95,15 +105,20 @@ jobs:
         --fail-at-end
         -DskipNativeTests=false
         -DfailIfNoTests=false
-        ${{ (inputs.runtodotests == false && inputs.gtk == 'gtk4') && '-DexcludedGroups=gtk4-todo' || '' }}
+        ${{ (inputs.runtodotests == false && inputs.gtk =='gtk4' && inputs.compositor == 'wayland') && '-DexcludedGroups=gtk4-todo,gtk4-wayland-todo' || '' }}
+        ${{ (inputs.runtodotests == false && inputs.gtk =='gtk3' && inputs.compositor == 'wayland') && '-DexcludedGroups=gtk3-wayland-todo' || '' }}
+        ${{ (inputs.runtodotests == false && inputs.gtk =='gtk4' && inputs.compositor != 'wayland') && '-DexcludedGroups=gtk4-todo' || '' }}
         clean install
     - name: Performance tests
       if: ${{ inputs.performance }}
       env:
         SWT_GTK4: "${{ inputs.gtk == 'gtk4' && '1' || '0' }}"
+        GDK_BACKEND: "${{ inputs.compositor == 'wayland' && 'wayland' || 'x11' }}"
       working-directory: tests/org.eclipse.swt.tests
       run: >-
-        ${{ contains(inputs.native, 'linux') && 'xvfb-run' || '' }}
+        ${{ inputs.compositor == 'x11' && 'xvfb-run' || '' }}
+        ${{ inputs.compositor == 'wayland' && 'wlheadless-run --width 1920 --height 1080 -- ' || '' }}
+        ${{ inputs.compositor == 'xwayland' && 'wlheadless-run --width 1920 --height 1080 -- xwayland-run -geometry 1920x1080  -- ' || '' }}
         mvn --batch-mode -V -U -e
         -DforkCount=1
         --fail-at-end
@@ -115,7 +130,7 @@ jobs:
       if: always()
       uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
       with:
-        name: test-results-${{ inputs.native }}-${{ inputs.gtk }}-java${{ inputs.java }}
+        name: test-results-${{ inputs.native }}-${{ inputs.gtk }}-${{ inputs.compositor }}-java${{ inputs.java }}
         if-no-files-found: warn
         path: |
           ${{ github.workspace }}/**/target/surefire-reports/*.xml

.github/workflows/maven.yml

@@ -86,12 +86,21 @@ jobs:
       matrix:
         java: ['21']
         gtk: [gtk3, gtk4]
+        compositor: [x11, xwayland, wayland]
+        exclude:
+          # run gtk3 on x11 only and gtk4 on wayland only
+          - gtk: gtk3
+            compositor: wayland
+          - gtk: gtk4
+            compositor: x11
+          - compositor: xwayland # xwayland doesn't seem to add much over x11 on xvfb
     uses: ./.github/workflows/build.yml
     with:
       runner: ubuntu-latest
       java: ${{ matrix.java }}
       native: gtk.linux.x86_64
       gtk: ${{ matrix.gtk }}
+      compositor: ${{ matrix.compositor }}
       performance: ${{ contains(github.event.pull_request.labels.*.name, 'performance') }}
       runtodotests: ${{ contains(github.event.pull_request.labels.*.name, 'runtodotests') }}