OK, I did it. This has got to be the most stupid commit ever on this repo.
Still, "print 'foo'" annoys me, and if want to have Avocado running on
Python 3 anytime, we would have to do this anyway.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

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

This way, we fix a bug of avocado unable to list tests
from its own tree (it'll try to import them and then
fail due to recursively trying to import the already
loaded avocado modules).
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Unittests: remove shebangs and license headers

Commit 6fa0bfd8 remove license headers from non-essential files, but
a couple of them, introduced by yours truly in a later date, still
has them.

For consistency sake, let's remove from them too.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Self test files used to be executable, but that changed on 143b574c.
So, it doesn't make much sense to keep the shebangs + python commands
on them.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

avocado/profiler.py: remove module that has been a placeholder

The idea of profilers running along a test is a pretty common and
desirable feature. But, for avocado, at least for now, we're seing
that feature emerging as an extention of the sysinfo module.

So, to avoid confusion, let's remove this placeholder module.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Fix Wrapper Patterns

Use shell glob style (*/datadir, note that you need to escape * when
running on shell) to match possible wrap scripts, when using
the command line option --wrap <script_script>:<glob_expression>.

Example to wrap the execution of binary synctest with ltrace.sh and
to wrap everything else with time.sh wrap script, when running
the proper synctest.py:

```
avocado run --wrap examples/wrappers/time.sh \
            --wrap examples/wrappers/ltrace.sh:\*/synctest \
            examples/tests/synctest.py
```

Update the unittests accordingly.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

avocado/sysinfo.py: simple formatting fix for the Command class

It looks like there was intention to add the extra parameter that
the Command class takes (whether to compress the log file or not),
but it wasn't added as a parameter to the string formatting operation.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

avocado.runner: Remove root logger logging upon timeout

.gitignore: Add .idea directory

Having it here was a mistake caused by commit 5347d8ec
causing timeout to be printed to avocado stdout. Let's
fix that.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

This is a directory used by PyCharm, one of the IDEs some
of the team members are using. Let's add it to .gitignore.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Pre-requesites to test discovery V7

Add the tabular_output() API to avocado.utils.astring.
That function allows us to align a matrix (list of strings) properly
for output exhibition. This operation is heavily used in informational
plugins, such as the list and plugin list plugins.

As we generally want tests to come with new APIs, this
includes one simple unittest for it.

Changes from v1:

 * Rename from matrix_to_str() to tabular_data(), suggested by rmoura
 * Added a unittest.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

That method is supposed to print a yellow colored message,
not a red colored one.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Instead of blindly trying to join the tagged name with the test logdir,
treat said tagged name in one corner case:

1) When tagged name derives from an absolute path (eg /tmp/mytest.py).

This way the leading / can be safely displayed while not causing
breakages in avocado.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Avocado tries hard to not surprise the user, and attempts to preserve
the test ID (from the command line test urls) in the test result directory
structure. Because of that, we should not keep using a test ID that is a
relative path, because too much can go wrong.

This patch simply checks if a test ID (from an test url) starts with a
"parent dir" symbol (..), and if so, changes it to an absolute path.
Detailed explanation on how this is currently broken follows:

At TestLoader.discover_test() (from loader.py), a test name is derived
from a test ID:

   test_name = params.get('id')

The test class itself, along with test parameters (including `id`) are
produced and returned by TestLoader._make_test().

The test class is then instantiated with these parameters, and a "tagged
name" is constructed by Test.get_tagged_name(). This tagged name is then
used to construct the log directories and files:

   self.logdir = path.init_dir(base_logdir, self.tagged_name)
   io.set_log_file_dir(self.logdir)
   self.logfile = os.path.join(self.logdir, 'debug.log')

This will try to create directories completely outside of what was
intended, and can even crash if there's no permission to do so, resulting
in the avocado test runner waiting for the test "early state" forever.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The moment where we load the test in avocado is critical,
since it happens on a subprocess, a failure there is
opaque to the user, and the test early state never
gets populated, which makes avocado hang forever.

Handle this case better, and print an exception right
away to the user.

Changes from v1:
 * Improved error message, per Cleber's comments.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

docs: Specify that avocado test class names are arbitrary

Refactor the test code and create a library containing
stack trace related utilities for avocado. They'll be
useful in a later patch, that improves visibility of
errors in the test loading stage.

Changes from v1:
 * Changed module name from tb to stacktrace, per rmoura's suggestion.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

plugins.remote: Improve json parsing

avocado: Add another branch in test detection heuristics

If we stop a stand alone test execution in the middle, we'll
have troubles since there's still no available test ID to
use in the json. Let's fetch that information in advance
from the file system.

Also, let's avoid a division by zero when no tests were
finished.

Changes from v1:

* Use the runtime module info (Cleber's work)
* Evaluate the pass rate in a cleaner fashion (Cleber's suggestion)
Signed-off-by: NCleber Rosa <crosa@redhat.com>
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

We already have a reference in the runtime module to the currently
running test, but, even though we could reference the job from the
currently running test, the job may still be running after all tests
finish.

So, let's add an explicit reference to the currently running job.

Notice: IMHO, there's no need to define when a job finishes running
and clear it from the runtime module. It can be argued that another
job would only replace the current one if/when its run() method
would be called.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Avocado sometimes produces unexpected texts (failures) before
the actual json output. This patch tries to parse the output
for the correct line instead of using first line.

Note: Avocado should not produce any strings when --json -
specified. Anyway having this logic might be still useful.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

It occurred to us that we can tell apart a buggy avocado
test from a random buggy module since all avocado instrumented
tests will have an avocado import. Therefore, let's do a regexp
search on the module to see if we find an avocado import header.

Of course, this still has room for mistakes, but this is a
best effort enterprise anyway. Update the diagram with the
extra branch in the test resolution.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Explain to the user that the class name for their avocado test
is arbitrary (that's actually a recent change, see 6674048d).
Also advise them to stick with CamelCase, just for style
purposes.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

docs: Improving test resolution diagram

Change the phrasing in some blocks of the test
resolution diagram so the meaning is more clear.

For example, 'Is it an importable module?' is more
aptly phrased as 'Can avocado import it?' and leaves
less room for confusion.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

[V2] Improve test load