You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by da...@apache.org on 2001/03/06 00:34:16 UTC

cvs commit: jakarta-velocity/src/java/org/apache/velocity/test ClasspathResourceTest.java

daveb       01/03/05 15:34:16

  Added:       src/java/org/apache/velocity/test ClasspathResourceTest.java
  Log:
  Test for whether the Classpathloader can find templates in Jar(s)
  
  Revision  Changes    Path
  1.1                  jakarta-velocity/src/java/org/apache/velocity/test/ClasspathResourceTest.java
  
  Index: ClasspathResourceTest.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 apache@apache.org.
   *
   * 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.BufferedWriter;
  import java.io.FileOutputStream;
  import java.io.OutputStreamWriter;
  import java.io.Writer;
  
  import java.util.Properties;
  
  import org.apache.velocity.VelocityContext;
  
  import org.apache.velocity.Template;
  import org.apache.velocity.test.provider.TestProvider;
  import org.apache.velocity.runtime.Runtime;
  import org.apache.velocity.runtime.RuntimeConstants;
  import org.apache.velocity.util.StringUtils;
  import org.apache.velocity.runtime.VelocimacroFactory;
  
  import junit.framework.TestCase;
  
  /**
   * Load templates from the Classpath.
   *
   * @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a>
   * @author <a href="mailto:daveb@miceda-data.com">Dave Bryson</a>
   * @version $Id: ClasspathResourceTest.java,v 1.1 2001/03/05 23:34:16 daveb Exp $
   */
  public class ClasspathResourceTest extends TestCase
  {
       /**
       * 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";
  
      /**
       * Overload velocity template
       */
      private final static String TEST_PROPERTY_FILE = "../test/cpload/velocity.properties";
  
      /**
       * Results relative to the build directory.
       */
      private static final String RESULT_DIR = "../test/cpload/result";
  
      /**
       * Results relative to the build directory.
       */
      private static final String COMPARE_DIR = "../test/cpload/compare";
  
      /**
       * Default constructor.
       */
      ClasspathResourceTest()
      {
          super("ClasspathResourceTest");
  
          try
          {
              Runtime.init( TEST_PROPERTY_FILE );
          }
          catch (Exception e)
          {
              System.err.println("Cannot setup ClasspathResourceTest!");
              e.printStackTrace();
              System.exit(1);
          }            
      }
  
      public static junit.framework.Test suite ()
      {
          return new ClasspathResourceTest();
      }
  
      /**
       * Runs the test.
       */
      public void runTest ()
      {
          try
          {
              Template template1 = Runtime.getTemplate(
                  getFileName(null, "template/test1", TMPL_FILE_EXT));
              
              Template template2 = Runtime.getTemplate(
                  getFileName(null, "template/test2", TMPL_FILE_EXT));
             
              FileOutputStream fos1 = 
                  new FileOutputStream (
                      getFileName(RESULT_DIR, "test1", RESULT_FILE_EXT));
  
              FileOutputStream fos2 = 
                  new FileOutputStream (
                      getFileName(RESULT_DIR, "test2", 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 both
               */
  
              VelocityContext context = new VelocityContext();
  
              template1.merge(context, writer1);
              writer1.flush();
              writer1.close();
              
              template2.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, "test1", RESULT_FILE_EXT));
              
          String compare1 = StringUtils.fileContentsToString
               (getFileName(COMPARE_DIR, "test1", CMP_FILE_EXT));
  
         String result2 = StringUtils.fileContentsToString
              (getFileName(RESULT_DIR, "test2", RESULT_FILE_EXT));
              
          String compare2 = StringUtils.fileContentsToString
               (getFileName(COMPARE_DIR, "test2", CMP_FILE_EXT));
  
          return ( result1.equals(compare1) && result2.equals(compare2));
      }
  
      /**
       * Performs cleanup activities for this test case.
       */
      protected void tearDown () throws Exception
      {
          // No op.
      }
  }