kwin/doc/TESTING.md

0001 # Testing in KWin
0002 KWin provides a unit and integration test suite for X11 and Wayland. The source code for the tests can be found in the subdirectory autotests. The test suite should be run prior to any merge to KWin.
0003
0004 # Dependencies
0005 The following additional software needs to be installed for running the test suite:
0006
0007 * Xvfb
0008 * Xephyr
0009 * glxgears
0010 * DMZ-white cursor theme
0011 * breeze window decoration
0012
0013 # Preparing OpenGL
0014 Some of the tests require OpenGL. The test suite is implemented against Mesa and uses the Mesa specific EGL extension
0015 EGL_MESA_platform_surfaceless. This extension supports rendering without any real GPU using llvmpipe as software
0016 emulation. This gives the tests a stable base removing variance introduced by different hardware and drivers.
0017
0018 Users of non-Mesa drivers (e.g. proprietary NVIDIA driver) need to ensure that Mesa is also installed. If your system
0019 uses libglvnd this should work out of the box, if not you might need to tune LD_LIBRARY_PATH.
0020
0021 # Running the test suite
0022 The test suite can be run from the build directory. Best is to do:
0023
0024     cd path/to/build/directory
0025     xvfb-run ctest
0026
0027 # Running individual tests
0028 All tests executables are created in the directory "bin" in the build directory. Each test can be executed by just starting it from within the test directory. To prevent side effects with the running session it is recommended to start a dedicated dbus session:
0029
0030     cd path/to/build/directory/bin
0031     dbus-run-session ./testFoo
0032
0033 For tests relying on X11 one should also either start a dedicated Xvfb and export DISPLAY or use xvfb-run as described above.