validateflow: Fail when a pad is not attached

Previously validateflow tests did not fail when the pad was not
attached.

This was a limitation caused by how the Validate API worked. Before, the
`notify::validate-runner` signal was not emitted until a monitor was
attached to the override. This made impossible to listen for the
runner's `stopping` signal.

This patch fixes the problem by setting `validate-runner` for all
existing overrides when the runner is initialized and adding checks in
validateflow to error in the case no pad was attached.

validate:launcher: Move '_format_config_template' to the utilities

So it can be reused by GES tests

validate: Check that position <= duration from the pipeline monitor

We should not require a scenario for that check to happen

validate:scenario: Cleanup spurious error message

validate-flow: Add an ignored-event-fields configuration

It replaces `record-stream-id` as it is a more generic way of doing
the same thing.

docs: Document the validateflow plugin

validate: More usage of g_strcmp0 instead of strcmp

validateflow: Use glib variant of strcmp

safer, and avoids missing include

validate: Include config.h before anything else

To avoid double-defines (such as GST_LEVEL_DEFAULT)

Back to development

Release 1.15.2

scenarios: don't clobber scenarios in 'make install'

/usr/bin/install: will not overwrite just-created '_inst/share/gstreamer-1.0/validate/scenarios/default-seek-flags.scenario' with '../../../../data/scenarios/rtsp_overrides/includes/default-seek-flags.scenario'

https://gitlab.freedesktop.org/gstreamer/gst-devtools/merge_requests/44#note_123683

validate: add new API to exports file

validate: Notice that issue summaries should be 'stable'

As they are used in the testsuite to define known issues

gst-validate-scenario: Make waits optional in appsrc-push

While in many cases it's desirable to wait for a buffer to be pushed
downstream when using appsrc-push, in some cases this is not possible as
such pushing action is dependent on following actions that would not be
executed if we wait.

An example for this is prerolling:

    appsrc ! qtdemux ! video/x-h264 ! decodebin name=dec ! %(videosink)s

    description, seek=false, handles-states=true
    appsrc-push, target-element-name=appsrc0, file-name="raw_h264.0.mp4"
    set-state, state=playing
    appsrc-eos, target-element-name=appsrc0

In order for the preroll to occur, both the appsrc needs to push the
buffer and the state needs to reach PLAYING. But `set-state` cannot
finish if the buffer has not been pushed (the state transition does not
finish) and conversely pushing the buffer will not finish until the
state has reached.

Making appsrc-push not wait for the buffer solves this problem. This
patch makes appsrc-push aware of this issue by only waiting for the
buffer to be pushed if the pipeline is in a state that allows buffers to
flow.

gst-validate-scenario: Fix (another) race condition in EOS handling

Since gst_validate_action_set_done() is asynchronous, the bus EOS
handler may already be running before the action is actually finished.
This patch ensures that is not a problem.

validateflow: interpolate folder directories into pipeline descriptions.

Allow 'pipeline' fields in validateflow to be interpolated with
directory keys like $(medias)s.

validate: allow config to check for minimum buffer frequency on pads

This change allow tests to check performance of elements by checking the
frequency at which buffers are pushed on src pads.
I re-used most of the logic from fpsdisplaysink to compute the
frequency.

We can now uses something like:
  GST_VALIDATE_CONFIG='core,min-buffer-frequency=60,target-element-factory-name=v4l2src'

The 'buffer-frequency-start' optional field can be used to ignore the
frequency during the start of the pipeline. This is useful when testing live
pipelines where configuring and setting up elements can take some time slowing
down the first buffers.

validate: factor out gst_validate_element_matches_target()

validateflow: Fix double-free on stdout

validate: report: Fix the way we print 'repeat' values

validate: Force LC_NUMERIC to C as it is required by our expression parser

And... add some expression parser unit tests

validate:scenario: Enhance variable implementation

- Stop arbitrarily consider params as ClockTime based on their names
  but add a convetion that the `.type` field of the ActionType should
  end by `(GstClockTime)` when it is a clock time.

validate:scenario: Make gst_validate_action_new public

Mainly so it can be used in unit tests.

validate:scenario: Allow using set-vars from numeric expressions

And require them to follow the `$varname` (can't be $(varname) as
parenthesis have another meaning in those expressions).

Still accept "duration" and "position" as varname for backward compat
but update our scenarios anyway.

validate: scenario: Parse playback times as we execute the scenario

This way we will be able to use 'set-vars' for it

validate:scenario: Enforce a synthax $(varname) to reference variables

This way it is clear that you are using a variable reading the scenario
and we can verify that what the scenario writer intents is to use an
already set variable.

validate: don't override max-latency if config contains multiple structs

gst_validate_utils_get_clocktime() is resetting the value if it's not
present in the struct so we were overriding it on the next iterations.

validate: baseclasses: include env variable in logged command

We were missing the env variables in the command written to the log
file, making it impossible to re-run the test later from the logs.

gst-validate-scenario: Add GST_VALIDATE_SCENARIO_EOS_HANDLING_LOCK

There was a race in appsrc-push when the pushed buffer caused an EOS.
The EOS event could be handled by the main thread, finishing the test
while the action, executing in the streaming thread, has not finished
yet.

A mutex is now introduced to add mutual exclusion for the two threads so
that an EOS does not cause the termination of the test while the action
is still going.

validateflow: Print some indication that the flow checking is happening

validate: Add autotools support for flow plugin

Revert "validate:launcher: Cache the result of meson introspect"

This reverts commit 05ce6d3b92e88341bd9743b021b33ce606c5d1bc.

We can't do that as it breaks meson logic to set envvars

validate:launcher: Do not sort tests all the time

Do it once only once it is fully populated

validate:launcher: Cache the result of meson introspect

Running it takes quite some time and we can easily cache it.

validate:launcher: Add a simple way to profile app

validate: scenario: not need to use an atomic to handle dropped count

It's all handled from the same thread.

validate: scenario: fix dropped checking when terminating scenario

We want to early return if either no max value has been set for the
scenario or if we didn't receive any QoS information.

validate: properly namespace config related checks

New validate plugin: validateflow

validateflow can be used to check the buffers and events flowing through
a custom pipeline match an expectation file. This can be used to test
non-regular-playback use cases like demuxers handling adaptive streaming
fragment pushing.

This patch includes also new actions used for these cases:
`appsrc-push`, `appsrc-eos` and `flush` (plus `checkpoint`, which is
only available with validateflow).

baseclass: add_validate_config: don't use self.proc_env

self.proc_env is created when starting the test but this API can be call
by generator when creating the test.

validate: allow scenarios to define a max nb of dropped buffers

The 'max-dropped' description field can now be used to specify the max
number of buffers than can be dropped by the QoS system.

validate:launcher: Error out in the check testsuite if rebuilding failed

validate: allow scenarios to define max pipeline latency

The 'max-latency' description field can now be used to specify the max
latency allowed for the running pipeline.

Scenarios: override seek flags for RTSP tests

Our RTSP server is not accurate, it makes no sense to perform
accuracy checks on the client-side segments.

validate:scenario: Set variables on all action fields

validate: Handle G_LOG_ERROR in our glog handler

validate:scenario: Rename action 'define-consts' to 'set-vars'

Those are not consts are they can be modified at runtime

validate: Cleanup flags/enum_from_string

scenario: prioritize SCENARIOS_PATH when including

validate: Let people know the testsuite starts running

Now that we do not print infos about successful tests when redirecting.

validate: Keep trying to print stack traces when our log hanlder is removed

There are cases where a crash happens after the program ends

validate:scenario: Give pipeline position when failling on EOS

validate:launcher: Do not print passing tests if not running in a tty

validate:scenario: Explicitely mark generated stop() action as such

validate:launcher:punittest: Raise an exception if a testsuite can't be loaded

pad-monitor: Remove unused pad getrange override

validate: Use g_object_{get|set}_qdata where applicable

This provides a substantial speedup compared to using strings

TestsManager: stop displaying blacklisted tests on stdout

It's basically spam, better suited to the debug logs

validate:launcher: Never print lines larger than the terminal

validate: scenario: Mark action as being executed right before calling ->execute

And make sure that we do not try to execute the following action

In the case the action type leads to the GMainContext to be ieterated

validate: Report the full test name in the xunit file

Looks like gitlab prefers this way of representing tests as it
displays only the name field in its junit reports.

Close #32

validate:launcher: Make baseclasses.py pep8 compliant

validate:launcher: Handle launching launching a sub launcher

If you use validate-launcher in a meson testsuite, those test now
gets integrated as one unique testsuite (with a pretty long namespace).

validate:launcher: Refactor the "main" function

- Move the parser code into a `LauncherConfig.create_parser()` method
- Remove the need to pass libsdir to the _TestsLauncher object
- Extract out a `setup_launcher_from_args` function

launcher: Move http serveur and xvfb server to the main test runner object

No good reason for it to be in the main function

launcher: Cleanup the way we find python test command line

By setting it before the test base class adds the current testsuite name in the classname

launcher: Fix test listing in meson VS gstcheck tests

You might select tests that match Meson but not gstcheck in which
case the 'meson only' variant is exposed but those should never exist.

validate:launcher: Add `%(config_path)s` in the pipeline desc vars

When defining pipelines_descriptions to run test on in a `.json` file, you might
need to point to paths in the testsuite directory (for media files URIs
for example), you can now do

 `"pipeline": "filesrc location="$(config_path)s/../medias/some/file.mkv...`

Release 1.15.1

Fix distcheck

Work around broken disthook check in release.mak so we don't
have to update the common submodules for that (applies only
to this module because the version number is in the top-level
meson.build but the package/dist directory is a subdir). This
only became a problem now because the common submodule hadn't
been updated for the last few years.

win32: update .def file for new API

Fixes distcheck

validate:launcher: Display unix nickname of signals leading to test failure

validate:launcher: Fix error message about 'crashed' test

pre-commit-python: Allow line breaks between binary operators

pre-commit-python overrides the list of ignored Python style errors.
Unfortunately, before this patch the list did not exclude W503 and
W504 (which are otherwise ignored by default).

The consequence of having those two warnings enabled at the same time is
that it's not possible to break lines on binary operators, which is an
unreasonable unintentional restriction:

  'validateflow': "validateflow, expectations-dir=\"" +
                  expectations_dir + "\", actual-results-dir=\"" +
                  actual_results_dir + "\"",

W504 line break after binary operator

  'validateflow': "validateflow, expectations-dir=\""
                  + expectations_dir + "\", actual-results-dir=\""
                  + actual_results_dir + "\"",

W503 line break before binary operator

This patch excludes W503 so that there is a valid style for breaking
lines on binary operators.

validate: Plug newly introduced leak

validate: Use filename instead of full path in dotfiles names

validate:tests: Fix race in `validate_padmonitor.buffer_outside_segment`

We were using a fakesrc which data flow was potentially breaking the
test.

validate: Lower a ERROR message to INFO

This behaviour is totally valid when running unit tests

validate:tests: s/discount_buffer/discont_buffer/

validate:tests: Fix race in `validate_padmonitor.buffer_before_segment`

We were using a fakesrc which data flow was potentially breaking the
test. Stop using it and remove dead code.

Fixes #34

validate: fix crash if timeout when media_descriptor is None

Some tests may not have any media_descriptor. If those were failing to
shutdown after EOS we were calling get_protocol() on None.

validate:launcher: Fix error message

validate:launcher: Fix discovery of commands

gst: allow building static libraries for e.g. Android/iOS

meson: Fix build on {cross-,}win{32,64}

We use visual studio module definitions for the list of symbols to
export when targetting Windows. Fixes CI failure:

../validate/tools/gst-validate.c:460: undefined reference to `gst_validate_spin_on_fault_signals'

validate:launcher: Do not CK_FORK on our test

Otherwise the process can't cleanly quit on assertion because of the way libcheck runner is implemented

validate: launcher: Add a way to retrieve trace without coredumpctl

Simply spnning on segfaults (like gst-launch) and catch that in
the launcher to transform the timeout into a segfault and grab a gdb
backtrace

validate:launcher: Do not take CK_DEFAULT_TIMEOUT into account to set the timeout

The timeout is what is set in the meson build definition otherwise we will not behave as 'meson test' which we should avoid

validate:launcher: Make failure as <failure> in our xunit reporter

I think it was a mistake to call them <error> as the two notions are
different (we marked failed test as "failures" in the <testuite> node).

Should make gitlab happy with our file!

Automatic update of common submodule

From eb6a86e to 59cb678

validate:launcher: Add a GST_VALIDATE_LAUNCHER_MAIN_DIR env variable

This is generally usefull so we do not have to pass -M every time we launch the launcher

And it adds support for nesting launcher calls always respecting the provided main directory

+ Fix some new pep8 errors

validate:launcher: Don't about unexisting tests when filtering tests

It was wrong

validate:launcher: Fix setting meson tests as "parallel"

validate:launcher: Avoid using not yet set variables

And make the file pep8 compliant with latest pep8 checker.

validate: launcher: Add a way to load pipeline tests from a scenario

validate: Update default testsuite git repository

validate: Enhance printing actions with fields

If you have maby field, printed actions where unreadable, clean that
up by adding new lines.

validate:scenario: Add an action to 'include' another scenario

This is particularly useful for scenario that define constants
that are used to check video frame checksum for example, we can
now have one single 'scenario' file that defines consts for the
checksum of the frames, and those can be reused everywhere.

validate:override: Notify override object when they get attached