a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Prevent metadata changes in a stable branch (#48994)

pull/4420/head
Matt Martz 2018-11-26 08:51:39 -06:00 committed by John R Barker
parent 1ed9e72dc3
commit 7287d396e2
2 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/docsite/rst/dev_guide/testing_validate-modules.rst
View File

@ -126,6 +126,7 @@ Errors
331 argument in argument_spec must be a dictionary/hash when used 331 argument in argument_spec must be a dictionary/hash when used
332 ``AnsibleModule`` schema validation error 332 ``AnsibleModule`` schema validation error
333 ``ANSIBLE_METADATA.status`` of deprecated or removed can't include other statuses 333 ``ANSIBLE_METADATA.status`` of deprecated or removed can't include other statuses
334 ``ANSIBLE_METADATA`` cannot be changed in a point release for a stable branch
.. ..
--------- ------------------- --------- -------------------

16
test/sanity/validate-modules/main.py
View File

@ -873,6 +873,7 @@ class ModuleValidator(Validator):
filename_deprecated_or_removed = True filename_deprecated_or_removed = True
# Have to check the metadata first so that we know if the module is removed or deprecated # Have to check the metadata first so that we know if the module is removed or deprecated
metadata = None
if not bool(doc_info['ANSIBLE_METADATA']['value']): if not bool(doc_info['ANSIBLE_METADATA']['value']):
self.reporter.error( self.reporter.error(
path=self.object_path, path=self.object_path,
@ -880,7 +881,6 @@ class ModuleValidator(Validator):
msg='No ANSIBLE_METADATA provided' msg='No ANSIBLE_METADATA provided'
) )
else: else:
metadata = None
if isinstance(doc_info['ANSIBLE_METADATA']['value'], ast.Dict): if isinstance(doc_info['ANSIBLE_METADATA']['value'], ast.Dict):
metadata = ast.literal_eval( metadata = ast.literal_eval(
doc_info['ANSIBLE_METADATA']['value'] doc_info['ANSIBLE_METADATA']['value']
@ -998,7 +998,7 @@ class ModuleValidator(Validator):
self._validate_docs_schema(doc, doc_schema(self.object_name.split('.')[0]), 'DOCUMENTATION', 305) self._validate_docs_schema(doc, doc_schema(self.object_name.split('.')[0]), 'DOCUMENTATION', 305)
self._check_version_added(doc) self._check_version_added(doc)
self._check_for_new_args(doc) self._check_for_new_args(doc, metadata)
if not bool(doc_info['EXAMPLES']['value']): if not bool(doc_info['EXAMPLES']['value']):
self.reporter.error( self.reporter.error(
@ -1309,13 +1309,13 @@ class ModuleValidator(Validator):
msg='"%s" is listed in DOCUMENTATION.options, but not accepted by the module' % arg msg='"%s" is listed in DOCUMENTATION.options, but not accepted by the module' % arg
) )
def _check_for_new_args(self, doc): def _check_for_new_args(self, doc, metadata):
if not self.base_branch or self._is_new_module(): if not self.base_branch or self._is_new_module():
return return
with CaptureStd(): with CaptureStd():
try: try:
existing_doc = get_docstring(self.base_module, fragment_loader, verbose=True)[0] existing_doc, dummy_examples, dummy_return, existing_metadata = get_docstring(self.base_module, fragment_loader, verbose=True)
existing_options = existing_doc.get('options', {}) or {} existing_options = existing_doc.get('options', {}) or {}
except AssertionError: except AssertionError:
fragment = doc['extends_documentation_fragment'] fragment = doc['extends_documentation_fragment']
@ -1346,6 +1346,14 @@ class ModuleValidator(Validator):
except ValueError: except ValueError:
mod_version_added = StrictVersion('0.0') mod_version_added = StrictVersion('0.0')
if self.base_branch and 'stable-' in self.base_branch:
if metadata != existing_metadata:
self.reporter.error(
path=self.object_path,
code=334,
msg=('ANSIBLE_METADATA cannot be changed in a point release for a stable branch')
)
options = doc.get('options', {}) or {} options = doc.get('options', {}) or {}
should_be = '.'.join(ansible_version.split('.')[:2]) should_be = '.'.join(ansible_version.split('.')[:2])