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

For upcoming release 64.0
Signed-off-by: NCleber Rosa <crosa@redhat.com>

This change enables loads of pylint checks that do not require big code
changes.
Signed-off-by: NCaio Carrara <ccarrara@redhat.com>

This change enables W0150 (lost-exception) and W1645 (Exception.message
removed in Python 3) related to exception heandling.

This change also enables other checks that didn't require code changes
W0122, W0123, W0124, W0125.

Reference: https://trello.com/c/Ohh7Q6qjSigned-off-by: NCaio Carrara <ccarrara@redhat.com>

The "paths" is supposed to be a list of paths and not just string.
Fortunatelly this was why this plugin actually worked, because it turned
paths into `['/', 'r', 'u', 'n']` making the root node available. Anyway
let's fix the value and use the only location this plugin puts variables
in, which is `/`.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

This plugin uses flat structure, there is no need to set the default
path.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

There was a minor bug/inconsistency in "to_str" method where
"self.parameter_path" is returned instead of list of leaves. Instead of
fixing it let's use the built-in "varianter.to_str" which uses the
"usual" implementation.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Implementation of the CIT varianter optional plugin.
Signed-off-by: NAmador Pahim <amador@apahim.org>
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Raising StopIteration gets translated to a RuntimeError in Python 3.7.
The same behavior can be achieved by 'return' from generators.

Reference: https://github.com/avocado-framework/avocado/issues/2721Signed-off-by: NCleber Rosa <crosa@redhat.com>

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

Fedora 29 (currently rawhide) has a python2-fabric3 package, so it can
use that (Fabric3) as a requirement on both Python 2.7 and 3.4+.  But
we have not switched to Fabric3 on other environments, so let's keep
the fabric (1.x) series there.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Add support for passing "--filter-by-tags" and
"--filter-by-tags-include-empty".

In selftest only "--filter-by-tags" was added to also test what
happens when argument is False.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Respect the "~/.ssh/config" files when using remote runner to allow
users to configure their connection details.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Currently each argument is handled on it's own. Let's change it to list
of whitelisted arguments with supported value types. There is a slight
difference in "-m" argument which uses the long "--mux-yaml" with this
change.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The PyYAML-4.0 to PyYAML-4.2b1 lack "construct_python_str" which is used
in varianter_yaml_to_mux. Note that 4.0 nor 4.1 were ever released on
pip but they exist in some distributions, therefor it makes sense to
include them here.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

This change reveleaed a couple of location in the symbolic names where
not being used, but their special values were being evaluated.  Let's
avoid using the special (and subtle) meaning of ALL (True) and
DEFAULT/AVAILABLE (which evaluate to False).

The enum library is part of the standard library, starting from 3.4
(which is the mininum version we require for Avocado).  On Python 2.7,
we can rely on the backport package.

This is of course not necessary right now, but I feel that we can
continue modernizing the code base, and not wait for 2020 and then be
liberated to use newer constructs and libraries.

Reference: https://trello.com/c/k90E1kdg/1357-loader-remove-compatibility-aliasesSigned-off-by: NCleber Rosa <crosa@redhat.com>

The 'tree.tree_view' reports bytes, but the 'to_str' method is supposed
to return text. To avoid mix-matching bytes and strings let's always
decode.

It's not really necessary to differentiate between ascii/utf8 as those
are the only encodings and ascii is a subset of utf8.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Signed-off-by: NMerlin Mathesius <mmathesi@redhat.com>

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

The fabric-2.0.0 is a complete rework of fabric using different
approach and will require many changes to our code. Let's keep using the
1.x.y version for now.

The fabric3 is still only based on 1.x.y branch but let's also limit
that one as it is based on the original fabric so it's expected that
they might eventually come-up with 2.x.y py3 fork.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Currently Avocado crashes on py2 when the exception contains unicode.
Let's use the new "astring.to_text" method to safely get the exception
details.

As this exception is part of the results, this commit also fixes the
result plugins to cope with unicodes in them.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

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

There are few issues (3 to my count) which affect a number of tests
on Python 3.  Instead of not executing any of the functional tests,
let's skip the broken ones.

This is important because it will prevent new issues from making
its way into the Avocado code.

The list of tests being skipped is being tracked on our planning board,
so that they are accounted for, and enabled when fixed.

Reference: https://trello.com/c/eFY9Vw1R/1282-python-3-functional-tests-checklistSigned-off-by: NCleber Rosa <crosa@redhat.com>

This prevents the plugin from trying to run references such as
Avocado-VT tests or any other that is not backed by an executable
file.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The fingerprint is used when replaying jobs causing "yaml_loader" test
not being replayable.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

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

And not only for the content of params, assuming the existence of
params.  This fixes the following error:

   $ avocado run passtest.py --vm-domain f26 --vm-username root
   JOB ID     : 488c8f26de7b52707e8ddb2b89d0f03a0622391d
   JOB LOG    : /home/cleber/avocado/job-results/job-2018-03-26T16.58-488c8f2/job.log
   DOMAIN     : f26
   LOGIN      : root@f26 (TIMEOUT: 120 seconds)
    (1/1) passtest.py:PassTest.test: PASS (0.01 s)
   RESULTS    : PASS 1 | ERROR 0 | FAIL 0 | SKIP 0 | WARN 0 | INTERRUPT 0 | CANCEL 0
   JOB TIME   : 1.39 s
   Error running method "render" of plugin "html": 'params'
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The following two issues come up on the CI environment:

    ************* Module avocado_runner_remote
    W0622: 51,0: ConnectionError: Redefining built-in 'ConnectionError'
    ************* Module tests.test_mux
    W0622:130,8: TestMuxTree.test_basic_functions: Redefining built-in 'ascii'

And are fixed here.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Each Job creates several dirs/files and uses certain handlers to setup
the environment, let's be explicit and instead of preparing everything
magically on __init__ and cleaning most of it after "run" let users to
"setup" and "cleanup" the Job handlers explicitly and to simplify the
usage also support __enter__ and __exit__ methods to be able to simply
use:

    # No job
    with Job(...) as job:
        # do your stuff with temporary handlers set
    # Job temporary handlers cleaned
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

These warnings are described as:

 W0612: Used when a variable is defined but not used.
 W0622: Used when a variable or function override a built-in.

After a suggestion from Andrei Stepanov, we decided to immediately
enable these.

Rerefence: https://pagure.io/standard-test-roles/pull-request/144
Reference: https://trello.com/c/Ohh7Q6qj/1183-enable-w-in-travis-make-checkSigned-off-by: NCleber Rosa <crosa@redhat.com>

The results *should* be the same without this change, but it
can lead to a different binary being used from the one that
was found previously.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The "self.params" should be Avocado params, but tests might override
them (and Avocado-vt does). Let's be lenient to failures and simply
report None.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Currently we propagate to test results the AvacadoParams object used by
the test. Holding that object in the test results makes the Avocado
process to consume a lot of memory.

For instance, in an Avocado job with 5000 tests (passtest.py), with
Avocado-VT in place, the Job object grows up from 59MB before running
the tests to 274MB after running the tests, a 215MB growth::

    (Pdb) pre_tests
    Partition of a set of 440754 objects. Total size = 59066528 bytes.

    (Pdb) post_tests
    Partition of a set of 1570821 objects. Total size = 274340184 bytes.

    (Pdb) growth
    Partition of a set of 1130073 objects. Total size = 215274464 bytes.

Since the 'params' item is important for both the HTML report and the
ResultsDB report, instead of dropping the 'params' item from the
results, this patch parses the AvocadoParams, populating the test
results with a list of tuples, each one containing the 'path', 'key' and
'value' per parameter basis. This improves the situation a lot. The same
Avocado Job will now only grow up from 59MB to 89MB::

    (Pdb) pre_tests
    Partition of a set of 440747 objects. Total size = 59066424 bytes.

    (Pdb) post_tests
    Partition of a set of 840812 objects. Total size = 89619904 bytes.

    (Pdb) growth
    Partition of a set of 400071 objects. Total size = 30554288 bytes.

The HTML and ResultsDB plugins were adapted accordingly.
Signed-off-by: NAmador Pahim <apahim@redhat.com>

In Python 3, the order of a dictionary items will be different than
under Python 2.  To not have to change the supporting code to return
OrderedDicts, let's just simplify the comparison, breaking them down
into each dictionary item.

This fixes the varianter_yaml_to_mux plugin unittest failure under
Python 3:

    ======================================================================
    FAIL: test_fingerprint_order (tests.test_mux.TestMuxTree)
    ----------------------------------------------------------------------
    Traceback (most recent call last):
      File "/home/cleber/src/avocado/avocado/optional_plugins/varianter_yaml_to_mux/tests/test_mux.py", line 231, in test_fingerprint_order
        self.assertEqual(str(variant1), "{'paths': '', 'variant': "
    AssertionError: "{'variant_id': 'child1-child2-9154', 'varia[65 chars] ''}" != "{'paths': '', 'variant': [TreeNode(name='ch[65 chars]54'}"
    - {'variant_id': 'child1-child2-9154', 'variant': [TreeNode(name='child1'), TreeNode(name='child2')], 'paths': ''}
    + {'paths': '', 'variant': [TreeNode(name='child1'), TreeNode(name='child2')], 'variant_id': 'child1-child2-9154'}
Signed-off-by: NCleber Rosa <crosa@redhat.com>

The '--filter-{only,out}' and '--multiplex' options have been
deprecated in favor of '--mux-filter-{only,out}' and '--mux-yaml'.
Let's remove them for good.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

Sometimes it's useful to be able to specify multiple references and not
just a single one. When list is provided with this patch per-item
discovery is performed.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

Allowing name_prefix to be list allows one to specified shared parts of
the name_prefix inherited from upper-node:

    !mux
    functional: !mux
        name_prefix: ["functional-"]
        rpm:
            name_prefix: ["rpm"]
        git:
            name_prefix: ["git"]

which results in: "functional-rpm" and "functional-git".
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

The `extra_params` is a mutable object and can be modified by loader.
This happens eg. in external_runner loader which removes the optional
key. This patch uses `copy.deepcopy` to avoid such issues.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

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

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