Only avocado.Test is of general interest to test writers. For that reason
the entire test module has been moved to the avocado.core namespace.

The recommended way to go about writing instrumented tests is something like:

   from avocado import Test
   class MyTest(Test):
      def test_foo(self):
         do_stuff()

Changes from v2:
* Fixed references in docstrings
* Fixed refrences of avocado.test in Writing Test Guide docs

Changes from v1:
* Fixed comment typo on commit message
* Fixed old reference of avocado.test (then test.Test) instead of
  avocado then Test in GDB docs.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This way we work similarly as to when we develop
avocado-virt, which is in fact very convenient.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Some upcoming test sources may want to simply append
multiplexer params to their original params, instead
of having them overwritten by avocado. Let's Define a
mechanism to do that. Test sources, as they assemble
the params that will be used with the test classes, may
define the key avocado_inject_params and set it to True.

If the avocado finds out about that param, it will append
the avocado specific params in the param 'avocado_params',
making it possible for said upcoming test classes to
retrieve avocado specific params.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

The last refactor allowed us to move loader specific info to test
loader plugins. This will allow new test loader plugins to add
new information about how to classify/find new tests, in a way
that we can list new tests without having to modify the test
lister plugin.

We did modify the test lister to list the extra test sources,
and also made it a priority 0 plugin, to ensure extra test
sources plugins get loaded after it, effectively preventing
errors like:

AttributeError: 'Namespace' object has no attribute 'vt_list_guests'
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Allow multiple plugins to implement a TestLoader class
that will allow avocado to understand new types of tests.
The url list will be passed through available test loaders,
that will see if they can handle it, if they can't, they pass
to the next one until we find out one loader that can take
care of the job.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

avocado.multiplexer: Evaluate abspath from right

One of the requirements is to evaluate paths from right to left. This
works fine with relative paths, but was intentionally disabled for
absolute paths. Anyway this behavior is wrong and both, absolute and
relative, paths should be evaluated from right to left and allow
remaining path on left.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

trinity example test: fix fetch of tarball parameter and update to 1.5

Because of the parameter behaviour change this test was failing to get
the name of the tarball to use during the test.

Once that was fixed, there was a couple of build errors. Instead of
debugging the build of the 1.4 version, I tried version 1.5, which
built without any problems. Let's use this oppotunity to fix the
test (wrapper) and update the (original test) tarball.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

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]

To simplify further changes in the test lister, to accomodate listing
tests from different plugins into the same command.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

This test exception was lost, even though we use it in
the definition of the avocado.test.MissingTest class.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

We need the flexibility to implement plugins that need to
display setup operations.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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