1 \input texinfo @c -*- texinfo -*-
3 @settitle FATE Automated Testing Environment
5 @center @titlefont{FATE Automated Testing Environment}
14 FATE provides a regression testsuite embedded within the Libav build system.
15 It can be run locally and optionally configured to send reports to a web
16 aggregator and viewer @url{http://fate.libav.org}.
18 It is advised to run FATE before submitting patches to the current codebase
19 and provide new tests when submitting patches to add additional features.
23 @section Samples and References
24 In order to run, FATE needs a large amount of data (samples and references)
25 that is provided separately from the actual source distribution.
27 To inform the build system about the testsuite location, pass
28 @option{--samples=<path to the samples>} to @command{configure} or set the
29 @var{SAMPLES} Make variable or the @var{FATE_SAMPLES} environment variable
32 The dataset is available through @command{rsync}, is possible to fetch
33 the current sample using the straight rsync command or through a specific
34 @ref{Makefile target}.
37 # rsync -aL rsync://fate-suite.libav.org/fate-suite/ fate-suite
41 # make fate-rsync SAMPLES=fate-suite
46 FATE regression test can be run through @command{make}.
47 Specific Makefile targets and Makefile variables are available:
49 @anchor{Makefile target}
50 @section FATE Makefile targets
53 List all fate/regression test targets.
55 Shortcut to download the fate test samples to the specified testsuite location.
57 Run the FATE test suite (requires the fate-suite dataset).
60 @section Fate Makefile variables
63 Verbosity level, can be set to 0, 1 or 2.
66 show just the test arguments
68 show just the command used in the test
73 Specify or override the path to the FATE samples at make time, it has a
74 meaning only while running the regression tests.
76 Specify how many threads to use while running regression tests, it is
77 quite useful to detect thread-related regressions.
79 Specify a mask to be applied to autodetected CPU flags.
83 make V=1 SAMPLES=/var/fate/samples THREADS=2 CPUFLAGS=mmx fate
86 @chapter Automated Tests
87 In order to automatically testing specific configurations, e.g. multiple
88 compilers, @command{tests/fate.sh} is provided.
90 This shell script builds Libav, runs the regression tests and prepares a
91 report that can be sent to @url{fate.libav.org} or directly examined locally.
93 @section Testing Profiles
94 The configuration file passed to @command{fate.sh} is shell scripts as well.
96 It must provide at least a @var{slot} identifier, the @var{repo} from
97 which fetch the sources, the @var{samples} directory, a @var{workdir} with
98 enough space to build and run all the tests.
99 Optional submit command @var{fate_recv} and a @var{comment} to describe
100 the testing profile are available.
102 Additional optional parameter to tune the Libav building and reporting process
106 slot= # some unique identifier
107 repo=git://git.libav.org/libav.git # the source repository
108 samples=/path/to/fate/samples
109 workdir= # directory in which to do all the work
110 fate_recv="ssh -T fate@@fate.libav.org" # command to submit report
111 comment= # optional description
113 # the following are optional and map to configure options
125 extra_conf= # extra configure options not covered above
127 #make= # name of GNU make if not 'make'
128 makeopts= # extra options passed to 'make'
129 #tar= # command to create a tar archive from its arguments on
130 # stdout, defaults to 'tar c'
133 @section Submitting Reports
134 In order to send reports you need to create an @command{ssh} key and send it
135 to @email{root@@libav.org}.
136 The current server fingerprint is @var{a4:99:d7:d3:1c:92:0d:56:d6:d5:61:be:01:ae:7d:e6}