Get rid of test_parameters_simple and test_parameters_name
and use only test_parameters variable.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

To avoid making SimpleTest a special case, use the same
parameters that any avocado test class should use,
so that the parameter `path` is now `name`.
Signed-off-by: NRudá Moura <rmoura@redhat.com>

Sysinfo: make it configurable [v2]

As the sysinfo configuration moves from hard coded to configurable,
unittests should not count on any existing condition, such as the
existence of files or commands collected.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This change adds flexibility to the current sysinfo implementation in
the sense that the commands to be executed and files to be collected
are no longer hard coded, but configurable.

The configuration file gains a section for that, and the files
themselves are plain text files that can be easily customized by users
to include extra commands/files.

Also, the the configuration for the profilers has been adjusted for a
uniform look, feel and experience.

Changes from v1:
 * Return the default `profiler` parameter value to None, so that it
   looks at the configuration value by default
Signed-off-by: NCleber Rosa <crosa@redhat.com>

A test may or may not have a data dir. Also, a test might
be on a read only location, so forcing the creation of
one will raise an OSError. This fixes a problem introduced
with 133b60e8.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

A simple wrapper for open() + readlines() that do not raise errors
in case of missing or inaccessible files.

Changes from v1:
 * Fix typo in docstring
Signed-off-by: NCleber Rosa <crosa@redhat.com>

First, this is purely a name change, no change of behaviour should
happen because of this.

Second, this is a naming issue, which means it can sound like a great
or awful idea and both opinions would be right about it.

Finally, IMHO, the name collectible is better suited here for a couple
of reasons:

 * It breaks apart from the already poluted use of log, logfile,
   logging, etc
 * It does not suggest that something will be logged in the
   traditional sense, that is, it will not go through the `logging`
   mechanism
 * It's more closely related to what us humans want, collect the files
   or command outputs for later analysis
Signed-off-by: NCleber Rosa <crosa@redhat.com>

We have mentioned a couple of times that symmetry is desirable on sysinfo
collectibles, so let's enforce that and simplify the code.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

When a relative file (or directory) operation is performed, it will
always be based on the current working directory. This means there's
no need to call `os.getcwd()` for that.

Let's skip that extra call and thus optmize this piece of code.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Avocado has no support for iterations other than running a given test
multiple times, so it makes sense to also remove this never used
portion of the sysinfo code.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The default commands and files to be executed/collected at the start
and end of tests have never been defined, so they're safe to be
removed.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

After all, this is not a unittest of avocado per se, but
an example test. Besides, when executing it as a unittest, we
create an undesirable job directory in ~/avocado/job-results.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Let's use regular, triple quoted strings.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

It turns out that the test classes defined at the top of the
unittest file were being loaded, therefore directories were
being created at the ~/avocado/job-results directory. We can
fix that by moving the auxiliary class definitions to the
unittest class itself.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

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

Use a try/finally block, when at the end of the test,
we restore the old settings object to not mess around with
the behavior of future unittests.

Changes from v1:
 * Use a try/finally block instead of simply cleaning up,
   since if a bug/error happens, that cleanup wouldn't be
   executed, per ldoktor's comments.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

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

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

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

The flag -r tells to the stand alone tests to clean their
temporary results at the end of the run, so that we don't
leave traces of their execution.

Changes from v1:
 * Wrote an actual commit message, explaining the purpose
   of the commit, per ldoktor's suggestion.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

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

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

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

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

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

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

Same idea. Let's keep that job-results directory clean.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

So that we clean up results after we are done with unittests.

Changes from v1:
 * Used super() instead of simply calling the method of the
   parent class, given that the the unittests are new object
   style classes, per ldoktor's suggestion.
Signed-off-by: NLucas Meneghel Rodrigues <lmr@redhat.com>

Makefile: clean auto generated API documentation files

The ReST files at doc/build/api are automatically generated by code
on `conf.py` and should also be removed on the `clean` target.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Test interruption and misleading UI on skipped tests [v2]

The default UI has changed a bit, so let's update the documentation to
match it.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This adds proper handling for tests that finish with state as INTERRUPTED.

A test can be interrupted in two different ways: if user hits CTRL+C while
the test is running, or if the test process receives a SIGINT.

This makes it possible for a (skilled) user to interrupt a single long running
test while not canceling the job completely.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Account for tests there were expected to be run on a given job, but were not
actually executed by incrementing the number of skipped tests.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

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