How to test Mir for a release¶

The following document details the criteria that must be met before we can publish an official release of Mir. When adding to this test plan, please do not fail to consider how your additions may be automated in the future, as this is the end goal of our release testing.

Note that all of these tests must be run after a release branch is created in the Mir repository, such that the repository is updated beforehand.

Setup¶

We will run the test plan on the miral-app test compositor.

Install mir from the release candidate PPA

sudo add-apt-repository --update ppa:mir-team/rc
sudo apt install mir-demos mir-platform-graphics-virtual mir-graphics-drivers-desktop mir-test-tools

Confirm that you can run miral-app

Testing each graphics platform¶

Each test must be performed across a combination of different display platforms and Ubuntu releases. The following matrix provides the environments in which we need to test:

	24.04	24.10
gbm-kms
eglstream-kms
eglstream-kms + gbm-kms hybrid
x11
wayland
virtual

To check which display platform we’ve selected, we can run miral-app and grep for the platform string as follows:

miral-app | grep "Selected display driver:"

Given the types of outputs that you have configured in your environment, you should encounter one of the following scenarios for each output:

When NOT on an Nvidia platform and NOT in a hosted environment, then mir:gbm-kms is selected
When you have an Nvidia card connected to an output and the system is using Nvidia’s proprietary drivers, then mir:eglstream-kms is selected
When you are running the compositor hosted in a session that supports X11, then mir:x11 is selected
When you are running the compositor hosted in a session that supports wayland and you force Mir to use the mir:wayland platform using:
```
miral-app --wayland-host=$WAYLAND_DISPLAY
```
then mir:wayland is selected.

Check that the virtual platform can run and you can connect to it via a VNC:

MIR_SERVER_PLATFORM_DISPLAY_LIBS=mir:virtual MIR_SERVER_VIRTUAL_OUTPUT=1280x1024 WAYLAND_DISPLAY=wayland-1 miral-app \
    --add-wayland-extension=zwp_virtual_keyboard_manager_v1:zwlr_virtual_pointer_manager_v1:zwlr_screencopy_manager_v1

After, in a separate VT, connect to the VNC:

WAYLAND_DISPLAY=wayland-1 ubuntu-frame-vnc

Then, check that you can connect via a VNC viewer:

gvncviewer localhost

The smoke tests¶

These verify our demo clients work with mir_demo_server and should be run for each platform on each of the ubuntu series (see previous section).

Decide which platform that you want to run the smoke tests on (e.g. gbm-kms, virtual, X11, etc.)
Run mir-smoke-test-runner like so:
```
MIR_SERVER_PLATFORM_DISPLAY_LIBS=<YOUR_PLATFORM> mir-smoke-test-runner
```
For example, if I wanted to run the tests on the virtual platform, I would run:
```
MIR_SERVER_PLATFORM_DISPLAY_LIBS=mir:virtual MIR_SERVER_VIRTUAL_OUTPUT=1280x1024 mir-smoke-test-runner
```
(Note that you do not have to connect via VNC for the smoke tests to run with the virtual platform.)
Confirm that the final output of the test is: Smoke testing complete with returncode 0.

Applications¶

For each empty box in the matrix above, ensure that the following applications can start

Test that the following QT Wayland applications can be started and can receive input:

sudo apt install qtwayland5 kate qterminal

# First...
kate

# Then...
qterminal

Test that weston-terminal can be started and can receive input:
```
sudo apt install weston
weston
```

Test that glmark2-wayland can be run:

sudo apt install glmark2-wayland
glmark2-wayland

(If using gbm-kms on a system with multiple GPUs) Test hybrid support with glmark2-wayland
```
sudo apt install glmark2-wayland
glmark2-wayland
DRI_PRIME=0 glmark2-wayland
DRI_PRIME=1 glmark2-wayland
```
(If more than 2 GPUs, may do DRI_PRIME=2 glmark2-wayland, etc)
Test that gnome-terminal can be started and can receive input:
```
sudo apt install gnome-terminal
gnome-terminal
```

Test that X11 apps can be started and can receive input:

sudo apt install x11-apps

# first,
xeyes

# then
xedit

# finally
xcalc

Mir Console Providers¶

For each Ubuntu release ensure that the compositor can start with each of the console providers:

	24.04	24.10
vt
logind
minimal

The following describes how to select each console provider:

vt:
```
miral-app --console-provider=vt --vt=4
```
- This requires running with root privileges
- You need to ensure that XDG_RUNTIME_DIR is set in the environment. If using sudo, it might strip this out; running something like sudo env XDG_RUNTIME_DIR=/run/user/1000 miral-shell ... will ensure this is set.
logind:
```
miral-app --console-provider=logind
```
- You can switch to vt4 and sign in
minimal:
```
miral-app --console-provider=minimal 
```
- This is used when all others fail
- This does not provide VT switching capabilities (Ctrl-Alt-F1, etc)
- This is only used for the gbm-x11, gbm-wayland, and virtual platforms

Window Manager Examples¶

Run with different window managers and confirm that the window management styles work as expected:

miral-app --window-manager=floating # traditional floating window manager
miral-app --window-manager=tiling # a tiling window manager
miral-app -kiosk # a typical kiosk

Testing Downstream Snaps (e.g. Ubuntu Frame and Miriway)¶

For each of our downstream snaps, check that you have installed a build with the Mir version under test (typically from the beta channel). Then run the tests for that snap.

E.g. for mir-test-tools:

   /snap/mir-test-tools/current/bin/selftest