ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-23 13:20:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Allow for vaulted templates in template lookup (#49819)

Browse source 
Fixes #34209
This commit is contained in:
Martin Krizek 2019-01-07 16:06:01 +01:00 • committed by Brian Coca
commit 6d604f9b01
6 changed files with 55 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/34209-template-lookup-vault-support.yaml Normal file
View file

@ -0,0 +1,2 @@
minor_changes:
- Allow for vaulted templates in template lookup (https://github.com/ansible/ansible/issues/34209)

62
lib/ansible/plugins/lookup/template.py
View file

@ -73,41 +73,41 @@ class LookupModule(LookupBase):
lookupfile = self.find_file_in_search_path(variables, 'templates', term) lookupfile = self.find_file_in_search_path(variables, 'templates', term)
display.vvvv("File lookup using %s as file" % lookupfile) display.vvvv("File lookup using %s as file" % lookupfile)
if lookupfile: if lookupfile:
with open(to_bytes(lookupfile, errors='surrogate_or_strict'), 'rb') as f: b_template_data, show_data = self._loader._get_file_contents(lookupfile)
template_data = to_text(f.read(), errors='surrogate_or_strict') template_data = to_text(b_template_data, errors='surrogate_or_strict')
# set jinja2 internal search path for includes # set jinja2 internal search path for includes
searchpath = variables.get('ansible_search_path', []) searchpath = variables.get('ansible_search_path', [])
if searchpath: if searchpath:
# our search paths aren't actually the proper ones for jinja includes. # our search paths aren't actually the proper ones for jinja includes.
# We want to search into the 'templates' subdir of each search path in # We want to search into the 'templates' subdir of each search path in
# addition to our original search paths. # addition to our original search paths.
newsearchpath = [] newsearchpath = []
for p in searchpath: for p in searchpath:
newsearchpath.append(os.path.join(p, 'templates')) newsearchpath.append(os.path.join(p, 'templates'))
newsearchpath.append(p) newsearchpath.append(p)
searchpath = newsearchpath searchpath = newsearchpath
searchpath.insert(0, os.path.dirname(lookupfile)) searchpath.insert(0, os.path.dirname(lookupfile))
self._templar.environment.loader.searchpath = searchpath self._templar.environment.loader.searchpath = searchpath
if variable_start_string is not None: if variable_start_string is not None:
self._templar.environment.variable_start_string = variable_start_string self._templar.environment.variable_start_string = variable_start_string
if variable_end_string is not None: if variable_end_string is not None:
self._templar.environment.variable_end_string = variable_end_string self._templar.environment.variable_end_string = variable_end_string
# The template will have access to all existing variables, # The template will have access to all existing variables,
# plus some added by ansible (e.g., template_{path,mtime}), # plus some added by ansible (e.g., template_{path,mtime}),
# plus anything passed to the lookup with the template_vars= # plus anything passed to the lookup with the template_vars=
# argument. # argument.
vars = variables.copy() vars = variables.copy()
vars.update(generate_ansible_template_vars(lookupfile)) vars.update(generate_ansible_template_vars(lookupfile))
vars.update(lookup_template_vars) vars.update(lookup_template_vars)
self._templar.set_available_variables(vars) self._templar.set_available_variables(vars)
# do the templating # do the templating
res = self._templar.template(template_data, preserve_trailing_newlines=True, res = self._templar.template(template_data, preserve_trailing_newlines=True,
convert_data=convert_data_p, escape_backslashes=False) convert_data=convert_data_p, escape_backslashes=False)
ret.append(res) ret.append(res)
else: else:
raise AnsibleError("the template file %s could not be found for the lookup" % term) raise AnsibleError("the template file %s could not be found for the lookup" % term)

2
test/integration/targets/lookups/runme.sh
View file

@ -7,3 +7,5 @@ set -eux
pip install passlib pip install passlib
ANSIBLE_ROLES_PATH=../ ansible-playbook lookups.yml -i ../../inventory -e @../../integration_config.yml "$@" ANSIBLE_ROLES_PATH=../ ansible-playbook lookups.yml -i ../../inventory -e @../../integration_config.yml "$@"
ansible-playbook template_lookup_vaulted.yml -i ../../inventory -e @../../integration_config.yml --vault-password-file test_vault_pass "$@"

13
test/integration/targets/lookups/template_lookup_vaulted.yml Normal file
View file

@ -0,0 +1,13 @@
# https://github.com/ansible/ansible/issues/34209
- hosts: localhost
gather_facts: no
vars:
hello_world: Hello World
tasks:
- name: Test that template lookup can handle vaulted templates
set_fact:
vaulted_hello_world: "{{ lookup('template', 'vaulted_hello.j2') }}"
- assert:
that:
- "vaulted_hello_world|trim == 'Unvaulted Hello World!'"

6
test/integration/targets/lookups/templates/vaulted_hello.j2 Normal file
View file

@ -0,0 +1,6 @@
$ANSIBLE_VAULT;1.1;AES256
33623433323331343363343830343365376233386637366264646634663632343963396664393463
3734626234626639323061643863613164643365363063310a663336663762356135396430353435
39303930613231336135623761363130653235666433383965306235653963343166633233323638
6635303662333734300a623063393761376531636535383164333632613839663237336463616436
62643437623538633335366435346532636666616139386332323034336530356131

1
test/integration/targets/lookups/test_vault_pass Normal file
View file

@ -0,0 +1 @@
test