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

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

Test API: Isolate avocado.job from being used by test developers. [V2]

Makefile: replace source tarball generation from distutils to git

Export avocado.core.job.main as avocado.main, so that make it look
like an API for test developers to use.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Move avocado.job to avocado.core.job, in conformance to our
purpose of keeping things not related to test developers,
inside avocado.core, isolated from users.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

It was noted that, on some Python version, the generated tarballs
actually have a lot of files missing. IMHO, if we track a file on git,
then it should make into the tarball. Also IMHO, the distutils sdist
code is a nice thing to have if you can't export your code right from
your SCM.

This is kept simple on purpose so that if we hit any unintended side
effect we can revert to the previous way of generation source
tarballs.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Test API: Isolate avocado.cli.app and avocado.cli.parser for being used.

Move avocado.cli.app and avocado.cli.parser to avocado.core,
in conformance to our purpose of keep things not related to
test developers, inside avocado.core.

Now the package avocado.cli is gone.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

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

Multiplexer tweaks

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

The current formatting is not the most convenient, since
some slightly different tests start to bend the initial
assumptions made when designing the format. Here I propose
something I came up with after some experiment. Examples
of log output:

00:23:57 DEBUG| PARAMS (key=virt.qemu.paths.qemu_bin, path=/*, default=None) => '/bin/qemu-kvm'
00:23:57 DEBUG| PARAMS (key=virt.guest.image_path, path=/*, default=/home/lmr/avocado/data/images/jeos-21-64.qcow2) => '/home/lmr/avocado/data/images/jeos-21-64.qcow2'
00:23:57 DEBUG| PARAMS (key=virt.qemu.template.contents, path=/*, default=None) => None
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

testplan: Description improvement

avocado.remote: Accept "timeout" arg

The description might contain valuable information.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

the executed test is passtest, thus the name in results should be
passtest.py and not boot.py
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The "timeout" argument was added to "run_testsuite" but not added to
avocado.remote, which now raises exception. This patch merges the
--remote-timeout and --job-timeout keeping only the --job-timeout.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

docs: revert attempt to fetch and build avocado-virt API documentation

docs: add section on GDB support and avocado-virt usage

Commit 120345aa attempted to download and build avocado-virt API
documentation together with the avocado API. While this was reliable
offline, it succeeded only on the very first version builds at
readthedocs.org.

So, let's revert back that hackish form of combining the docs. Further
commits will add API documentation generation to avocado-virt itself,
and link avocado and avocado-virt by means of the intersphinx mapping
feature and readthedocs.org sub-project support.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

It was attempted to fill in the gaps so that avocado-virt would be
able to transparently use avocado GDB support. It turns out that a
number of foundation changes will have to be made to support launching
process in the background while running inside GDB.

So, for now, let's document that limitation.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

avocado.plugins: Make plugins description uniform

avocado.runner: Swap runTest() and _runTest().

Trivial patch that normalizes description of the
plugins present on the base avocado repository.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Swap runTest() with _runTest().
Now run_suite() will call runTest() and then, create a subprocess
with _runTest().

Plus more refactoring:

* Update documentation.
* Use longer variable names.
* Cosmetics.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

The '/' prefix is leftover from -m $using:$path development and was
already solved in -m patch. Remove this code which actually breaks the
params resolving.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

 avocado.multiplexer: Support for overriding entry points and yaml locations [v3]

  Set timeout per job execution [V4]

Signed-off-by: NRudá Moura <rmoura@redhat.com>

Add parameter to specify the job timeout a number of seconds
or a number followed by a suffix for seconds, minutes or hours.

Examples:

avocado run --job-timeout 10 synctest sleeptest ...
avocado run --job-timeout 2m synctest sleeptest ...
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Allows to specify the total amount of time (in seconds)
that a test suite is allow to execute in a job execution.

When the timeout happens in a running test, then the test
is marked as error and the following test cases are marked
as skipped.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

run_suite() will accept an optional parameter to set (in seconds)
the timeout for the test suite to execute.

If the timeout happens in the middle of the test, it will report
as an error. The other tests (if any) will be marked as skipped.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Use TimeOutSkipTest as a placeholder for a test, to mark
that it will not execute due a job timeout.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Remove redundant initialization in classes:
* MissingTest
* BuggyTest
* NotATest
Signed-off-by: NRudá Moura <rmoura@redhat.com>

 avocado: Exception handling bugfixes [v2]

There are python traps (they can't be called scripts) which on import
modify stdin/out/err. This even on discovery makes avocado behave very
badly and it's hard to discover what and when it happened. This patch
provides dummy stdin/out/err when discovering the tests.

This solution only takes care of stdin/out/err related issues, safer
method would be to spawn another process and gather the info there.
Still we can't avoid modifying the OS during the discovery, but that's
IMO acceptable for a test-framework.

The examples/tests/failtest_ugly.py is used in basic_tests unittest
using "avocado list" (without this patch it waits for input, than it
prints the test's outputs and exits without listing the tests).
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Some very ugly modules use sys.exit() on imports. These are not catched
by Exception thus BaseException is required.

I did not omit KeyboardInterrupt as users get mad when ctrl+c doesn't
work. On the other hand nasty python code raising KeyboardInterrupt on
import can interrupt test-discovery (avocado list nasty.py => Interrupted
by user)
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>