README
1 X server test suite
2
3This suite contains a set of tests to verify the behaviour of functions used
4internally to the server.
5
6= How it works =
7Through some automake abuse, we link the test programs with the same static
8libraries as the Xorg binary. The test suites can then call various functions
9and verify their behaviour - without the need to start the server or connect
10clients.
11
12This testing only works for functions that do not rely on a particular state
13of the X server. Unless the test suite replicates the expected state, which
14may be difficult.
15
16= How to run the tests =
17Run "make check" in the test directory. This will compile the tests and execute
18them in the order specified in the TESTS variable in test/Makefile.am.
19
20Each set of tests related to a subsystem are available as a binary that can be
21executed directly. For example, run "xkb" to perform some xkb-related tests.
22
23== Adding a new test ==
24When adding a new test, ensure that you add a short description of what the
25test does and what the expected outcome is.
26