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)

When using Xwayland, the GDK_BACKEND can be either x11 or wayland.
For the other two cases the two need to match.

This commit enables 5 new configuration options to build, with
"GTK3 x11 (uses Xvfb)" being the pre-existing one. It is expected
a future commit will start limiting how many of these run for
all PRs.

Part of #2714

Author: jonahgraham

.github/workflows/build.yml

@@ -29,7 +29,41 @@ on:
         required: false
         default: false
       gtk:
-        description: "(Required on Linux only) GTK version to use (one of gtk3, gtk4)"
+        description: |
+          (Required on Linux only) GTK version to use (one of gtk3, gtk4)
+
+          Controls the SWT_GTK4 environemnt variable.
+        type: string
+        required: false
+        default: ""
+      gdk_backend:
+        description: |
+          (Required on Linux only) GDK_BACKEND to use (one of x11, wayland)
+
+          Sets the GDK_BACKEND to x11 or wayland. The compositor has to support
+          the GDK_BACKEND to be useful. For example, setting GDK_BACKEND to
+          x11 and compositor to wayland will lead to no available handles
+          due to no x11 display being available.
+        type: string
+        required: false
+        default: ""
+      compositor:
+        description: |
+          (Required on Linux only) Compositor type to use (one of x11, xwayland, wayland)
+
+          x11: Uses a "pure" x11 compositor with no wayland display running, using Xvfb.
+             This is the most common setup for older linux distros that don't come
+             with wayland, and for some lightweight distro that only have x11.
+          xwayland: Runs weston for Wayland display and Xwayland for x11 display
+             simulatanously. Xwayland provides an x11 display and draws that on
+             the Wayland compositor.
+             This is the most common setup for most current linux distros, as of this
+             writing. Xwayland provides a way for apps that have nor updated to Wayland
+             to continue to run. There are some signs that Xwayland may be removed
+             in future distros.
+          wayland: Uses a "pure" wayland compositor with no x11 display running, using
+             weston.
+             This is likely to be the future default setup of most distros.
         type: string
         required: false
         default: ""
@@ -55,6 +89,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, xwayland-run depends on all the needed packages
+        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 +120,11 @@ jobs:
       env:
         GTK_XCFLAGS: '-Wno-deprecated-declarations'
         SWT_GTK4: "${{ inputs.gtk == 'gtk4' && '1' || '0' }}"
+        GDK_BACKEND: "${{ inputs.gdk_backend }}"
       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 +134,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.gdk_backend == 'wayland') && '-DexcludedGroups=gtk4-todo,gtk4-wayland-todo' || '' }}
+        ${{ (inputs.runtodotests == false && inputs.gtk =='gtk4' && inputs.gdk_backend == 'x11')     && '-DexcludedGroups=gtk4-todo' || '' }}
+        ${{ (inputs.runtodotests == false && inputs.gtk =='gtk3' && inputs.gdk_backend == 'wayland') && '-DexcludedGroups=gtk3-wayland-todo' || '' }}
         clean install
     - name: Performance tests
       if: ${{ inputs.performance }}
       env:
         SWT_GTK4: "${{ inputs.gtk == 'gtk4' && '1' || '0' }}"
+        GDK_BACKEND: "${{ inputs.gdk_backend }}"
       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 +159,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]
+        gdk_backend: [x11, wayland]
+        compositor: [x11, xwayland, wayland]
+        exclude:
+          - gdk_backend: x11
+            compositor: wayland
+          - gdk_backend: wayland
+            compositor: x11
     uses: ./.github/workflows/build.yml
     with:
       runner: ubuntu-latest
       java: ${{ matrix.java }}
       native: gtk.linux.x86_64
       gtk: ${{ matrix.gtk }}
+      gdk_backend: ${{ matrix.gdk_backend }}
+      compositor: ${{ matrix.compositor }}
       performance: ${{ contains(github.event.pull_request.labels.*.name, 'performance') }}
       runtodotests: ${{ contains(github.event.pull_request.labels.*.name, 'runtodotests') }}