From 4854705267968e478b1026b3d6e9cb9a3a0006a2 Mon Sep 17 00:00:00 2001
From: Virgil Dupras <hsoft@hardcoded.net>
Date: Tue, 29 Nov 2016 16:23:06 -0500
Subject: [PATCH] Fix regression in jinja2 include search path (#18617)

* 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

(cherry picked from commit bf48383610e2edb1f10ebdda820b9fa0d81dedda)
---
 lib/ansible/plugins/lookup/template.py               |  8 ++++++++
 test/integration/roles/test_lookups/tasks/main.yml   | 11 +++++++++++
 test/integration/targets/lookups/templates/hello.txt |  1 +
 test/integration/targets/lookups/templates/world.txt |  1 +
 4 files changed, 21 insertions(+)
 create mode 100644 test/integration/targets/lookups/templates/hello.txt
 create mode 100644 test/integration/targets/lookups/templates/world.txt

diff --git a/lib/ansible/plugins/lookup/template.py b/lib/ansible/plugins/lookup/template.py
index 4ab0ad1ed02..e335b9339f3 100644
--- a/lib/ansible/plugins/lookup/template.py
+++ b/lib/ansible/plugins/lookup/template.py
@@ -49,6 +49,14 @@ class LookupModule(LookupBase):
                     # 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
diff --git a/test/integration/roles/test_lookups/tasks/main.yml b/test/integration/roles/test_lookups/tasks/main.yml
index f861ceaedeb..8ca6f956ffc 100644
--- a/test/integration/roles/test_lookups/tasks/main.yml
+++ b/test/integration/roles/test_lookups/tasks/main.yml
@@ -268,3 +268,14 @@
         - product.results[6]['item'] == ["C", "1"]
         - product.results[7]['item'] == ["C", "2"]
         - product.results[8]['item'] == ["C", "3"]
+
+# Template lookups
+
+# ref #18526
+- name: Test that we have a proper jinja search path in template lookup
+  set_fact:
+    hello_world: "{{ lookup('template', 'hello.txt') }}"
+
+- assert:
+    that:
+      - "hello_world|trim == 'Hello world!'"
diff --git a/test/integration/targets/lookups/templates/hello.txt b/test/integration/targets/lookups/templates/hello.txt
new file mode 100644
index 00000000000..be15a4f3334
--- /dev/null
+++ b/test/integration/targets/lookups/templates/hello.txt
@@ -0,0 +1 @@
+Hello {% include 'world.txt' %}!
diff --git a/test/integration/targets/lookups/templates/world.txt b/test/integration/targets/lookups/templates/world.txt
new file mode 100644
index 00000000000..cc628ccd107
--- /dev/null
+++ b/test/integration/targets/lookups/templates/world.txt
@@ -0,0 +1 @@
+world