The get_data_path utility API of the Test class is a convenience,
it simply joins the name of a given file to the datadir location.

IMHO the value is low when compared to the pollution of the namespace
and yet another compatibility/stability promise.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The supported interface for getting the test tagged name is the
attribute `tagged_name`, so there's no need to make this utility
method visible on the API.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

These two attributes are simply utility logger instances that test
writers can use to write "directly" to the test process' STDOUT and
STDERR.

I agree that having those ready to use inside a test is a nice to
have, but I don't think it justifies the polution to the test class
namespace.

Let's remove those and document how the user can use Python's standard
logging API to retrieve the logger instances that Avocado provides to
tests. This will continue to exist and be supported.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The default tag in the class constructor already is None, so no
there's no need for the conditional assignment here.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The Avocado Test class inherits from unittest.TestCase, and for that
matter it already contains implementations of setUp and tearDown.

It could be argued that the point is to better document those, but
then the same logic should be applied to all other unittest.TestCase
methods.

So, given that argument, let's remove those.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

IMO it makes sense for the filename property of the Test class to
check if the detected source code file actually exists.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The current approach using "string.rstrip()" is buggy and can
remove unintended characters.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

avocado.core.test: Refactor *SkipTests and support extra params [v2]

All *SkipTests are now inherited from "SkipTest" baseclass. This
baseclass contains improved __init__ which removes any unsupported
parameters from the Test.__init__ super call.

This is because those classes are used to substitute other avocado test
classes, for example "avocado-vt" tests which contain "vt_params"
argument unsupported by Test.__init__.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Python 3 partial support [v2]

As string.letters is gone on Python 3.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Python 3 is more strict about I/O to files not openend in text
mode. Let's encode the message in utf-8 and have bytes written
to the traceback log file.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

A regex match does not return its length by default, let's use len()
on it.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The tree/multiplex modules have clear conditionals when the system
is not multiplex capable, namely because of the lack of YAML libraries.

Let's reflect that on their tests.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The StringIO module now lives under io as io.StringIO on Python 3.
Let's deal with both names.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The urlparse module now lives under urllib as urllib.parse on
Python 3.  Let's deal with both names.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The ConfigParser module is named configparser on Python 3.  Let's deal
with both names.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This changes the print statements to print functions.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This commit changes the idiom on (hopefully all) except statements,
from:
   except foo, details:

to:
   except foo as details:

Which is compatible with both Python 2 and 3.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This is a simple compatibility fix that uses hashlib API that is
available on both Python 2 and 3.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This change introduces symbolic names for various filesystem
permission modes, instead of the literal octals with which
Python 3 shows no compassion.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This commit ports the, arguably old style code (even enough old
to "modern" Python 2 standards) found in the "external" spark
and gdbmi parsers. It includes changes such as:

* print style (using print "function")
* lambda parameter style
* dict "has_key" changed to "key in dict" idiom
* use of string instances instead of the external string module. This
  change is intended to make the same code compatible with Python 2
  and 3. That is, even when using 2to3, this doesn't get
  "fixed". Instead of writing a "fixer", let's just make this code be
  more Pythonic and compatible.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Avocado's setup.py used to not be based on setuptools, but plain
distutils. Then, it wasn't possible to use 2to3 when to help with
Python 3 automatic adjustments.

Since 333e439b it's now based on setuptools so we can enable 2to3.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Those two are interconnected, let's keep them in one file instead of
local imports.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Avoid unnecessary complexity of quering for enabled logs and only support
os.environ to show the full traceback.

Additionally avoid problems with redirected sys.stderr by writing
directly to fd 2, which is STDERR.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

This patch changes the way logging is initialized in avocado app:

1. stdout/stderr/logging is replaced with in-memory handlers
2. when arg parsing is done, logging is reconfigured accordingly to
   setting and re-logs stored messages (when streams are enabled)
3. when job starts and "test" stream is enabled, "" and "avocado.test"
   streams are enabled
4. when job finishes and "test" stream enabled the additional outputs,
   the additional outputs are disabled again.

The 3 and 4 is necessarily as the "" logger contains all logs including
avocado initialization (stevedore, PIL, ...). This way the "test" stream
still outputs everything, but only during the job-execution and not
during avocado initialization and cleanup. (one can use "early" log to
see those).

Last but not least it keeps "avocado.app" output in stdout (and stderr),
but it moves all other outputs to stderr instead. This is IMO better
handling as one can distinguish between debug and "additional" output.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Refactor logging initialization [subset/first round]

No actual changes, only reorder imports alphabetically (system, utils,
relative).
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The format_help was used to show "avocado multiplex -h" when
incompatible options were used, but it requires the parser to be stored
and as this is the only plugin doing this, let's just get rid of it
instead fixing the bug.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The function "add_console_handler" is quite useful. This patch extends
it's capabilities and renames it to fit the new purpose.

Because the new default logging level for "add_log_handler" is INFO,
we add the "avocado.test" and root logger to level DEBUG.

Then finally a few adjustments to the tests that rely on specific
log format and level:

1) selftests/functional/test_multiplex.py: adapt to changes in
test logger That means that extra prefixes ('avocado.test') are
printed out on each line when avocado is run with '--show-job-log'.
While at it, be more precise and check for the specific params at the
specific run with the given variant, instead of looking for a given
param in the output of the three tests variants.

2) selftests/functional/test_standalone.py: adapt to the change of
log prefix ('avocado.test') and extra line because of DEBUG level.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Lets share this log with all debug info in avocado not enabled by default.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The "start_file_logging" is used when job results are created to add
job file-handlers to logging.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

avocado.core.html: Fix the unicode handling for older pystache [v2]

Python 2.6 works fine with both, but let's use the specific version
of pystache we support (in html-plugin) but don't test in CI.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The older versions of pystache encodes the result into default encoding
(ascii), which causes exceptions when writing the results into
utf8 file using codecs.

The newer pystache doesn't require this as it already returns unicode.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The sysinfo files can contain non-ascii characters.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

This hook is used by older pystache (pystache==0.4.1). We don't
use it so let's simply ignore it.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The --upgrade forces all mentioned packages into the highest possible
version, even though the existing ones match the prescription. Without
it the packages that match prescription are kept and only non-matching
ones are upgraded.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>