Fix small bug in external plugins

Live test state

New multiplexer

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

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

That change has to be made all at once for the sake of
bisectability. Update avocado.job and the multiplexer
plugin with the new multiplexing library code.

Also, update functional tests, the avocado sample tests
with the new YAML based config files, and the requirements.txt
file with the new prominent dependency of avocado, PyYAML.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Based on the new treenode data structure, we
built a new multiplexing algorithm. It has some
different properties and uses a more standard
YAML file format for the configuration files.

This commit is the new base library.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Introduce a new data structure that will be the base of
our new multiplexing mechanism.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Which doesn't hold any logic, but serves as an example.

To watch the intended behavior in action, I recommend running the
"one_hundred_cycles" variant of this tests.

The test runner will show that the test is running (yellow throbber
spinning), and once each six seconds (+1% into the test run) a green
throbber will be shown.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

A test writer can write its own check that will be called by default, or just decide
on each call to communicate_progress() if there has been any (progress).

Also, the job main loop now shows a green throbber when there has been real test
progress.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

So that it can report back its state whenever it feels like it.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Including number of sleep cycles, sleep cycle length and finally
the sleep method, either using the python time.sleep() or running
the shell "sleep" command.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

So that multiple test states can be received by the main loop, but
only if the test is finished we break out from the loop.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

And running state. Every time the state is produced and put in the queue,
the elapsed time is updated. Also, a new flag, "running", shows if the
framework has entered or exited the test entry point.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The throbber that gives visual indication of progress can now show if the progress
includes test specific progress (GREEN) or if the test process is running (YELLOW)
but actual progress is unknown.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

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

Add functional tests to explore external plugins in two
bad scenarios: 1) plugin without configure() method implemented,
2) plugin with syntax error.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Fix the variable to display in log when an external plugin fails
to load.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

setup.py: add missing !#/bin/env python header

avocado.job: Change Ctrl+C handling

Without it, setup.py is interpreted as a bash script.

Instead of sending SIGKILL to child processes right away,
ignore Ctrl+C for a time window of 2 seconds, explaining
to the user that, and that after the ignore window,
new Ctrl+C will send SIGKILL to the children and terminate
the process.

The functional test was removed, and will be re-added
once I figure out how to properly test the interrupt
behavior.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Initial man page support

This page is intended as a basic offline aid for new users of avocado.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

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

IMHO, the generated sphinx config file is too noisy and thus hard to
manage. Let's clean it up.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

More usability fixes

Instead of displaying a not very informative 'too few arguments'
message, display the original error message that mentions about
test IDs *and* the run help output. Adjustments to the original
functional test were made accordingly.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Instead of displaying a not very helpful 'too few args'
message, let's display the full --help output on an
empty args list. Comes with a functional test.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

avocado.plugins.builtin: Builtin plugins are dynamic.

the builtin plugin list were once static coded, but now
they are search and loaded by run-time,
by inspecting the directory <avocado_home>/avocado/plugins.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Not found fixes

We have introduced the new NOT_FOUND status, but haven't
updated the output plugins with it. Let's fix this bug.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

avocado.cli.app: Fix to display all --help options.

Fix the way that we handle argument parsing, to display
all options for subcommands when --help is passed.

We fix the problem by using parents parse.

Plus: cosmetic fixes in avocado.plugins regarding
argument parse.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Looks like a travis worker can be a lot slower than I thought at first,
in the order of 50 times slower than a 2 year old development machine.

So now, the timeout is 250 times higher than the test run would take
under the mentioned development machine (0.12s), but still able to
catch bugs if the loop does not cycle immediatelly on failure for the
100 failtests.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Job main loop: functional tests timing

Looks like test bots, such as travis, can have very little resources
at times and run things really slowly, example:

======================================================================
FAIL: Sleeptest is supposed to take 1 second, let's make a sandwich of
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/travis/build/avocado-framework/avocado/selftests/all/
functional/avocado/basic_tests.py", line 238, in test_runner_sleep_fail_sleep_timing
    self.assertLess(actual_time, 4.0)
AssertionError: 4.036144018173218 not less than 4.0

Let's increase the maximum expected times.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Test execution times async