shorten: Fix invalid free()
[ffmpeg.git] / doc / fate.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle FATE Automated Testing Environment
4 @titlepage
5 @center @titlefont{FATE Automated Testing Environment}
6 @end titlepage
7
8 @node Top
9 @top
10
11 @contents
12
13 @chapter Introduction
14
15   FATE is an extended regression suite on the client-side and a means
16 for results aggregation and presentation on the server-side.
17
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
21 FATE server.
22
23   In any way you can have a look at the publicly viewable FATE results
24 by visiting this website:
25
26   @url{http://fate.ffmpeg.org/}
27
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.
32
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.
37
38   In the third part you can find a comprehensive listing of FATE makefile
39 targets and variables.
40
41
42 @chapter Using FATE from your FFmpeg source directory
43
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:
47
48 @example
49 make fate-rsync SAMPLES=fate-suite/
50 make fate       SAMPLES=fate-suite/
51 @end example
52
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:
59
60 @example
61 ./configure --samples=fate-suite/
62 make fate-rsync
63 make fate
64 @end example
65
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.
71
72 @example
73 FATE_SAMPLES=fate-suite/ make fate
74 @end example
75
76 @float NOTE
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.
79 @end float
80
81
82 @chapter Submitting the results to the FFmpeg result aggregation server
83
84   To submit your results to the server you should run fate through the
85 shell script tests/fate.sh from the FFmpeg sources. This script needs
86 to be invoked with a configuration file as its first argument.
87
88 @example
89 tests/fate.sh /path/to/fate_config
90 @end example
91
92   A configuration file template with comments describing the individual
93 configuration variables can be found at @file{tests/fate_config.sh.template}.
94
95 @ifhtml
96   The mentioned configuration template is also available here:
97 @verbatiminclude ../tests/fate_config.sh.template
98 @end ifhtml
99
100   Create a configuration that suits your needs, based on the configuration
101 template. The `slot' configuration variable can be any string that is not
102 yet used, but it is suggested that you name it adhering to the following
103 pattern <arch>-<os>-<compiler>-<compiler version>. The configuration file
104 itself will be sourced in a shell script, therefore all shell features may
105 be used. This enables you to setup the environment as you need it for your
106 build.
107
108   For your first test runs the `fate_recv' variable should be empty or
109 commented out. This will run everything as normal except that it will omit
110 the submission of the results to the server. The following files should be
111 present in $workdir as specified in the configuration file:
112
113 @itemize
114     @item configure.log
115     @item compile.log
116     @item test.log
117     @item report
118     @item version
119 @end itemize
120
121   When you have everything working properly you can create an SSH key and
122 send its public part to the FATE server administrator.
123
124   Configure your SSH client to use public key authentication with that key
125 when connecting to the FATE server. Also do not forget to check the identity
126 of the server and to accept its host key. This can usually be achieved by
127 running your SSH client manually and killing it after you accepted the key.
128 The FATE server's fingerprint is:
129
130   b1:31:c8:79:3f:04:1d:f8:f2:23:26:5a:fd:55:fa:92
131
132   The only thing left is to automate the execution of the fate.sh script and
133 the synchronisation of the samples directory.
134
135
136 @chapter FATE makefile targets and variables
137
138 @section Makefile targets
139
140 @table @option
141 @item fate-rsync
142     Download/synchronize sample files to the configured samples directory.
143
144 @item fate-list
145     Will list all fate/regression test targets.
146
147 @item fate
148     Run the FATE test suite (requires the fate-suite dataset).
149 @end table
150
151 @section Makefile variables
152
153 @table @option
154 @item V
155     Verbosity level, can be set to 0, 1 or 2.
156     @itemize
157         @item 0: show just the test arguments
158         @item 1: show just the command used in the test
159         @item 2: show everything
160     @end itemize
161
162 @item SAMPLES
163     Specify or override the path to the FATE samples at make time, it has a
164     meaning only while running the regression tests.
165
166 @item THREADS
167     Specify how many threads to use while running regression tests, it is
168     quite useful to detect thread-related regressions.
169 @end table
170
171 Example:
172 @example
173 make V=1 SAMPLES=/var/fate/samples THREADS=2 fate
174 @end example