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

One less than ideal aspect of our output module is that
plugins have to use a bunch of primitives of that module
out of necessity (such as get_paginator()).

Avocado needs a single entity that controls output for
the application. Let's start by covering the needs of
plugins, by introducing the list_mode argument to the
constructor of that class. When list_mode is set to
True, instead of the regular logging system we'll use
the output paginator class (that will use less if
available to display large amounts of output line with
pagination. Also, turn a useful method that was private
to public, ._log() -> .log().
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Multiplexer documentation fixes

/root was removed in a9ea39d6, but the documentation was not fixed.

Get rid of "/root" for the root node and use empty string as name,
in order to avoid to prefix filters and to display information
with the /root prefix in every output.

The output will be just like this:

./scripts/avocado multiplex mux.yaml --filter-only /hw/cpu/arm --filter-out /os
Variants generated:
Variant 1:    /hw/cpu/arm, /hw/disk/scsi, /env/debug
Variant 2:    /hw/cpu/arm, /hw/disk/scsi, /env/prod
Variant 3:    /hw/cpu/arm, /hw/disk/virtio, /env/debug
Variant 4:    /hw/cpu/arm, /hw/disk/virtio, /env/prod
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Update documentation regarding external plugins and the hello world plugin example.

Make it clear that we need to prefix every external plugin
with "avocado_" to load it. Also, using the new updated "Hello
World!" plugin example.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Update the "Hello World!" plugin example to match
the recent changes that we've made in the plugin structure.

avocado.plugins.vm: Add option group for libvirt domain options

As it helps organizing the help output of the application.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

GDB: deal with fatal signals and generate core dumps (v2)

This adds two related features:

1) dealing with fatal signals such as SIGSEGV
2) generating core dumps automatically (disabled by default) if requested

So now the behaviour on fatal signals (SISEGV and SIGABRT) for now cause
the test to be skipped. Other ways to deal with this proved to be complex
and not really effective.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

multiplexer: Reintroduce command line options for filters.

docs/ContributionGuide: Update with new ML address

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

Reintroduce command line options --filter-only and --filter-out
to control the global filters for multiplexing, both by the test runner
and the multiplex plugin.

Group multiplex command line options together in the group
"multiplex" inside the test runner.

Examples:

avocado run --help
... other options ...
multiplex arguments:
  -m MULTIPLEX_FILE, --multiplex-file MULTIPLEX_FILE
                        Path to an avocado multiplex (.yaml) file
  --filter-only [FILTER_ONLY [FILTER_ONLY ...]]
                        Filter only path(s) from multiplexing
  --filter-out [FILTER_OUT [FILTER_OUT ...]]
                        Filter out path(s) from multiplexing

avocado run footest --multiplex foo.yaml \
	--filter-only /root/env /root/os/linux \
        --filter-out /root/hw/virtio

avocado multiplex mux.yaml \
	--filter-only /root/os/win /root/hw/cpu/intel \
        --filter-out /root/hw/disk/virtio
Variants generated:
Variant 1:    /root/hw/cpu/intel, /root/hw/disk/scsi, /root/os/win/winxp, /root/env/debug
Variant 2:    /root/hw/cpu/intel, /root/hw/disk/scsi, /root/os/win/winxp, /root/env/prod
Variant 3:    /root/hw/cpu/intel, /root/hw/disk/scsi, /root/os/win/win7, /root/env/debug
Variant 4:    /root/hw/cpu/intel, /root/hw/disk/scsi, /root/os/win/win7, /root/env/prod
Variant 5:    /root/hw/cpu/intel, /root/hw/disk/scsi, /root/os/win/win8, /root/env/debug
Variant 6:    /root/hw/cpu/intel, /root/hw/disk/scsi, /root/os/win/win8, /root/env/prod
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Ruda's multiplex updates

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

Include documentation for path_parent and any_sibling and
use variable names more relevant.

In function any_sibling, if the number of arguments is less than 2,
then returns False, because it is obviously alone.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

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

Include unit test for support functions used in the multiplexer.py
module: path_parent() and any_sibling().
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Provide a better output when the number of variants of a multiplex
is zero (for a giving set of tests and one multiplex file).

Also, when there is no tests passed, report early.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

For the filter_only and filter_out functions for filtering,
always accept a string or a list of string for for the parameters.

So this is possible to parse a YAML file like:

foo:
    filter-only: /root/env/prod

or

foo:
    filter-only: [/root/env/prod]

The previous behavior was treating the string as sequence,
so the filters were using the chars as input values.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

To make things easy for debugging, changing the default
behavior of repr() and str() to the class TreeNode.

* For repr() just output the node name.
  Example: TreeNode(name='prod')
* For str() output the node path and the variables from the environment.
  Example: /root/env/prod: foo=123, bar=456

So the output looks like that:

... after a break pointing into the multiplex() function...

(Pdb) print args[0]
[TreeNode(name='short'), TreeNode(name='medium'), TreeNode(name='long'), TreeNode(name='longest')]

(Pdb) print args[0][0]
/root/short: sleep_length=0.5
Signed-off-by: NRuda Moura <rmoura@redhat.com>

VM plugin improvements

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>

Reword and align messages that inform libvirt domain
and VM login.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Set a Job ID in the host, and force the avocado command
run using it inside the VM. With this, we get to display
that information to the user.

Also, right now, as we parse and display results all at once,
displaying the job log doesn't matter much. Therefore,
let's keep the output symmetrical to the one obtained
running avocado in the host.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

When running tests on a VM, the tests are copied to it
and subsequently executed using absolute paths. While
this is technically correct, it is better to replicate
the dir structure of the tests in the source machine.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

The terminal support class retracts one character on regular
operation of the HumanOutput plugin (throbber). However,
we don't need that on the VM output plugin.

To avoid messing up with the internal state of the
TerminalSupport class, let's just add an extra padding
space to the VM result class.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

journal plugin: put the journal file in the right directory

Docs update

vm plugin: use test states instead of test instances

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

As it's the norm now with other plugins.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

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>

Here right directory means the top log job result directory,
along with the job id file and the job.log file, etc.

Looks like there was a change in the meaning of `job.logdir`
and because of that, the journal plugin was saving the file
one directory up the tree.

Also, we needed the job logdir as part of the test state, just
like we need the job unique id.
Signed-off-by: NCleber Rosa <crosa@redhat.com>