1 files changed, 299 insertions, 0 deletions
diff --git a/velocity-engine-core/src/test/java/org/apache/velocity/test/EvaluateTestCase.java b/velocity-engine-core/src/test/java/org/apache/velocity/test/EvaluateTestCase.java
new file mode 100644
index 00000000..fc5c1d1b
--- /dev/null
+++ b/velocity-engine-core/src/test/java/org/apache/velocity/test/EvaluateTestCase.java
@@ -0,0 +1,299 @@
+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.Template;
+import org.apache.velocity.VelocityContext;
+import org.apache.velocity.app.VelocityEngine;
+import org.apache.velocity.app.event.implement.EscapeHtmlReference;
+import org.apache.velocity.context.Context;
+import org.apache.velocity.exception.ParseErrorException;
+import org.apache.velocity.runtime.RuntimeConstants;
+
+import java.io.BufferedWriter;
+import java.io.FileOutputStream;
+import java.io.OutputStreamWriter;
+import java.io.StringWriter;
+import java.io.Writer;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Test #evaluate directive.
+ *
+ * @author <a href="mailto:wglass@forio.com">Will Glass-Husain</a>
+ * @version $Id$
+ */
+public class EvaluateTestCase extends BaseTestCase
+{
+
+    /**
+    * 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";
+
+   /**
+    * Path for templates. This property will override the
+    * value in the default velocity properties file.
+    */
+   private final static String FILE_RESOURCE_LOADER_PATH = TEST_COMPARE_DIR + "/evaluate";
+
+   /**
+    * Results relative to the build directory.
+    */
+   private static final String RESULTS_DIR = TEST_RESULT_DIR + "/evaluate";
+
+   /**
+    * Results relative to the build directory.
+    */
+   private static final String COMPARE_DIR = TEST_COMPARE_DIR + "/evaluate/compare";
+
+    /**
+     * Default constructor.
+     * @param name
+     */
+    public EvaluateTestCase(String name)
+    {
+        super(name);
+    }
+
+    @Override
+    public void setUp() throws Exception
+    {
+        super.setUp();
+        assureResultsDirectoryExists(RESULTS_DIR);
+    }
+
+    @Override
+    protected void setUpEngine(VelocityEngine engine)
+    {
+        // extension hook
+    }
+
+
+    /**
+     * Test basic functionality.
+     * @throws Exception
+     */
+    public void testEvaluate()
+    throws Exception
+    {
+        Map props = new HashMap();
+        testFile("eval1", props);
+    }
+
+    /**
+     * Test evaluate directive preserves macros (VELOCITY-591)
+     * @throws Exception
+     */
+    public void testEvaluateMacroPreserve()
+    throws Exception
+    {
+        Map properties = new HashMap();
+        testFile("eval2", properties);
+
+        properties.put(RuntimeConstants.VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL,"false");
+        testFile("eval2", properties);
+    }
+
+    /**
+     * Test in a macro context.
+     * @throws Exception
+     */
+    public void testEvaluateVMContext()
+    throws Exception
+    {
+        testFile("evalvmcontext", new HashMap());
+    }
+
+    /**
+     * Test #stop and #break
+     * @throws Exception
+     */
+    public void testStopAndBreak()
+    {
+        engine.setProperty("evaluate.provide.scope.control", "true");
+        assertEvalEquals("t ", "t #stop t2 #evaluate('t3')");
+        assertEvalEquals("t ", "t #break t2 #evaluate('t3')");
+        assertEvalEquals("t t2 t3 ", "t t2 #evaluate('t3 #stop t4') t5");
+        assertEvalEquals("t t2 t3  t5", "t t2 #evaluate('t3 #break t4') t5");
+        assertEvalEquals("t t2 t3 ", "t t2 #evaluate('t3 #break($evaluate.topmost) t4') t5");
+    }
+
+    /**
+     * Test that the event handlers work in #evaluate (since they are
+     * attached to the context).  Only need to check one - they all
+     * work the same.
+     * @throws Exception
+     */
+    public void testEventHandler()
+    throws Exception
+    {
+        VelocityEngine ve = new VelocityEngine();
+        ve.setProperty(RuntimeConstants.EVENTHANDLER_REFERENCEINSERTION, EscapeHtmlReference.class.getName());
+        ve.init();
+
+        Context context = new VelocityContext();
+        context.put("lt","<");
+        context.put("gt",">");
+        StringWriter writer = new StringWriter();
+        ve.evaluate(context, writer, "test","${lt}test${gt} #evaluate('${lt}test2${gt}')");
+        assertEquals("&lt;test&gt; &lt;test2&gt;", writer.toString());
+
+    }
+
+
+    /**
+     * Test errors are thrown
+     * @throws Exception
+     */
+    public void testErrors()
+    throws Exception
+    {
+        VelocityEngine ve = new VelocityEngine();
+        ve.init();
+
+        Context context = new VelocityContext();
+
+        // no arguments
+        StringWriter writer = new StringWriter();
+        try
+        {
+            ve.evaluate(context, writer, "test",
+                              "#evaluate()");
+            fail("Expected exception");
+        }
+        catch (ParseErrorException e)
+        {
+            assertEquals("test",e.getTemplateName());
+            assertEquals(1,e.getLineNumber());
+            assertEquals(1,e.getColumnNumber());
+        }
+
+        // too many arguments
+        writer = new StringWriter();
+        try
+        {
+            ve.evaluate(context, writer, "test",
+                              "#evaluate('aaa' 'bbb')");
+            fail("Expected exception");
+        }
+        catch (ParseErrorException e)
+        {
+            assertEquals("test",e.getTemplateName());
+            assertEquals(1,e.getLineNumber());
+            assertEquals(17,e.getColumnNumber());
+        }
+
+        // argument not a string or reference
+        writer = new StringWriter();
+        try
+        {
+            ve.evaluate(context, writer, "test",
+                              "#evaluate(10)");
+            fail("Expected exception");
+        }
+        catch (ParseErrorException e)
+        {
+            assertEquals("test",e.getTemplateName());
+            assertEquals(1,e.getLineNumber());
+            assertEquals(11,e.getColumnNumber());
+        }
+
+        // checking line/col for parse error
+        writer = new StringWriter();
+        try
+        {
+            String eval = "this is a multiline\n\n\n\n\n test #foreach() with an error";
+            context.put("eval",eval);
+            ve.evaluate(context, writer, "test",
+                              "first line\n second line: #evaluate($eval)");
+            fail("Expected exception");
+        }
+        catch (ParseErrorException e)
+        {
+            // should be start of #evaluate
+            assertEquals("test",e.getTemplateName());
+            assertEquals(2,e.getLineNumber());
+            assertEquals(15,e.getColumnNumber());
+        }
+    }
+
+    /**
+     * Test a file parses with no errors and compare to existing file.
+     * @param basefilename
+     * @throws Exception
+     */
+    private void testFile(String basefilename, Map<String, Object> properties)
+    throws Exception
+    {
+        info("Test file: "+basefilename);
+        VelocityEngine ve = engine;
+        ve.addProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, FILE_RESOURCE_LOADER_PATH);
+
+        for (String key : properties.keySet())
+        {
+            String value = (String) properties.get(key);
+            ve.addProperty(key, value);
+            info("Add property: " + key + " = " + value);
+        }
+
+        ve.init();
+
+        Template template;
+        FileOutputStream fos;
+        Writer fwriter;
+
+        template = ve.getTemplate( getFileName(null, basefilename, TMPL_FILE_EXT) );
+
+        fos = new FileOutputStream (
+                getFileName(RESULTS_DIR, basefilename, RESULT_FILE_EXT));
+
+        fwriter = new BufferedWriter( new OutputStreamWriter(fos) );
+
+        template.merge(context, fwriter);
+        fwriter.flush();
+        fwriter.close();
+
+        if (!isMatch(RESULTS_DIR, COMPARE_DIR, basefilename, RESULT_FILE_EXT, CMP_FILE_EXT))
+        {
+            String result = getFileContents(RESULTS_DIR, basefilename, RESULT_FILE_EXT);
+            String compare = getFileContents(COMPARE_DIR, basefilename, CMP_FILE_EXT);
+
+            String msg = "Output was incorrect\n"+
+                "-----Result-----\n"+ result +
+                "----Expected----\n"+ compare +
+                "----------------";
+
+            fail(msg);
+        }
+    }
+
+}