annotate test/automated/README @ 3754:09d4fa3a787a gsoc2009_unit_tests

Added README.
author Edgar Simo <bobbens@gmail.com>
date Thu, 06 Aug 2009 16:58:24 +0000
parents
children e04d9c69a6fd
rev   line source
3754
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
1
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
2
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
3 SDL Automated Testing Framework User Documentation
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
4 by Edgar Simo Serra
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
5
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
6
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
7
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
8 Abstract
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
9
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
10 The SDL Automated Testing Framework, hereby after called SDL_AT, is a meant
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
11 to test the SDL code for regressions and other possible failures. It can also
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
12 be used to display what your SDL set up supports.
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
13
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
14
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
15
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
16 Basics
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
17
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
18 The main way to use the framework is to compile it and run it, that can be
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
19 done with the following command:
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
20
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
21 $> make test
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
22
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
23 It should then display something like:
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
24
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
25 Platform : All tests successful (2)
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
26 SDL_RWops : All tests successful (5)
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
27 SDL_Surface : All tests successful (6)
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
28 Rendering with x11 driver : All tests successful (4)
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
29
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
30 Indicating that all tests were successful. If however a test fails output it
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
31 will report the failure to stderr indicating where and why it happened. This
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
32 output can then be sent to the developers so they can attempt to fix the
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
33 problem.
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
34
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
35
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
36
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
37 Advanced
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
38
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
39 Usage: ./testsdl [OPTIONS]
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
40 Options are:
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
41 -m, --manual enables tests that require user interaction
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
42 --noplatform do not run the platform tests
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
43 --norwops do not run the rwops tests
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
44 --nosurface do not run the surface tests
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
45 --norender do not run the render tests
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
46 -v, --verbose increases verbosity level by 1 for each -v
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
47 -q, --quiet only displays errors
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
48 -h, --help display this message and exit
09d4fa3a787a Added README.
Edgar Simo <bobbens@gmail.com>
parents:
diff changeset
49