[FFmpeg-devel] [PATCH 3/3] tests: add README.md file with simple instructions

[FFmpeg-devel] [PATCH 3/3] tests: add README.md file with simple instructions

[Stefano Sabatini]

---
 tests/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 tests/README.md

diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 0000000000..4bcae0b403
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,48 @@
+FFmpeg tests
+============
+
+Tests are useful to make sure that code changes do not introduce regressions.
+
+## FATE tests
+
+FATE (FFmpeg Automated Test Environment) is the system used to test
+regressions and should be used for new changes which affect the API or
+components behavior.
+
+To run all tests, run the following command from the commandline:
+```
+make fate
+```
+
+To get the complete list of tests:
+```
+make fate-list
+```
+
+You can specify a subset of tests to run by specifying the
+corresponding element form the list with the `fate-` prefix, e.g.:
+```
+make fate-ffprobe_compact fate-ffprobe_xml
+```
+
+## FATE samples
+
+By default, FFmpeg uses only the standalone tests. To use the
+collected FATE samples, you need download and configure the tests with
+the FATE samples path.
+
+To upload or update the samples, run the command:
+```
+make fate-rsync SAMPLES=/path/to/samples
+```
+
+Then you need to setup the path where the samples are located, either
+when configuring with:
+```
+./configure --samples=path/to/fate/samples
+```
+
+or when running the tests with:
+```
+FATE_SAMPLES=path/to/fate/samples make fate
+```
-- 
2.25.1

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

Re: [FFmpeg-devel] [PATCH 3/3] tests: add README.md file with simple instructions

[Thilo Borgmann]

Hi,

Am 03.04.22 um 15:59 schrieb Stefano Sabatini:
> ---
>   tests/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 48 insertions(+)
>   create mode 100644 tests/README.md
> 
> diff --git a/tests/README.md b/tests/README.md
> new file mode 100644
> index 0000000000..4bcae0b403
> --- /dev/null
> +++ b/tests/README.md

currently we got part of that in doc/fate.texi. Doesn't it make more sense to add that there?

-Thilo


_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

Re: [FFmpeg-devel] [PATCH 3/3] tests: add README.md file with simple instructions

[Stefano Sabatini]

[-- Attachment #1: Type: text/plain, Size: 585 bytes --]

On date Monday 2022-04-04 10:30:27 +0200, Thilo Borgmann wrote:
> Hi,
> 
> Am 03.04.22 um 15:59 schrieb Stefano Sabatini:
> > ---
> >   tests/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
> >   1 file changed, 48 insertions(+)
> >   create mode 100644 tests/README.md
> > 
> > diff --git a/tests/README.md b/tests/README.md
> > new file mode 100644
> > index 0000000000..4bcae0b403
> > --- /dev/null
> > +++ b/tests/README.md
> 
> currently we got part of that in doc/fate.texi. Doesn't it make more sense to add that there?

Makes sense, totally missed it, updated.

[-- Attachment #2: 0001-doc-fate-add-note-about-showing-test-names-and-runni.patch --]
[-- Type: text/x-diff, Size: 1165 bytes --]

From b17625eeddf7083286b529e56050d5dafd7c7680 Mon Sep 17 00:00:00 2001
From: Stefano Sabatini <stefasab@gmail.com>
Date: Sun, 3 Apr 2022 15:22:09 +0200
Subject: [PATCH] doc/fate: add note about showing test names and running a
 tests subset

---
 doc/fate.texi | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/doc/fate.texi b/doc/fate.texi
index c3550785a1..8450856015 100644
--- a/doc/fate.texi
+++ b/doc/fate.texi
@@ -79,6 +79,21 @@ 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
 
+To get the complete list of tests, run the command:
+@example
+make fate-list
+@end example
+
+You can specify a subset of tests to run by specifying the
+corresponding elements from the list with the @code{fate-} prefix,
+e.g. as in:
+@example
+make fate-ffprobe_compact fate-ffprobe_xml
+@end example
+
+This makes it easier to run a few tests in case of failure without
+running the complete test suite.
+
 To use a custom wrapper to run the test, pass @option{--target-exec} to
 @command{configure} or set the @var{TARGET_EXEC} Make variable.
 
-- 
2.25.1


[-- Attachment #3: Type: text/plain, Size: 251 bytes --]

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

Re: [FFmpeg-devel] [PATCH 3/3] tests: add README.md file with simple instructions

[Thilo Borgmann]

Am 05.04.22 um 23:40 schrieb Stefano Sabatini:
> On date Monday 2022-04-04 10:30:27 +0200, Thilo Borgmann wrote:
>> Hi,
>>
>> Am 03.04.22 um 15:59 schrieb Stefano Sabatini:
>>> ---
>>>    tests/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
>>>    1 file changed, 48 insertions(+)
>>>    create mode 100644 tests/README.md
>>>
>>> diff --git a/tests/README.md b/tests/README.md
>>> new file mode 100644
>>> index 0000000000..4bcae0b403
>>> --- /dev/null
>>> +++ b/tests/README.md
>>
>> currently we got part of that in doc/fate.texi. Doesn't it make more sense to add that there?
> 
> Makes sense, totally missed it, updated.

Pushed, thanks!

-Thilo
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

Re: [FFmpeg-devel] [PATCH 3/3] tests: add README.md file with simple instructions

[Stefano Sabatini]

On date Wednesday 2022-04-06 09:24:16 +0200, Thilo Borgmann wrote:
> Am 05.04.22 um 23:40 schrieb Stefano Sabatini:
> > On date Monday 2022-04-04 10:30:27 +0200, Thilo Borgmann wrote:
> > > Hi,
> > > 
> > > Am 03.04.22 um 15:59 schrieb Stefano Sabatini:
> > > > ---
> > > >    tests/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
> > > >    1 file changed, 48 insertions(+)
> > > >    create mode 100644 tests/README.md
> > > > 
> > > > diff --git a/tests/README.md b/tests/README.md
> > > > new file mode 100644
> > > > index 0000000000..4bcae0b403
> > > > --- /dev/null
> > > > +++ b/tests/README.md
> > > 
> > > currently we got part of that in doc/fate.texi. Doesn't it make more sense to add that there?
> > 
> > Makes sense, totally missed it, updated.
> 
> Pushed, thanks!

Thanks!
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".