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

Better error message if the template is not utf-8 encoded (#41030)

Browse source 
* Better error message if the template is not utf-8 encoded

Also document this in the porting guide
This commit is contained in:
Toshio Kuratomi 2018-06-05 19:07:11 -07:00 committed by GitHub
parent 980cdbe679
commit cef4d862bc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/docsite/rst/porting_guides/porting_guide_2.5.rst
View file

@ -202,6 +202,12 @@ desired.
* The :ref:`blockinfile module <blockinfile_module>` had its ``follow`` parameter removed because * The :ref:`blockinfile module <blockinfile_module>` had its ``follow`` parameter removed because
it inherently modifies the content of an existing file so it makes no sense to operate on the it inherently modifies the content of an existing file so it makes no sense to operate on the
link itself. link itself.
* In Ansible-2.5.3, the :ref:`template module <template_module>` became more strict about its
``src`` file being proper utf-8. Previously, non-utf8 contents in a template module src file
would result in a mangled output file (the non-utf8 characters would be replaced with a unicode
replacement character). Now, on Python2, the module will error out with the message, "Template
source files must be utf-8 encoded". On Python3, the module will first attempt to pass the
non-utf8 characters through verbatim and fail if that does not succeed.
Plugins Plugins
======= =======

5
lib/ansible/plugins/action/template.py
View file

@ -120,7 +120,10 @@ class ActionModule(ActionBase):
# template the source data locally & get ready to transfer # template the source data locally & get ready to transfer
try: try:
with open(b_tmp_source, 'rb') as f: with open(b_tmp_source, 'rb') as f:
template_data = to_text(f.read(), errors='surrogate_or_strict') try:
template_data = to_text(f.read(), errors='surrogate_or_strict')
except UnicodeError:
raise AnsibleActionFail("Template source files must be utf-8 encoded")
# set jinja2 internal search path for includes # set jinja2 internal search path for includes
searchpath = task_vars.get('ansible_search_path', []) searchpath = task_vars.get('ansible_search_path', [])