ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Finishing touches on template cleanup.

Browse source
This commit is contained in:
Michael DeHaan 2013-10-19 11:37:13 -04:00
parent 1e85c7544b
commit 5031104c3a
3 changed files with 71 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
lib/ansible/runner/__init__.py
View file

@ -71,11 +71,6 @@ def _executor_hook(job_queue, result_queue, new_stdin):
host = job_queue.get(block=False) host = job_queue.get(block=False)
return_data = multiprocessing_runner._executor(host, new_stdin) return_data = multiprocessing_runner._executor(host, new_stdin)
result_queue.put(return_data) result_queue.put(return_data)
if 'LEGACY_TEMPLATE_WARNING' in return_data.flags:
# pass data back up across the multiprocessing fork boundary
template.Flags.LEGACY_TEMPLATE_WARNING = True
except Queue.Empty: except Queue.Empty:
pass pass
except: except:
@ -371,15 +366,6 @@ class Runner(object):
def _executor(self, host, new_stdin): def _executor(self, host, new_stdin):
''' handler for multiprocessing library ''' ''' handler for multiprocessing library '''
def get_flags():
# flags are a way of passing arbitrary event information
# back up the chain, since multiprocessing forks and doesn't
# allow state exchange
flags = []
if template.Flags.LEGACY_TEMPLATE_WARNING:
flags.append('LEGACY_TEMPLATE_WARNING')
return flags
try: try:
if not new_stdin: if not new_stdin:
self._new_stdin = os.fdopen(os.dup(sys.stdin.fileno())) self._new_stdin = os.fdopen(os.dup(sys.stdin.fileno()))
@ -389,7 +375,6 @@ class Runner(object):
exec_rc = self._executor_internal(host, new_stdin) exec_rc = self._executor_internal(host, new_stdin)
if type(exec_rc) != ReturnData: if type(exec_rc) != ReturnData:
raise Exception("unexpected return type: %s" % type(exec_rc)) raise Exception("unexpected return type: %s" % type(exec_rc))
exec_rc.flags = get_flags()
# redundant, right? # redundant, right?
if not exec_rc.comm_ok: if not exec_rc.comm_ok:
self.callbacks.on_unreachable(host, exec_rc.result) self.callbacks.on_unreachable(host, exec_rc.result)
@ -397,11 +382,11 @@ class Runner(object):
except errors.AnsibleError, ae: except errors.AnsibleError, ae:
msg = str(ae) msg = str(ae)
self.callbacks.on_unreachable(host, msg) self.callbacks.on_unreachable(host, msg)
return ReturnData(host=host, comm_ok=False, result=dict(failed=True, msg=msg), flags=get_flags()) return ReturnData(host=host, comm_ok=False, result=dict(failed=True, msg=msg))
except Exception: except Exception:
msg = traceback.format_exc() msg = traceback.format_exc()
self.callbacks.on_unreachable(host, msg) self.callbacks.on_unreachable(host, msg)
return ReturnData(host=host, comm_ok=False, result=dict(failed=True, msg=msg), flags=get_flags()) return ReturnData(host=host, comm_ok=False, result=dict(failed=True, msg=msg))
# ***************************************************** # *****************************************************

85
lib/ansible/utils/template.py
View file

@ -70,9 +70,6 @@ def _get_extensions():
return jinja_exts return jinja_exts
class Flags:
LEGACY_TEMPLATE_WARNING = False
# TODO: refactor this file # TODO: refactor this file
FILTER_PLUGINS = None FILTER_PLUGINS = None
@ -97,10 +94,13 @@ def _legacy_varFindLimitSpace(basedir, vars, space, part, lookup_fatal, depth, e
templating for part and a few more things templating for part and a few more things
DEPRECATED DEPRECATED
LEGACY VARIABLES ARE SLATED FOR REMOVAL IN ANSIBLE 1.6 LEGACY VARIABLES ARE SLATED FOR REMOVAL IN ANSIBLE 1.5
use {{ foo }} INSTEAD use {{ foo }} INSTEAD
''' '''
if not C.DEFAULT_LEGACY_PLAYBOOK_VARIABLES:
raise Exception("we should not be here")
# Previous part couldn't be found, nothing to limit to # Previous part couldn't be found, nothing to limit to
if space is None: if space is None:
return space return space
@ -153,14 +153,14 @@ def _legacy_varFind(basedir, text, vars, lookup_fatal, depth, expand_lists):
original data in the caller. original data in the caller.
DEPRECATED DEPRECATED
LEGACY VARIABLES ARE SLATED FOR REMOVAL IN ANSIBLE 1.6 LEGACY VARIABLES ARE SLATED FOR REMOVAL IN ANSIBLE 1.5
use {{ foo }} INSTEAD use {{ foo }} INSTEAD
''' '''
# short circuit this whole function if we have specified we don't want # short circuit this whole function if we have specified we don't want
# legacy var replacement # legacy var replacement
if C.DEFAULT_LEGACY_PLAYBOOK_VARIABLES == False: if not C.DEFAULT_LEGACY_PLAYBOOK_VARIABLES:
return None raise Exception("we should not be here")
start = text.find("$") start = text.find("$")
if start == -1: if start == -1:
@ -271,10 +271,13 @@ def legacy_varReplace(basedir, raw, vars, lookup_fatal=True, depth=0, expand_lis
''' Perform variable replacement of $variables in string raw using vars dictionary ''' Perform variable replacement of $variables in string raw using vars dictionary
DEPRECATED DEPRECATED
LEGACY VARIABLES ARE SLATED FOR REMOVAL IN ANSIBLE 1.6 LEGACY VARIABLES ARE SLATED FOR REMOVAL IN ANSIBLE 1.5
use {{ foo }} INSTEAD use {{ foo }} INSTEAD
''' '''
if not C.DEFAULT_LEGACY_PLAYBOOK_VARIABLES:
raise Exception("we should not be here")
# this code originally from yum (and later modified a lot) # this code originally from yum (and later modified a lot)
orig = raw orig = raw
@ -313,17 +316,26 @@ def legacy_varReplace(basedir, raw, vars, lookup_fatal=True, depth=0, expand_lis
if result != orig: if result != orig:
from ansible import utils from ansible import utils
utils.deprecated("Legacy variable subsitution, such as using ${foo} or $foo instead of {{ foo }} is currently valid but will be phased out and has been out of favor since version 1.2. This is the last of legacy features on our deprecation list. You may continue to use this if you have specific needs for now","1.6") utils.deprecated("Legacy variable subsitution, such as using ${foo} or $foo instead of {{ foo }} is currently valid but will be phased out and has been out of favor since version 1.2. This is the last of legacy features on our deprecation list. You may continue to use this if you have specific needs for now","1.5")
return result return result
def template(basedir, input_value, vars, lookup_fatal=True, depth=-1, expand_lists=True, convert_bare=False): def template(basedir, input_value, vars, lookup_fatal=True, depth=-1, expand_lists=True, convert_bare=False, fail_on_undefined=False, filter_fatal=True):
last_time = input_value last_time = input_value
result = None result = None
changed = True changed = True
while changed: while changed:
result = _template( result = _template(
basedir, last_time, vars, lookup_fatal=lookup_fatal, depth=depth, expand_lists=expand_lists, convert_bare=convert_bare) basedir,
last_time,
vars,
lookup_fatal=lookup_fatal,
depth=depth,
expand_lists=expand_lists,
convert_bare=convert_bare,
fail_on_undefined=fail_on_undefined,
filter_fatal=filter_fatal,
)
if last_time != result: if last_time != result:
changed = True changed = True
else: else:
@ -334,7 +346,7 @@ def template(basedir, input_value, vars, lookup_fatal=True, depth=-1, expand_lis
raise errors.AnsibleError("template recursion depth exceeded") raise errors.AnsibleError("template recursion depth exceeded")
return result return result
def template(basedir, varname, vars, lookup_fatal=True, depth=0, expand_lists=True, convert_bare=False, fail_on_undefined=False, filter_fatal=True): def _template(basedir, varname, vars, lookup_fatal=True, depth=0, expand_lists=True, convert_bare=False, fail_on_undefined=False, filter_fatal=True):
''' templates a data structure by traversing it and substituting for other data structures ''' ''' templates a data structure by traversing it and substituting for other data structures '''
try: try:
@ -346,24 +358,25 @@ def template(basedir, varname, vars, lookup_fatal=True, depth=0, expand_lists=Tr
if isinstance(varname, basestring): if isinstance(varname, basestring):
if '{{' in varname or '{%' in varname: if '{{' in varname or '{%' in varname:
varname = template_from_string(basedir, varname, vars, fail_on_undefined) varname = template_from_string(basedir, varname, vars, fail_on_undefined)
if not '$' in varname:
if not C.DEFAULT_LEGACY_PLAYBOOK_VARIABLES:
return varname return varname
if not '$' in varname:
return varname
m = _legacy_varFind(basedir, varname, vars, lookup_fatal, depth, expand_lists) m = _legacy_varFind(basedir, varname, vars, lookup_fatal, depth, expand_lists)
if not m: if not m:
return varname return varname
if m['start'] == 0 and m['end'] == len(varname): if m['start'] == 0 and m['end'] == len(varname):
if m['replacement'] is not None: if m['replacement'] is not None:
Flags.LEGACY_TEMPLATE_WARNING = True
return template(basedir, m['replacement'], vars, lookup_fatal, depth, expand_lists) return template(basedir, m['replacement'], vars, lookup_fatal, depth, expand_lists)
else: else:
return varname return varname
else: else:
Flags.LEGACY_TEMPLATE_WARNING = True
return legacy_varReplace(basedir, varname, vars, lookup_fatal, depth, expand_lists) return legacy_varReplace(basedir, varname, vars, lookup_fatal, depth, expand_lists)
elif isinstance(varname, (list, tuple)): elif isinstance(varname, (list, tuple)):
return [template(basedir, v, vars, lookup_fatal, depth, expand_lists, fail_on_undefined=fail_on_undefined) for v in varname] return [ template(basedir, v, vars, lookup_fatal, depth, expand_lists, fail_on_undefined=fail_on_undefined) for v in varname]
elif isinstance(varname, dict): elif isinstance(varname, dict):
d = {} d = {}
for (k, v) in varname.iteritems(): for (k, v) in varname.iteritems():
@ -371,6 +384,7 @@ def template(basedir, varname, vars, lookup_fatal=True, depth=0, expand_lists=Tr
return d return d
else: else:
return varname return varname
except errors.AnsibleFilterError: except errors.AnsibleFilterError:
if filter_fatal: if filter_fatal:
raise raise
@ -394,7 +408,6 @@ def template_from_file(basedir, path, vars):
environment.filters.update(_get_filters()) environment.filters.update(_get_filters())
environment.globals['lookup'] = my_lookup environment.globals['lookup'] = my_lookup
if fail_on_undefined: if fail_on_undefined:
print "DEBUG: fail on undefined is engaged"
environment.undefined = StrictUndefined environment.undefined = StrictUndefined
try: try:
@ -414,7 +427,6 @@ def template_from_file(basedir, path, vars):
(key,val) = pair.split(':') (key,val) = pair.split(':')
setattr(environment,key.strip(),ast.literal_eval(val.strip())) setattr(environment,key.strip(),ast.literal_eval(val.strip()))
t = environment.from_string(data)
vars = vars.copy() vars = vars.copy()
try: try:
template_uid = pwd.getpwuid(os.stat(realpath).st_uid).pw_name template_uid = pwd.getpwuid(os.stat(realpath).st_uid).pw_name
@ -439,9 +451,16 @@ def template_from_file(basedir, path, vars):
) )
try: try:
t = environment.from_string(data)
res = t.render(vars) res = t.render(vars)
except jinja2.exceptions.UndefinedError, e: except jinja2.exceptions.UndefinedError, e:
raise errors.AnsibleUndefinedVariable("One or more undefined variables: %s" % str(e)) raise errors.AnsibleUndefinedVariable("One or more undefined variables: %s" % str(e))
except TemplateSyntaxError, e:
# Throw an exception which includes a more user friendly error message
values = dict(name=realpath, lineno=e.lineno, error=str(e))
msg = 'file: %(name)s, line number: %(lineno)s, error: %(error)s' % values
error = errors.AnsibleError(msg)
raise error
if data.endswith('\n') and not res.endswith('\n'): if data.endswith('\n') and not res.endswith('\n'):
res = res + '\n' res = res + '\n'
@ -450,13 +469,14 @@ def template_from_file(basedir, path, vars):
def template_from_string(basedir, data, vars, fail_on_undefined=False): def template_from_string(basedir, data, vars, fail_on_undefined=False):
''' run a string through the (Jinja2) templating engine ''' ''' run a string through the (Jinja2) templating engine '''
def my_lookup(*args, **kwargs):
kwargs['vars'] = vars
return lookup(*args, basedir=basedir, **kwargs)
if type(data) == str: if type(data) == str:
data = unicode(data, 'utf-8') data = unicode(data, 'utf-8')
environment = jinja2.Environment(trim_blocks=True, undefined=StrictUndefined, extensions=_get_extensions()) environment = jinja2.Environment(trim_blocks=True, undefined=StrictUndefined, extensions=_get_extensions())
environment.filters.update(_get_filters()) environment.filters.update(_get_filters())
if fail_on_undefined:
print "DEBUG: fail on undefined is engaged, 2"
environment.undefined = StrictUndefined
if '_original_file' in vars: if '_original_file' in vars:
basedir = os.path.dirname(vars['_original_file']) basedir = os.path.dirname(vars['_original_file'])
@ -467,6 +487,21 @@ def template_from_string(basedir, data, vars, fail_on_undefined=False):
# TODO: may need some way of using lookup plugins here seeing we aren't calling # TODO: may need some way of using lookup plugins here seeing we aren't calling
# the legacy engine, lookup() as a function, perhaps? # the legacy engine, lookup() as a function, perhaps?
if type(data) == str:
data = unicode(data, 'utf-8')
environment = jinja2.Environment(trim_blocks=True, undefined=StrictUndefined, extensions=_get_extensions())
environment.filters.update(_get_filters())
if '_original_file' in vars:
basedir = os.path.dirname(vars['_original_file'])
filesdir = os.path.abspath(os.path.join(basedir, '..', 'files'))
if os.path.exists(filesdir):
basedir = filesdir
# TODO: may need some way of using lookup plugins here seeing we aren't calling
# the legacy engine, lookup() as a function, perhaps?
data = data.decode('utf-8')
try: try:
t = environment.from_string(data) t = environment.from_string(data)
except Exception, e: except Exception, e:
@ -475,19 +510,11 @@ def template_from_string(basedir, data, vars, fail_on_undefined=False):
else: else:
return data return data
def my_lookup(*args, **kwargs):
kwargs['vars'] = vars
return lookup(*args, basedir=basedir, **kwargs)
t.globals['lookup'] = my_lookup
try: try:
return t.render(vars) return t.render(vars)
except jinja2.exceptions.UndefinedError: except jinja2.exceptions.UndefinedError:
if fail_on_undefined: if fail_on_undefined:
raise raise
else: else:
# this shouldn't happen due to undeclared check above
return data return data

12
test/TestUtils.py
View file

@ -9,6 +9,7 @@ from nose.plugins.skip import SkipTest
import ansible.utils import ansible.utils
import ansible.utils.template as template2 import ansible.utils.template as template2
import ansible.constants as C
class TestUtils(unittest.TestCase): class TestUtils(unittest.TestCase):
@ -16,6 +17,10 @@ class TestUtils(unittest.TestCase):
### varReplace function tests ### varReplace function tests
def test_varReplace_var_complex_var(self): def test_varReplace_var_complex_var(self):
old_setting = C.DEFAULT_LEGACY_PLAYBOOK_VARIABLES
C.DEFAULT_LEGACY_PLAYBOOK_VARIABLES = True
vars = { vars = {
'x': '$y', 'x': '$y',
'y': { 'y': {
@ -26,6 +31,8 @@ class TestUtils(unittest.TestCase):
res = template2.template(None, template, vars) res = template2.template(None, template, vars)
assert res == 'result' assert res == 'result'
C.DEFAULT_LEGACY_PLAYBOOK_VARIABLES = old_setting
##################################### #####################################
### template_ds function tests ### template_ds function tests
@ -53,6 +60,9 @@ class TestUtils(unittest.TestCase):
], ],
} }
old_setting = C.DEFAULT_LEGACY_PLAYBOOK_VARIABLES
C.DEFAULT_LEGACY_PLAYBOOK_VARIABLES = True
template = '${data.var}' template = '${data.var}'
res = template2.template(None, template, vars) res = template2.template(None, template, vars)
assert sorted(res) == sorted(vars['data']['var']) assert sorted(res) == sorted(vars['data']['var'])
@ -69,6 +79,8 @@ class TestUtils(unittest.TestCase):
res = template2.template(None, template, vars) res = template2.template(None, template, vars)
assert res == template assert res == template
C.DEFAULT_LEGACY_PLAYBOOK_VARIABLES = old_setting
##################################### #####################################
### Template function tests ### Template function tests