internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-01 00:03:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add checks for from module_utils import * (#21800)

Browse Source
This commit is contained in:
Matt Martz
2017-02-22 15:16:35 -06:00
committed by Matt Clay
parent 8c521655e1
commit 4b320ce0e4
2 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
test/sanity/validate-modules/README.rst
View File

@@ -76,6 +76,8 @@ Errors
+---------+--------------------------------------------------------------------------------------------------------------------------------------------+
| 207 | ``REPLACER_WINDOWS`` not found in module |
+---------+--------------------------------------------------------------------------------------------------------------------------------------------+
| 208 | ``module_utils`` imports should import specific components, not ``*`` |
+---------+--------------------------------------------------------------------------------------------------------------------------------------------+
+---------+--------------------------------------------------------------------------------------------------------------------------------------------+
| **3xx** | **Documentation** |
+---------+--------------------------------------------------------------------------------------------------------------------------------------------+
@@ -140,6 +142,8 @@ Warnings
+=========+============================================================================================================================================+
| **2xx** | **Imports** |
+---------+--------------------------------------------------------------------------------------------------------------------------------------------+
| 208 | ``module_utils`` imports should import specific components for legacy module, not ``*`` |
+---------+--------------------------------------------------------------------------------------------------------------------------------------------+
| 291 | Try/Except ``HAS_`` expression missing |
+---------+--------------------------------------------------------------------------------------------------------------------------------------------+
| 292 | Did not find ``ansible.module_utils.basic`` import |

13
test/sanity/validate-modules/validate-modules
View File

@@ -364,6 +364,19 @@ class ModuleValidator(Validator):
linenos.append(child.lineno)
for name in child.names:
if ('module_utils' in getattr(child, 'module', '') and
isinstance(name, ast.alias) and
name.name == '*'):
msg = (
208,
('module_utils imports should import specific '
'components, not "*". line %d' % child.lineno)
)
if self._is_new_module():
self.errors.append(msg)
else:
self.warnings.append(msg)
if (isinstance(name, ast.alias) and
name.name == 'basic'):
found_basic = True