add salt jinja utils tests

tests/simple.py

@@ -3,5 +3,6 @@ import unittest
 class SimpleTest(unittest.TestCase):
     def test_success(self):
         assert True
+    @unittest.expectedFailure
     def test_fail(self):
         assert False

tests/templates/files/test/hello_import

@@ -0,0 +1,3 @@
+{% from 'macro' import mymacro -%}
+{% from 'macro' import mymacro -%}
+{{ mymacro('Hey') ~ mymacro(a|default('a'), b|default('b')) }}

tests/templates/files/test/hello_include

@@ -0,0 +1 @@
+{% include 'hello_import' -%}

tests/templates/files/test/hello_simple

@@ -0,0 +1 @@
+world

tests/templates/files/test/macro

@@ -0,0 +1,4 @@
+# macro
+{% macro mymacro(greeting, greetee='world') -%}
+{{ greeting ~ ' ' ~ greetee }} !
+{%- endmacro %}

tests/templates/jinja.py

@@ -0,0 +1,112 @@
+import unittest
+from os import path
+from salt.utils.jinja import SaltCacheLoader, get_template
+from jinja2 import Environment
+
+TEMPLATES_DIR = path.dirname(path.abspath(__file__))
+
+class MockFileClient(object):
+    '''
+    Does not download files but records any file request for testing
+    '''
+    def __init__(self, loader=None):
+        if loader: loader._file_client = self
+        self.requests = []
+    def get_file(self, template, dest='', makedirs=False, env='base'):
+        self.requests.append({
+            'path': template, 
+            'dest': dest,
+            'makedirs': makedirs,
+            'env': env
+        })
+
+class TestSaltCacheLoader(unittest.TestCase):
+    def test_searchpath(self):
+        '''
+        The searchpath is based on the cachedir option and the env parameter
+        '''
+        loader = SaltCacheLoader({'cachedir': '/tmp'}, env='test')
+        assert loader.searchpath == '/tmp/files/test'
+    def test_mockclient(self):
+        '''
+        A MockFileClient is used that records all file request normally send to the master.
+        '''
+        loader = SaltCacheLoader({'cachedir': TEMPLATES_DIR}, 'test')
+        fc = MockFileClient(loader)
+        res = loader.get_source(None, 'hello_simple')
+        assert len(res) == 3
+        self.assertEqual(res[0], 'world\n')
+        self.assertEqual(res[1], '%s/files/test/hello_simple' % TEMPLATES_DIR)
+        assert res[2](), "Template up to date?"
+        assert len(fc.requests)
+        self.assertEqual(fc.requests[0]['path'], 'salt://hello_simple')
+    def get_test_env(self):
+        '''
+        Setup a simple jinja test environment
+        '''
+        loader = SaltCacheLoader({'cachedir': TEMPLATES_DIR}, 'test')
+        fc = MockFileClient(loader)
+        jinja = Environment(loader=loader)
+        return fc, jinja
+    def test_import(self):
+        '''
+        You can import and use macros from other files
+        '''
+        fc, jinja = self.get_test_env()
+        result = jinja.get_template('hello_import').render()
+        self.assertEqual(result, 'Hey world !a b !')
+        assert len(fc.requests) == 2
+        self.assertEqual(fc.requests[0]['path'], 'salt://hello_import')
+        self.assertEqual(fc.requests[1]['path'], 'salt://macro')
+    def test_include(self):
+        '''
+        You can also include a template that imports and uses macros
+        '''
+        fc, jinja = self.get_test_env()
+        result = jinja.get_template('hello_include').render()
+        self.assertEqual(result, 'Hey world !a b !')
+        assert len(fc.requests) == 3
+        self.assertEqual(fc.requests[0]['path'], 'salt://hello_include')
+        self.assertEqual(fc.requests[1]['path'], 'salt://hello_import')
+        self.assertEqual(fc.requests[2]['path'], 'salt://macro')
+    def test_include_context(self):
+        '''
+        Context variables are passes to the included template by default.
+        '''
+        _, jinja = self.get_test_env()
+        result = jinja.get_template('hello_include').render(a='Hi', b='Salt')
+        self.assertEqual(result, 'Hey world !Hi Salt !')
+
+class TestGetTemplate(unittest.TestCase):
+    def test_fallback(self):
+        '''
+        A Template without loader is returned as fallback 
+        if the file is not contained in the searchpath
+        '''
+        filename = '%s/files/test/hello_simple' % TEMPLATES_DIR
+        tmpl = get_template(filename, {'cachedir': TEMPLATES_DIR}, env='other')
+        self.assertEqual(tmpl.render(), 'world')
+    def test_fallback_noloader(self):
+        '''
+        If the fallback is used any attempt to load other templates
+        will raise a TypeError.
+        '''
+        filename = '%s/files/test/hello_import' % TEMPLATES_DIR
+        tmpl = get_template(filename, {'cachedir': TEMPLATES_DIR}, env='other')
+        self.assertRaises(TypeError, tmpl.render)
+    def test_env(self):
+        '''
+        If the template is within the searchpath it can
+        import, include and extend other templates.
+        The initial template is expected to be already cached
+        get_template does not request it from the master again.
+        '''
+        fc = MockFileClient()
+        # monkey patch file client
+        _fc = SaltCacheLoader.file_client
+        SaltCacheLoader.file_client = lambda loader: fc 
+        filename = '%s/files/test/hello_import' % TEMPLATES_DIR
+        tmpl = get_template(filename, {'cachedir': TEMPLATES_DIR}, env='test')
+        self.assertEqual(tmpl.render(a='Hi', b='Salt'), 'Hey world !Hi Salt !')
+        self.assertEqual(fc.requests[0]['path'], 'salt://macro')
+        SaltCacheLoader.file_client = _fc