# -*- coding: utf-8 -*- # # Copyright (C) 2006-2009 Edgewall Software # All rights reserved. # # This software is licensed as described in the file COPYING, which # you should have received as part of this distribution. The terms # are also available at http://genshi.edgewall.org/wiki/License. # # This software consists of voluntary contributions made by many # individuals. For the exact contribution history, see the revision # history and logs, available at http://genshi.edgewall.org/log/. import doctest import os import pickle import shutil import sys import tempfile import unittest import six from genshi.compat import BytesIO, StringIO from genshi.core import Markup from genshi.filters.i18n import Translator from genshi.input import XML from genshi.template.base import BadDirectiveError, TemplateSyntaxError from genshi.template.loader import TemplateLoader, TemplateNotFound from genshi.template.markup import MarkupTemplate class MarkupTemplateTestCase(unittest.TestCase): """Tests for markup template processing.""" def test_parse_fileobj(self): fileobj = StringIO(' ${var} $var') tmpl = MarkupTemplate(fileobj) self.assertEqual(' 42 42', str(tmpl.generate(var=42))) def test_parse_stream(self): stream = XML(' ${var} $var') tmpl = MarkupTemplate(stream) self.assertEqual(' 42 42', str(tmpl.generate(var=42))) def test_pickle(self): stream = XML('$var') tmpl = MarkupTemplate(stream) buf = BytesIO() pickle.dump(tmpl, buf, 2) buf.seek(0) unpickled = pickle.load(buf) self.assertEqual('42', str(unpickled.generate(var=42))) def test_interpolate_mixed3(self): tmpl = MarkupTemplate(' ${var} $var') self.assertEqual(' 42 42', str(tmpl.generate(var=42))) def test_interpolate_leading_trailing_space(self): tmpl = MarkupTemplate('${ foo }') self.assertEqual('bar', str(tmpl.generate(foo='bar'))) def test_interpolate_multiline(self): tmpl = MarkupTemplate("""${dict( bar = 'baz' )[foo]}""") self.assertEqual('baz', str(tmpl.generate(foo='bar'))) def test_interpolate_non_string_attrs(self): tmpl = MarkupTemplate('') self.assertEqual('', str(tmpl.generate())) def test_interpolate_list_result(self): tmpl = MarkupTemplate('$foo') self.assertEqual('buzz', str(tmpl.generate(foo=('buzz',)))) def test_empty_attr(self): tmpl = MarkupTemplate('') self.assertEqual('', str(tmpl.generate())) def test_empty_attr_interpolated(self): tmpl = MarkupTemplate('') self.assertEqual('', str(tmpl.generate(attr=''))) def test_bad_directive_error(self): xml = '

' try: tmpl = MarkupTemplate(xml, filename='test.html') except BadDirectiveError as e: self.assertEqual('test.html', e.filename) self.assertEqual(1, e.lineno) def test_directive_value_syntax_error(self): xml = """

""" try: tmpl = MarkupTemplate(xml, filename='test.html').generate() self.fail('Expected TemplateSyntaxError') except TemplateSyntaxError as e: self.assertEqual('test.html', e.filename) self.assertEqual(1, e.lineno) def test_expression_syntax_error(self): xml = """

Foo ${bar"}

""" try: tmpl = MarkupTemplate(xml, filename='test.html') self.fail('Expected TemplateSyntaxError') except TemplateSyntaxError as e: self.assertEqual('test.html', e.filename) self.assertEqual(2, e.lineno) def test_expression_syntax_error_multi_line(self): xml = """

${bar"}

""" try: tmpl = MarkupTemplate(xml, filename='test.html') self.fail('Expected TemplateSyntaxError') except TemplateSyntaxError as e: self.assertEqual('test.html', e.filename) self.assertEqual(3, e.lineno) def test_markup_noescape(self): """ Verify that outputting context data that is a `Markup` instance is not escaped. """ tmpl = MarkupTemplate("""
$myvar
""") self.assertEqual("""
foo
""", str(tmpl.generate(myvar=Markup('foo')))) def test_text_noescape_quotes(self): """ Verify that outputting context data in text nodes doesn't escape quotes. """ tmpl = MarkupTemplate("""
$myvar
""") self.assertEqual("""
"foo"
""", str(tmpl.generate(myvar='"foo"'))) def test_attr_escape_quotes(self): """ Verify that outputting context data in attribtes escapes quotes. """ tmpl = MarkupTemplate("""
""") self.assertEqual("""
""", str(tmpl.generate(myvar='"foo"'))) def test_directive_element(self): tmpl = MarkupTemplate("""
bar
""") self.assertEqual("""
bar
""", str(tmpl.generate(myvar='"foo"'))) def test_normal_comment(self): tmpl = MarkupTemplate("""
""") self.assertEqual("""
""", str(tmpl.generate())) def test_template_comment(self): tmpl = MarkupTemplate("""
""") self.assertEqual("""
""", str(tmpl.generate())) def test_parse_with_same_namespace_nested(self): tmpl = MarkupTemplate("""
""") self.assertEqual("""
""", str(tmpl.generate())) def test_latin1_encoded_with_xmldecl(self): tmpl = MarkupTemplate(u"""
\xf6
""".encode('iso-8859-1'), encoding='iso-8859-1') self.assertEqual(u"""\n
\xf6
""", six.text_type(tmpl.generate())) def test_latin1_encoded_explicit_encoding(self): tmpl = MarkupTemplate(u"""
\xf6
""".encode('iso-8859-1'), encoding='iso-8859-1') self.assertEqual(u"""
\xf6
""", six.text_type(tmpl.generate())) def test_exec_with_trailing_space(self): """ Verify that a code block processing instruction with trailing space does not cause a syntax error (see ticket #127). """ MarkupTemplate(""" """) def test_exec_import(self): tmpl = MarkupTemplate("""
${timedelta(days=2)}
""") self.assertEqual("""
2 days, 0:00:00
""", str(tmpl.generate())) def test_exec_def(self): tmpl = MarkupTemplate("""
${foo()}
""") self.assertEqual("""
42
""", str(tmpl.generate())) def test_namespace_on_removed_elem(self): """ Verify that a namespace declaration on an element that is removed from the generated stream does not get pushed up to the next non-stripped element (see ticket #107). """ tmpl = MarkupTemplate(""" Size """) self.assertEqual("""\n """, str(tmpl.generate())) def test_include_in_loop(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file1 = open(os.path.join(dirname, 'tmpl1.html'), 'w') try: file1.write("""
Included $idx
""") finally: file1.close() file2 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file2.write(""" """) finally: file2.close() loader = TemplateLoader([dirname]) tmpl = loader.load('tmpl2.html') self.assertEqual("""
Included 0
Included 1
Included 2
""", tmpl.generate(name='tmpl1').render(encoding=None)) finally: shutil.rmtree(dirname) def test_dynamic_include_href(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file1 = open(os.path.join(dirname, 'tmpl1.html'), 'w') try: file1.write("""
Included
""") finally: file1.close() file2 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file2.write(""" """) finally: file2.close() loader = TemplateLoader([dirname]) tmpl = loader.load('tmpl2.html') self.assertEqual("""
Included
""", tmpl.generate(name='tmpl1').render(encoding=None)) finally: shutil.rmtree(dirname) def test_select_included_elements(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file1 = open(os.path.join(dirname, 'tmpl1.html'), 'w') try: file1.write("""
  • $item
  • """) finally: file1.close() file2 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file2.write("""
      ${select('li')}
    """) finally: file2.close() loader = TemplateLoader([dirname]) tmpl = loader.load('tmpl2.html') self.assertEqual("""
    • 1
    • 2
    • 3
    """, tmpl.generate().render(encoding=None)) finally: shutil.rmtree(dirname) def test_fallback_when_include_found(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file1 = open(os.path.join(dirname, 'tmpl1.html'), 'w') try: file1.write("""
    Included
    """) finally: file1.close() file2 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file2.write(""" Missing """) finally: file2.close() loader = TemplateLoader([dirname]) tmpl = loader.load('tmpl2.html') self.assertEqual("""
    Included
    """, tmpl.generate().render(encoding=None)) finally: shutil.rmtree(dirname) def test_error_when_include_not_found(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file2 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file2.write(""" """) finally: file2.close() loader = TemplateLoader([dirname], auto_reload=True) tmpl = loader.load('tmpl2.html') self.assertRaises(TemplateNotFound, tmpl.generate().render) finally: shutil.rmtree(dirname) def test_fallback_when_include_not_found(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file2 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file2.write(""" Missing """) finally: file2.close() loader = TemplateLoader([dirname]) tmpl = loader.load('tmpl2.html') self.assertEqual(""" Missing """, tmpl.generate().render(encoding=None)) finally: shutil.rmtree(dirname) def test_fallback_when_auto_reload_true(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file2 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file2.write(""" Missing """) finally: file2.close() loader = TemplateLoader([dirname], auto_reload=True) tmpl = loader.load('tmpl2.html') self.assertEqual(""" Missing """, tmpl.generate().render(encoding=None)) finally: shutil.rmtree(dirname) def test_include_in_fallback(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file1 = open(os.path.join(dirname, 'tmpl1.html'), 'w') try: file1.write("""
    Included
    """) finally: file1.close() file2 = open(os.path.join(dirname, 'tmpl3.html'), 'w') try: file2.write(""" Missing """) finally: file2.close() loader = TemplateLoader([dirname]) tmpl = loader.load('tmpl3.html') self.assertEqual("""
    Included
    """, tmpl.generate().render(encoding=None)) finally: shutil.rmtree(dirname) def test_nested_include_fallback(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file2 = open(os.path.join(dirname, 'tmpl3.html'), 'w') try: file2.write(""" Missing """) finally: file2.close() loader = TemplateLoader([dirname]) tmpl = loader.load('tmpl3.html') self.assertEqual(""" Missing """, tmpl.generate().render(encoding=None)) finally: shutil.rmtree(dirname) def test_nested_include_in_fallback(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file1 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file1.write("""
    Included
    """) finally: file1.close() file2 = open(os.path.join(dirname, 'tmpl3.html'), 'w') try: file2.write(""" """) finally: file2.close() loader = TemplateLoader([dirname]) tmpl = loader.load('tmpl3.html') self.assertEqual("""
    Included
    """, tmpl.generate().render(encoding=None)) finally: shutil.rmtree(dirname) def test_include_fallback_with_directive(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file2 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file2.write(""" tmpl1.html not found """) finally: file2.close() loader = TemplateLoader([dirname]) tmpl = loader.load('tmpl2.html') self.assertEqual(""" tmpl1.html not found """, tmpl.generate(debug=True).render(encoding=None)) finally: shutil.rmtree(dirname) def test_include_inlined(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file1 = open(os.path.join(dirname, 'tmpl1.html'), 'w') try: file1.write("""
    Included
    """) finally: file1.close() file2 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file2.write(""" """) finally: file2.close() loader = TemplateLoader([dirname], auto_reload=False) tmpl = loader.load('tmpl2.html') # if not inlined the following would be 5 self.assertEqual(7, len(tmpl.stream)) self.assertEqual("""
    Included
    """, tmpl.generate().render(encoding=None)) finally: shutil.rmtree(dirname) def test_include_inlined_in_loop(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file1 = open(os.path.join(dirname, 'tmpl1.html'), 'w') try: file1.write("""
    Included $idx
    """) finally: file1.close() file2 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file2.write(""" """) finally: file2.close() loader = TemplateLoader([dirname], auto_reload=False) tmpl = loader.load('tmpl2.html') self.assertEqual("""
    Included 0
    Included 1
    Included 2
    """, tmpl.generate().render(encoding=None)) finally: shutil.rmtree(dirname) def test_include_inline_recursive(self): dirname = tempfile.mkdtemp(suffix='genshi_test') try: file1 = open(os.path.join(dirname, 'tmpl1.html'), 'w') try: file1.write( '
    ' '$depth' '' '' '' '
    ' ) finally: file1.close() loader = TemplateLoader([dirname], auto_reload=False) tmpl = loader.load(os.path.join(dirname, 'tmpl1.html')) self.assertEqual( "
    0
    1
    2
    ", tmpl.generate(depth=0).render(encoding=None)) finally: shutil.rmtree(dirname) def test_allow_exec_false(self): xml = (""" This is replaced. """) try: tmpl = MarkupTemplate(xml, filename='test.html', allow_exec=False) self.fail('Expected SyntaxError') except TemplateSyntaxError as e: pass def test_allow_exec_true(self): xml = (""" This is replaced. """) tmpl = MarkupTemplate(xml, filename='test.html', allow_exec=True) def test_exec_in_match(self): xml = (""" ${title}

    moot text

    """) tmpl = MarkupTemplate(xml, filename='test.html', allow_exec=True) self.assertEqual(""" wakka wakka wakka """, tmpl.generate().render(encoding=None)) def test_with_in_match(self): xml = ("""

    ${select('text()')}

    ${select('.')}

    ${foo}

    """) tmpl = MarkupTemplate(xml, filename='test.html') self.assertEqual("""

    bar

    bar

    """, tmpl.generate().render(encoding=None)) def test_nested_include_matches(self): # See ticket #157 dirname = tempfile.mkdtemp(suffix='genshi_test') try: file1 = open(os.path.join(dirname, 'tmpl1.html'), 'w') try: file1.write("""
    Some content.
    """) finally: file1.close() file2 = open(os.path.join(dirname, 'tmpl2.html'), 'w') try: file2.write("""

    Some full html document that includes file1.html

    """) finally: file2.close() file3 = open(os.path.join(dirname, 'tmpl3.html'), 'w') try: file3.write("""
    Some added stuff. ${select('*|text()')}
    """) finally: file3.close() loader = TemplateLoader([dirname]) tmpl = loader.load('tmpl3.html') self.assertEqual("""

    Some full html document that includes file1.html

    Some added stuff. Some content.
    """, tmpl.generate().render(encoding=None)) finally: shutil.rmtree(dirname) def test_nested_matches_without_buffering(self): xml = (""" ${select('*|text')} And some other stuff... Foo Bar """) tmpl = MarkupTemplate(xml, filename='test.html') self.assertEqual(""" Foo And some other stuff... """, tmpl.generate().render(encoding=None)) def test_match_without_select(self): # See xml = (""" This replaces the other text. This gets replaced. """) tmpl = MarkupTemplate(xml, filename='test.html') self.assertEqual(""" This replaces the other text. """, tmpl.generate().render(encoding=None)) def test_match_tail_handling(self): # See xml = (""" ${select('.')} fish fish fish fish """) tmpl = MarkupTemplate(xml, filename='test.html') self.assertEqual(""" fish fish fish fish """, tmpl.generate().render(encoding=None)) def test_directive_single_line_with_translator(self): tmpl = MarkupTemplate("""
    """) translator = Translator(lambda s: s) tmpl.add_directives(Translator.NAMESPACE, translator) self.assertEqual("""
    0 1
    """, str(tmpl.generate())) def suite(): suite = unittest.TestSuite() suite.addTest(doctest.DocTestSuite(MarkupTemplate.__module__)) suite.addTest(unittest.makeSuite(MarkupTemplateTestCase, 'test')) return suite if __name__ == '__main__': unittest.main(defaultTest='suite')