xserver-multidpi/test
Gaetan Nadon 6a5bf15fa9 Add generalized unit test support using util-macros.
A handful of modules have begun adding unit test programs.
These macros will help providing a consistent interface which will
help package builders and developers to manage the functionality.

XORG_ENABLE_UNIT_TESTS will turn on/off unit testing, regardless
of how it is implemented. The default (yes/no) can be specified by each
module. It can be used by itself if glib or -wrap support is not needed.

XORG_WITH_GLIB will probe the system for glib-2.0. A different version
can be specified in each module. It will consult XORG_ENABLE_UNIT_TESTS
but can be used by itself in contexts other then unit testing.
The default (yes/no) can be specified by each module.

XORG_LD_WRAP will probe the linker for -wrap support. It will consult
XORG_ENABLE_UNIT_TESTS but can be used by itself in contexts
other then unit testing.

configure options:
  --enable-unit-tests     Enable building unit test cases (default: auto)
  --with-glib             Use GLib library for unit testing (default: auto)

Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Keith Packard <keithp@keithp.com>
2011-03-18 11:36:19 -07:00
..
xi2 Add generalized unit test support using util-macros. 2011-03-18 11:36:19 -07:00
.gitignore Ignore build products in the server's test suite. 2010-05-26 11:17:53 -07:00
input.c Merge branch 'mi-cleanup' into next 2011-02-23 08:44:42 +10:00
list.c test: add some tests for basic list manipulation. 2011-03-14 13:25:06 -04:00
Makefile.am Add generalized unit test support using util-macros. 2011-03-18 11:36:19 -07:00
README Add a test-suite for in-server unit-testing. 2009-04-28 16:03:56 +10:00
xkb.c Add a test-suite for in-server unit-testing. 2009-04-28 16:03:56 +10:00
xtest.c If XTest is always required, then eliminate the XTest devPrivate 2010-06-07 19:56:47 -07:00

                        X server test suite

This suite contains a set of tests to verify the behaviour of functions used
internally to the server. This test suite is based on glib's testing
framework [1].

= How it works =
Through some automake abuse, we link the test programs with the same static
libraries as the Xorg binary. The test suites can then call various functions
and verify their behaviour - without the need to start the server or connect
clients.

This testing only works for functions that do not rely on a particular state
of the X server. Unless the test suite replicates the expected state, which
may be difficult.

= How to run the tests =
Run "make check" the test directory. This will compile the tests and execute
them in the order specified in the TESTS variable in test/Makefile.am.

Each set of tests related to a subsystem are available as a binary that can be
executed directly. For example, run "xkb" to perform some xkb-related tests.

== Adding a new test ==
When adding a new test, ensure that you add a short description of what the
test does and what the expected outcome is. If the test reproduces a
particular bug, using g_test_bug().

== Misc ==

The programs "gtester" and "gtester-report" may be used to generate XML/HTML
log files of tests succeeded and failed.

---------

[1] http://library.gnome.org/devel/glib/stable/glib-Testing.html