Static checks: introduce usage of "avocado-static-checks" project

.github/workflows/ci.yml

@@ -17,6 +17,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0
+          submodules: true
       - name: Check signed-off-by
         run: ./selftests/signedoff-check.sh
       - name: Install make

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "avocado-static-checks"]
+	path = avocado-static-checks
+	url = https://github.com/avocado-framework/avocado-static-checks

CODING_STYLE

@@ -15,7 +15,7 @@ Base coding style
 
 The coding style for all Python code is the one enforced by black (see
 https://black.readthedocs.io/en/stable/the_black_code_style/).  The
-selftests/style.sh script can be used to verify the code style matches.
+avocado-static-checks/check-style script can be used to verify the code style matches.
 
 
 Variable names and UpPeR cAsE

Makefile

@@ -46,8 +46,8 @@ requirements: pip
 	- $(PYTHON) -m pip install -r requirements.txt
 
 check:
-	./selftests/style.sh
-	./selftests/isort.sh
+	./avocado-static-checks/check-style
+	./avocado-static-checks/check-import-order
 	inspekt lint --disable W,R,C,E0203,E0601,E1002,E1101,E1102,E1103,E1120,F0401,I0011,E1003,W605,I1101 --exclude avocado-libs,scripts/github
 	pylint --errors-only --disable=all --enable=spelling --spelling-dict=en_US --spelling-private-dict-file=spell.ignore *
 

avocado_vt/loader.py

@@ -84,7 +84,6 @@ def arch_listing(config, guest_name_parser=None):
 
 
 class NotAvocadoVTTest(object):
-
     """
     Not an Avocado-vt test (for reporting purposes)
     """
@@ -93,7 +92,6 @@ class NotAvocadoVTTest(object):
 if AVOCADO_LOADER_AVAILABLE:
 
     class VirtTestLoader(loader.TestLoader, DiscoveryMixIn):
-
         """
         Avocado loader plugin to load avocado-vt tests
         """

avocado_vt/options.py

@@ -36,7 +36,6 @@
 
 
 class VirtTestOptionsProcess(object):
-
     """
     Pick virt test options and parse them to get to a cartesian parser.
     """

avocado_vt/plugins/vt.py

@@ -196,7 +196,6 @@ def _str_or_none(arg):
 
 
 class VTRun(CLI):
-
     """
     Avocado VT - legacy virt-test support
     """

avocado_vt/plugins/vt_bootstrap.py

@@ -25,7 +25,6 @@
 
 
 class VTBootstrap(CLICmd):
-
     """
     Avocado VT - implements the 'vt-bootstrap' subcommand
     """

avocado_vt/plugins/vt_joblock.py

@@ -19,7 +19,6 @@
 
 
 class LockCreationError(Exception):
-
     """
     Represents any error situation when attempting to create a lock file
     """
@@ -28,7 +27,6 @@ class LockCreationError(Exception):
 
 
 class OtherProcessHoldsLockError(Exception):
-
     """
     Represents a condition where other process has the lock
     """

avocado_vt/plugins/vt_list.py

@@ -85,7 +85,6 @@
 
 
 class VTLister(CLI):
-
     """
     Avocado VT - implements legacy virt-test listing
     """

avocado_vt/plugins/vt_list_archs.py

@@ -7,7 +7,6 @@
 
 
 class VTListArchs(CLICmd):
-
     """
     Avocado VT - implements vt-list-archs command
     """

avocado_vt/plugins/vt_list_guests.py

@@ -8,7 +8,6 @@
 
 
 class VTListGuests(CLICmd):
-
     """
     Avocado VT - implements vt-list-guests command
     """

avocado_vt/test.py

@@ -68,7 +68,6 @@ def cleanup_env(env_filename, env_version):
 
 
 class VirtTest(test.Test, utils.TestUtils):
-
     """
     Minimal test class used to run a virt test.
     """

docs/source/contributing/DownloadSource.rst

@@ -6,7 +6,7 @@ The main source is maintained on git and may be cloned as below:
 
 ::
 
-    git clone https://github.com/avocado-framework/avocado-vt.git
+    git clone --recurse-submodules https://github.com/avocado-framework/avocado-vt.git
 
 If you want to learn how to use git as an effective contribution tool, consider
 reading `the git workflow autotest docs <https://github.com/autotest/autotest/wiki/GitWorkflow>`_

docs/source/contributing/Guidelines.rst

@@ -77,7 +77,7 @@ Rules for Maintainers
 Rules for Contributors
 ======================
 
-1. [Must] Coding style should conform to what's enforced by black (see ``selftests/style.sh``)
+1. [Must] Coding style should conform to what's enforced by black (see ``./avocado-static-checks/check-style``)
 2. [Must] PR commit message is meaningful. Refer to the link on how to write a good commit message
 3. [Must] Travis CI pass and no conflict
 4. [Must] Provide test results. If no, provide justification. Apply to any PR

examples/tests/bad_test.py

@@ -4,6 +4,7 @@
 :difficulty: simple
 :copyright: 2014 Red Hat Inc.
 """
+
 from avocado.utils import process
 
 

examples/tests/guest_hostname.py

@@ -4,6 +4,7 @@
 :difficulty: simple
 :copyright: 2014 Red Hat Inc.
 """
+
 import logging
 
 LOG = logging.getLogger("avocado.vt.examples.guest_hostname")

examples/tests/hostname.py

@@ -6,6 +6,7 @@
 :difficulty: simple
 :copyright: 2014 Red Hat Inc.
 """
+
 import logging
 
 from avocado.utils import process

examples/tests/ls_disk.py

@@ -12,6 +12,7 @@
 :difficulty: advanced
 :copyright: 2014 Red Hat Inc.
 """
+
 import logging
 
 LOG = logging.getLogger("avocado.vt.examples.lsdisk")

examples/tests/service.py

@@ -6,6 +6,7 @@
 :difficulty: advanced
 :copyright: 2014 Red Hat Inc.
 """
+
 import logging
 import time
 

requirements-travis.txt

@@ -5,5 +5,5 @@ inspektor==0.5.3
 aexpect>=1.6.4
 netifaces==0.11.0
 pyenchant==3.2.2
-black==22.3.0
+black==24.3.0
 isort==5.10.1

scripts/github/github_issues.py

@@ -24,7 +24,6 @@ def __init__(self, *stuff):
 
 
 class GithubCache(object):
-
     """
     Auto-refreshing github.GithubObject.GithubObject from dict
     """
@@ -193,7 +192,6 @@ def cached_data(self):
 
 
 class GithubIssuesBase(list):
-
     """
     Base class for cached list of github issues
     """
@@ -318,7 +316,6 @@ def values(self):
 
 
 class GithubIssues(GithubIssuesBase, object):
-
     """
     Read-only List-like interface to cached github issues in standardized format
     """
@@ -696,7 +693,6 @@ def __init__(self, key, number):
 
 
 class MutableIssue(dict):
-
     """Allow modification of some issue values"""
 
     def __init__(self, github_issues, issue_number):

scripts/koji_pkgspec.py

@@ -22,7 +22,6 @@
 
 
 class OptionParser(optparse.OptionParser):
-
     """
     KojiPkgSpec App option parser
     """
@@ -58,7 +57,6 @@ def __init__(self):
 
 
 class App(object):
-
     """
     KojiPkgSpec app
     """

scripts/logging_config.py

@@ -4,7 +4,6 @@
 
 
 class AllowBelowSeverity(logging.Filter):
-
     """
     Allows only records less severe than a given level (the opposite of what
     the normal logging level filtering does.

scripts/regression.py

@@ -67,7 +67,6 @@ def get_test_keyval(jobid, keyname, default=""):
 
 
 class Sample(object):
-
     """Collect test results in same environment to a sample"""
 
     def __init__(self, sample_type, arg):

scripts/virt_disk.py

@@ -21,7 +21,6 @@
 
 
 class OptionParser(optparse.OptionParser):
-
     """
     App option parser
     """
@@ -82,7 +81,6 @@ def __init__(self):
 
 
 class App:
-
     """
     Virt Disk Creation App
     """

selftests/doc/test_doc_build.py

@@ -3,6 +3,7 @@
 
 This is geared towards documentation build regression testing.
 """
+
 import os
 import unittest
 
@@ -52,7 +53,7 @@ def test_build_docs(self):
                 "%s ERRORS and/or WARNINGS detected while building the html docs:\n"
                 % len(failure_lines)
             )
-            for (index, failure_line) in enumerate(failure_lines):
+            for index, failure_line in enumerate(failure_lines):
                 e_msg += "%s) %s\n" % (index + 1, failure_line)
             e_msg += "Full output: %s\n" % "\n".join(output_lines)
             e_msg += "Please check the output and fix your docstrings/.rst docs"

selftests/unit/test_libvirt_network.py

@@ -31,7 +31,6 @@
 
 
 class NetworkTestBase(unittest.TestCase):
-
     """
     Base class for NetworkXML test providing fake virsh commands.
     """
@@ -111,7 +110,6 @@ def setUp(self):
 
 
 class NetworkXMLTest(NetworkTestBase):
-
     """
     Unit test class for manipulator methods in NetworkXML class.
     """

selftests/unit/test_qemu_devices.py

@@ -42,7 +42,6 @@
 
 
 class ParamsDict(dict):
-
     """params like dictionary"""
 
     def objects(self, item):
@@ -51,14 +50,13 @@ def objects(self, item):
 
     def object_params(self, obj):
         ret = self.copy()
-        for (param, value) in six.iteritems(self):
+        for param, value in six.iteritems(self):
             if param.endswith("_%s" % obj):
                 ret[param[: -len("_%s" % obj)]] = value
         return ret
 
 
 class MockHMPMonitor(qemu_monitor.HumanMonitor):
-
     """Dummy class inherited from qemu_monitor.HumanMonitor"""
 
     def __init__(self):  # pylint: disable=W0231
@@ -69,7 +67,6 @@ def __del__(self):
 
 
 class Devices(unittest.TestCase):
-
     """set of qemu devices tests"""
 
     def test_q_base_device(self):
@@ -151,7 +148,6 @@ def test_q_device(self):
 
 
 class Buses(unittest.TestCase):
-
     """Set of bus-representation tests"""
 
     def test_q_sparse_bus(self):
@@ -671,7 +667,6 @@ def test_usb_bus(self):
 
 
 class Container(unittest.TestCase):
-
     """Tests related to the abstract representation of qemu machine"""
 
     def setUp(self):

selftests/unit/test_qemu_monitor.py

@@ -15,7 +15,6 @@
 
 
 class MockMonitor(qemu_monitor.Monitor):
-
     """Dummy class inherited from qemu_monitor.HumanMonitor"""
 
     def __init__(self):  # pylint: disable=W0231