xref: /OK3568_Linux_fs/external/xserver/test/README (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun                        X server test suite
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunThis suite contains a set of tests to verify the behaviour of functions used
4*4882a593Smuzhiyuninternally to the server.
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun= How it works =
7*4882a593SmuzhiyunThrough some automake abuse, we link the test programs with the same static
8*4882a593Smuzhiyunlibraries as the Xorg binary. The test suites can then call various functions
9*4882a593Smuzhiyunand verify their behaviour - without the need to start the server or connect
10*4882a593Smuzhiyunclients.
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunThis testing only works for functions that do not rely on a particular state
13*4882a593Smuzhiyunof the X server. Unless the test suite replicates the expected state, which
14*4882a593Smuzhiyunmay be difficult.
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun= How to run the tests =
17*4882a593SmuzhiyunRun "make check" in the test directory. This will compile the tests and execute
18*4882a593Smuzhiyunthem in the order specified in the TESTS variable in test/Makefile.am.
19*4882a593Smuzhiyun
20*4882a593SmuzhiyunEach set of tests related to a subsystem are available as a binary that can be
21*4882a593Smuzhiyunexecuted directly. For example, run "xkb" to perform some xkb-related tests.
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun== Adding a new test ==
24*4882a593SmuzhiyunWhen adding a new test, ensure that you add a short description of what the
25*4882a593Smuzhiyuntest does and what the expected outcome is.
26