gitadmin
/
tuoheng_airport_stream_discard_20240715
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
11 Commits
3 Branches
Tree: 2f57369d6f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '2f57369d6f'
${ noResults }
tuoheng_airport_stream_disc.../ffmpeg/doc/fate.html

346 lines
15KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

  2. <html>

  3. <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->

  4.   <head>

  5.     <meta charset="utf-8">

  6.     <title>

  7.       FFmpeg Automated Testing Environment

  8.     </title>

  9.     <meta name="viewport" content="width=device-width,initial-scale=1.0">

  10.     <link rel="stylesheet" type="text/css" href="bootstrap.min.css">

  11.     <link rel="stylesheet" type="text/css" href="style.min.css">

  12.   </head>

  13.   <body>

  14.     <div class="container">

  15.       <h1>

  16.       FFmpeg Automated Testing Environment

  17.       </h1>

  18. <div align="center">

  19. </div>

  20. 

  21. 

  22. <a name="Top"></a>

  23. <a name="SEC_Top"></a>

  24. 

  25. <div class="Contents_element" id="SEC_Contents">

  26. <h2 class="contents-heading">Table of Contents</h2>

  27. 

  28. <div class="contents">

  29. 

  30. <ul class="no-bullet">

  31.   <li><a id="toc-Introduction" href="#Introduction">1 Introduction</a></li>

  32.   <li><a id="toc-Using-FATE-from-your-FFmpeg-source-directory" href="#Using-FATE-from-your-FFmpeg-source-directory">2 Using FATE from your FFmpeg source directory</a></li>

  33.   <li><a id="toc-Submitting-the-results-to-the-FFmpeg-result-aggregation-server" href="#Submitting-the-results-to-the-FFmpeg-result-aggregation-server">3 Submitting the results to the FFmpeg result aggregation server</a></li>

  34.   <li><a id="toc-Uploading-new-samples-to-the-fate-suite" href="#Uploading-new-samples-to-the-fate-suite">4 Uploading new samples to the fate suite</a></li>

  35.   <li><a id="toc-FATE-makefile-targets-and-variables" href="#FATE-makefile-targets-and-variables">5 FATE makefile targets and variables</a>

  36.   <ul class="no-bullet">

  37.     <li><a id="toc-Makefile-targets" href="#Makefile-targets">5.1 Makefile targets</a></li>

  38.     <li><a id="toc-Makefile-variables" href="#Makefile-variables">5.2 Makefile variables</a></li>

  39.     <li><a id="toc-Examples" href="#Examples">5.3 Examples</a></li>

  40.   </ul></li>

  41. </ul>

  42. </div>

  43. </div>

  44. 

  45. <a name="Introduction"></a>

  46. <h2 class="chapter">1 Introduction<span class="pull-right"><a class="anchor hidden-xs" href="#Introduction" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Introduction" aria-hidden="true">TOC</a></span></h2>

  47. 

  48. <p>FATE is an extended regression suite on the client-side and a means

  49. for results aggregation and presentation on the server-side.

  50. </p>

  51. <p>The first part of this document explains how you can use FATE from

  52. your FFmpeg source directory to test your ffmpeg binary. The second

  53. part describes how you can run FATE to submit the results to FFmpeg&rsquo;s

  54. FATE server.

  55. </p>

  56. <p>In any way you can have a look at the publicly viewable FATE results

  57. by visiting this website:

  58. </p>

  59. <p><a href="http://fate.ffmpeg.org/">http://fate.ffmpeg.org/</a>

  60. </p>

  61. <p>This is especially recommended for all people contributing source

  62. code to FFmpeg, as it can be seen if some test on some platform broke

  63. with their recent contribution. This usually happens on the platforms

  64. the developers could not test on.

  65. </p>

  66. <p>The second part of this document describes how you can run FATE to

  67. submit your results to FFmpeg&rsquo;s FATE server. If you want to submit your

  68. results be sure to check that your combination of CPU, OS and compiler

  69. is not already listed on the above mentioned website.

  70. </p>

  71. <p>In the third part you can find a comprehensive listing of FATE makefile

  72. targets and variables.

  73. </p>

  74. 

  75. <a name="Using-FATE-from-your-FFmpeg-source-directory"></a>

  76. <h2 class="chapter">2 Using FATE from your FFmpeg source directory<span class="pull-right"><a class="anchor hidden-xs" href="#Using-FATE-from-your-FFmpeg-source-directory" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Using-FATE-from-your-FFmpeg-source-directory" aria-hidden="true">TOC</a></span></h2>

  77. 

  78. <p>If you want to run FATE on your machine you need to have the samples

  79. in place. You can get the samples via the build target fate-rsync.

  80. Use this command from the top-level source directory:

  81. </p>

  82. <div class="example">

  83. <pre class="example">make fate-rsync SAMPLES=fate-suite/

  84. make fate       SAMPLES=fate-suite/

  85. </pre></div>

  86. 

  87. <p>The above commands set the samples location by passing a makefile

  88. variable via command line. It is also possible to set the samples

  89. location at source configuration time by invoking configure with

  90. <samp>--samples=&lt;path to the samples directory&gt;</samp>. Afterwards you can

  91. invoke the makefile targets without setting the <var>SAMPLES</var> makefile

  92. variable. This is illustrated by the following commands:

  93. </p>

  94. <div class="example">

  95. <pre class="example">./configure --samples=fate-suite/

  96. make fate-rsync

  97. make fate

  98. </pre></div>

  99. 

  100. <p>Yet another way to tell FATE about the location of the sample

  101. directory is by making sure the environment variable FATE_SAMPLES

  102. contains the path to your samples directory. This can be achieved

  103. by e.g. putting that variable in your shell profile or by setting

  104. it in your interactive session.

  105. </p>

  106. <div class="example">

  107. <pre class="example">FATE_SAMPLES=fate-suite/ make fate

  108. </pre></div>

  109. 

  110. <div class="info">

  111. <p>Do not put a &rsquo;~&rsquo; character in the samples path to indicate a home

  112. directory. Because of shell nuances, this will cause FATE to fail.

  113. </p></div>

  114. <p>To get the complete list of tests, run the command:

  115. </p><div class="example">

  116. <pre class="example">make fate-list

  117. </pre></div>

  118. 

  119. <p>You can specify a subset of tests to run by specifying the

  120. corresponding elements from the list with the <code>fate-</code> prefix,

  121. e.g. as in:

  122. </p><div class="example">

  123. <pre class="example">make fate-ffprobe_compact fate-ffprobe_xml

  124. </pre></div>

  125. 

  126. <p>This makes it easier to run a few tests in case of failure without

  127. running the complete test suite.

  128. </p>

  129. <p>To use a custom wrapper to run the test, pass <samp>--target-exec</samp> to

  130. <code>configure</code> or set the <var>TARGET_EXEC</var> Make variable.

  131. </p>

  132. 

  133. <a name="Submitting-the-results-to-the-FFmpeg-result-aggregation-server"></a>

  134. <h2 class="chapter">3 Submitting the results to the FFmpeg result aggregation server<span class="pull-right"><a class="anchor hidden-xs" href="#Submitting-the-results-to-the-FFmpeg-result-aggregation-server" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Submitting-the-results-to-the-FFmpeg-result-aggregation-server" aria-hidden="true">TOC</a></span></h2>

  135. 

  136. <p>To submit your results to the server you should run fate through the

  137. shell script <samp>tests/fate.sh</samp> from the FFmpeg sources. This script needs

  138. to be invoked with a configuration file as its first argument.

  139. </p>

  140. <div class="example">

  141. <pre class="example">tests/fate.sh /path/to/fate_config

  142. </pre></div>

  143. 

  144. <p>A configuration file template with comments describing the individual

  145. configuration variables can be found at <samp>doc/fate_config.sh.template</samp>.

  146. </p>

  147. <p>The mentioned configuration template is also available here:

  148. </p><pre class="verbatim">slot=                                    # some unique identifier

  149. repo=git://source.ffmpeg.org/ffmpeg.git  # the source repository

  150. #branch=release/2.6                       # the branch to test

  151. samples=                                 # path to samples directory

  152. workdir=                                 # directory in which to do all the work

  153. #fate_recv=&quot;ssh -T fate@fate.ffmpeg.org&quot; # command to submit report

  154. comment=                                 # optional description

  155. build_only=     # set to &quot;yes&quot; for a compile-only instance that skips tests

  156. ignore_tests=

  157. 

  158. # the following are optional and map to configure options

  159. arch=

  160. cpu=

  161. cross_prefix=

  162. as=

  163. cc=

  164. ld=

  165. target_os=

  166. sysroot=

  167. target_exec=

  168. target_path=

  169. target_samples=

  170. extra_cflags=

  171. extra_ldflags=

  172. extra_libs=

  173. extra_conf=     # extra configure options not covered above

  174. 

  175. #make=          # name of GNU make if not 'make'

  176. makeopts=       # extra options passed to 'make'

  177. #makeopts_fate= # extra options passed to 'make' when running tests,

  178.                 # defaulting to makeopts above if this is not set

  179. #tar=           # command to create a tar archive from its arguments on stdout,

  180.                 # defaults to 'tar c'

  181. </pre>

  182. <p>Create a configuration that suits your needs, based on the configuration

  183. template. The <code>slot</code> configuration variable can be any string that is not

  184. yet used, but it is suggested that you name it adhering to the following

  185. pattern &lsquo;<samp><var>arch</var>-<var>os</var>-<var>compiler</var>-<var>compiler version</var></samp>&rsquo;. The

  186. configuration file itself will be sourced in a shell script, therefore all

  187. shell features may be used. This enables you to setup the environment as you

  188. need it for your build.

  189. </p>

  190. <p>For your first test runs the <code>fate_recv</code> variable should be empty or

  191. commented out. This will run everything as normal except that it will omit

  192. the submission of the results to the server. The following files should be

  193. present in $workdir as specified in the configuration file:

  194. </p>

  195. <ul>

  196. <li> configure.log

  197.     </li><li> compile.log

  198.     </li><li> test.log

  199.     </li><li> report

  200.     </li><li> version

  201. </li></ul>

  202. 

  203. <p>When you have everything working properly you can create an SSH key pair

  204. and send the public key to the FATE server administrator who can be contacted

  205. at the email address <a href="mailto:fate-admin@ffmpeg.org">fate-admin@ffmpeg.org</a>.

  206. </p>

  207. <p>Configure your SSH client to use public key authentication with that key

  208. when connecting to the FATE server. Also do not forget to check the identity

  209. of the server and to accept its host key. This can usually be achieved by

  210. running your SSH client manually and killing it after you accepted the key.

  211. The FATE server&rsquo;s fingerprint is:

  212. </p>

  213. <dl compact="compact">

  214. <dt><span>&lsquo;<samp>RSA</samp>&rsquo;</span></dt>

  215. <dd><p>d3:f1:83:97:a4:75:2b:a6:fb:d6:e8:aa:81:93:97:51

  216. </p></dd>

  217. <dt><span>&lsquo;<samp>ECDSA</samp>&rsquo;</span></dt>

  218. <dd><p>76:9f:68:32:04:1e:d5:d4:ec:47:3f:dc:fc:18:17:86

  219. </p></dd>

  220. </dl>

  221. 

  222. <p>If you have problems connecting to the FATE server, it may help to try out

  223. the <code>ssh</code> command with one or more <samp>-v</samp> options. You should

  224. get detailed output concerning your SSH configuration and the authentication

  225. process.

  226. </p>

  227. <p>The only thing left is to automate the execution of the fate.sh script and

  228. the synchronisation of the samples directory.

  229. </p>

  230. <a name="Uploading-new-samples-to-the-fate-suite"></a>

  231. <h2 class="chapter">4 Uploading new samples to the fate suite<span class="pull-right"><a class="anchor hidden-xs" href="#Uploading-new-samples-to-the-fate-suite" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Uploading-new-samples-to-the-fate-suite" aria-hidden="true">TOC</a></span></h2>

  232. 

  233. <p>If you need a sample uploaded send a mail to samples-request.

  234. </p>

  235. <p>This is for developers who have an account on the fate suite server.

  236. If you upload new samples, please make sure they are as small as possible,

  237. space on each client, network bandwidth and so on benefit from smaller test cases.

  238. Also keep in mind older checkouts use existing sample files, that means in

  239. practice generally do not replace, remove or overwrite files as it likely would

  240. break older checkouts or releases.

  241. Also all needed samples for a commit should be uploaded, ideally 24

  242. hours, before the push.

  243. If you need an account for frequently uploading samples or you wish to help

  244. others by doing that send a mail to ffmpeg-devel.

  245. </p>

  246. <div class="example">

  247. <pre class="example">#First update your local samples copy:

  248. rsync -vauL --chmod=Dg+s,Duo+x,ug+rw,o+r,o-w,+X fate-suite.ffmpeg.org:/home/samples/fate-suite/ ~/fate-suite

  249. 

  250. #Then do a dry run checking what would be uploaded:

  251. 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

  252. 

  253. #Upload the files:

  254. 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

  255. </pre></div>

  256. 

  257. 

  258. <a name="FATE-makefile-targets-and-variables"></a>

  259. <h2 class="chapter">5 FATE makefile targets and variables<span class="pull-right"><a class="anchor hidden-xs" href="#FATE-makefile-targets-and-variables" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-FATE-makefile-targets-and-variables" aria-hidden="true">TOC</a></span></h2>

  260. 

  261. <a name="Makefile-targets"></a>

  262. <h3 class="section">5.1 Makefile targets<span class="pull-right"><a class="anchor hidden-xs" href="#Makefile-targets" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Makefile-targets" aria-hidden="true">TOC</a></span></h3>

  263. 

  264. <dl compact="compact">

  265. <dt><span><samp>fate-rsync</samp></span></dt>

  266. <dd><p>Download/synchronize sample files to the configured samples directory.

  267. </p>

  268. </dd>

  269. <dt><span><samp>fate-list</samp></span></dt>

  270. <dd><p>Will list all fate/regression test targets.

  271. </p>

  272. </dd>

  273. <dt><span><samp>fate</samp></span></dt>

  274. <dd><p>Run the FATE test suite (requires the fate-suite dataset).

  275. </p></dd>

  276. </dl>

  277. 

  278. <a name="Makefile-variables"></a>

  279. <h3 class="section">5.2 Makefile variables<span class="pull-right"><a class="anchor hidden-xs" href="#Makefile-variables" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Makefile-variables" aria-hidden="true">TOC</a></span></h3>

  280. 

  281. <dl compact="compact">

  282. <dt><span><code>V</code></span></dt>

  283. <dd><p>Verbosity level, can be set to 0, 1 or 2.

  284.     </p><ul>

  285. <li> 0: show just the test arguments

  286.         </li><li> 1: show just the command used in the test

  287.         </li><li> 2: show everything

  288.     </li></ul>

  289. 

  290. </dd>

  291. <dt><span><code>SAMPLES</code></span></dt>

  292. <dd><p>Specify or override the path to the FATE samples at make time, it has a

  293. meaning only while running the regression tests.

  294. </p>

  295. </dd>

  296. <dt><span><code>THREADS</code></span></dt>

  297. <dd><p>Specify how many threads to use while running regression tests, it is

  298. quite useful to detect thread-related regressions.

  299. </p>

  300. </dd>

  301. <dt><span><code>THREAD_TYPE</code></span></dt>

  302. <dd><p>Specify which threading strategy test, either &lsquo;<samp>slice</samp>&rsquo; or &lsquo;<samp>frame</samp>&rsquo;,

  303. by default &lsquo;<samp>slice+frame</samp>&rsquo;

  304. </p>

  305. </dd>

  306. <dt><span><code>CPUFLAGS</code></span></dt>

  307. <dd><p>Specify CPU flags.

  308. </p>

  309. </dd>

  310. <dt><span><code>TARGET_EXEC</code></span></dt>

  311. <dd><p>Specify or override the wrapper used to run the tests.

  312. The <code>TARGET_EXEC</code> option provides a way to run FATE wrapped in

  313. <code>valgrind</code>, <code>qemu-user</code> or <code>wine</code> or on remote targets

  314. through <code>ssh</code>.

  315. </p>

  316. </dd>

  317. <dt><span><code>GEN</code></span></dt>

  318. <dd><p>Set to &lsquo;<samp>1</samp>&rsquo; to generate the missing or mismatched references.

  319. </p>

  320. </dd>

  321. <dt><span><code>HWACCEL</code></span></dt>

  322. <dd><p>Specify which hardware acceleration to use while running regression tests,

  323. by default &lsquo;<samp>none</samp>&rsquo; is used.

  324. </p>

  325. </dd>

  326. <dt><span><code>KEEP</code></span></dt>

  327. <dd><p>Set to &lsquo;<samp>1</samp>&rsquo; to keep temp files generated by fate test(s) when test is successful.

  328. Default is &lsquo;<samp>0</samp>&rsquo;, which removes these files. Files are always kept when a test

  329. fails.

  330. </p>

  331. </dd>

  332. </dl>

  333. 

  334. <a name="Examples"></a>

  335. <h3 class="section">5.3 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples" aria-hidden="true">TOC</a></span></h3>

  336. 

  337. <div class="example">

  338. <pre class="example">make V=1 SAMPLES=/var/fate/samples THREADS=2 CPUFLAGS=mmx fate

  339. </pre></div>

  340.       <p style="font-size: small;">

  341.         This document was generated using <a href="https://www.gnu.org/software/texinfo/"><em>makeinfo</em></a>.

  342.       </p>

  343.     </div>

  344.   </body>

  345. </html>