50adc5409b
* Add several new doc<->arg_spec checks. See #18183 * Update ignore.txt for validate-modules
138 lines
4.2 KiB
Python
138 lines
4.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2015 Matt Martz <matt@sivel.net>
|
|
# Copyright (C) 2015 Rackspace US, Inc.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import ast
|
|
import sys
|
|
|
|
from io import BytesIO, TextIOWrapper
|
|
|
|
import yaml
|
|
import yaml.reader
|
|
|
|
from ansible.module_utils._text import to_text
|
|
from ansible.module_utils.parsing.convert_bool import boolean
|
|
|
|
|
|
class AnsibleTextIOWrapper(TextIOWrapper):
|
|
def write(self, s):
|
|
super(AnsibleTextIOWrapper, self).write(to_text(s, self.encoding, errors='replace'))
|
|
|
|
|
|
def find_globals(g, tree):
|
|
"""Uses AST to find globals in an ast tree"""
|
|
for child in tree:
|
|
if hasattr(child, 'body') and isinstance(child.body, list):
|
|
find_globals(g, child.body)
|
|
elif isinstance(child, (ast.FunctionDef, ast.ClassDef)):
|
|
g.add(child.name)
|
|
continue
|
|
elif isinstance(child, ast.Assign):
|
|
try:
|
|
g.add(child.targets[0].id)
|
|
except (IndexError, AttributeError):
|
|
pass
|
|
elif isinstance(child, ast.Import):
|
|
g.add(child.names[0].name)
|
|
elif isinstance(child, ast.ImportFrom):
|
|
for name in child.names:
|
|
g_name = name.asname or name.name
|
|
if g_name == '*':
|
|
continue
|
|
g.add(g_name)
|
|
|
|
|
|
class CaptureStd():
|
|
"""Context manager to handle capturing stderr and stdout"""
|
|
|
|
def __enter__(self):
|
|
self.sys_stdout = sys.stdout
|
|
self.sys_stderr = sys.stderr
|
|
sys.stdout = self.stdout = AnsibleTextIOWrapper(BytesIO(), encoding=self.sys_stdout.encoding)
|
|
sys.stderr = self.stderr = AnsibleTextIOWrapper(BytesIO(), encoding=self.sys_stderr.encoding)
|
|
return self
|
|
|
|
def __exit__(self, exc_type, exc_value, traceback):
|
|
sys.stdout = self.sys_stdout
|
|
sys.stderr = self.sys_stderr
|
|
|
|
def get(self):
|
|
"""Return ``(stdout, stderr)``"""
|
|
|
|
return self.stdout.buffer.getvalue(), self.stderr.buffer.getvalue()
|
|
|
|
|
|
def parse_yaml(value, lineno, module, name, load_all=False):
|
|
traces = []
|
|
errors = []
|
|
data = None
|
|
|
|
if load_all:
|
|
loader = yaml.safe_load_all
|
|
else:
|
|
loader = yaml.safe_load
|
|
|
|
try:
|
|
data = loader(value)
|
|
if load_all:
|
|
data = list(data)
|
|
except yaml.MarkedYAMLError as e:
|
|
e.problem_mark.line += lineno - 1
|
|
e.problem_mark.name = '%s.%s' % (module, name)
|
|
errors.append({
|
|
'msg': '%s is not valid YAML' % name,
|
|
'line': e.problem_mark.line + 1,
|
|
'column': e.problem_mark.column + 1
|
|
})
|
|
traces.append(e)
|
|
except yaml.reader.ReaderError as e:
|
|
traces.append(e)
|
|
# TODO: Better line/column detection
|
|
errors.append({
|
|
'msg': ('%s is not valid YAML. Character '
|
|
'0x%x at position %d.' % (name, e.character, e.position)),
|
|
'line': lineno
|
|
})
|
|
except yaml.YAMLError as e:
|
|
traces.append(e)
|
|
errors.append({
|
|
'msg': '%s is not valid YAML: %s: %s' % (name, type(e), e),
|
|
'line': lineno
|
|
})
|
|
|
|
return data, errors, traces
|
|
|
|
|
|
def maybe_convert_bool(value):
|
|
"""Safe conversion to boolean, catching TypeError and returning the original result
|
|
|
|
Only used in doc<->arg_spec comparisons
|
|
"""
|
|
try:
|
|
return boolean(value)
|
|
except TypeError:
|
|
return value
|
|
|
|
|
|
def compare_unordered_lists(a, b):
|
|
"""Safe list comparisons
|
|
|
|
Supports:
|
|
- unordered lists
|
|
- unhashable elements
|
|
"""
|
|
return len(a) == len(b) and all(x in b for x in a)
|