avocado.docs: Update documentation regarding argument parsing.

Update documentation regarding the last update on argument parsing.
Like option --silent goes to run subcommand and there's no
need to quote for multiples test names.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

avocado.test: Use job.unique_id to build temporary path.

if job.unique_id is available in test, use this information
to build the temporary path used in attribute workdir.

The template format is $TMP/job-<unique_id>-<random>/.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

avocado.cli.parser: New way to parsing arguments.

The parser for the subcommand run now accepts one or more
tests ids (paths / aliases) and there isn't a need to quote the list
as a string.

Example:

* Before: avocado 'sleeptest failtest /usr/bin/true'
* Now: avocado sleeptest failtest /usr/bin/true

So it's now possible to run avocado like `avocado run *.py`.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Remove generic option --silent and turn it to subcommand run.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

On Plugin.configure(), remove app_parser and cmd_parser arguments
and now use parse, an instance of avocado.cli.parser.Parser().
The application (old app_parser) is available with parser.application.
The subcommands (old cmd_parser) is available with parser.subcommands.

Now the runner plugins (like sysinfo, datadir, run, etc.)
make use of the standard method run() to execute the logic.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Modify how we parse command line arguments,
by removing the logic that was inside avocado.cli.app into
this new module.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Debian updates

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

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

avocado.core.tree: Add copyright note

Attributing copyright to Jaime Huerta-Cepas <jhcepas@gmail.com>,
author of the original tree node structure, that we drew inspiration
from and used part of the code (tree drawing).

CC: Jaime Huerta-Cepas <jhcepas@gmail.com>
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Refactory plugins

Build devhelp files for Avocado

Rename `arc` to `avocado`.
Plus:  change instructions for devhelp.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Use `Avocado` to project name.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Bump to the latest version, released after sprint 11.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

avocado.process: Make processes to fail when interrupted by user

So that the avocado command does produce its
intended output. Fixes a small bug introduced with
the simplification of the json and xunit plugins.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Some tests, such as the trinity test, may pass even
when interrupted (Ctrl+C), and that is counter intuitive
with the expected semantic of Ctrl+C. So, even if a command
passed, let's raise a CmdError exception if interrupted.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

Add new "hello world!" plugin, to perform functional tests
on external plugins.

Created class ExternalPluginsTest() to move all
functional tests regarding external plugins there.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

Log a message when loading external plugins discovers that
there is no plugin inside a module.

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

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

* Add optional parameters 'name' and 'enabled' to the constructor.
  You can just use the class variables name and enabled.
  Change plugin variable to noname and enabled variable to False.

* Include new attribute 'description' to include short documentation
  about the plugin. By default it uses the docstring of the class
  or fall backs to a message that there is no documentation.

* Add repr() facility.
Signed-off-by: NRuda Moura <rmoura@redhat.com>

avocado.core.tree: Add note about ETE2 and copyright clarification

Add a note in the copyright headers and tree docstrings
recognizing that the base Tree data structure had inspiration
(and the ASCII drawing code) from the ETE2 project, and
hereby list Jaime Huerta Cepas <jhcepas@gmail.com> as one
of the authors of the code, with his express consent.

CC: Jaime Huerta Cepas <jhcepas@gmail.com>
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Ctrl c improvements last

Not necessary or desirable, since we get trinity's
output in the logs already, and the output of the
test is quite extensive.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

1) Revert the test subprocess side SIGINT handler
   to its original form (just raising an appropriate
   TestInterruptError exception)
2) Move the KeyboardInterrupt handling to the test
   run main loop, as we had nested handling blocks
   that ended up creating a deadlock.
3) Start counting the ignore window time after Ctrl+C is
   pressed by the second time, not the first.

With this, we finally get trinity to call its Ctrl+C
handler correctly and cleanup after itself, as well
as avocado cleaning up correctly if enough time is
given to the test subprocesses to end.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Chasing a bug, I found opportunities to improve the
process related code:

*  Populating the CmdResult object on every
   opportunity that wait() or poll() is executed
   in the subprocess.

*  Changing the name of the original wait() method
   to run(), making it consistent with the run()
   function of the module.

Also, to avoid a defunct process on a Ctrl+C, register
the SIGINT signal handler to the SubProcess wait()
method.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

For a number of reasons, the original implementation
called the processes with shell=False (subprocess default),
I noticed later that we lose things like the ability
to use pipes in commands executed and proper job
control and process handling.

So change that and use shell=True.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

If a process is misbehaved, that message will be confusing,
because avocado is actually waiting on child processes to
finish.

Then let's get rid of the message altogether.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Fix small bug in external plugins

Live test state

New multiplexer