salt/tests/unit/test_template.py
2021-07-06 09:04:28 -04:00

110 lines
3.8 KiB
Python

"""
:codeauthor: :email: `Mike Place <mp@saltstack.com>`
"""
import io
from salt import template
from tests.support.mock import MagicMock
from tests.support.unit import TestCase
class TemplateTestCase(TestCase):
render_dict = {
"jinja": "fake_jinja_func",
"json": "fake_json_func",
"mako": "fake_make_func",
}
def test_compile_template_bad_type(self):
"""
Test to ensure that unsupported types cannot be passed to the template compiler
"""
ret = template.compile_template(["1", "2", "3"], None, None, None, None)
self.assertDictEqual(ret, {})
def test_compile_template_preserves_windows_newlines(self):
"""
Test to ensure that a file with Windows newlines, when rendered by a
template renderer, does not eat the CR character.
"""
def _get_rend(renderer, value):
"""
We need a new MagicMock each time since we're dealing with StringIO
objects which are read like files.
"""
return {renderer: MagicMock(return_value=io.StringIO(value))}
input_data_windows = "foo\r\nbar\r\nbaz\r\n"
input_data_non_windows = input_data_windows.replace("\r\n", "\n")
renderer = "test"
blacklist = whitelist = []
ret = template.compile_template(
":string:",
_get_rend(renderer, input_data_non_windows),
renderer,
blacklist,
whitelist,
input_data=input_data_windows,
).read()
# Even though the mocked renderer returned a string without the windows
# newlines, the compiled template should still have them.
self.assertEqual(ret, input_data_windows)
# Now test that we aren't adding them in unnecessarily.
ret = template.compile_template(
":string:",
_get_rend(renderer, input_data_non_windows),
renderer,
blacklist,
whitelist,
input_data=input_data_non_windows,
).read()
self.assertEqual(ret, input_data_non_windows)
# Finally, ensure that we're not unnecessarily replacing the \n with
# \r\n in the event that the renderer returned a string with the
# windows newlines intact.
ret = template.compile_template(
":string:",
_get_rend(renderer, input_data_windows),
renderer,
blacklist,
whitelist,
input_data=input_data_windows,
).read()
self.assertEqual(ret, input_data_windows)
def test_check_render_pipe_str(self):
"""
Check that all renderers specified in the pipe string are available.
"""
ret = template.check_render_pipe_str("jinja|json", self.render_dict, None, None)
self.assertIn(("fake_jinja_func", ""), ret)
self.assertIn(("fake_json_func", ""), ret)
self.assertNotIn(("OBVIOUSLY_NOT_HERE", ""), ret)
def test_check_renderer_blacklisting(self):
"""
Check that all renderers specified in the pipe string are available.
"""
ret = template.check_render_pipe_str(
"jinja|json", self.render_dict, ["jinja"], None
)
self.assertListEqual([("fake_json_func", "")], ret)
ret = template.check_render_pipe_str(
"jinja|json", self.render_dict, None, ["jinja"]
)
self.assertListEqual([("fake_jinja_func", "")], ret)
ret = template.check_render_pipe_str(
"jinja|json", self.render_dict, ["jinja"], ["jinja"]
)
self.assertListEqual([], ret)
ret = template.check_render_pipe_str(
"jinja|json", self.render_dict, ["jinja"], ["jinja", "json"]
)
self.assertListEqual([("fake_json_func", "")], ret)