ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-28 21:31:26 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

validate-modules: Documentation bool (#50085)

Browse source 
* validate-modules: Documentation bool

This check allows to catch cases where type of argument is different than documentation does.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Wrong comparison for 'str'

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Add ignore.txt

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Fix logic and clean up ignore.txt
This commit is contained in:
Abhijeet Kasurde 2019-02-16 03:57:52 +05:30 • committed by Matt Clay
parent f1e67c3328
commit e0d8d9c2bf
3 changed files with 70 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

28
test/sanity/validate-modules/main.py
View file

@ -1235,18 +1235,25 @@ class ModuleValidator(Validator):
self.reporter.error(
path=self.object_path,
code=324,
msg=('Value for "default" from the argument_spec (%r) for "%s" does not match the '
'documentation (%r)' % (arg_default, arg, doc_default))
msg=("argument_spec for '%s' defines default as '%s' but documentation defines default as '%s'" % (arg, arg_default, doc_default))
)
# TODO: needs to recursively traverse suboptions
doc_type = docs.get('options', {}).get(arg, {}).get('type', 'str')
if 'type' in data and data['type'] == 'bool' and doc_type != 'bool':
self.reporter.error(
path=self.object_path,
code=325,
msg='argument_spec for "%s" defines type="bool" but documentation does not' % (arg,)
)
doc_type = docs.get('options', {}).get(arg, {}).get('type')
if 'type' in data:
if data['type'] != doc_type and doc_type is not None:
self.reporter.error(
path=self.object_path,
code=325,
msg="argument_spec for '%s' defines type as '%s' but documentation defines type as '%s'" % (arg, data['type'], doc_type)
)
else:
if doc_type != 'str' and doc_type is not None:
self.reporter.error(
path=self.object_path,
code=335,
msg="argument_spec for '%s' implies type as 'str' but documentation defines as '%s'" % (arg, doc_type)
)
# TODO: needs to recursively traverse suboptions
doc_choices = []
@ -1287,8 +1294,7 @@ class ModuleValidator(Validator):
self.reporter.error(
path=self.object_path,
code=326,
msg=('Value for "choices" from the argument_spec (%r) for "%s" does not match the '
'documentation (%r)' % (arg_choices, arg, doc_choices))
msg=("argument_spec for '%s' defines choices as '%s' but documentation defines choices as '%s'" % (arg, arg_choices, doc_choices))
)
if docs: