This complex patch replaces the custom `--multiplex` handling with a
brand new plugin called `yaml_to_mux`. This touches several place and
removes the `yaml` functionality from the avocado core and moves it into
the plugin code.

There are still 2 references from plugins to the `yaml_to_mux` plugin
which are not defined as a public API yet.

1. remote runner - which allows copying --multiplex files to remote
                   machine.
2. replay - which allows overriding of the job's mux variants with
            the --multiplex files. Note that by doing this you
            lose the system-wide options. It is described in the
            warning message.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

This plugin will allow users to easily visualize the diff between 2
jobs, identified by their job ids.
Signed-off-by: NAmador Pahim <apahim@redhat.com>

This reverts commit 00e9aa46.

Let's create a release_notes directory and an dedicated index file.
Signed-off-by: NAmador Pahim <apahim@redhat.com>

Add captions to separate sections in readthedocs left menu.
Remove the heads as we are now using captions.
Fix anchors.
Signed-off-by: NAmador Pahim <apahim@redhat.com>

Including the release notes in our docs.
Signed-off-by: NAmador Pahim <apahim@redhat.com>

This patch adds "Logging system" chapter to the documentation describing
the existing and recent features related to logging.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Doccument the --replay option for the run command.
Signed-off-by: NAmador Pahim <apahim@redhat.com>

So that regular and advanced users (Avocado hackers) know better
where to look for specific information.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

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

In order for the process to not get lost and help newer
maintainers, here's a writeup with the steps to keep in
mind when releasing avocado.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Currently we can only specify the loader plugins order via settings.
This patch adds "--loaders" argument and improves the granularity.
Now it's possible to set either @plugin_name, or TEST_TYPE, where
TEST_TYPE is the mapped name of the plugin (eg. SIMPLE, VT, ...)

There is one special name "DEFAULT", which injects all unspecified
loaders in the position of the "DEFAULT" keyword. When "DEFAULT" is
not specified, not-listed plugins/test_types are not evaluated.
(therefor it's possible to restrict some test loaders or only some
test types).

As the usecase changed slightly, the settings option was renamed
from plugins.loader_plugins_priority to plugins.loaders.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Avocado currently has 3 very distinct namespaces boundaries: test
API, utils, and core. Let's create 3 separate sections so that
users know which one(s) they could use for a given task.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

As listing plugins is already mentioned in other sections, and
documentation on writing a plugin is probably the last thing a regular
user would look for.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Into a new section named "Running Tests Remotely".
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Including groupping together the "human" results and then "machine"
result formats in another subsection.

Changes from v1:
 * Wording suggestion: "on how to write a plugin" instead of "on how
   to write plugin"
Signed-off-by: NCleber Rosa <crosa@redhat.com>

We don't want users to care if some core feature is implemented as
a plugin. The important piece of information here is that Avocado
allows for its result to be written in different formats.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

As this pretty much documents how Avocado saves the results, it's
pretty much a reference document.

The location of the job logs is pretty clear in the Getting Started
section when the user runs their first tests, and it's pretty obvious
even for 1st time users not even reading the documentation.

If users want to understand more about it, or customize the location,
the Reference Guide is indeed the place to go.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This includes moving the reference text and diagram on test order
resolution to the Reference Guide. Since this also included
information on what are simple and instrumented tests, let's
merge and reuse that.

Also, let's rename "Simple example" to "Basic example" so that it
does not confuse users with the concept of a Simple Test, since this
example is actually an Instrumented Test.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This commit tries to reduce the learning curve for a new Avocado user.

* The sections were broken down with new levels
* Reduce text by using links if users want more information on a topic
* Introduced a Reference Guide, where these more detailed and often
  design/internals about Avocado will be documented.
* Default the usage examples assuming an installation based on packages
* A lot of wording changes, always intending to make it simpler

Changes from v1:
* Wording changes suggested by Lucas.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Sure, sphix gave us a hand with the generation of the index file to
point us to the right direction. But, by now, we don't have to keep
that old tip.
Signed-off-by: NCleber Rosa <crosa@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>

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>

Add documentation manual page part for the command line
feature `--wrapper`.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Introduce the documentation regarding the new remote plugin.
Include information about using the remote plugin in the manual page.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

It was something that we forgot to do back when the feature
was implemented. This basic guide should be enough to
understand and use the feature.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

It should go last in the list of topics, preceding only
the API docs.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

Give pointers on how to contribute to the project. Links
to Mailing lists, pointers to the IRC channel and a brief
explanation of the development model.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Also, remove the references to the old system.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

That explains the dir structure for avocado test results.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

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

To complement the xunit output plugin mode made by
Ruda.

CC: Ruda Moura <rmoura@redhat.com>
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

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

Now that we have Ubuntu PPAs and Fedora COPRs, we can
show people the easy way to test avocado.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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