mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 12:21:26 -07:00
bf48383610
* Fix regression in jinja2 include search path
Since commit 3c39bb5, the 'ansible_search_path' variable is used to set
jinja2's search path for {% include %} directives. However, this path is
the the proper one because our templates live in 'templates' subdirs in
our search path.
This is a regression because previously, our include search path would
include the dirname of the currently interpreted file, which worked most
of the time.
fixes #18526
* Fix template lookup search path
Improve fix in commit c96c853 so that the search path contain both
template-suffixed paths as well as original paths.
ref PR #18617
* Add integration test for template lookups
Tests regression at #18526
This test fails on current devel branch and succeeds on PR #18617
70 lines
2.9 KiB
Python
70 lines
2.9 KiB
Python
# (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible 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.
|
|
#
|
|
# Ansible 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 Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import os
|
|
|
|
from ansible.errors import AnsibleError
|
|
from ansible.plugins.lookup import LookupBase
|
|
from ansible.module_utils._text import to_bytes, to_text
|
|
|
|
try:
|
|
from __main__ import display
|
|
except ImportError:
|
|
from ansible.utils.display import Display
|
|
display = Display()
|
|
|
|
|
|
class LookupModule(LookupBase):
|
|
|
|
def run(self, terms, variables, **kwargs):
|
|
|
|
convert_data_p = kwargs.get('convert_data', True)
|
|
ret = []
|
|
|
|
for term in terms:
|
|
display.debug("File lookup term: %s" % term)
|
|
|
|
lookupfile = self.find_file_in_search_path(variables, 'templates', term)
|
|
display.vvvv("File lookup using %s as file" % lookupfile)
|
|
if lookupfile:
|
|
with open(to_bytes(lookupfile, errors='surrogate_or_strict'), 'rb') as f:
|
|
template_data = to_text(f.read(), errors='surrogate_or_strict')
|
|
|
|
# set jinja2 internal search path for includes
|
|
if 'ansible_search_path' in variables:
|
|
searchpath = variables['ansible_search_path']
|
|
# 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
|
|
# addition to our original search paths.
|
|
newsearchpath = []
|
|
for p in searchpath:
|
|
newsearchpath.append(os.path.join(p, 'templates'))
|
|
newsearchpath.append(p)
|
|
searchpath = newsearchpath
|
|
else:
|
|
searchpath = [self._loader._basedir, os.path.dirname(lookupfile)]
|
|
self._templar.environment.loader.searchpath = searchpath
|
|
|
|
# do the templating
|
|
res = self._templar.template(template_data, preserve_trailing_newlines=True,convert_data=convert_data_p)
|
|
ret.append(res)
|
|
else:
|
|
raise AnsibleError("the template file %s could not be found for the lookup" % term)
|
|
|
|
return ret
|