avocado.utils: Add tools for Avocado development [v2]

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

Python's line_profiler is very handy and it might be handy to mention
it in our documentation.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

This module should contain useful tools for avocado debugging and
currently contains simple decorator which prints execution
duration of decorated functions and accumulated duration.

This is very easy to use and helpful to compare different versions.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

avocado.multiplexer: Support for multiple yaml files [v2]

Rename "drop-in test" (DropIn) to "simple test" (SimpleTest).

The setup.py related changes are good enough to make the
avocado debian packages OK, but we were lacking the
python-pystache dependency on debian. Fix this.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Since the 'config' plugin supersedes functionality
in the 'datadir' plugin, let's remove it from avocado.
Update the configuration accordingly.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Add a section that explains how the avocado config system
works.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Whatever is in the system wide settings can be later
overriden by users. Also, change the settings.config_path
attribute to settings.config_paths, and change it to
a list. This way users can see the order in which their
config files are parsed. Also, Introduce a system wide conf.d
directory, that is supposed to ship config files for avocado
plugins. The order for config parsing is:

 * System wide avocado config (/etc/avocado/avocado.conf)
 * System wide avocado plugins config (/etc/avocado/conf.d/*.conf)
 * Local config for the user running avocado (~/.config/avocado/avocado.conf)
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

To avoid problems with /tmp being mounted on a tmpfs in
certain systems.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Add the config plugin, that introduces the 'config'
subcommand. This shows to the user the config keys
available in the system.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

As discussed in the Trello card

https://trello.com/c/WsDMg7RP/161-initial-support-for-avocado-config-files-server-and-client

Move settings.ini to avocado.conf. The basic idea is
that the name is more intuitive.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

And put a reminder of the purpose of that file, while we're at it.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Due the concept of "drop-in" tests didn't match the actual
purpose of running any script or binary as a test in Avocado, we're
going to use the term "simple test" (defined in SimpleTest class)
to contrast with "native test", which are Python modules that
uses Avocado's API.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Fix garbage output on remote and vm plugins.

When using the remote or vm plugins, the JSON (or XML) result from
the remote server is coming with garbage at the end.
This commit fix this by filtering the result.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Values doesn't need to be ordered, only node->child dependency order
matters.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Instead of adjusting existing tests I rewrote them from scratch with
parallel execution in mind.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

create_variants_from_yaml is hideously long. Use multiplex_yamls instead.

Additionally change default values from lists to None.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

This patch adds support for multiple yaml files by merging the values
together. Merge overrides the nodes value and appends missing children
iteratively. It's deterministic AND order dependant (yaml1 yaml2 migh
not provide the same results as yaml2 yaml1!).
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

these functions were only used in unittests and were redundant to
tree.apply_filters().
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

defaults [] are not recommended, use None instead.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Yaml creates pairs of items, thus isinstance(dict) branch should
not be possible (I hope).
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Move class TestRunner inside avocado.job into a proper new module avocado.runner

Iterator should raise StopIteration, not return None.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Original implementation compared self and then parent node. Parent
node again compared self and children => infinite recursion.

In the end we actually don't want to compare parents, because we care
about what is after this node. This implementation compares only Node
and children.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Change plugins vm and remote to use new module `avocado.runner`
that contains the TestRunner class.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Remove TestRunner class from this module, it's now defined inside new
module `avocado.runner`.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Creates the module `avocado.runner` where the `TestRunner` class lives.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

 Run avocado when called by 'python -m avocado'

selftests..multiplex_tests: Check that vars changes

Replace test_run_mplex_timeout with test_run_mplex_params test which
executes 'env_variables.sh' and checks that output contain correct
output. This test checks the multiplexer capability to change variable
value.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Add a main entry point when avocado is called
by the command line option 'python -m avocado'.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Plugin tweaks

Put the sysinfo and test_lister plugins into separate
plugin files. Although not strictly necessary, the
neat 1 plugin - 1 source file relation makes things
organized and easy to understand.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

This way we define more clearly the attributes of the
plugin object (many of them will implement a parser
object).
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Get to a more toned down output for the subcommands
'datadir', 'plugins' and 'list'.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

It is useful information to the user where the config file
is, to reinforce where avocado is picking the default values.
So add it to the output of `datadir` and `list` subcommands.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>