ansible-test - Clean up future boilerplate. (#76874)

* ansible-test - Clarify need for empty __init__.py
* ansible-test - Update code-smell boilerplate.
* Update code-smell boilerplate for core.
* Update future boilerplate test for ansible-test.

All ansible-test code (except for targets) and core-specific sanity tests now use the same boilerplate.

The test also checks for unwanted `__future__` and `metaclass` boilerplate.

* Relocate target tools to the correct directory.

Several tools used on target Python versions were incorrectly placed in the controller directory.

test/lib/ansible_test/__init__.py

@@ -0,0 +1,2 @@
+# Empty __init__.py to allow importing of `ansible_test._util.target.common` under Python 2.x.
+# This allows the ansible-test entry point to report supported Python versions before exiting.

test/lib/ansible_test/_internal/util.py

@@ -83,6 +83,7 @@ ANSIBLE_TEST_CONTROLLER_ROOT = os.path.join(ANSIBLE_TEST_UTIL_ROOT, 'controller'
 ANSIBLE_TEST_TARGET_ROOT = os.path.join(ANSIBLE_TEST_UTIL_ROOT, 'target')
 
 ANSIBLE_TEST_TOOLS_ROOT = os.path.join(ANSIBLE_TEST_CONTROLLER_ROOT, 'tools')
+ANSIBLE_TEST_TARGET_TOOLS_ROOT = os.path.join(ANSIBLE_TEST_TARGET_ROOT, 'tools')
 
 # Modes are set to allow all users the same level of access.
 # This permits files to be used in tests that change users.

test/lib/ansible_test/_internal/util_common.py

@@ -31,7 +31,7 @@ from .util import (
     raw_command,
     ANSIBLE_TEST_DATA_ROOT,
     ANSIBLE_TEST_TARGET_ROOT,
-    ANSIBLE_TEST_TOOLS_ROOT,
+    ANSIBLE_TEST_TARGET_TOOLS_ROOT,
     ApplicationError,
     SubprocessError,
     generate_name,
@@ -425,7 +425,7 @@ def run_command(
 
 def yamlcheck(python):
     """Return True if PyYAML has libyaml support, False if it does not and None if it was not found."""
-    result = json.loads(raw_command([python.path, os.path.join(ANSIBLE_TEST_TOOLS_ROOT, 'yamlcheck.py')], capture=True)[0])
+    result = json.loads(raw_command([python.path, os.path.join(ANSIBLE_TEST_TARGET_TOOLS_ROOT, 'yamlcheck.py')], capture=True)[0])
 
     if not result['yaml']:
         return None

test/lib/ansible_test/_internal/venv.py

@@ -14,7 +14,7 @@ from .util import (
     find_python,
     SubprocessError,
     get_available_python_versions,
-    ANSIBLE_TEST_TOOLS_ROOT,
+    ANSIBLE_TEST_TARGET_TOOLS_ROOT,
     display,
     remove_tree,
     ApplicationError,
@@ -150,7 +150,7 @@ def get_python_real_prefix(args, python_path):  # type: (EnvironmentConfig, str)
     """
     Return the real prefix of the specified interpreter or None if the interpreter is not a virtual environment created by 'virtualenv'.
     """
-    cmd = [python_path, os.path.join(os.path.join(ANSIBLE_TEST_TOOLS_ROOT, 'virtualenvcheck.py'))]
+    cmd = [python_path, os.path.join(os.path.join(ANSIBLE_TEST_TARGET_TOOLS_ROOT, 'virtualenvcheck.py'))]
     check_result = json.loads(run_command(args, cmd, capture=True, always=True)[0])
     real_prefix = check_result['real_prefix']
     return real_prefix

test/lib/ansible_test/_util/__init__.py

@@ -1,3 +1,2 @@
-"""Nearly empty __init__.py to allow importing under Python 2.x."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+# Empty __init__.py to allow importing of `ansible_test._util.target.common` under Python 2.x.
+# This allows the ansible-test entry point to report supported Python versions before exiting.

test/lib/ansible_test/_util/controller/sanity/code-smell/action-plugin-docs.py

@@ -1,6 +1,5 @@
 """Test to verify action plugins have an associated module to provide documentation."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/changelog.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/changelog/sphinx.py

@@ -1,5 +1,4 @@
 """Block the sphinx module from being loaded."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 raise ImportError('The sphinx module has been prevented from loading to maintain consistent test results.')

test/lib/ansible_test/_util/controller/sanity/code-smell/empty-init.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/future-import-boilerplate.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import ast
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/line-endings.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import sys
 

test/lib/ansible_test/_util/controller/sanity/code-smell/metaclass-boilerplate.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import ast
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/no-assert.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/no-basestring.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/no-dict-iteritems.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/no-dict-iterkeys.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/no-dict-itervalues.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/no-get-exception.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/no-illegal-filenames.py

@@ -1,8 +1,7 @@
 # a script to check for illegal filenames on various Operating Systems. The
 # main rules are derived from restrictions on Windows
 # https://msdn.microsoft.com/en-us/library/aa365247#naming_conventions
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import struct

test/lib/ansible_test/_util/controller/sanity/code-smell/no-main-display.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import sys
 

test/lib/ansible_test/_util/controller/sanity/code-smell/no-smart-quotes.py

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/no-unicode-literals.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/replace-urlopen.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/runtime-metadata.py

@@ -1,6 +1,5 @@
 """Schema validation of ansible-core's ansible_builtin_runtime.yml and collection's meta/runtime.yml"""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import datetime
 import os

test/lib/ansible_test/_util/controller/sanity/code-smell/shebang.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import re

test/lib/ansible_test/_util/controller/sanity/code-smell/symlinks.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/use-argspec-type-path.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/lib/ansible_test/_util/controller/sanity/code-smell/use-compat-six.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/lib/ansible_test/_util/controller/sanity/integration-aliases/yaml_to_json.py

@@ -1,6 +1,5 @@
 """Read YAML from stdin and write JSON to stdout."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import json
 import sys

test/lib/ansible_test/_util/controller/sanity/pylint/plugins/deprecated.py

@@ -2,8 +2,7 @@
 # (c) 2018, Matt Martz <matt@sivel.net>
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 # -*- coding: utf-8 -*-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import datetime
 import re

test/lib/ansible_test/_util/controller/sanity/pylint/plugins/string_format.py

@@ -2,8 +2,7 @@
 # (c) 2018, Matt Martz <matt@sivel.net>
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 # -*- coding: utf-8 -*-
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import astroid
 from pylint.interfaces import IAstroidChecker

test/lib/ansible_test/_util/controller/sanity/pylint/plugins/unwanted.py

@@ -1,7 +1,5 @@
 """A plugin for pylint to identify imports and functions which should not be used."""
-from __future__ import (absolute_import, division, print_function)
-
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import typing as t

test/lib/ansible_test/_util/controller/sanity/validate-modules/main.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 from validate_modules.main import main
 

test/lib/ansible_test/_util/controller/sanity/validate-modules/validate_modules/__init__.py

@@ -15,6 +15,5 @@
 #
 #    You should have received a copy of the GNU General Public License
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 __version__ = '0.0.1b'

test/lib/ansible_test/_util/controller/sanity/validate-modules/validate_modules/main.py

@@ -15,8 +15,7 @@
 #
 #    You should have received a copy of the GNU General Public License
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import abc
 import argparse

test/lib/ansible_test/_util/controller/sanity/validate-modules/validate_modules/module_args.py

@@ -15,8 +15,7 @@
 #
 #    You should have received a copy of the GNU General Public License
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import runpy
 import inspect

test/lib/ansible_test/_util/controller/sanity/validate-modules/validate_modules/schema.py

@@ -3,8 +3,7 @@
 # Copyright: (c) 2015, Matt Martz <matt@sivel.net>
 # Copyright: (c) 2015, Rackspace US, Inc.
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 

test/lib/ansible_test/_util/controller/sanity/validate-modules/validate_modules/utils.py

@@ -15,8 +15,7 @@
 #
 #    You should have received a copy of the GNU General Public License
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import ast
 import datetime

test/lib/ansible_test/_util/controller/sanity/yamllint/yamllinter.py

@@ -1,6 +1,5 @@
 """Wrapper around yamllint that supports YAML embedded in Ansible modules."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import ast
 import json

test/lib/ansible_test/_util/controller/tools/collection_detail.py

@@ -1,6 +1,5 @@
 """Retrieve collection detail."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import json
 import os

test/lib/ansible_test/_util/controller/tools/sslcheck.py

@@ -1,6 +1,5 @@
 """Show openssl version."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import json
 

test/lib/ansible_test/_util/controller/tools/yaml_to_json.py

@@ -1,6 +1,5 @@
 """Read YAML from stdin and write JSON to stdout."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import datetime
 import json

test/lib/ansible_test/_util/target/__init__.py

@@ -1,3 +1,2 @@
-"""Nearly empty __init__.py to allow importing under Python 2.x."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+# Empty __init__.py to allow importing of `ansible_test._util.target.common` under Python 2.x.
+# This allows the ansible-test entry point to report supported Python versions before exiting.

test/lib/ansible_test/_util/target/common/__init__.py

@@ -1,3 +1,2 @@
-"""Nearly empty __init__.py to allow importing under Python 2.x."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+# Empty __init__.py to allow importing of `ansible_test._util.target.common` under Python 2.x.
+# This allows the ansible-test entry point to report supported Python versions before exiting.

test/sanity/code-smell/ansible-requirements.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/sanity/code-smell/ansible-test-future-boilerplate.json

@@ -3,7 +3,8 @@
         ".py"
     ],
     "prefixes": [
-        "test/lib/ansible_test/_internal/"
+        "test/sanity/",
+        "test/lib/ansible_test/"
     ],
     "output": "path-message"
 }

test/sanity/code-smell/ansible-test-future-boilerplate.py

@@ -1,12 +1,19 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import ast
 import sys
 
 
 def main():
+    # The following directories contain code which must work under Python 2.x.
+    py2_compat = (
+        'test/lib/ansible_test/_util/target/',
+    )
+
     for path in sys.argv[1:] or sys.stdin.read().splitlines():
+        if any(path.startswith(prefix) for prefix in py2_compat):
+            continue
+
         with open(path, 'rb') as path_fd:
             lines = path_fd.read().splitlines()
 
@@ -15,11 +22,16 @@ def main():
             # Files are allowed to be empty of everything including boilerplate
             missing = False
 
+        invalid_future = []
+
         for text in lines:
             if text == b'from __future__ import annotations':
                 missing = False
                 break
 
+            if text.startswith(b'from __future__ ') or text == b'__metaclass__ = type':
+                invalid_future.append(text.decode())
+
         if missing:
             with open(path) as file:
                 contents = file.read()
@@ -39,6 +51,9 @@ def main():
         if missing:
             print('%s: missing: from __future__ import annotations' % path)
 
+        for text in invalid_future:
+            print('%s: invalid: %s' % (path, text))
+
 
 if __name__ == '__main__':
     main()

test/sanity/code-smell/botmeta.py

@@ -1,6 +1,5 @@
 """Make sure the data in BOTMETA.yml is valid"""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import glob
 import os

test/sanity/code-smell/configure-remoting-ps1.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 

test/sanity/code-smell/deprecated-config.py

@@ -16,8 +16,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import mmap
 import os

test/sanity/code-smell/docs-build.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import re

test/sanity/code-smell/no-unwanted-files.py

@@ -1,6 +1,5 @@
 """Prevent unwanted files from being added to the source tree."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import sys

test/sanity/code-smell/obsolete-files.py

@@ -1,6 +1,5 @@
 """Prevent files from being added to directories that are now obsolete."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import sys

test/sanity/code-smell/package-data.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import contextlib
 import fnmatch

test/sanity/code-smell/release-names.py

@@ -20,8 +20,7 @@ Test that the release name is present in the list of used up release names
 """
 
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 from yaml import safe_load
 

test/sanity/code-smell/required-and-default-attributes.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import sys

test/sanity/code-smell/rstcheck.py

@@ -1,6 +1,5 @@
 """Sanity test using rstcheck and sphinx."""
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import re
 import subprocess

test/sanity/code-smell/test-constraints.py

@@ -1,5 +1,4 @@
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import os
 import re

test/sanity/code-smell/update-bundled.py

@@ -21,8 +21,7 @@ a newer upstream release.
 """
 
 
-from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
+from __future__ import annotations
 
 import fnmatch
 import json