src/test/org/apache/velocity/test/util/introspection/UberspectImplTestCase.java

package org.apache.velocity.test.util.introspection;

import java.io.StringWriter;
import java.util.Arrays;
import java.util.Iterator;

import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.runtime.RuntimeConstants;
import org.apache.velocity.test.BaseTestCase;
import org.apache.velocity.test.misc.TestLogChute;

/*
 * 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;

/**
 * Tests the default uberspector.
 */
public class UberspectImplTestCase extends BaseTestCase
{
    VelocityEngine engine;

    public UberspectImplTestCase(String name)
        throws Exception
    {
        super(name);
    }

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

    @Override
    public void setUp()
        throws Exception
    {
        engine = new VelocityEngine();
        
        engine.setProperty(RuntimeConstants.RUNTIME_LOG_LOGSYSTEM_CLASS, TestLogChute.class.getName());
        engine.addProperty(RuntimeConstants.UBERSPECT_CLASSNAME,"org.apache.velocity.util.introspection.UberspectImpl");
	    engine.init();
    }

    @Override
    public void tearDown()
    {
    }

    public void testPrivateIterator()
        throws Exception
    {
        VelocityContext context = new VelocityContext();
        context.put("privateClass", new PrivateClass());
        context.put("privateMethod", new PrivateMethod());
        context.put("publicMethod", new PublicMethod());
        StringWriter writer = new StringWriter();

        engine.evaluate(context, writer, "test", "#foreach($i in $privateClass)$i#end");
        assertEquals(writer.toString(), "");

        writer = new StringWriter();
        engine.evaluate(context, writer, "test", "#foreach($i in $privateMethod)$i#end");
        assertEquals(writer.toString(), "");

        writer = new StringWriter();
        engine.evaluate(context, writer, "test", "#foreach($i in $publicMethod)$i#end");
        assertEquals(writer.toString(), "123");
    }
    
    public void testIterableForeach()
    {
        VelocityContext context = new VelocityContext();
        context.put("iterable", new SomeIterable());
        StringWriter writer = new StringWriter();

        engine.evaluate(context, writer, "test", "#foreach($i in $iterable)$i#end");
        assertEquals(writer.toString(), "123");
    }

    private class PrivateClass
    {
        public Iterator iterator()
        {
            return Arrays.asList("X", "Y", "Z").iterator();
        }
    }

    public class PrivateMethod
    {
        private Iterator iterator()
        {
            return Arrays.asList("A", "B", "C").iterator();
        }
    }

    public class PublicMethod
    {
        public Iterator iterator()
        {
            return Arrays.asList("1", "2", "3").iterator();
        }
    }

    public class SomeIterable implements Iterable
    {
        public Iterator iterator()
        {
            return Arrays.asList("1", "2", "3").iterator();
        }
    }
}