|
Packit Service |
a04d08 |
# Copyright (C) 2014 Yahoo! Inc.
|
|
Packit Service |
a04d08 |
#
|
|
Packit Service |
a04d08 |
# Author: Joshua Harlow <harlowja@yahoo-inc.com>
|
|
Packit Service |
a04d08 |
#
|
|
Packit Service |
a04d08 |
# This file is part of cloud-init. See LICENSE file for license information.
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
from cloudinit.tests import helpers as test_helpers
|
|
Packit Service |
a04d08 |
import textwrap
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
from cloudinit import templater
|
|
Packit Service |
a04d08 |
from cloudinit.util import load_file, write_file
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
try:
|
|
Packit Service |
a04d08 |
import Cheetah
|
|
Packit Service |
a04d08 |
HAS_CHEETAH = True
|
|
Packit Service |
a04d08 |
c = Cheetah # make pyflakes and pylint happy, as Cheetah is not used here
|
|
Packit Service |
a04d08 |
except ImportError:
|
|
Packit Service |
a04d08 |
HAS_CHEETAH = False
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
class TestTemplates(test_helpers.CiTestCase):
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
with_logs = True
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
jinja_utf8 = b'It\xe2\x80\x99s not ascii, {{name}}\n'
|
|
Packit Service |
a04d08 |
jinja_utf8_rbob = b'It\xe2\x80\x99s not ascii, bob\n'.decode('utf-8')
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
@staticmethod
|
|
Packit Service |
a04d08 |
def add_header(renderer, data):
|
|
Packit Service |
a04d08 |
"""Return text (py2 unicode/py3 str) with template header."""
|
|
Packit Service |
a04d08 |
if isinstance(data, bytes):
|
|
Packit Service |
a04d08 |
data = data.decode('utf-8')
|
|
Packit Service |
a04d08 |
return "## template: %s\n" % renderer + data
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_render_basic(self):
|
|
Packit Service |
a04d08 |
in_data = textwrap.dedent("""
|
|
Packit Service |
a04d08 |
${b}
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
c = d
|
|
Packit Service |
a04d08 |
""")
|
|
Packit Service |
a04d08 |
in_data = in_data.strip()
|
|
Packit Service |
a04d08 |
expected_data = textwrap.dedent("""
|
|
Packit Service |
a04d08 |
2
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
c = d
|
|
Packit Service |
a04d08 |
""")
|
|
Packit Service |
a04d08 |
out_data = templater.basic_render(in_data, {'b': 2})
|
|
Packit Service |
a04d08 |
self.assertEqual(expected_data.strip(), out_data)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
@test_helpers.skipIf(not HAS_CHEETAH, 'cheetah renderer not available')
|
|
Packit Service |
a04d08 |
def test_detection(self):
|
|
Packit Service |
a04d08 |
blob = "## template:cheetah"
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
(template_type, _renderer, contents) = templater.detect_template(blob)
|
|
Packit Service |
a04d08 |
self.assertIn("cheetah", template_type)
|
|
Packit Service |
a04d08 |
self.assertEqual("", contents.strip())
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
blob = "blahblah $blah"
|
|
Packit Service |
a04d08 |
(template_type, _renderer, _contents) = templater.detect_template(blob)
|
|
Packit Service |
a04d08 |
self.assertIn("cheetah", template_type)
|
|
Packit Service |
a04d08 |
self.assertEqual(blob, contents)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
blob = '##template:something-new'
|
|
Packit Service |
a04d08 |
self.assertRaises(ValueError, templater.detect_template, blob)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_render_cheetah(self):
|
|
Packit Service |
a04d08 |
blob = '''## template:cheetah
|
|
Packit Service |
a04d08 |
$a,$b'''
|
|
Packit Service |
a04d08 |
c = templater.render_string(blob, {"a": 1, "b": 2})
|
|
Packit Service |
a04d08 |
self.assertEqual("1,2", c)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_render_jinja(self):
|
|
Packit Service |
a04d08 |
blob = '''## template:jinja
|
|
Packit Service |
a04d08 |
{{a}},{{b}}'''
|
|
Packit Service |
a04d08 |
c = templater.render_string(blob, {"a": 1, "b": 2})
|
|
Packit Service |
a04d08 |
self.assertEqual("1,2", c)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_render_default(self):
|
|
Packit Service |
a04d08 |
blob = '''$a,$b'''
|
|
Packit Service |
a04d08 |
c = templater.render_string(blob, {"a": 1, "b": 2})
|
|
Packit Service |
a04d08 |
self.assertEqual("1,2", c)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_render_basic_deeper(self):
|
|
Packit Service |
a04d08 |
hn = 'myfoohost.yahoo.com'
|
|
Packit Service |
a04d08 |
expected_data = "h=%s\nc=d\n" % hn
|
|
Packit Service |
a04d08 |
in_data = "h=$hostname.canonical_name\nc=d\n"
|
|
Packit Service |
a04d08 |
params = {
|
|
Packit Service |
a04d08 |
"hostname": {
|
|
Packit Service |
a04d08 |
"canonical_name": hn,
|
|
Packit Service |
a04d08 |
},
|
|
Packit Service |
a04d08 |
}
|
|
Packit Service |
a04d08 |
out_data = templater.render_string(in_data, params)
|
|
Packit Service |
a04d08 |
self.assertEqual(expected_data, out_data)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_render_basic_no_parens(self):
|
|
Packit Service |
a04d08 |
hn = "myfoohost"
|
|
Packit Service |
a04d08 |
in_data = "h=$hostname\nc=d\n"
|
|
Packit Service |
a04d08 |
expected_data = "h=%s\nc=d\n" % hn
|
|
Packit Service |
a04d08 |
out_data = templater.basic_render(in_data, {'hostname': hn})
|
|
Packit Service |
a04d08 |
self.assertEqual(expected_data, out_data)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_render_basic_parens(self):
|
|
Packit Service |
a04d08 |
hn = "myfoohost"
|
|
Packit Service |
a04d08 |
in_data = "h = ${hostname}\nc=d\n"
|
|
Packit Service |
a04d08 |
expected_data = "h = %s\nc=d\n" % hn
|
|
Packit Service |
a04d08 |
out_data = templater.basic_render(in_data, {'hostname': hn})
|
|
Packit Service |
a04d08 |
self.assertEqual(expected_data, out_data)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_render_basic2(self):
|
|
Packit Service |
a04d08 |
mirror = "mymirror"
|
|
Packit Service |
a04d08 |
codename = "zany"
|
|
Packit Service |
a04d08 |
in_data = "deb $mirror $codename-updates main contrib non-free"
|
|
Packit Service |
a04d08 |
ex_data = "deb %s %s-updates main contrib non-free" % (mirror,
|
|
Packit Service |
a04d08 |
codename)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
out_data = templater.basic_render(in_data,
|
|
Packit Service |
a04d08 |
{'mirror': mirror,
|
|
Packit Service |
a04d08 |
'codename': codename})
|
|
Packit Service |
a04d08 |
self.assertEqual(ex_data, out_data)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_jinja_nonascii_render_to_string(self):
|
|
Packit Service |
a04d08 |
"""Test jinja render_to_string with non-ascii content."""
|
|
Packit Service |
a04d08 |
self.assertEqual(
|
|
Packit Service |
a04d08 |
templater.render_string(
|
|
Packit Service |
a04d08 |
self.add_header("jinja", self.jinja_utf8), {"name": "bob"}),
|
|
Packit Service |
a04d08 |
self.jinja_utf8_rbob)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_jinja_nonascii_render_undefined_variables_to_default_py3(self):
|
|
Packit Service |
a04d08 |
"""Test py3 jinja render_to_string with undefined variable default."""
|
|
Packit Service |
a04d08 |
self.assertEqual(
|
|
Packit Service |
a04d08 |
templater.render_string(
|
|
Packit Service |
a04d08 |
self.add_header("jinja", self.jinja_utf8), {}),
|
|
Packit Service |
a04d08 |
self.jinja_utf8_rbob.replace('bob', 'CI_MISSING_JINJA_VAR/name'))
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_jinja_nonascii_render_to_file(self):
|
|
Packit Service |
a04d08 |
"""Test jinja render_to_file of a filename with non-ascii content."""
|
|
Packit Service |
a04d08 |
tmpl_fn = self.tmp_path("j-render-to-file.template")
|
|
Packit Service |
a04d08 |
out_fn = self.tmp_path("j-render-to-file.out")
|
|
Packit Service |
a04d08 |
write_file(filename=tmpl_fn, omode="wb",
|
|
Packit Service |
a04d08 |
content=self.add_header(
|
|
Packit Service |
a04d08 |
"jinja", self.jinja_utf8).encode('utf-8'))
|
|
Packit Service |
a04d08 |
templater.render_to_file(tmpl_fn, out_fn, {"name": "bob"})
|
|
Packit Service |
a04d08 |
result = load_file(out_fn, decode=False).decode('utf-8')
|
|
Packit Service |
a04d08 |
self.assertEqual(result, self.jinja_utf8_rbob)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
def test_jinja_nonascii_render_from_file(self):
|
|
Packit Service |
a04d08 |
"""Test jinja render_from_file with non-ascii content."""
|
|
Packit Service |
a04d08 |
tmpl_fn = self.tmp_path("j-render-from-file.template")
|
|
Packit Service |
a04d08 |
write_file(tmpl_fn, omode="wb",
|
|
Packit Service |
a04d08 |
content=self.add_header(
|
|
Packit Service |
a04d08 |
"jinja", self.jinja_utf8).encode('utf-8'))
|
|
Packit Service |
a04d08 |
result = templater.render_from_file(tmpl_fn, {"name": "bob"})
|
|
Packit Service |
a04d08 |
self.assertEqual(result, self.jinja_utf8_rbob)
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
@test_helpers.skipIfJinja()
|
|
Packit Service |
a04d08 |
def test_jinja_warns_on_missing_dep_and_uses_basic_renderer(self):
|
|
Packit Service |
a04d08 |
"""Test jinja render_from_file will fallback to basic renderer."""
|
|
Packit Service |
a04d08 |
tmpl_fn = self.tmp_path("j-render-from-file.template")
|
|
Packit Service |
a04d08 |
write_file(tmpl_fn, omode="wb",
|
|
Packit Service |
a04d08 |
content=self.add_header(
|
|
Packit Service |
a04d08 |
"jinja", self.jinja_utf8).encode('utf-8'))
|
|
Packit Service |
a04d08 |
result = templater.render_from_file(tmpl_fn, {"name": "bob"})
|
|
Packit Service |
a04d08 |
self.assertEqual(result, self.jinja_utf8.decode())
|
|
Packit Service |
a04d08 |
self.assertIn(
|
|
Packit Service |
a04d08 |
'WARNING: Jinja not available as the selected renderer for desired'
|
|
Packit Service |
a04d08 |
' template, reverting to the basic renderer.',
|
|
Packit Service |
a04d08 |
self.logs.getvalue())
|
|
Packit Service |
a04d08 |
|
|
Packit Service |
a04d08 |
# vi: ts=4 expandtab
|