cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

ansible-test - Improve __main__ checks.

Browse source
This commit is contained in:
Matt Clay 2021-04-25 11:34:23 -07:00
parent 39a49963b5
commit 8223dfccbe
3 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
changelogs/fragments/ansible-test-main-check.yml Normal file
View file

@ -0,0 +1,6 @@
minor_changes:
- ansible-test - The ``validate-modules`` sanity test no longer enforces the ``missing-if-name-main``, ``last-line-main-call`` or ``missing-main-call`` checks
on non-deleted Ansible modules. Modules are still required to instantiate ``AnsibleModule`` when ``__name__ == '__main__'``.
- ansible-test - The ``import`` sanity test now requires that Ansible modules guard instantiation of ``AnsibleModule`` with a ``if __name__ == '__main__'``
conditional, or equivalent logic.
- ansible-test - The ``import`` sanity test now requires that non-modules do not instantiate ``AnsibleModule`` on import.

10
test/lib/ansible_test/_data/sanity/import/importer.py
View file

@ -238,6 +238,8 @@ def main():
capture_normal = Capture() capture_normal = Capture()
capture_main = Capture() capture_main = Capture()
run_module_ok = False
try: try:
with monitor_sys_modules(path, messages): with monitor_sys_modules(path, messages):
with restrict_imports(path, name, messages, restrict_to_module_paths): with restrict_imports(path, name, messages, restrict_to_module_paths):
@ -245,13 +247,19 @@ def main():
import_module(name) import_module(name)
if run_main: if run_main:
run_module_ok = is_ansible_module
with monitor_sys_modules(path, messages): with monitor_sys_modules(path, messages):
with restrict_imports(path, name, messages, restrict_to_module_paths): with restrict_imports(path, name, messages, restrict_to_module_paths):
with capture_output(capture_main): with capture_output(capture_main):
runpy.run_module(name, run_name='__main__', alter_sys=True) runpy.run_module(name, run_name='__main__', alter_sys=True)
except ImporterAnsibleModuleException: except ImporterAnsibleModuleException:
# module instantiated AnsibleModule without raising an exception # module instantiated AnsibleModule without raising an exception
pass if not run_module_ok:
if is_ansible_module:
report_message(path, 0, 0, 'module-guard', "AnsibleModule instantiation not guarded by `if __name__ == '__main__'`", messages)
else:
report_message(path, 0, 0, 'non-module', "AnsibleModule instantiated by import of non-module", messages)
except BaseException as ex: # pylint: disable=locally-disabled, broad-except except BaseException as ex: # pylint: disable=locally-disabled, broad-except
# intentionally catch all exceptions, including calls to sys.exit # intentionally catch all exceptions, including calls to sys.exit
exc_type, _exc, exc_tb = sys.exc_info() exc_type, _exc, exc_tb = sys.exc_info()

5
test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/main.py
View file

@ -545,7 +545,7 @@ class ModuleValidator(Validator):
**options['error'] **options['error']
) )
def _find_module_utils(self, main): def _find_module_utils(self):
linenos = [] linenos = []
found_basic = False found_basic = False
for child in self.ast.body: for child in self.ast.body:
@ -2228,8 +2228,7 @@ class ModuleValidator(Validator):
self._validate_ansible_module_call(docs) self._validate_ansible_module_call(docs)
self._check_for_sys_exit() self._check_for_sys_exit()
self._find_rejectlist_imports() self._find_rejectlist_imports()
main = self._find_main_call() self._find_module_utils()
self._find_module_utils(main)
self._find_has_import() self._find_has_import()
first_callable = self._get_first_callable() first_callable = self._get_first_callable()
self._ensure_imports_below_docs(doc_info, first_callable) self._ensure_imports_below_docs(doc_info, first_callable)