This change deprecates the use of the of the `datadir` property,
and switches to `get_data()` instead.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The whiteboard test is an example test, and, since, we're about to
deprecate the datadir attribute, let's remote this call to chdir.

If we believe that's necessary to stress this part of the API, let's
write a (non-example) test for that.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This method allows to look for test data in ways that are more
flexible than the current "datadir" feature currently available.

The current "datadir" is bound to the test filename only, and
can not provide different data for different tests hosted within
a single test file.

The newly introduced get_data() method looks for test data in
various locations, to be able to provide custom data not only
to different tests hosted inside a single test file, but also
to different variants.

Note about this alternative implementation of `get_data()`: it does so
in a much more detached form.  It allows for other test types to
clearly change the way data files are stored and accessed.  It also
introduces the concept of named data sources.

In the previous implementation, the types of "data dirs" were hard
coded, while in this approach, they're defined at the class level and
it's up to the `get_data()` implementation to deal with it.
Consequently, the `get_data()` method gets a second (optional)
parameter that allows the user to specify from which data source the
data file should be retrieved.

This is necessary, for example, when we add configurability to sources
of data files, such as expected `stdout`, `stderr` and `output` files.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

* https://github.com/avocado-framework/avocado:
  Python 3 port: use six.string_types on isinstance checks
  Python 3 port: adapt to range differences
  Python 3 port: use next() builtin function
  Python 3 port: fix "unclosed file" conditions in avocado.core.{safe,}loader
  selftests/unit/test_test.py: only create fake tests where used
  selftests/unit/test_utils_stacktrace.py: extract raise exception test
  avocado/core/jobdata_compat_36_to_52.py: remove unused code
  avocado/core/loader.py: simplify and improve detection of Python files
  avocado/utils/path.py: optmize is_python method

Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

* https://github.com/avocado-framework/avocado:
  Introducing the golang plugin

golang ships a builtin test runner, which is called by
`go test <opts> <package or path>`. This patch introduces the golang
optional plugin, which can be used to discover and run golang tests
using Avocado.
Signed-off-by: NAmador Pahim <apahim@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

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

This basically adds portability improvements, while at the same
time improving some of the checks that were done using the "str"
type instead of "basestring".
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Basically switch to use the alias provided by six, with the Python
3 name.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Instead of the iterator next method.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The current code, which doesn't close the file, produces
"ResourceWarning: unclosed file" in Python 3.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This test currently creates some Avocado test instances (as part of
the test itself) that doesn't get used.  Let's limit the creation to
where they're used.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The test that makes sure an exception is raised is completely isolated
from the other checks, and can be made a test of its own.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The filter attribute and the del statement do not seem to be
necessary here.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The use of PathInspector checks too much and too little at the same time.
For once, it attempts to find Python code inside a file that doesn't have
a '.py' suffix.

This means that a file named "test" instead of "test.py" can be recognized
as an INSTRUMENTED test.  A file no ending in ".py" can not be currently
loaded as a Python module by Avocado, and it results in a test execution
ERROR.

This changes the behavior for files with Python code, but not ending
in '.py' that can not be loaded as INSTRUMENTED tests, and will now
result in NOT_A_TEST instead.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

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

Trivial typo correction for the Makefile.
Signed-off-by: NPo-Hsu Lin <po-hsu.lin@canonical.com>

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

Our "astring" library used to be encoding-lenient, let's bring back the
fall-back way of translating unfriendly chars in case the user passes
unicode.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The 4235b329 changed the
stdout/stderr/output logging handlers to not to add tailing '\n's, but
these are processed by LoggingFile, which is designed to remove the
'\n's and to logged them per line. As a result the unittest was
incorrectly changed as the first outputs actually add the '\n' which was
removed in the expected output.

This patch keeps the raw approach as it is necessary for the last
buffered line and instead of buffering puts all lines including the
tailing '\n' and not '\n' for the remaining last line (if it's
available). Consequently this should improve the situation where output
is being produced by stderr and stdout concurrently as no buffering of
the non-tailing-newline output is done on LoggingFile level.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The FS_UNSAFE_CHARS could be useful to users when dealing with filenames
but not in need of the full "string_to_safe_path" function.

The FS_TRANSLATE was also brought back, but it's usability outside this
module is questioned, therefor it's created as private variable. The
reason to include this on module level is to only create the translation
once and not per each call.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

* https://github.com/avocado-framework/avocado:
  Removed port related information while returing location

Signed-off-by: NAmador Pahim <apahim@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

This changes uses the six compatibility equivalents for iterkeys,
iteritems and itervalues.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

The main goal here is to make string_to_safe_path behave properly
under Python 3.  The big change here is the added code that selects
the module where the maketrans() function is located, which in Python
3 is a static method of bytes.

Additionally, it removes the module level definitions
(FS_UNSAFE_CHARS, FS_TRANSLATE) which don't have any other use so far.

FS_USNAFE_CHARS has become a simple variable, now expressed as a
sequence of bytes.  If other characters are added to the translation
table, maketrans() will make sure the they are the same size, so
I believe the code to generate the second argument of the same size
can be dropped.

Now, a side effect is that, on Python 2, the result of the json
parsing (json.loads()) is a dict with unicode keys and values.  When
that is passed to the updated string_to_safe_path() implementation, a
causes TypeError is raised (from Objects/unicodeobj.c,
charmaptranslate_lookup()).
Signed-off-by: NCleber Rosa <crosa@redhat.com>

And its related functions (callers and callees).

In Python 3, strings are unicode, so an encode operation will
return a byte object, while a decode (on a byte or bytearray)
will return a string (unicode).

To start with, string_safe_encode() wants to solve the problem
of users mising unicode and other encoded strings, which doesn't
make sense for Python 3.

Additionally, it uses encode and decode in a way that is
very specific to Python 2, such as assuming the result of a
decode() can then be "encode()d" and still be a string.

For Python 3, the idea here is to *not* deal with any
encode/decode operations attempting to get a "safe" string.
The first part of the function, which converts non-string
objects to string, is still being relied upon by some code,
so it's kept (at least for now).
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Earlier function used to return the entire physical slot location
including port information if any. Now it returns slot information
only till adapter level, not the port level.
Signed-off-by: NVenkat R B <vrbagal1@linux.vnet.ibm.com>

This is a mass change for something that has proved right (it was
applied on previous commits on a as-needed basis).  To avoid having to
hit the same issues over and over again, let's change all occurences.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Signed-off-by: NAmador Pahim <apahim@redhat.com>

Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

* https://github.com/avocado-framework/avocado:
  Project infrastructure removal of flexmock
  selftests/unit/test_vm.py: port from flexmock to mock
  selftests/unit/test_utils_partition.py: port TestMtabLock.test_lock to mock
  selftests/unit/test_test.py: port test_all_dirs_exists_no_hang to mock
  selftests/unit/test_test.py: remote flexmock requirement of test_long_name
  selftests/unit/test_datadir.py: port test_settings_dir_alternate_dynamic to mock
  selftests/unit/test_datadir.py: port test_unique_log_dir to mock
  selftests/unit/test_datadir.py: port test_datadir_from_config to mock
  selftests/unit/test_distro.py: port from flexmock to mock (unittest.mock)
  selftests/unit/test_remote.py: port from flexmock to mock (unittest.mock)
  RemoteTestRunner: fix description of setup() method

This commit revomes flexmock from the various requirements file, from
the RPM SPEC file.  Starting here, it's officially no longer an
Avocado dependency.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The approach used on this port is to avoid excessive mocking, like the
test_remote.py port, and use the real code, unless when insteracting
with dynamic and non-existing components (such as a the hypervisor or
running domain).

A partial list of the changes when compared to the previous version:

* Args was made into a real argparse.Namespace instance because
  there's no need for it to be a mocked object.  Actually, it is
  better to have an exact object instance, rather than a mock when
  it's possible to.

* The "references" attribute being set on the, then mocked, job instance
  has been dropped, because the natural way of passing that to the job
  is using the "reference" key in args.  Also, while purely cosmetic,
  the references that look like the example instrumented tests have
  been renamed (passtest -> passtest.py).

* Removal of JSON_RESULTS, which was not being used in the test.

* Use dry_run and clean up job results.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

And remove module flexmock requirements.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

And remove the requirement on flexmock on this module.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Basically, this is not about switching to mock instead, because
mocking properties is more challeging with mock, and mocking
a property of an existing instance is, to the best of my knowledge,
not possible.

So, it seemed like a good idea to use a different test class with an
overloaded property that returns the fake filename, and while at it,
separate split that into two other tests.

It should be easier to understand what each block (now a test) is
about.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Pretty straightforward port, not really any remarks besides another
test file becoming flexmock free.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Besides the obvious port, I reckon that using a more obvious fake
return value for the return of `time.strftime` improves the legibility
of the test.
Signed-off-by: NCleber Rosa <crosa@redhat.com>