Merge "Fix usage of {% raw %} tags and Jinja2 headers"

doc/source/index.rst

@@ -153,7 +153,63 @@ Resulting file on the remote host:
   [hello]
   cruel = world
 
-Installing collection
+
+Preventing content from renderring
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There are few different way that can be used to prevent some content
+from being renderred. First one is to use Jinja's ``{% raw %}`` tag.
+
+Template:
+
+.. code-block :: ini
+
+  [foo]
+  # comment
+  bar = {% raw %}{{ baz }}{% endraw %}
+
+
+Result:
+
+.. code-block :: ini
+
+  [foo]
+  # comment
+  bar = {{ baz }}
+
+Another way around could be customizing Jinja tags used to identify variables
+and block string. For that `variable_start/end_string` or `block_start/end_string`
+options could be used. These variables could be provided as an arguments to
+the module or by adding a special header to template file.
+
+.. Note::
+
+  Please mention, that changing identification for start/end of blocks works only
+  inside the template and does not affect ``config_overrides`` option.
+
+Template:
+
+.. code-block :: ini
+
+
+  #jinja2:variable_start_string:'[%', variable_end_string:'%]'
+
+  [foo]
+  # comment
+  bar = {{ baz }}
+  foo = [% inventory_hostname %]
+
+
+Result:
+
+.. code-block :: ini
+
+  [foo]
+  # comment
+  bar = {{ baz }}
+  foo = localhost
+
+
 ---------------------
 
 To use the collection, include this in your meta/main.yml:

plugins/action/config_template.py

@@ -883,7 +883,10 @@ class ActionModule(ActionBase):
         else:
             self._templar.available_variables = temp_vars
 
-        resultant = self._check_templar(data=template_data, extra=_vars)
+        if self._task.args.get('content'):
+            resultant = template_data
+        else:
+            resultant = self._check_templar(data=template_data, extra=_vars)
 
         if LooseVersion(__ansible_version__) < LooseVersion("2.9"):
             # Access to protected method is unavoidable in Ansible
@@ -953,10 +956,6 @@ class ActionModule(ActionBase):
                 }
                 changed = len(mods['changed']) > 0
 
-        # Re-template the resultant object as it may have new data within it
-        #  as provided by an override variable.
-        resultant = self._check_templar(data=resultant, extra=_vars)
-
         # run the copy module
         new_module_args = self._task.args.copy()
         # Access to protected method is unavoidable in Ansible

releasenotes/notes/raw_tag_fixed-9c7cc7506314f76b.yaml

@@ -0,0 +1,5 @@
+---
+fixes:
+  - |
+    Jinja2 {% raw %} tag and string escapnig, as well as special headers in
+    template files are working as expected now.

tests/files/test_raw_content.ini.expected

@@ -0,0 +1,9 @@
+[foo]
+# comment
+bar = {{ baz }}
+foo = delta
+foobar = [% test_raw_content_variable %]
+
+[section2]
+alfa = delta
+

tests/templates/test_raw_content.ini

@@ -0,0 +1,7 @@
+#jinja2:variable_start_string:'[%', variable_end_string:'%]'
+
+[foo]
+# comment
+bar = {{ baz }}
+foo = [% test_raw_content_variable %]
+foobar = {% raw %}[% test_raw_content_variable %]{% endraw %}

tests/test-ini.yml

@@ -284,3 +284,54 @@
     config_overrides: "{{ test_diff_overrides }}"
   register: test_diff_remove_ini
   notify: test_diff_remove_ini check diff
+
+# Check if {% raw %} is working
+- name: Test template with jinja vars in it
+  config_template:
+    src: "{{ playbook_dir }}/templates/test_raw_content.ini"
+    dest: "/tmp/test_raw_content.ini"
+    config_overrides: "{{ test_raw_content_overrides }}"
+    config_type: ini
+
+- name: Test content with jinja vars in it
+  config_template:
+    content: |
+      #jinja2:variable_start_string:'[%', variable_end_string:'%]'
+
+      [foo]
+      # comment
+      bar = {{ baz }}
+      foo = [% test_raw_content_variable %]
+      foobar = {% raw %}[% test_raw_content_variable %]{% endraw %}
+    dest: "/tmp/test_raw_usr_content.ini"
+    config_overrides: "{{ test_raw_content_overrides }}"
+    config_type: ini
+
+- name: Read test_raw_content.ini
+  slurp:
+    src: /tmp/test_raw_content.ini
+  register: test_raw_content
+
+- name: Read test_raw_usr_content.ini
+  slurp:
+    src: /tmp/test_raw_usr_content.ini
+  register: test_raw_usr_content
+
+- debug:
+    msg: "Raw Jinja content - {{ test_raw_content.content | b64decode }}"
+
+- debug:
+    msg: "Raw Jinja user content - {{ test_raw_usr_content.content | b64decode }}"
+
+- debug:
+    msg: "Raw Jinja content Expected - {{ test_raw_content_expected.content | b64decode }}"
+
+- name: Compare files
+  assert:
+    that:
+      - "(test_raw_content_expected.content | b64decode) == (test_raw_usr_content.content | b64decode)"
+
+- name: Compare files
+  assert:
+    that:
+      - "(test_raw_content_expected.content | b64decode) == (test_raw_content.content | b64decode)"

tests/test.yml

@@ -78,6 +78,11 @@
         src: "{{ playbook_dir }}/files/test_jinja_variables.yml.expected"
       register: test_jinja_variables_expected
 
+    - name: Read expected test_jinja_variables.yml
+      slurp:
+        src: "{{ playbook_dir }}/files/test_raw_content.ini.expected"
+      register: test_raw_content_expected
+
     - import_tasks: test-common-tasks.yml
 
   handlers:
@@ -176,6 +181,10 @@
     test_jinja_variables:
       section1:
         baz: "baz"
+    test_raw_content_variable: "delta"
+    test_raw_content_overrides:
+      section2:
+        alfa: "{{ test_raw_content_variable }}"
     test_enhanced_comments_ini_overrides:
       DEFAULT:
         default_availability_zone: zone1