fate.texi 8.12 KB
Newer Older
1
\input texinfo @c -*- texinfo -*-
2
@documentencoding UTF-8
3

4
@settitle FFmpeg Automated Testing Environment
5
@titlepage
6
@center @titlefont{FFmpeg Automated Testing Environment}
7 8
@end titlepage

9
@node Top
10 11 12 13 14 15
@top

@contents

@chapter Introduction

16
FATE is an extended regression suite on the client-side and a means
17
for results aggregation and presentation on the server-side.
18

19
The first part of this document explains how you can use FATE from
20 21 22
your FFmpeg source directory to test your ffmpeg binary. The second
part describes how you can run FATE to submit the results to FFmpeg's
FATE server.
23

24
In any way you can have a look at the publicly viewable FATE results
25
by visiting this website:
26

27
@url{http://fate.ffmpeg.org/}
28

29
This is especially recommended for all people contributing source
30
code to FFmpeg, as it can be seen if some test on some platform broke
31
with their recent contribution. This usually happens on the platforms
32
the developers could not test on.
33

34
The second part of this document describes how you can run FATE to
35 36 37 38
submit your results to FFmpeg's FATE server. If you want to submit your
results be sure to check that your combination of CPU, OS and compiler
is not already listed on the above mentioned website.

39
In the third part you can find a comprehensive listing of FATE makefile
40 41 42 43 44
targets and variables.


@chapter Using FATE from your FFmpeg source directory

45
If you want to run FATE on your machine you need to have the samples
46 47 48 49 50 51 52 53
in place. You can get the samples via the build target fate-rsync.
Use this command from the top-level source directory:

@example
make fate-rsync SAMPLES=fate-suite/
make fate       SAMPLES=fate-suite/
@end example

54
The above commands set the samples location by passing a makefile
55 56
variable via command line. It is also possible to set the samples
location at source configuration time by invoking configure with
57 58
@option{--samples=<path to the samples directory>}. Afterwards you can
invoke the makefile targets without setting the @var{SAMPLES} makefile
59
variable. This is illustrated by the following commands:
60 61

@example
62 63 64
./configure --samples=fate-suite/
make fate-rsync
make fate
65 66
@end example

67
Yet another way to tell FATE about the location of the sample
68 69 70 71 72
directory is by making sure the environment variable FATE_SAMPLES
contains the path to your samples directory. This can be achieved
by e.g. putting that variable in your shell profile or by setting
it in your interactive session.

73
@example
74
FATE_SAMPLES=fate-suite/ make fate
75 76
@end example

77 78 79 80 81
@float NOTE
Do not put a '~' character in the samples path to indicate a home
directory. Because of shell nuances, this will cause FATE to fail.
@end float

82 83 84
To use a custom wrapper to run the test, pass @option{--target-exec} to
@command{configure} or set the @var{TARGET_EXEC} Make variable.

85 86 87

@chapter Submitting the results to the FFmpeg result aggregation server

88
To submit your results to the server you should run fate through the
89
shell script @file{tests/fate.sh} from the FFmpeg sources. This script needs
90 91 92 93 94 95
to be invoked with a configuration file as its first argument.

@example
tests/fate.sh /path/to/fate_config
@end example

96
A configuration file template with comments describing the individual
97
configuration variables can be found at @file{doc/fate_config.sh.template}.
98 99

@ifhtml
100
The mentioned configuration template is also available here:
101
@verbatiminclude fate_config.sh.template
102 103
@end ifhtml

104 105
Create a configuration that suits your needs, based on the configuration
template. The @env{slot} configuration variable can be any string that is not
106
yet used, but it is suggested that you name it adhering to the following
107 108 109 110
pattern @samp{@var{arch}-@var{os}-@var{compiler}-@var{compiler version}}. The
configuration file itself will be sourced in a shell script, therefore all
shell features may be used. This enables you to setup the environment as you
need it for your build.
111

112
For your first test runs the @env{fate_recv} variable should be empty or
113 114 115 116 117 118 119 120 121 122 123 124
commented out. This will run everything as normal except that it will omit
the submission of the results to the server. The following files should be
present in $workdir as specified in the configuration file:

@itemize
    @item configure.log
    @item compile.log
    @item test.log
    @item report
    @item version
@end itemize

125
When you have everything working properly you can create an SSH key pair
126
and send the public key to the FATE server administrator who can be contacted
127
at the email address @email{fate-admin@@ffmpeg.org}.
128

129
Configure your SSH client to use public key authentication with that key
130 131 132 133 134
when connecting to the FATE server. Also do not forget to check the identity
of the server and to accept its host key. This can usually be achieved by
running your SSH client manually and killing it after you accepted the key.
The FATE server's fingerprint is:

135
@table @samp
136 137 138 139 140
@item RSA
   d3:f1:83:97:a4:75:2b:a6:fb:d6:e8:aa:81:93:97:51
@item ECDSA
   76:9f:68:32:04:1e:d5:d4:ec:47:3f:dc:fc:18:17:86
@end table
141

142
If you have problems connecting to the FATE server, it may help to try out
143 144 145 146
the @command{ssh} command with one or more @option{-v} options. You should
get detailed output concerning your SSH configuration and the authentication
process.

147
The only thing left is to automate the execution of the fate.sh script and
148 149
the synchronisation of the samples directory.

150 151
@chapter Uploading new samples to the fate suite

152 153
If you need a sample uploaded send a mail to samples-request.

154 155 156 157 158 159
This is for developers who have an account on the fate suite server.
If you upload new samples, please make sure they are as small as possible,
space on each client, network bandwidth and so on benefit from smaller test cases.
Also keep in mind older checkouts use existing sample files, that means in
practice generally do not replace, remove or overwrite files as it likely would
break older checkouts or releases.
160 161
Also all needed samples for a commit should be uploaded, ideally 24
hours, before the push.
162 163
If you need an account for frequently uploading samples or you wish to help
others by doing that send a mail to ffmpeg-devel.
164 165 166 167 168 169 170 171 172 173 174 175

@example
#First update your local samples copy:
rsync -vauL --chmod=Dg+s,Duo+x,ug+rw,o+r,o-w,+X fate-suite.ffmpeg.org:/home/samples/fate-suite/ ~/fate-suite

#Then do a dry run checking what would be uploaded:
rsync -vanL --no-g --chmod=Dg+s,Duo+x,ug+rw,o+r,o-w,+X ~/fate-suite/ fate-suite.ffmpeg.org:/home/samples/fate-suite

#Upload the files:
rsync -vaL  --no-g --chmod=Dg+s,Duo+x,ug+rw,o+r,o-w,+X ~/fate-suite/ fate-suite.ffmpeg.org:/home/samples/fate-suite
@end example

176 177 178 179

@chapter FATE makefile targets and variables

@section Makefile targets
180 181 182

@table @option
@item fate-rsync
183
Download/synchronize sample files to the configured samples directory.
184 185

@item fate-list
186
Will list all fate/regression test targets.
187

188 189 190 191
@item fate
Run the FATE test suite (requires the fate-suite dataset).
@end table

192 193
@section Makefile variables

194
@table @env
195 196
@item V
Verbosity level, can be set to 0, 1 or 2.
197 198 199 200 201 202
    @itemize
        @item 0: show just the test arguments
        @item 1: show just the command used in the test
        @item 2: show everything
    @end itemize

203 204 205
@item SAMPLES
Specify or override the path to the FATE samples at make time, it has a
meaning only while running the regression tests.
206

207 208 209
@item THREADS
Specify how many threads to use while running regression tests, it is
quite useful to detect thread-related regressions.
210

211
@item THREAD_TYPE
212 213
Specify which threading strategy test, either @samp{slice} or @samp{frame},
by default @samp{slice+frame}
214

215
@item CPUFLAGS
216
Specify CPU flags.
217

218 219
@item TARGET_EXEC
Specify or override the wrapper used to run the tests.
220
The @env{TARGET_EXEC} option provides a way to run FATE wrapped in
221 222
@command{valgrind}, @command{qemu-user} or @command{wine} or on remote targets
through @command{ssh}.
223

224
@item GEN
225
Set to @samp{1} to generate the missing or mismatched references.
226 227 228

@item HWACCEL
Specify which hardware acceleration to use while running regression tests,
229
by default @samp{none} is used.
230

231 232 233 234 235
@item KEEP
Set to @samp{1} to keep temp files generated by fate test(s) when test is successful.
Default is @samp{0}, which removes these files. Files are always kept when a test
fails.

236 237
@end table

238 239
@section Examples

240
@example
241
make V=1 SAMPLES=/var/fate/samples THREADS=2 CPUFLAGS=mmx fate
242
@end example