[xwiki-notifications] r10960 - xwiki-platform/core/trunk/xwiki-velocity/src/test/java/org/xwiki/velocity/introspection

[sdumitriu (SVN)]

Author: sdumitriu
Date: 2008-07-01 02:26:47 +0200 (Tue, 01 Jul 2008)
New Revision: 10960

Added:
   xwiki-platform/core/trunk/xwiki-velocity/src/test/java/org/xwiki/velocity/introspection/LinkingUberspectorTest.java
Log:
XWIKI-2531: Custom Velocity Uberspector that allows linking several uberspectors
Adding unit tests


Added: xwiki-platform/core/trunk/xwiki-velocity/src/test/java/org/xwiki/velocity/introspection/LinkingUberspectorTest.java
===================================================================
--- xwiki-platform/core/trunk/xwiki-velocity/src/test/java/org/xwiki/velocity/introspection/LinkingUberspectorTest.java	                        (rev 0)
+++ xwiki-platform/core/trunk/xwiki-velocity/src/test/java/org/xwiki/velocity/introspection/LinkingUberspectorTest.java	2008-07-01 00:26:47 UTC (rev 10960)
@@ -0,0 +1,153 @@
+/*
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ *
+ */
+package org.xwiki.velocity.introspection;
+
+import java.io.StringReader;
+import java.io.StringWriter;
+import java.util.Date;
+import java.util.Properties;
+
+import org.apache.velocity.runtime.RuntimeConstants;
+import org.apache.velocity.util.introspection.SecureUberspector;
+import org.apache.velocity.util.introspection.UberspectImpl;
+import org.xwiki.velocity.VelocityEngine;
+
+import com.xpn.xwiki.test.AbstractXWikiComponentTestCase;
+
+/**
+ * Unit tests for {@link LinkingUberspector}.
+ */
+public class LinkingUberspectorTest extends AbstractXWikiComponentTestCase
+{
+    private VelocityEngine engine;
+
+    @Override
+    protected void setUp() throws Exception
+    {
+        super.setUp();
+        this.engine = (VelocityEngine) getComponentManager().lookup(VelocityEngine.ROLE);
+    }
+
+    /*
+     * Tests that the uberspectors in the list are called, and without a real uberspector no methods are found.
+     */
+    public void testEmptyArray() throws Exception
+    {
+        Properties prop = new Properties();
+        prop.setProperty(RuntimeConstants.UBERSPECT_CLASSNAME, LinkingUberspector.class.getCanonicalName());
+        prop.setProperty(LinkingUberspector.UBERSPECT_ARRAY_CLASSNAMES, TestingUberspector.class.getCanonicalName());
+        TestingUberspector.methodCalls = 0;
+        this.engine.initialize(prop);
+        StringWriter writer = new StringWriter();
+        this.engine.evaluate(new org.apache.velocity.VelocityContext(), writer, "mytemplate", new StringReader(
+            "#set($foo = 'hello')#set($bar = $foo.toString())$bar"));
+        assertEquals("$bar", writer.toString());
+        assertEquals(1, TestingUberspector.methodCalls);
+    }
+
+    /*
+     * Tests that using several uberspectors in the array works, methods are correctly found by a valid uberspector in
+     * the chain, and after a method is found no further calls are performed.
+     */
+    public void testBasicArray() throws Exception
+    {
+        Properties prop = new Properties();
+        prop.setProperty(RuntimeConstants.UBERSPECT_CLASSNAME, LinkingUberspector.class.getCanonicalName());
+        prop.setProperty(LinkingUberspector.UBERSPECT_ARRAY_CLASSNAMES, TestingUberspector.class.getCanonicalName()
+            + "," + TestingUberspector.class.getCanonicalName() + "," + UberspectImpl.class.getCanonicalName() + ","
+            + TestingUberspector.class.getCanonicalName());
+        TestingUberspector.methodCalls = 0;
+        TestingUberspector.getterCalls = 0;
+        this.engine.initialize(prop);
+        StringWriter writer = new StringWriter();
+        this.engine.evaluate(new org.apache.velocity.VelocityContext(), writer, "mytemplate", new StringReader(
+            "#set($foo = 'hello')#set($bar = $foo.toString())$bar"));
+        assertEquals("hello", writer.toString());
+        assertEquals(2, TestingUberspector.methodCalls);
+        assertEquals(0, TestingUberspector.getterCalls);
+    }
+
+    /*
+     * Tests that invalid uberspectors classnames are ignored.
+     */
+    public void testInvalidUberspectorsAreIgnored() throws Exception
+    {
+        Properties prop = new Properties();
+        prop.setProperty(RuntimeConstants.UBERSPECT_CLASSNAME, LinkingUberspector.class.getCanonicalName());
+        prop.setProperty(LinkingUberspector.UBERSPECT_ARRAY_CLASSNAMES, Date.class.getCanonicalName() + ","
+            + AbstractChainableUberspector.class.getCanonicalName() + "," + InvalidUberspector.class.getCanonicalName()
+            + "," + TestingUberspector.class.getCanonicalName() + "," + UberspectImpl.class.getCanonicalName());
+        TestingUberspector.methodCalls = 0;
+        InvalidUberspector.methodCalls = 0;
+        this.engine.initialize(prop);
+        StringWriter writer = new StringWriter();
+        this.engine.evaluate(new org.apache.velocity.VelocityContext(), writer, "mytemplate", new StringReader(
+            "#set($foo = 'hello')#set($bar = $foo.toString())$bar"));
+        assertEquals("hello", writer.toString());
+        assertEquals(1, TestingUberspector.methodCalls);
+        assertEquals(0, InvalidUberspector.methodCalls);
+    }
+
+    /*
+     * Checks that the default (non-secure) uberspector works and allows calling restricted methods.
+     */
+    public void testDefaultUberspectorWorks() throws Exception
+    {
+        Properties prop = new Properties();
+        prop.setProperty(RuntimeConstants.UBERSPECT_CLASSNAME, LinkingUberspector.class.getCanonicalName());
+        prop.setProperty(LinkingUberspector.UBERSPECT_ARRAY_CLASSNAMES, UberspectImpl.class.getCanonicalName());
+        this.engine.initialize(prop);
+        StringWriter writer = new StringWriter();
+        this.engine.evaluate(new org.apache.velocity.VelocityContext(), writer, "mytemplate", new StringReader(
+            "#set($foo = 'hello')" + "#set($bar = $foo.getClass().getConstructors())$bar"));
+        assertTrue(writer.toString().startsWith("[Ljava.lang.reflect.Constructor"));
+    }
+
+    /*
+     * Checks that the secure uberspector works and does not allow calling restricted methods.
+     */
+    public void testSecureUberspectorWorks() throws Exception
+    {
+        Properties prop = new Properties();
+        prop.setProperty(RuntimeConstants.UBERSPECT_CLASSNAME, LinkingUberspector.class.getCanonicalName());
+        prop.setProperty(LinkingUberspector.UBERSPECT_ARRAY_CLASSNAMES, SecureUberspector.class.getCanonicalName());
+        this.engine.initialize(prop);
+        StringWriter writer = new StringWriter();
+        this.engine.evaluate(new org.apache.velocity.VelocityContext(), writer, "mytemplate", new StringReader(
+            "#set($foo = 'hello')" + "#set($bar = $foo.getClass().getConstructors())$foo$bar"));
+        assertEquals("hello$bar", writer.toString());
+    }
+
+    /*
+     * Checks that when the array property is not configured, by default the secure ubespector is used.
+     */
+    public void testSecureUberspectorEnabledByDefault() throws Exception
+    {
+        Properties prop = new Properties();
+        prop.setProperty(RuntimeConstants.UBERSPECT_CLASSNAME, LinkingUberspector.class.getCanonicalName());
+        prop.setProperty(LinkingUberspector.UBERSPECT_ARRAY_CLASSNAMES, "");
+        this.engine.initialize(prop);
+        StringWriter writer = new StringWriter();
+        this.engine.evaluate(new org.apache.velocity.VelocityContext(), writer, "mytemplate", new StringReader(
+            "#set($foo = 'hello')" + "#set($bar = $foo.getClass().getConstructors())$foo$bar"));
+        assertEquals("hello$bar", writer.toString());
+    }
+}


Property changes on: xwiki-platform/core/trunk/xwiki-velocity/src/test/java/org/xwiki/velocity/introspection/LinkingUberspectorTest.java
___________________________________________________________________
Name: svn:keywords
   + Id
Name: svn:eol-style
   + native