1 \input texinfo @c -*- texinfo -*-
3 @settitle FFmpeg Automated Testing Environment
5 @center @titlefont{FFmpeg Automated Testing Environment}
15 FATE is an extended regression suite on the client-side and a means
16 for results aggregation and presentation on the server-side.
18 The first part of this document explains how you can use FATE from
19 your FFmpeg source directory to test your ffmpeg binary. The second
20 part describes how you can run FATE to submit the results to FFmpeg's
23 In any way you can have a look at the publicly viewable FATE results
24 by visiting this website:
26 @url{http://fate.ffmpeg.org/}
28 This is especially recommended for all people contributing source
29 code to FFmpeg, as it can be seen if some test on some platform broke
30 with there recent contribution. This usually happens on the platforms
31 the developers could not test on.
33 The second part of this document describes how you can run FATE to
34 submit your results to FFmpeg's FATE server. If you want to submit your
35 results be sure to check that your combination of CPU, OS and compiler
36 is not already listed on the above mentioned website.
38 In the third part you can find a comprehensive listing of FATE makefile
39 targets and variables.
42 @chapter Using FATE from your FFmpeg source directory
44 If you want to run FATE on your machine you need to have the samples
45 in place. You can get the samples via the build target fate-rsync.
46 Use this command from the top-level source directory:
49 make fate-rsync SAMPLES=fate-suite/
50 make fate SAMPLES=fate-suite/
53 The above commands set the samples location by passing a makefile
54 variable via command line. It is also possible to set the samples
55 location at source configuration time by invoking configure with
56 `--samples=<path to the samples directory>'. Afterwards you can
57 invoke the makefile targets without setting the SAMPLES makefile
58 variable. This is illustrated by the following commands:
61 ./configure --samples=fate-suite/
66 Yet another way to tell FATE about the location of the sample
67 directory is by making sure the environment variable FATE_SAMPLES
68 contains the path to your samples directory. This can be achieved
69 by e.g. putting that variable in your shell profile or by setting
70 it in your interactive session.
73 FATE_SAMPLES=fate-suite/ make fate
77 Do not put a '~' character in the samples path to indicate a home
78 directory. Because of shell nuances, this will cause FATE to fail.
81 To use a custom wrapper to run the test, pass @option{--target-exec} to
82 @command{configure} or set the @var{TARGET_EXEC} Make variable.
85 @chapter Submitting the results to the FFmpeg result aggregation server
87 To submit your results to the server you should run fate through the
88 shell script tests/fate.sh from the FFmpeg sources. This script needs
89 to be invoked with a configuration file as its first argument.
92 tests/fate.sh /path/to/fate_config
95 A configuration file template with comments describing the individual
96 configuration variables can be found at @file{tests/fate_config.sh.template}.
99 The mentioned configuration template is also available here:
100 @verbatiminclude ../tests/fate_config.sh.template
103 Create a configuration that suits your needs, based on the configuration
104 template. The `slot' configuration variable can be any string that is not
105 yet used, but it is suggested that you name it adhering to the following
106 pattern <arch>-<os>-<compiler>-<compiler version>. The configuration file
107 itself will be sourced in a shell script, therefore all shell features may
108 be used. This enables you to setup the environment as you need it for your
111 For your first test runs the `fate_recv' variable should be empty or
112 commented out. This will run everything as normal except that it will omit
113 the submission of the results to the server. The following files should be
114 present in $workdir as specified in the configuration file:
124 When you have everything working properly you can create an SSH key and
125 send its public part to the FATE server administrator who can be contacted
126 at the email address @email{fate-admin@@ffmpeg.org}.
128 Configure your SSH client to use public key authentication with that key
129 when connecting to the FATE server. Also do not forget to check the identity
130 of the server and to accept its host key. This can usually be achieved by
131 running your SSH client manually and killing it after you accepted the key.
132 The FATE server's fingerprint is:
134 b1:31:c8:79:3f:04:1d:f8:f2:23:26:5a:fd:55:fa:92
136 The only thing left is to automate the execution of the fate.sh script and
137 the synchronisation of the samples directory.
140 @chapter FATE makefile targets and variables
142 @section Makefile targets
146 Download/synchronize sample files to the configured samples directory.
149 Will list all fate/regression test targets.
152 Run the FATE test suite (requires the fate-suite dataset).
155 @section Makefile variables
159 Verbosity level, can be set to 0, 1 or 2.
161 @item 0: show just the test arguments
162 @item 1: show just the command used in the test
163 @item 2: show everything
167 Specify or override the path to the FATE samples at make time, it has a
168 meaning only while running the regression tests.
171 Specify how many threads to use while running regression tests, it is
172 quite useful to detect thread-related regressions.
174 Specify which threading strategy test, either @var{slice} or @var{frame},
175 by default @var{slice+frame}
179 Specify or override the wrapper used to run the tests.
180 The @var{TARGET_EXEC} option provides a way to run FATE wrapped in
181 @command{valgrind}, @command{qemu-user} or @command{wine} or on remote targets
182 through @command{ssh}.
187 make V=1 SAMPLES=/var/fate/samples THREADS=2 CPUFLAGS=mmx fate