ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-05-30 04:49:09 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add several new doc<->arg_spec checks (#36247)

Browse source 
* Add several new doc<->arg_spec checks. See #18183

* Update ignore.txt for validate-modules
This commit is contained in:
Matt Martz 2018-02-15 14:34:40 -06:00 • committed by John R Barker
parent 77fa41795e
commit 50adc5409b
4 changed files with 2958 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -45,7 +45,7 @@ from module_args import AnsibleModuleImportError, get_argument_spec
from schema import doc_schema, metadata_1_1_schema, return_schema
from utils import CaptureStd, parse_yaml
from utils import CaptureStd, compare_unordered_lists, maybe_convert_bool, parse_yaml
from voluptuous.humanize import humanize_error
from ansible.module_utils.six import PY3, with_metaclass
@ -1058,6 +1058,34 @@ class ModuleValidator(Validator):
'should not be marked as required' % arg)
)
doc_default = docs.get('options', {}).get(arg, {}).get('default', None)
if data.get('type') == 'bool':
doc_default = maybe_convert_bool(doc_default)
if 'default' in data and data['default'] != doc_default:
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)' % (data['default'], arg, doc_default))
)
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_choices = docs.get('options', {}).get(arg, {}).get('choices', [])
if not compare_unordered_lists(data.get('choices', []), doc_choices):
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)' % (data.get('choices', []), arg, doc_choices))
)
if docs:
try:
add_fragments(docs, self.object_path, fragment_loader=fragment_loader)