Developers using Avocado's GDB support may need to use their custom
build of GDB, or simply their system has GDB at a different location.
So, allow users to optionally specify the path to the GDB binary.

Also, allow GDB API users to pass extra options to GDB via the command
line.

Changes from v1:
   * use `avocado.utils.process.find_command` as the first default
     location for the gdb binary, falling back to the hard coded
     default of `/usr/bin/gdb` if that fails.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

selftest.run: Don't use coverage and xunit by default

Usually coverage and xunit are unused and only slows down CI. This patch
disables it by default. In order to get coverage please run
`selftest/coverageall`.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

avocado.utils.archive: Add support for .tar.xz [V3]

This patch wraps LZMA archive in order to work with python 2.7 tarfile.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

avocado.utils.process: Fix system_output() call

Suppress debug output in this call, which is unnecessary.
Also, ignore its rc, given that we'll kill child processes
only if they actually exist.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Include support to add extra environment variables in module `avocado.utils.process`.

Don't use the shell like feature to pass environment variables
to the make command, instead of make use of the new feature
in module avocado.utils.process to pass environment variables.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Don't use the shell like feature to pass environment variables
to the make command, instead of make use of the new feature
in module avocado.utils.process to pass environment variables.

Plus make use of argument make to define the make command name.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

The main SubProcess class now supports an argument (env) to receive
extra environment variables to the subprocess execution.

Note that it's extra in the sense that it includes the
current environment variables, so the previous environment is
not destroyed.

The utility functions now accepts this extra environment variables.
It's more robust to pass variables as a dictionary than
using the shell feature of shell variables.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

[V5] Process init on demand

Add functional tests for the class avocado.utils.process.SubProcess,
regarding the methods start() and run().

Even we already use it for other tests, we must have
tests for this own basic feature.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

In order to show more clearly process information, add
a __repr__() method, and modify __str__() to the SubProcess
class.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

After observing some racing conditions related to the execution
of processes on sub shells, step back and provide users
the ability to chose whether they want their command to
be executed in a subshell (in most cases, you'll want it
only if you want to use shell constructs such as pipes in
the resulting command).

Add the param shell to the SubProcess constructor (shell=False),
and modify avocado to use shell=True in the few commands that
actually require it.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Now that we do not initialize the subprocess upon class
initialization, add a utility method .start(), that will
start running the command, useful for background commands.

In order to make things symmetrical, add a .stop() method,
that will send a sigterm to the process, then wait on it.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Currently, as soon as we initialize a process.SubProcess
object, a subprocess.Popen() object is created. This breaks
the user's expectation that the process will start when
run() is called. Therefore, move process execution to
a private method, and call that method in all public
methods of the class.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

The reasoning here being that we don't want this part of
the public API. We don't need users to interact directly
with the Popen object, since the interaction will be
done by means of the public methods.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Introduce avocado.utils.script module [V3]

Remote machine plugin [V4]

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>

Introduce a new unit test for remote plugin.

Since the remote plugin and the vm plugin share the same RemoteTest
class, we need to update the vm_unittest to use this class.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Introduce remote plugin that allows one to run tests on a remote
machine, by using the SSH network connection provided in module
avocado.utils.remote.

Since the remote plugin and the vm plugin share the same RemoteTest
test class, we're going to define this class inside avocado.test module.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Introduce avocado.utils.script module to handle the creation
of scripts stored in the file system.

The module includes a flexible class for creating generic scripts and
 includes utilities functions too. Some examples:

    CONTENT = """
    #!/bin/sh
    echo "Hi There!"
    """

    x = avocado.utils.script.Script('/var/tmp/test.sh', CONTENT)
    x.save()
    ... do something with x, like run it ...
    x.remove()

    t = avocado.utils.script.make_temp_script('test.sh', CONTENT)
    ... do something with y, like run it ...

Avocado functional tests makes use of script creation,
so we will handle these creation using this proper module.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

avocado.job: Move sysinfo collection to test result object

We found a bug: The sysinfo collection was overwriting the
post information in jobs run through the vm plugin. Fix
the problem by moving the information collection to the
test result object. This is transparent to plugins, one
important requirement of the solution.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

avocado: Bump release to 0.14.0

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

examples: Be didactic with mux-environment.yaml.

avocado.core.tree: Match whole key in filters.

When filtering nodes, use the whole key for comparing.

So if you have /long and /longest and you're filtering for /long,
then it will match /long alone.

The previous behaviour was using the partial
string match, so both /long and /longest were being returned,
which is wrong.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

The example for multiplex must be didactic, using one
that would make sense in a real world usage.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

examples/mux-environmentyaml: Don't use local filters.

Remove lines that contains local filters, which is a feature
that is disabled by now (it's broken).
Signed-off-by: NRudá Moura <rmoura@redhat.com>

GDB stdout support

Manpage: Update information regarding global filters and multiplexer.

avocado.utils.remote: Changes to the .run() method

Avocado's GDB support when using avocado.utils.process API
now properly populates the command result stdout attribute.

This now allows tests that run programs and check its output
(stdout only, not stderr) to work transparently under GDB.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The init method on SubProcess got new parameters. Even if not
implemented in GDBSubProcess, those two ducks must quack alike.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Update the manual page of avocado to match the current status of the multiplexer,
regarding command line options for global filters.

Fix information on command line option -c | --content. It's about variables.

Plus:  cosmetic fixes around.
Signed-off-by: NRudá Moura <rmoura@redhat.com>