geirm 00/12/03 17:18:51 Added: src/java/org/apache/velocity/test ContextSafetyTestCase.java Log: Tests to see if we can do a change of data object in the Context and remerge a template. Note that this is not a trivial change, such as a different string, but altogether something more evil, like switching between a j.u.Vector and an Object array. This is what happens when multiple threads are using the same template with different data objects in the template, or a single thread is repeatedly merging() with different data objects. No one ran across it, yet, but we could, and eventually would. Revision Changes Path 1.1 jakarta-velocity/src/java/org/apache/velocity/test/ContextSafetyTestCase.java Index: ContextSafetyTestCase.java =================================================================== package org.apache.velocity.test; /* * The Apache Software License, Version 1.1 * * Copyright (c) 2000 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, if * any, must include the following acknowlegement: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowlegement may appear in the software itself, * if and wherever such third-party acknowlegements normally appear. * * 4. The names "The Jakarta Project", "Velocity", and "Apache Software * Foundation" must not be used to endorse or promote products derived * from this software without prior written permission. For written * permission, please contact [EMAIL PROTECTED] * * 5. Products derived from this software may not be called "Apache" * nor may "Apache" appear in their names without prior written * permission of the Apache Group. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. */ import java.io.*; import java.util.Vector; import junit.framework.*; import org.apache.velocity.Context; import org.apache.velocity.Template; import org.apache.velocity.test.provider.TestProvider; import org.apache.velocity.runtime.Runtime; import org.apache.velocity.util.StringUtils; /** * Tests if we are context safe : can we switch objects in the context * and re-merge the template safely. * * @author <a href="mailto:[EMAIL PROTECTED]">Geir Magnusson Jr.</a> * @version $Id: ContextSafetyTestCase.java,v 1.1 2000/12/04 01:18:50 geirm Exp $ */ public class ContextSafetyTestCase extends RuntimeTestCase { /** * VTL file extension. */ private static final String TMPL_FILE_EXT = "vm"; /** * Comparison file extension. */ private static final String CMP_FILE_EXT = "cmp"; /** * Comparison file extension. */ private static final String RESULT_FILE_EXT = "res"; /** * Results relative to the build directory. */ private static final String RESULT_DIR = "../test/templates/results"; /** * Results relative to the build directory. */ private static final String COMPARE_DIR = "../test/templates/compare"; ContextSafetyTestCase() { super("ContextSafetyTestCase"); } /** * Runs the test. */ public void runTest () { /* * make a Vector and String array because * they are treated differently in Foreach() */ Vector v = new Vector(); v.addElement( new String("vector hello 1") ); v.addElement( new String("vector hello 2") ); v.addElement( new String("vector hello 3") ); String strArray[] = new String[3]; strArray[0] = "array hello 1"; strArray[1] = "array hello 2"; strArray[2] = "array hello 3"; Context context = new Context(); try { /* * get the template and the output */ Template template = Runtime.getTemplate(getFileName(null, "context_safety", TMPL_FILE_EXT)); FileOutputStream fos1 = new FileOutputStream (getFileName(RESULT_DIR, "context_safety1", RESULT_FILE_EXT)); FileOutputStream fos2 = new FileOutputStream (getFileName(RESULT_DIR, "context_safety2", RESULT_FILE_EXT)); Writer writer1 = new BufferedWriter(new OutputStreamWriter(fos1)); Writer writer2 = new BufferedWriter(new OutputStreamWriter(fos2)); /* * put the Vector into the context, and merge */ context.put("vector", v); template.merge(context, writer1); writer1.flush(); writer1.close(); /* * now put the string array into the context, and merge */ context.put("vector", strArray); template.merge(context, writer2); writer2.flush(); writer2.close(); if (!isOutputCorrect()) { fail("Output incorrect."); } } catch (Exception e) { fail(e.getMessage()); } } /** * Concatenates the file name parts together appropriately. * * @return The full path to the file. */ private static String getFileName (String dir, String base, String ext) { StringBuffer buf = new StringBuffer(); if (dir != null) { buf.append(dir).append('/'); } buf.append(base).append('.').append(ext); return buf.toString(); } /** * Turns a base file name into a test case name. * * @param s The base file name. * @return The test case name. */ private static final String getTestCaseName (String s) { StringBuffer name = new StringBuffer(); name.append(Character.toTitleCase(s.charAt(0))); name.append(s.substring(1, s.length()).toLowerCase()); return name.toString(); } /** * Returns whether the processed template matches the content of the * provided comparison file. * * @return Whether the output matches the contents of the comparison file. * * @exception Exception Test failure condition. */ protected boolean isOutputCorrect() throws Exception { String result1 = StringUtils.fileContentsToString (getFileName(RESULT_DIR, "context_safety1", RESULT_FILE_EXT)); String compare1 = StringUtils.fileContentsToString (getFileName(COMPARE_DIR, "context_safety1", CMP_FILE_EXT)); String result2 = StringUtils.fileContentsToString (getFileName(RESULT_DIR, "context_safety2", RESULT_FILE_EXT)); String compare2 = StringUtils.fileContentsToString (getFileName(COMPARE_DIR, "context_safety2", CMP_FILE_EXT)); return ( result1.equals(compare1) && result2.equals(compare2)); } /** * Performs cleanup activities for this test case. */ protected void tearDown () throws Exception { // No op. } }
