kwin/TESTING.md

# Testing in KWin
KWin provides a unit and integration test suit 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.

# Dependencies
The following additional software needs to be installed for running the test suite:

* Xvfb
* Xephyr
* glxgears
* DMZ-white cursor theme
* breeze window decoration

# Preparing a run of the test suite
In case your system does not support the EGL extension EGL_MESA_platform_surfaceless,
please load the kernel module "vgem". This is required to provide a virtual OpenGL device.

    sudo modprobe vgem

Furthermore the user executing the test suite must be able to read and write to the dri device created by vgem.

# Running the test suite
The test suite can be run from the build directory. Best is to do:

    cd path/to/build/directory
    xvfb-run ctest

# Running individual tests
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:

    cd path/to/build/directory/bin
    dbus-run-session ./testFoo

For tests relying on X11 one should also either start a dedicated Xvfb and export DISPLAY or use xvfb-run as described above.
Add a TESTING.md document describing how to run the unit test suite Reviewers: #kwin Subscribers: kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D16777 2018-11-09 12:51:08 +00:00			`# Testing in KWin`
			`KWin provides a unit and integration test suit 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.`

			`# Dependencies`
			`The following additional software needs to be installed for running the test suite:`

			`* Xvfb`
			`* Xephyr`
			`* glxgears`
			`* DMZ-white cursor theme`
			`* breeze window decoration`

			`# Preparing a run of the test suite`
[platforms/virtual] Add support for EGL_MESA_platform_surfaceless Summary: Thus we don't require vgem any more which fails with latest mesa. Kepping the vgem variant as fallback for older systems. See T10245 Test Plan: SceneOpenGL Test passes without init vgem, not tested with latest mesa Reviewers: #kwin Subscribers: kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D17980 2019-01-05 09:45:26 +00:00			`In case your system does not support the EGL extension EGL_MESA_platform_surfaceless,`
			`please load the kernel module "vgem". This is required to provide a virtual OpenGL device.`
Add a TESTING.md document describing how to run the unit test suite Reviewers: #kwin Subscribers: kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D16777 2018-11-09 12:51:08 +00:00
			`sudo modprobe vgem`

			`Furthermore the user executing the test suite must be able to read and write to the dri device created by vgem.`

			`# Running the test suite`
			`The test suite can be run from the build directory. Best is to do:`

			`cd path/to/build/directory`
			`xvfb-run ctest`

			`# Running individual tests`
			`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:`

			`cd path/to/build/directory/bin`
			`dbus-run-session ./testFoo`

			`For tests relying on X11 one should also either start a dedicated Xvfb and export DISPLAY or use xvfb-run as described above.`