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>

Do sanity checks in Avocado sources.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Add a new selftest to verify cyclical dependencies between Avocado
modules. It requires snakefood and NetworkX installed.

You can verify by running 'make check_cyclical'.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Merge the code of module avocado.core.tree_debug back to
to module avocado.core.tree, so we remove a cyclical dependency
between the modules.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Multiplexed nodes affects heavily the tree structure and users should
see i in the tree view. This patch makes "multiplex" nodes visible.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Move avocado.restclient.cli to avocado.core.restclient.cli,
related to `avocado-rest-client` script.

Users can make use of `avocado.restclient.connection` and
`avocado.restclient.response`.
These are very lightweight and intended to let users query and manipulate
avocado-server data without starting from scratch.
Signed-off-by: NCleber Rosa <crosa@redhat.com>
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Add section inside "Development Tips" to include a graph
of module dependencies.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

In the documentation, explain that the test API is everything
under avocado module, but excludes avocado.core.

Also, Avocado works with plugins, so let's talk about it,
in the introduction too.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Plugins improve list view [v2]

This is how I believe *plugin* dependencies should be handled. If
something that a plugin requires is not present, it simply fails to
load.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Pick the information collected while loading plugins to display to the
user clearly why some of their plugins are not working.

Changes from v1:

* Instead of guessing the plugin disable cause, use a more generic but
  accurate description.  The description chosen is to simply say that
  the plugin was disabled during configuration (`configure()`), which
  is often done, but not limited to, missing dependencies.
* Changed the presentation from having colored `Enabled` or `Disabled`
  at the RHS of the plugin description to a single colored header.
* Increased one space in the formatting string (`format_str`)
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Store failed plugins instead of logging them to stderr.  That will
allow us to give better information to the user as of why a given
plugin was disabled.

Changes from v1:
 * Dropped the use of FailedPlugin in favor of a simpler (name,
   reason) tuple.
 * Catch a single, and more broad `Exception` since `ImportError`s
   will also be caught and treated the same way.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NCleber Rosa <crosa@redhat.com>

Avocado shouldn't crash, it should only notify user about the failure.
This patch modifies the existing mux exceptions to reflect this rule and
adds new exception handler for incorrect yaml file.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Revert "GDB: use gdbserver --server-sdtderr option if available"

avocado/utils/data_factory.py: replace prefix of temporary directory nam...

Move avocado.remote to avocado.core.remote, in conformance to our
purpose of keeping things not related to test developers,
inside avocado.core, isolated from users.
Signed-off-by: NRudá Moura <rmoura@redhat.com>