geirm 01/05/17 07:04:12 Added: src/java/org/apache/velocity/test EventHandlingTestCase.java Log: Unit test for the event handling. Nothing terribly fancy, but tests all features. Revision Changes Path 1.1 jakarta-velocity/src/java/org/apache/velocity/test/EventHandlingTestCase.java Index: EventHandlingTestCase.java =================================================================== package org.apache.velocity.test; /* * The Apache Software License, Version 1.1 * * Copyright (c) 2001 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.StringWriter; import junit.framework.TestCase; import org.apache.velocity.app.Velocity; import org.apache.velocity.VelocityContext; import org.apache.velocity.runtime.log.LogSystem; import org.apache.velocity.exception.ParseErrorException; import org.apache.velocity.exception.MethodInvocationException; import org.apache.velocity.context.EventCartridge; import org.apache.velocity.context.ReferenceInsertionEventHandler; import org.apache.velocity.context.MethodExceptionEventHandler; import org.apache.velocity.context.NullSetEventHandler; /** * Tests event handling * * @author <a href="mailto:[EMAIL PROTECTED]";>Geir Magnusson Jr.</a> * @version $Id: EventHandlingTestCase.java,v 1.1 2001/05/17 14:04:08 geirm Exp $ */ public class EventHandlingTestCase extends TestCase implements ReferenceInsertionEventHandler, NullSetEventHandler, MethodExceptionEventHandler, LogSystem { private String logString = null; private boolean exceptionSwitch = true; private static String NO_REFERENCE_VALUE = "<no reference value>"; private static String REFERENCE_VALUE = "<reference value>"; /** * Default constructor. */ public EventHandlingTestCase() { super("EventHandlingTestCase"); try { /* * use an alternative logger. Set it up here and pass it in. */ Velocity.setProperty(Velocity.RUNTIME_LOG_LOGSYSTEM, this ); Velocity.init(); } catch (Exception e) { System.err.println("Cannot setup event handling test : " + e); System.exit(1); } } public static junit.framework.Test suite () { return new EventHandlingTestCase(); } /** * Runs the test. */ public void runTest () { /* * lets make a Context and add some data */ VelocityContext context = new VelocityContext(); context.put("name", "Velocity"); /* * Now make an event cartridge, register all the * event handlers (at once) and attach it to the * Context */ EventCartridge ec = new EventCartridge(); ec.addEventHandler(this); ec.attachToContext( context ); try { /* * First, the reference insertion handler */ String s = "$name"; StringWriter w = new StringWriter(); Velocity.evaluate( context, w, "mystring", s ); if ( !w.toString().equals( REFERENCE_VALUE )) { fail( "Reference insertion test 1"); } /* * using the same handler, we can deal with * null references as well */ s = "$floobie"; w = new StringWriter(); Velocity.evaluate( context, w, "mystring", s ); if ( !w.toString().equals( NO_REFERENCE_VALUE )) { fail( "Reference insertion test 2"); } /* * now lets test setting a null value - this test * should result in *no* log output. */ s = "#set($settest = $NotAReference)"; w = new StringWriter(); logString = null; Velocity.evaluate( context, w, "mystring", s ); if( logString != null) { fail( "NullSetEventHandler test 1"); } /* * now lets test setting a null value - this test * should result in log output. */ s = "#set($logthis = $NotAReference)"; w = new StringWriter(); logString = null; Velocity.evaluate( context, w, "mystring", s ); if( logString == null) { fail( "NullSetEventHandler test 1"); } /* * finally, we test a method exception event - we do this * by putting this class in the context, and calling * a method that does nothing but throw an exception. * we use a little switch to turn the event handling * on and off * * Note also how the reference insertion process * happens as well */ exceptionSwitch = true; context.put("this", this ); s = " $this.throwException()"; w = new StringWriter(); try { Velocity.evaluate( context, w, "mystring", s ); } catch( MethodInvocationException mee ) { fail("MethodExceptionEvent test 1"); } catch( Exception e ) { fail("MethodExceptionEvent test 1"); } /* * now, we turn the switch off, and we can see that the * exception will propgate all the way up here, and * wil be caught by the catch() block below */ exceptionSwitch = false; s = " $this.throwException()"; w = new StringWriter(); try { Velocity.evaluate( context, w, "mystring", s ); fail("MethodExceptionEvent test 2"); } catch( MethodInvocationException mee ) { /* * correct - should land here... */ } catch( Exception e ) { fail("MethodExceptionEvent test 2"); } } catch( ParseErrorException pee ) { fail("ParseErrorException" + pee); } catch( MethodInvocationException mee ) { fail("MethodInvocationException" + mee); } catch( Exception e ) { fail("Exception" + e); } } /** * silly method to throw an exception to test * the method invocation exception event handling */ public void throwException() throws Exception { throw new Exception("Hello from throwException()"); } /** * Event handler for when a reference is inserted into the output stream. */ public Object referenceInsert( String reference, Object value ) { /* * if we have a value * return a known value */ String s = null; if( value != null ) { s = REFERENCE_VALUE; } else { /* * we only want to deal with $floobie - anything * else we let go */ if ( reference.equals("$floobie") ) { s = NO_REFERENCE_VALUE; } } return s; } /** * Event handler for when the right hand side of * a #set() directive is null, which results in * a log message. This method gives the application * a chance to 'vote' on msg generation */ public boolean nullSetLogMessage( String reference ) { if (reference.equals("$settest")) return false; return true; } /** * Handles exceptions thrown during in-template method access */ public Object methodException( Class claz, String method, Exception e ) throws Exception { /* * only do processing if the switch is on */ if( exceptionSwitch && method.equals("throwException")) { return "handler"; } throw e; } /** * handler for LogSystem interface */ public void logVelocityMessage(int level, String message) { logString = message; } }
