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

DOC options must be a dict when used with extends_documentation_fragment (#21745)

Browse source 
* Fix string formatting
* Provide better tracebacks
* When options is None and extends_documentation_fragment is in use, add an error that options must be a dict
* If options was specified and not a dict, then error
This commit is contained in:
Matt Martz 2017-02-21 19:42:39 -06:00 committed by Matt Clay
parent 404b2864ef
commit b143fdea54
2 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/ansible/utils/module_docs.py
View file

@ -117,7 +117,7 @@ def get_docstring(filename, verbose=False):
elif isinstance(doc[key], MutableSequence):
doc[key] = sorted(frozenset(doc[key] + value))
else:
raise Exception("Attempt to extend a documentation fragement (%s) of unknown type: %s" (fragment_name, filename))
raise Exception("Attempt to extend a documentation fragement (%s) of unknown type: %s" % (fragment_name, filename))
elif 'EXAMPLES' == theid:
plainexamples = child.value.s[1:] # Skip first empty line

16
test/sanity/validate-modules/validate-modules
View file

@ -28,6 +28,7 @@ import re
import subprocess
import sys
import tempfile
import traceback
from collections import OrderedDict
from contextlib import contextmanager
@ -569,13 +570,20 @@ class ModuleValidator(Validator):
303,
'DOCUMENTATION fragment missing: %s' % fragment
))
except Exception as e:
self.traces.append(e)
except Exception:
self.traces.append(traceback.format_exc())
self.errors.append((
304,
'Unknown DOCUMENTATION error, see TRACE'
))
if 'options' in doc and doc['options'] is None and doc.get('extends_documentation_fragment'):
self.errors.append((
305,
('DOCUMENTATION.options must be a dictionary/hash when used '
'with DOCUMENTATION.extends_documentation_fragment')
))
self._validate_docs_schema(doc, doc_schema, 'DOCUMENTATION', 305)
self._check_version_added(doc)
self._check_for_new_args(doc)
@ -760,8 +768,8 @@ class ModuleValidator(Validator):
self.errors.append((401, 'Python SyntaxError while parsing module'))
try:
compile(self.text, self.path, 'exec')
except Exception as e:
self.traces.append(e)
except Exception:
self.traces.append(traceback.format_exc())
return
if self._python_module():