aboutsummaryrefslogtreecommitdiff
path: root/velocity-engine-core/src/test/java/org/apache/velocity/test/TextblockTestCase.java
blob: fc042544e2b58b72716e24407ca340f6eabb7c9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
package org.apache.velocity.test;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import org.apache.velocity.runtime.RuntimeInstance;
import org.apache.velocity.runtime.parser.Parser;
import org.apache.velocity.runtime.parser.node.ASTTextblock;

import java.lang.reflect.Field;

/**
 * This class tests the Textblock directive.
 */
public class TextblockTestCase extends BaseTestCase
{
    // these are all here so that the test case adapts instantly
    // to changes in the textblock start/end sequences
    private String START = null;
    private String END = null;
    private String PARTIAL_START = null;
    private String PARTIAL_END = null;
    private String END_OF_START = null;
    private String START_OF_END = null;

    public TextblockTestCase(String name)
    {
        super(name);
        //DEBUG = true;
    }

    @Override
    protected void setUp() throws Exception
    {
        super.setUp();

        // get a valid parser instance to initialize string constants
        Field riField = engine.getClass().getDeclaredField("ri");
        riField.setAccessible(true);
        RuntimeInstance ri = (RuntimeInstance)riField.get(engine);
        Parser parser = ri.createNewParser();
        ASTTextblock astTextblock = new ASTTextblock(parser, 0);
        START = astTextblock.START;
        END = astTextblock.END;
        PARTIAL_START = START.substring(0, START.length() - 1);
        PARTIAL_END = END.substring(1);
        END_OF_START = START.substring(START.length() - 1);
        START_OF_END = END.substring(0, 1);
    }

    public String textblock(String s)
    {
        return START + s + END;
    }

    public void assertTextblockEvalEquals(String s) throws Exception
    {
        assertEvalEquals(s, textblock(s));
    }

    /**
     * https://issues.apache.org/jira/browse/VELOCITY-661
     */
    public void testTextblockAjaxcode() throws Exception
    {
        String s = "var myId = 'someID';$('#test).append($.template('<div id=\"${myId}\"></div>').apply({myId: myId}));";
        assertEvalEquals(s + " 123", textblock(s)+" #foreach($i in [1..3])$i#end");
    }

    public void testLooseTextblockEnd() throws Exception
    {
        // just like a multi-line comment end (*#), this must be
        // followed by a character.  by itself, it bombs for some reason.
        assertEvalEquals(END+" ", END+" ");
    }

    public void testTextblockStartInTextblock() throws Exception
    {
        assertTextblockEvalEquals(START);
    }

    public void testTextblockEndBetweenTwoTextblockHalves() throws Exception
    {
        // just like a multi-line comment end (*#), the end token
        // in the middle must be followed by some character.
        // by itself, it bombs.  not sure why that is, but the
        // same has been true of multi-line comments without complaints,
        // so i'm not going to worry about it just yet.
        assertEvalEquals(" "+END+"  ", textblock(" ")+END+" "+textblock(" "));
    }

    public void testZerolengthTextblock() throws Exception
    {
        assertTextblockEvalEquals("");
    }

    public void testTextblockInsideForeachLoop() throws Exception
    {
        String s = "var myId = 'someID';$('#test).append($.template('<div id=\"${myId}\"></div>').apply({myId: myId}));";
        assertEvalEquals("1 "+s+"2 "+s+"3 "+s, "#foreach($i in [1..3])$i "+ textblock(s) + "#end");
    }

    public void testSingleHashInsideTextblock() throws Exception
    {
        assertTextblockEvalEquals(" # ");
    }

    public void testDollarInsideTextblock() throws Exception
    {
        assertTextblockEvalEquals("$");
    }

    public void testTextblockInsideComment() throws Exception
    {
        String s = "FOOBAR";
        assertEvalEquals("", "#* comment "+textblock(s) + " *#");
    }

    public void testPartialStartEndTokensInsideTextblock() throws Exception
    {
        assertTextblockEvalEquals(PARTIAL_START+"foo"+PARTIAL_END);
    }

    public void testDupeTokenChars() throws Exception
    {
        assertTextblockEvalEquals(END_OF_START+START_OF_END);
        assertTextblockEvalEquals(END_OF_START+END_OF_START+START_OF_END+START_OF_END);
        assertTextblockEvalEquals(END_OF_START+END_OF_START+"#"+START_OF_END+START_OF_END);
    }

    /**
     * https://issues.apache.org/jira/browse/VELOCITY-584
     */
    public void testServerSideIncludeEscaping() throws Exception
    {
        assertTextblockEvalEquals("<!--#include file=\"wisdom.inc\"--> ");
    }

    /**
     * https://issues.apache.org/jira/browse/VELOCITY-676
     */
    public void testLineCommentInsideTextblock() throws Exception
    {
        assertTextblockEvalEquals("##x");
    }

}