ansible-core 2.19.2rc1__py3-none-any.whl → 2.20.0b1__py3-none-any.whl

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

@@ -17,14 +17,13 @@ from voluptuous import Required, Schema, Invalid
 from voluptuous.humanize import humanize_error
 
 from ansible.module_utils.compat.version import StrictVersion, LooseVersion
-from ansible.module_utils.six import string_types
 from ansible.utils.collection_loader import AnsibleCollectionRef
 from ansible.utils.version import SemanticVersion
 
 
 def fqcr(value):
     """Validate a FQCR."""
-    if not isinstance(value, string_types):
+    if not isinstance(value, str):
         raise Invalid('Must be a string that is a FQCR')
     if not AnsibleCollectionRef.is_valid_fqcr(value):
         raise Invalid('Must be a FQCR')
@@ -33,7 +32,7 @@ def fqcr(value):
 
 def fqcr_or_shortname(value):
     """Validate a FQCR or a shortname."""
-    if not isinstance(value, string_types):
+    if not isinstance(value, str):
         raise Invalid('Must be a string that is a FQCR or a short name')
     if '.' in value and not AnsibleCollectionRef.is_valid_fqcr(value):
         raise Invalid('Must be a FQCR or a short name')
@@ -48,7 +47,7 @@ def isodate(value, check_deprecation_date=False, is_tombstone=False):
     else:
         # make sure we have a string
         msg = 'Expected ISO 8601 date string (YYYY-MM-DD), or YAML date'
-        if not isinstance(value, string_types):
+        if not isinstance(value, str):
             raise Invalid(msg)
         # From Python 3.7 in, there is datetime.date.fromisoformat(). For older versions,
         # we have to do things manually.
@@ -80,7 +79,7 @@ def removal_version(value, is_ansible, current_version=None, is_tombstone=False)
         'Removal version must be a string' if is_ansible else
         'Removal version must be a semantic version (https://semver.org/)'
     )
-    if not isinstance(value, string_types):
+    if not isinstance(value, str):
         raise Invalid(msg)
     try:
         if is_ansible:
@@ -191,7 +190,7 @@ def validate_metadata_file(path, is_ansible, check_deprecation_dates=False):
                 'removal_version': partial(removal_version, is_ansible=is_ansible,
                                            current_version=current_version),
                 'removal_date': partial(isodate, check_deprecation_date=check_deprecation_dates),
-                'warning_text': Any(*string_types),
+                'warning_text': str,
             }
         ),
         avoid_additional_data
@@ -204,7 +203,7 @@ def validate_metadata_file(path, is_ansible, check_deprecation_dates=False):
                 'removal_version': partial(removal_version, is_ansible=is_ansible,
                                            current_version=current_version, is_tombstone=True),
                 'removal_date': partial(isodate, is_tombstone=True),
-                'warning_text': Any(*string_types),
+                'warning_text': str,
             }
         ),
         avoid_additional_data
@@ -228,18 +227,15 @@ def validate_metadata_file(path, is_ansible, check_deprecation_dates=False):
     # Adjusted schema for module_utils
     plugin_routing_schema_mu = Any(
         plugins_routing_common_schema.extend({
-            ('redirect'): Any(*string_types)}
+            ('redirect'): str}
         ),
     )
 
-    list_dict_plugin_routing_schema = [{str_type: plugin_routing_schema}
-                                       for str_type in string_types]
+    list_dict_plugin_routing_schema = [{str: plugin_routing_schema}]
 
-    list_dict_plugin_routing_schema_mu = [{str_type: plugin_routing_schema_mu}
-                                          for str_type in string_types]
+    list_dict_plugin_routing_schema_mu = [{str: plugin_routing_schema_mu}]
 
-    list_dict_plugin_routing_schema_modules = [{str_type: plugin_routing_schema_modules}
-                                               for str_type in string_types]
+    list_dict_plugin_routing_schema_modules = [{str: plugin_routing_schema_modules}]
 
     plugin_schema = Schema({
         ('action'): Any(None, *list_dict_plugin_routing_schema),
@@ -267,13 +263,12 @@ def validate_metadata_file(path, is_ansible, check_deprecation_dates=False):
 
     import_redirection_schema = Any(
         Schema({
-            ('redirect'): Any(*string_types),
+            ('redirect'): str,
             # import_redirect doesn't currently support deprecation
         }, extra=PREVENT_EXTRA)
     )
 
-    list_dict_import_redirection_schema = [{str_type: import_redirection_schema}
-                                           for str_type in string_types]
+    list_dict_import_redirection_schema = [{str: import_redirection_schema}]
 
     # action_groups schema
 
@@ -289,7 +284,7 @@ def validate_metadata_file(path, is_ansible, check_deprecation_dates=False):
         }, extra=PREVENT_EXTRA)
     }, extra=PREVENT_EXTRA)
     action_group_schema = All([metadata_dict, fqcr_or_shortname], at_most_one_dict)
-    list_dict_action_groups_schema = [{str_type: action_group_schema} for str_type in string_types]
+    list_dict_action_groups_schema = [{str: action_group_schema}]
 
     # top level schema
 
@@ -298,7 +293,7 @@ def validate_metadata_file(path, is_ansible, check_deprecation_dates=False):
         ('plugin_routing'): Any(plugin_schema),
         ('import_redirection'): Any(None, *list_dict_import_redirection_schema),
         # requires_ansible: In the future we should validate this with SpecifierSet
-        ('requires_ansible'): Any(*string_types),
+        ('requires_ansible'): str,
         ('action_groups'): Any(*list_dict_action_groups_schema),
     }, extra=PREVENT_EXTRA)
 

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

@@ -80,36 +80,39 @@ class AnsibleUnwantedChecker(BaseChecker):
                'Identifies imports which should not be used.'),
     )
 
-    unwanted_imports = dict(
-        # Additional imports that we may want to start checking:
-        # boto=UnwantedEntry('boto3', modules_only=True),
-        # requests=UnwantedEntry('ansible.module_utils.urls', modules_only=True),
-        # urllib=UnwantedEntry('ansible.module_utils.urls', modules_only=True),
-
+    unwanted_imports = {
         # see https://docs.python.org/2/library/urllib2.html
-        urllib2=UnwantedEntry('ansible.module_utils.urls',
-                              ignore_paths=(
-                                  '/lib/ansible/module_utils/urls.py',
-                              )),
+        'urllib2': UnwantedEntry(
+            'ansible.module_utils.urls',
+            ignore_paths=(
+                '/lib/ansible/module_utils/urls.py',
+            )
+        ),
 
         # see https://docs.python.org/3/library/collections.abc.html
-        collections=UnwantedEntry('ansible.module_utils.six.moves.collections_abc',
-                                  names=(
-                                      'MappingView',
-                                      'ItemsView',
-                                      'KeysView',
-                                      'ValuesView',
-                                      'Mapping', 'MutableMapping',
-                                      'Sequence', 'MutableSequence',
-                                      'Set', 'MutableSet',
-                                      'Container',
-                                      'Hashable',
-                                      'Sized',
-                                      'Callable',
-                                      'Iterable',
-                                      'Iterator',
-                                  )),
-    )
+        'collections': UnwantedEntry(
+            'collections.abc',
+            names=(
+                'MappingView',
+                'ItemsView',
+                'KeysView',
+                'ValuesView',
+                'Mapping', 'MutableMapping',
+                'Sequence', 'MutableSequence',
+                'Set', 'MutableSet',
+                'Container',
+                'Hashable',
+                'Sized',
+                'Callable',
+                'Iterable',
+                'Iterator',
+            )
+        ),
+
+        'ansible.module_utils.six': UnwantedEntry(
+            'the Python standard library equivalent'
+        ),
+    }
 
     unwanted_functions = {
         # see https://docs.python.org/3/library/tempfile.html#tempfile.mktemp

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

@@ -72,7 +72,7 @@ from ansible.module_utils.compat.version import StrictVersion, LooseVersion
 from ansible.module_utils.basic import to_bytes
 from ansible.plugins.loader import fragment_loader
 from ansible.plugins.list import IGNORE as REJECTLIST
-from ansible.utils.plugin_docs import add_collection_to_versions_and_dates, add_fragments, get_docstring
+from ansible.utils.plugin_docs import AnsibleFragmentError, add_collection_to_versions_and_dates, add_fragments, get_docstring
 from ansible.utils.version import SemanticVersion
 
 from .module_args import AnsibleModuleImportError, AnsibleModuleNotInitialized, get_py_argument_spec, get_ps_argument_spec
@@ -1003,21 +1003,15 @@ class ModuleValidator(Validator):
             add_collection_to_versions_and_dates(doc, self.collection_name,
                                                  is_module=self.plugin_type == 'module')
 
-            missing_fragment = False
             with CaptureStd():
                 try:
                     get_docstring(os.path.abspath(self.path), fragment_loader=fragment_loader,
                                   verbose=True,
                                   collection_name=self.collection_name,
                                   plugin_type=self.plugin_type)
-                except AssertionError:
-                    fragment = doc['extends_documentation_fragment']
-                    self.reporter.error(
-                        path=self.object_path,
-                        code='missing-doc-fragment',
-                        msg='DOCUMENTATION fragment missing: %s' % fragment
-                    )
-                    missing_fragment = True
+                except AnsibleFragmentError:
+                    # Will be re-triggered below when explicitly calling add_fragments()
+                    pass
                 except Exception as e:
                     self.reporter.trace(
                         path=self.object_path,
@@ -1029,9 +1023,16 @@ class ModuleValidator(Validator):
                         msg='Unknown DOCUMENTATION error, see TRACE: %s' % e
                     )
 
-            if not missing_fragment:
+            try:
                 add_fragments(doc, os.path.abspath(self.object_path), fragment_loader=fragment_loader,
-                              is_module=self.plugin_type == 'module')
+                              is_module=self.plugin_type == 'module', section='DOCUMENTATION')
+            except AnsibleFragmentError as exc:
+                error = str(exc).replace(os.path.abspath(self.object_path), self.object_path)
+                self.reporter.error(
+                    path=self.object_path,
+                    code='doc-fragment-error',
+                    msg=f'Error while adding fragments: {error}'
+                )
 
             if 'options' in doc and doc['options'] is None:
                 self.reporter.error(
@@ -1130,6 +1131,16 @@ class ModuleValidator(Validator):
                     self.collection_name,
                     is_module=self.plugin_type == 'module',
                     return_docs=True)
+                try:
+                    add_fragments(returns, os.path.abspath(self.object_path), fragment_loader=fragment_loader,
+                                  is_module=self.plugin_type == 'module', section='RETURN')
+                except AnsibleFragmentError as exc:
+                    error = str(exc).replace(os.path.abspath(self.object_path), self.object_path)
+                    self.reporter.error(
+                        path=self.object_path,
+                        code='return-fragment-error',
+                        msg=f'Error while adding fragments: {error}'
+                    )
             self._validate_docs_schema(
                 returns,
                 return_schema(for_collection=bool(self.collection), plugin_type=self.plugin_type),
@@ -1268,16 +1279,18 @@ class ModuleValidator(Validator):
         if not isinstance(options, dict):
             return
         for key, value in options.items():
-            self._validate_semantic_markup(value.get('description'))
-            self._validate_semantic_markup_options(value.get('suboptions'))
+            if isinstance(value, dict):
+                self._validate_semantic_markup(value.get('description'))
+                self._validate_semantic_markup_options(value.get('suboptions'))
 
     def _validate_semantic_markup_return_values(self, return_vars):
         if not isinstance(return_vars, dict):
             return
         for key, value in return_vars.items():
-            self._validate_semantic_markup(value.get('description'))
-            self._validate_semantic_markup(value.get('returned'))
-            self._validate_semantic_markup_return_values(value.get('contains'))
+            if isinstance(value, dict):
+                self._validate_semantic_markup(value.get('description'))
+                self._validate_semantic_markup(value.get('returned'))
+                self._validate_semantic_markup_return_values(value.get('contains'))
 
     def _validate_all_semantic_markup(self, docs, return_docs):
         if not isinstance(docs, dict):
@@ -1617,7 +1630,7 @@ class ModuleValidator(Validator):
         try:
             if not context:
                 add_fragments(docs, os.path.abspath(self.object_path), fragment_loader=fragment_loader,
-                              is_module=self.plugin_type == 'module')
+                              is_module=self.plugin_type == 'module', section='DOCUMENTATION')
         except Exception:
             # Cannot merge fragments
             return

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

@@ -28,7 +28,6 @@ from contextlib import contextmanager
 
 from ansible.executor.powershell.module_manifest import PSModuleDepFinder
 from ansible.module_utils.basic import FILE_COMMON_ARGUMENTS, AnsibleModule
-from ansible.module_utils.six import reraise
 from ansible.module_utils.common.text.converters import to_bytes, to_text
 
 from .utils import CaptureStd, find_executable, get_module_name_from_filename
@@ -153,7 +152,7 @@ def get_py_argument_spec(filename, collection):
             pass
         except BaseException as e:
             # we want to catch all exceptions here, including sys.exit
-            reraise(AnsibleModuleImportError, AnsibleModuleImportError('%s' % e), sys.exc_info()[2])
+            raise AnsibleModuleImportError from e
 
         if not fake.called:
             raise AnsibleModuleNotInitialized()