Armin Ronacher | ccf284b | 2007-05-21 16:44:26 +0200 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | """ |
| 3 | unit test for the parser |
| 4 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
| 5 | |
Armin Ronacher | 62ccd1b | 2009-01-04 14:26:19 +0100 | [diff] [blame] | 6 | :copyright: (c) 2009 by the Jinja Team. |
Armin Ronacher | ccf284b | 2007-05-21 16:44:26 +0200 | [diff] [blame] | 7 | :license: BSD, see LICENSE for more details. |
| 8 | """ |
Armin Ronacher | 5dcb724 | 2010-02-06 14:01:26 +0100 | [diff] [blame] | 9 | from jinja2 import Environment, Template, TemplateSyntaxError |
Armin Ronacher | ccf284b | 2007-05-21 16:44:26 +0200 | [diff] [blame] | 10 | |
Armin Ronacher | 42979eb | 2009-07-26 11:08:50 +0200 | [diff] [blame] | 11 | env = Environment() |
Rene Leonhardt | c7e6c6d | 2009-04-20 23:08:53 +0200 | [diff] [blame] | 12 | |
Armin Ronacher | ccf284b | 2007-05-21 16:44:26 +0200 | [diff] [blame] | 13 | |
| 14 | PHP_SYNTAX = '''\ |
| 15 | <!-- I'm a comment, I'm not interesting -->\ |
| 16 | <? for item in seq -?> |
| 17 | <?= item ?> |
| 18 | <?- endfor ?>''' |
| 19 | |
| 20 | ERB_SYNTAX = '''\ |
| 21 | <%# I'm a comment, I'm not interesting %>\ |
| 22 | <% for item in seq -%> |
| 23 | <%= item %> |
| 24 | <%- endfor %>''' |
| 25 | |
| 26 | COMMENT_SYNTAX = '''\ |
| 27 | <!--# I'm a comment, I'm not interesting -->\ |
| 28 | <!-- for item in seq ---> |
| 29 | ${item} |
| 30 | <!--- endfor -->''' |
| 31 | |
Armin Ronacher | 4f7d2d5 | 2008-04-22 10:40:26 +0200 | [diff] [blame] | 32 | MAKO_SYNTAX = '''\ |
Armin Ronacher | 59b6bd5 | 2009-03-30 21:00:16 +0200 | [diff] [blame] | 33 | <%# regular comment %> |
Armin Ronacher | 4f7d2d5 | 2008-04-22 10:40:26 +0200 | [diff] [blame] | 34 | % for item in seq: |
| 35 | ${item} |
| 36 | % endfor''' |
Armin Ronacher | ccf284b | 2007-05-21 16:44:26 +0200 | [diff] [blame] | 37 | |
Armin Ronacher | 59b6bd5 | 2009-03-30 21:00:16 +0200 | [diff] [blame] | 38 | MAKO_SYNTAX_LINECOMMENTS = '''\ |
| 39 | <%# regular comment %> |
| 40 | % for item in seq: |
| 41 | ${item} ## the rest of the stuff |
| 42 | % endfor''' |
| 43 | |
Armin Ronacher | ecc051b | 2007-06-01 18:25:28 +0200 | [diff] [blame] | 44 | BALANCING = '''{{{'foo':'bar'}.foo}}''' |
| 45 | |
Armin Ronacher | 9b0545a | 2007-09-26 13:16:41 +0200 | [diff] [blame] | 46 | STARTCOMMENT = '''{# foo comment |
| 47 | and bar comment #} |
| 48 | {% macro blub() %}foo{% endmacro %} |
| 49 | {{ blub() }}''' |
| 50 | |
Armin Ronacher | db7985d | 2009-03-31 23:51:56 +0200 | [diff] [blame] | 51 | LINE_SYNTAX_PRIORITY1 = '''\ |
| 52 | /* ignore me. |
| 53 | I'm a multiline comment */ |
| 54 | ## for item in seq: |
| 55 | * ${item} # this is just extra stuff |
| 56 | ## endfor |
| 57 | ''' |
| 58 | |
| 59 | LINE_SYNTAX_PRIORITY2 = '''\ |
Armin Ronacher | 59b6bd5 | 2009-03-30 21:00:16 +0200 | [diff] [blame] | 60 | /* ignore me. |
| 61 | I'm a multiline comment */ |
| 62 | # for item in seq: |
| 63 | * ${item} ## this is just extra stuff |
Armin Ronacher | 3617a02 | 2009-04-01 19:17:31 +0200 | [diff] [blame] | 64 | ## extra stuff i just want to ignore |
Armin Ronacher | 59b6bd5 | 2009-03-30 21:00:16 +0200 | [diff] [blame] | 65 | # endfor |
| 66 | ''' |
| 67 | |
Armin Ronacher | ccf284b | 2007-05-21 16:44:26 +0200 | [diff] [blame] | 68 | |
Armin Ronacher | ccf284b | 2007-05-21 16:44:26 +0200 | [diff] [blame] | 69 | def test_php_syntax(): |
| 70 | env = Environment('<?', '?>', '<?=', '?>', '<!--', '-->') |
| 71 | tmpl = env.from_string(PHP_SYNTAX) |
| 72 | assert tmpl.render(seq=range(5)) == '01234' |
| 73 | |
| 74 | |
| 75 | def test_erb_syntax(): |
| 76 | env = Environment('<%', '%>', '<%=', '%>', '<%#', '%>') |
| 77 | tmpl = env.from_string(ERB_SYNTAX) |
| 78 | assert tmpl.render(seq=range(5)) == '01234' |
| 79 | |
| 80 | |
| 81 | def test_comment_syntax(): |
| 82 | env = Environment('<!--', '-->', '${', '}', '<!--#', '-->') |
| 83 | tmpl = env.from_string(COMMENT_SYNTAX) |
| 84 | assert tmpl.render(seq=range(5)) == '01234' |
| 85 | |
| 86 | |
Armin Ronacher | 42979eb | 2009-07-26 11:08:50 +0200 | [diff] [blame] | 87 | def test_balancing(): |
Armin Ronacher | ecc051b | 2007-06-01 18:25:28 +0200 | [diff] [blame] | 88 | tmpl = env.from_string(BALANCING) |
| 89 | assert tmpl.render() == 'bar' |
Armin Ronacher | 9b0545a | 2007-09-26 13:16:41 +0200 | [diff] [blame] | 90 | |
| 91 | |
Armin Ronacher | 42979eb | 2009-07-26 11:08:50 +0200 | [diff] [blame] | 92 | def test_start_comment(): |
Armin Ronacher | 9b0545a | 2007-09-26 13:16:41 +0200 | [diff] [blame] | 93 | tmpl = env.from_string(STARTCOMMENT) |
| 94 | assert tmpl.render().strip() == 'foo' |
Armin Ronacher | 4f7d2d5 | 2008-04-22 10:40:26 +0200 | [diff] [blame] | 95 | |
| 96 | |
| 97 | def test_line_syntax(): |
| 98 | env = Environment('<%', '%>', '${', '}', '<%#', '%>', '%') |
| 99 | tmpl = env.from_string(MAKO_SYNTAX) |
| 100 | assert [int(x.strip()) for x in tmpl.render(seq=range(5)).split()] == \ |
Rene Leonhardt | c7e6c6d | 2009-04-20 23:08:53 +0200 | [diff] [blame] | 101 | range(5) |
Armin Ronacher | 59b6bd5 | 2009-03-30 21:00:16 +0200 | [diff] [blame] | 102 | |
| 103 | env = Environment('<%', '%>', '${', '}', '<%#', '%>', '%', '##') |
| 104 | tmpl = env.from_string(MAKO_SYNTAX_LINECOMMENTS) |
| 105 | assert [int(x.strip()) for x in tmpl.render(seq=range(5)).split()] == \ |
| 106 | range(5) |
| 107 | |
| 108 | |
| 109 | def test_line_syntax_priority(): |
Armin Ronacher | db7985d | 2009-03-31 23:51:56 +0200 | [diff] [blame] | 110 | # XXX: why is the whitespace there in front of the newline? |
| 111 | env = Environment('{%', '%}', '${', '}', '/*', '*/', '##', '#') |
| 112 | tmpl = env.from_string(LINE_SYNTAX_PRIORITY1) |
Armin Ronacher | 1bb3ab7 | 2009-04-01 19:16:25 +0200 | [diff] [blame] | 113 | assert tmpl.render(seq=[1, 2]).strip() == '* 1\n* 2' |
Armin Ronacher | 59b6bd5 | 2009-03-30 21:00:16 +0200 | [diff] [blame] | 114 | env = Environment('{%', '%}', '${', '}', '/*', '*/', '#', '##') |
Armin Ronacher | db7985d | 2009-03-31 23:51:56 +0200 | [diff] [blame] | 115 | tmpl = env.from_string(LINE_SYNTAX_PRIORITY2) |
Armin Ronacher | 3617a02 | 2009-04-01 19:17:31 +0200 | [diff] [blame] | 116 | assert tmpl.render(seq=[1, 2]).strip() == '* 1\n\n* 2' |
Armin Ronacher | 5dcb724 | 2010-02-06 14:01:26 +0100 | [diff] [blame] | 117 | |
| 118 | |
| 119 | def test_error_messages(): |
| 120 | def assert_error(code, expected): |
| 121 | try: |
| 122 | Template(code) |
| 123 | except TemplateSyntaxError, e: |
| 124 | assert str(e) == expected, 'unexpected error message' |
| 125 | else: |
| 126 | assert False, 'that was suposed to be an error' |
| 127 | |
| 128 | assert_error('{% for item in seq %}...{% endif %}', |
| 129 | "Encountered unknown tag 'endif'. Jinja was looking " |
| 130 | "for the following tags: 'endfor' or 'else'. The " |
| 131 | "innermost block that needs to be closed is 'for'.") |
| 132 | assert_error('{% if foo %}{% for item in seq %}...{% endfor %}{% endfor %}', |
| 133 | "Encountered unknown tag 'endfor'. Jinja was looking for " |
| 134 | "the following tags: 'elif' or 'else' or 'endif'. The " |
| 135 | "innermost block that needs to be closed is 'if'.") |
| 136 | assert_error('{% if foo %}', |
| 137 | "Unexpected end of template. Jinja was looking for the " |
| 138 | "following tags: 'elif' or 'else' or 'endif'. The " |
| 139 | "innermost block that needs to be closed is 'if'.") |
| 140 | assert_error('{% for item in seq %}', |
| 141 | "Unexpected end of template. Jinja was looking for the " |
| 142 | "following tags: 'endfor' or 'else'. The innermost block " |
| 143 | "that needs to be closed is 'for'.") |
Armin Ronacher | 92622e9 | 2010-02-07 01:27:47 +0100 | [diff] [blame^] | 144 | assert_error('{% block foo-bar-baz %}', |
| 145 | "Block names in Jinja have to be valid Python identifiers " |
| 146 | "and may not contain hypens, use an underscore instead.") |