Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use repr on replacements for only_if #1091

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/ansible/runner/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ def _executor_internal_inner(self, host, module_name, module_args, inject, port,
new_args = new_args + "%s='%s' " % (k,v)
module_args = new_args

conditional = utils.template(self.basedir, self.conditional, inject)
conditional = utils.template(self.basedir, self.conditional, inject, do_repr=True)
if not utils.check_conditional(conditional):
result = utils.jsonify(dict(skipped=True))
self.callbacks.on_skipped(host, inject.get('item',None))
Expand Down
30 changes: 18 additions & 12 deletions lib/ansible/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,12 +174,13 @@ def parse_json(raw_data):
class VarNotFoundException(Exception):
pass

def _varLookup(name, vars):
def _varLookup(name, vars, depth=0):
''' find the contents of a possibly complex variable in vars. '''

path = name.split('.')
space = vars
for part in path:
part = varReplace(part, vars, depth=depth + 1)
if part in space:
space = space[part]
elif "[" in part:
Expand All @@ -194,7 +195,7 @@ def _varLookup(name, vars):
raise VarNotFoundException()
return space

_KEYCRE = re.compile(r"\$(?P<complex>\{){0,1}((?(complex)[\w\.\[\]]+|\w+))(?(complex)\})")
_KEYCRE = re.compile(r"\$(?P<complex>\{){0,1}((?(complex)[\w\.\[\]\$\{\}]+|\w+))(?(complex)\})")

def varLookup(varname, vars):
''' helper function used by with_items '''
Expand All @@ -207,10 +208,13 @@ def varLookup(varname, vars):
except VarNotFoundException:
return None

def varReplace(raw, vars):
def varReplace(raw, vars, do_repr=False, depth=0):
''' Perform variable replacement of $variables in string raw using vars dictionary '''
# this code originally from yum

if (depth > 20):
raise errors.AnsibleError("template recursion depth exceeded")

done = [] # Completed chunks to return

while raw:
Expand All @@ -223,11 +227,19 @@ def varReplace(raw, vars):
# original)

try:
replacement = unicode(_varLookup(m.group(2), vars))
replacement = unicode(_varLookup(m.group(2), vars, depth))
replacement = varReplace(replacement, vars, depth=depth + 1)
except VarNotFoundException:
replacement = m.group()

start, end = m.span()
if do_repr:
replacement = repr(replacement)
if (start > 0 and
((raw[start - 1] == "'" and raw[end] == "'") or
(raw[start - 1] == '"' and raw[end] == '"'))):
start -= 1
end += 1
done.append(raw[:start]) # Keep stuff leading up to token
done.append(replacement) # Append replacement value
raw = raw[end:] # Continue with remainder of string
Expand Down Expand Up @@ -269,21 +281,15 @@ def varReplaceFilesAndPipes(basedir, raw):
return ''.join(done)


def template(basedir, text, vars):
def template(basedir, text, vars, do_repr=False):
''' run a text buffer through the templating engine until it no longer changes '''

prev_text = ''
try:
text = text.decode('utf-8')
except UnicodeEncodeError:
pass # already unicode
depth = 0
while prev_text != text:
depth = depth + 1
if (depth > 20):
raise errors.AnsibleError("template recursion depth exceeded")
prev_text = text
text = varReplace(unicode(text), vars)
text = varReplace(unicode(text), vars, do_repr)
text = varReplaceFilesAndPipes(basedir, text)
return text

Expand Down
49 changes: 49 additions & 0 deletions test/TestUtils.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,55 @@ def test_varReplace_nested_list(self):

assert res == 'hello world'

def test_varReplace_repr_basic(self):
vars = {
'color': '$favorite_color',
'favorite_color': 'blue',
}

template = '$color == "blue"'
res = ansible.utils.varReplace(template, vars, do_repr=True)
assert eval(res)

def test_varReplace_repr_varinvar(self):
vars = {
'foo': 'foo',
'bar': 'bar',
'foobar': '$foo$bar',
'var': {
'foo': 'foo',
'foobar': '$foo$bar',
},
}

template = '$foobar == "foobar"'
res = ansible.utils.varReplace(template, vars, do_repr=True)
assert eval(res)

def test_varReplace_repr_varindex(self):
vars = {
'foo': 'foo',
'var': {
'foo': 'bar',
},
}

template = '${var.$foo} == "bar"'
res = ansible.utils.varReplace(template, vars, do_repr=True)
assert eval(res)

def test_varReplace_repr_varpartindex(self):
vars = {
'foo': 'foo',
'var': {
'foobar': 'foobar',
},
}

template = '${var.${foo}bar} == "foobar"'
res = ansible.utils.varReplace(template, vars, do_repr=True)
assert eval(res)

def test_template_varReplace_iterated(self):
template = 'hello $who'
vars = {
Expand Down