aboutsummaryrefslogtreecommitdiff
path: root/velocity-engine-core/src/test/java/org/apache/velocity/test/sql/DataSourceResourceLoaderTestCase.java
blob: 757b6e84c406ddcea9fee05f79fdc5c270a6eeb8 (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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
package org.apache.velocity.test.sql;

/*
 * 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 junit.framework.Test;
import junit.framework.TestSuite;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.runtime.RuntimeInstance;
import org.apache.velocity.runtime.resource.loader.DataSourceResourceLoader;
import org.apache.velocity.test.misc.TestLogger;
import org.apache.velocity.util.ExtProperties;

import javax.sql.DataSource;
import java.io.BufferedWriter;
import java.io.FileOutputStream;
import java.io.OutputStreamWriter;
import java.io.StringWriter;
import java.io.Writer;


public class DataSourceResourceLoaderTestCase
        extends BaseSQLTest
{
    /**
     * Comparison file extension.
     */
    private static final String CMP_FILE_EXT = "cmp";

    /**
     * Comparison file extension.
     */
    private static final String RESULT_FILE_EXT = "res";

    /**
     * Path to template file.  This will get combined with the
     * application directory to form an absolute path
     */
    private final static String DATA_PATH = TEST_COMPARE_DIR + "/ds";

    /**
     * Results relative to the build directory.
     */
    private static final String RESULTS_DIR = TEST_RESULT_DIR + "/ds";

    /**
     * Results relative to the build directory.
     */
    private static final String COMPARE_DIR = TEST_COMPARE_DIR + "/ds/templates";

    /* engine with VARCHAR templates data source */
    private RuntimeInstance varcharTemplatesEngine = null;

    /* engine with CLOB templates data source */
    private RuntimeInstance clobTemplatesEngine = null;

    public DataSourceResourceLoaderTestCase(final String name)
    	throws Exception
    {
        super(name, DATA_PATH);
    }

    public static Test suite()
    {
        return new TestSuite(DataSourceResourceLoaderTestCase.class);
    }

    @Override
    public void setUp()
            throws Exception
    {

        assureResultsDirectoryExists(RESULTS_DIR);

        DataSource ds1 = new TestDataSource(TEST_JDBC_DRIVER_CLASS, TEST_JDBC_URI, TEST_JDBC_LOGIN, TEST_JDBC_PASSWORD);
        DataSourceResourceLoader rl1 = new DataSourceResourceLoader();
        rl1.setDataSource(ds1);

        DataSource ds2 = new TestDataSource(TEST_JDBC_DRIVER_CLASS, TEST_JDBC_URI, TEST_JDBC_LOGIN, TEST_JDBC_PASSWORD);
        DataSourceResourceLoader rl2 = new DataSourceResourceLoader();
        rl2.setDataSource(ds2);

        ExtProperties props = new ExtProperties();
        props.addProperty( "resource.loader", "ds" );
        props.setProperty( "ds.resource.loader.instance", rl1);
        props.setProperty( "ds.resource.loader.resource.table",           "velocity_template_varchar");
        props.setProperty( "ds.resource.loader.resource.keycolumn",       "vt_id");
        props.setProperty( "ds.resource.loader.resource.templatecolumn",  "vt_def");
        props.setProperty( "ds.resource.loader.resource.timestampcolumn", "vt_timestamp");
        props.setProperty(Velocity.RUNTIME_LOG_INSTANCE, new TestLogger(false, false));

        varcharTemplatesEngine = new RuntimeInstance();
        varcharTemplatesEngine.setConfiguration(props);
        varcharTemplatesEngine.init();

        ExtProperties props2 = (ExtProperties)props.clone();
        props2.setProperty( "ds.resource.loader.instance", rl2);
        props2.setProperty( "ds.resource.loader.resource.table",           "velocity_template_clob");
        clobTemplatesEngine = new RuntimeInstance();
        clobTemplatesEngine.setConfiguration(props2);
        clobTemplatesEngine.init();
    }

    /**
     * Tests loading and rendering of a simple template. If that works, we are able to get data
     * from the database.
     */
    public void testSimpleTemplate()
            throws Exception
    {
        Template t = executeTest("testTemplate1", varcharTemplatesEngine);
        assertFalse("Timestamp is 0", 0 == t.getLastModified());
        t = executeTest("testTemplate1", clobTemplatesEngine);
        assertFalse("Timestamp is 0", 0 == t.getLastModified());    }

    public void testUnicode(RuntimeInstance engine)
        throws Exception
    {
        Template template = engine.getTemplate(UNICODE_TEMPLATE_NAME);

        Writer writer = new StringWriter();
        VelocityContext context = new VelocityContext();
        template.merge(context, writer);
        writer.flush();
        writer.close();

        String outputText = writer.toString();

        if (!normalizeNewlines(UNICODE_TEMPLATE).equals(
                normalizeNewlines( outputText ) ))
        {
            fail("Output incorrect for Template: " + UNICODE_TEMPLATE_NAME);
        }
    }

    /**
     * Now we have a more complex example. Run a very simple tool.
     * from the database.
     */
    public void testRenderTool()
            throws Exception
    {
        Template t = executeTest("testTemplate2", varcharTemplatesEngine);
        assertFalse("Timestamp is 0", 0 == t.getLastModified());
        t = executeTest("testTemplate2", clobTemplatesEngine);
        assertFalse("Timestamp is 0", 0 == t.getLastModified());
    }

    /**
     * Will a NULL timestamp choke the loader?
     */
    public void testNullTimestamp()
            throws Exception
    {
        Template t = executeTest("testTemplate3", varcharTemplatesEngine);
        assertEquals("Timestamp is not 0", 0, t.getLastModified());
        t = executeTest("testTemplate3", clobTemplatesEngine);
        assertEquals("Timestamp is not 0", 0, t.getLastModified());    }

    /**
     * Does it load the global Macros from the DB?
     */
    public void testMacroInvocation()
            throws Exception
    {
        Template t = executeTest("testTemplate4", varcharTemplatesEngine);
        assertFalse("Timestamp is 0", 0 == t.getLastModified());
        t = executeTest("testTemplate4", clobTemplatesEngine);
        assertFalse("Timestamp is 0", 0 == t.getLastModified());
    }

    protected Template executeTest(final String templateName, RuntimeInstance engine)
    	throws Exception
    {
        Template template = engine.getTemplate(templateName);

        FileOutputStream fos =
                new FileOutputStream (
                        getFileName(RESULTS_DIR, templateName, RESULT_FILE_EXT));

        Writer writer = new BufferedWriter(new OutputStreamWriter(fos));

        VelocityContext context = new VelocityContext();
        context.put("tool", new DSRLTCTool());

        template.merge(context, writer);
        writer.flush();
        writer.close();

        if (!isMatch(RESULTS_DIR, COMPARE_DIR, templateName,
                        RESULT_FILE_EXT, CMP_FILE_EXT))
        {
            fail("Output incorrect for Template: " + templateName);
        }

        return template;
    }

    public static final class DSRLTCTool
    {
        public int add(final int a, final int b)
	{
	    return a + b;
	}

	    public String getMessage()
	{
	    return "And the result is:";
	}
    }
}