avocado.multiplexer: Support for modifying multiplex tree on cmdline [v3]

This patch adds "--env" argument, which allows one to specify
[path:]key:value records which are injected into the multiplex tree
parsed from yaml files.

It also demonstrate the way plugins can override multiplex tree
therefor modify test params during activate/run phase.

There are few intrusive changes. It reuses the existing namespace
during "avocado.core.parser.Parser.finish" part to keep the values set
during "Plugin.activate" phase and it adds
"self.args.default_multiplex_tree" argument which is reserved for
multiplex tree to be merged into tree made from yaml files.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

This function can be used to retrieve existing node by path separated
by '/'. Additionally when "create" is supplied it it can create the
missing nodes in the same way as "mkdir -p" in bash.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Originally we used multiplex = True and False. This patch adds None and
the value is not updated during merge when the new node's multiplex is
None.

Currently this means that once node is set as multiplex, there is no way
to undo this. We might consider creating !nomux flag in the future to
force multiplex = False, but this is currently not needed.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The TreeNodeDebug needs the origin to work properly. This patch allows
combyining debug and non-debug trees by supplying "Unknown" origin when
to non-debug TreeNodes.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

avocado.multiplexer: Inject YAML files into /run [v2]

This patch changes the default mux-entry to `/run` as it tends to be
more convenient.

The biggest change is that this location is used as default location
for added YAML files. It's also used as the base when using relative
path YAML file injection. The only way to include file into the exact
location is to use absolute path (`/your/location`).

The benefit is that single simple YAML file doesn't require any additional
location and is in the default mux-entry location. Check the documentation
for details.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

In order to avoid confusion among users as to whether
a plugin is disabled or not, enforce that through outputting
warnings on the app stderr.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

In certain situations where avocado might be running
headless, we still want users to know of errors loading
plugins. So output problems into the main job log.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

avocado.core: Internal attribute to take_action() is now 'dispatch'.

Couple of multiplexer related improvements [v2]

When using TreeNodeDebug and inject location, origin uses the combination
of inject location and path for path. This patch removes the inject
location and preserves only the path.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

path_parent returns parent, the extra return won't affect the result.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

This patch removes the empty line between variants when generating only
a list of variants to compress the output. It preserves the empty line
in case contents are listed as the output might get messy.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

There is a great difference between filter path ending with slash or
without it. It might be a source of confusion so this patch normalize
the filter path to match the tree names (without the ending slash).

    --filter-only /path1 /path2/  => /path1,/path2
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Use the less generic term 'dispatch', for the proper internal
attribute, to dispatch the code to execute, after parsing
command line and so on.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

setup.py: Add missing gdb.conf file in the avocado RPM

The GDB config file was not being installed and packaged in the RPM
package. This should fix it.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Doc fixes

Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

We forgot to update all places where the params API
was referenced, leaving us with old constructs in code
samples, such as referring to a params key by
self.params.key.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Final updates for release 0.24.0

When running "Avocado Virt Boot Test Run and HTML report"
the user must provide '--sysinfo on' in order to acquire system
information.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Signed-off-by: NRudá Moura <rmoura@redhat.com>

setup.cfg: Update to 0.24.0

This little detail has gone unnoticed. Let's fix it.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Updates for the upcoming version 0.24.0

Update package to version 0.24.0 and fix position of plugins.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Signed-off-by: NRudá Moura <rmoura@redhat.com>

Signed-off-by: NRudá Moura <rmoura@redhat.com>

Update diagram of modules and dependencies

Signed-off-by: NRudá Moura <rmoura@redhat.com>

avocado.multiplexer: Use !mux and support for recursive mux [v3]

This patch adds documentation of the "new params API" and removes the
compatility layer. From now on only the API with paths is valid:

    self.params.get(key, path='*', default=None)

where the default path '*' matches anything from --mux-entry path.
Default path is `/test`.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

This patch modifies all example tests to use the new API. It uses the
default path, which is `*`, which matches the mux-entry paths ONLY.
In order to get the values it's necessarily to inject the YAML files
into the mux-entry path, by default `/test`, eg:

    avocado run sleeptest -m /test:examples/tests/sleeptest.py.data/
    sleeptest.yaml

It might seen as a bit more complicated to execute, but it's definitely
easier for maintaining and combining existing YAML files. To execute
matrix of tests you simply inject them into 2 different `/test` children,
eg: `-m /test/by_length:lengths.yaml /test/by_method:methods.yaml`.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

When using ``avocado run -m $location:$path`` the last node of the
$location has to preserve value/mux of the root of the parsed $path
file. Previously it was just a fresh node and all values/tags were
missing. This patch only renames the original parsed root and extend
the tree of the remaining $location nodes.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

This patch modifies the multiplexer logic to support full recursive
multiplexation, unlike the old version which only flattened the
multiplexed nodes. This allows greater flexibility.

Additionally it removes the !join flag and inverts the logic to use !mux
instead. By default leaves are not multiplexed and all are part of the
current params. Users can specify exact nodes which get multiplexed by
using !mux keyword.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>