You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by oh...@apache.org on 2006/01/15 19:27:21 UTC
svn commit: r369247 [2/2] - in /jakarta/commons/proper/configuration/trunk:
./ src/java/org/apache/commons/configuration/tree/xpath/
src/test/org/apache/commons/configuration/tree/xpath/
Added: jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/TestXPathExpressionEngine.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/TestXPathExpressionEngine.java?rev=369247&view=auto
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/TestXPathExpressionEngine.java (added)
+++ jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/TestXPathExpressionEngine.java Sun Jan 15 10:26:46 2006
@@ -0,0 +1,524 @@
+/*
+ * Copyright 2006 The Apache Software Foundation.
+ *
+ * Licensed 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.
+ */
+package org.apache.commons.configuration.tree.xpath;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+import org.apache.commons.configuration.tree.ConfigurationNode;
+import org.apache.commons.configuration.tree.DefaultConfigurationNode;
+import org.apache.commons.configuration.tree.NodeAddData;
+import org.apache.commons.jxpath.JXPathContext;
+import org.apache.commons.jxpath.JXPathContextFactory;
+import org.apache.commons.jxpath.JXPathContextFactoryConfigurationError;
+import org.apache.commons.jxpath.ri.JXPathContextReferenceImpl;
+import org.apache.commons.jxpath.ri.model.NodePointerFactory;
+
+import junit.framework.TestCase;
+
+/**
+ * Test class for XPathExpressionEngine.
+ *
+ * @author Oliver Heger
+ * @version $Id$
+ */
+public class TestXPathExpressionEngine extends TestCase
+{
+ /** Constant for the test root node. */
+ static final ConfigurationNode ROOT = new DefaultConfigurationNode(
+ "testRoot");
+
+ /** Constant for the valid test key. */
+ static final String TEST_KEY = "TESTKEY";
+
+ /** The expression engine to be tested. */
+ XPathExpressionEngine engine;
+
+ protected void setUp() throws Exception
+ {
+ super.setUp();
+ initMockContextFactory();
+ engine = new XPathExpressionEngine();
+ }
+
+ protected void tearDown() throws Exception
+ {
+ MockJXPathContextFactory.context = null; // reset context
+ super.tearDown();
+ }
+
+ /**
+ * Tests the query() method with a normal expression.
+ */
+ public void testQueryExpression()
+ {
+ List nodes = engine.query(ROOT, TEST_KEY);
+ assertEquals("Incorrect number of results", 1, nodes.size());
+ assertSame("Wrong result node", ROOT, nodes.get(0));
+ checkSelectCalls(1);
+ }
+
+ /**
+ * Tests a query that has no results. This should return an empty list.
+ */
+ public void testQueryWithoutResult()
+ {
+ List nodes = engine.query(ROOT, "a non existing key");
+ assertTrue("Result list is not empty", nodes.isEmpty());
+ checkSelectCalls(1);
+ }
+
+ /**
+ * Tests a query with an empty key. This should directly return the root
+ * node without invoking the JXPathContext.
+ */
+ public void testQueryWithEmptyKey()
+ {
+ checkEmptyKey("");
+ }
+
+ /**
+ * Tests a query with a null key. Same as an empty key.
+ */
+ public void testQueryWithNullKey()
+ {
+ checkEmptyKey(null);
+ }
+
+ /**
+ * Helper method for testing undefined keys.
+ *
+ * @param key the key
+ */
+ private void checkEmptyKey(String key)
+ {
+ List nodes = engine.query(ROOT, key);
+ assertEquals("Incorrect number of results", 1, nodes.size());
+ assertSame("Wrong result node", ROOT, nodes.get(0));
+ checkSelectCalls(0);
+ }
+
+ /**
+ * Tests if the used JXPathContext is correctly initialized.
+ */
+ public void testCreateContext()
+ {
+ JXPathContext ctx = engine.createContext(ROOT, TEST_KEY);
+ assertNotNull("Context is null", ctx);
+ assertTrue("Lenient mode is not set", ctx.isLenient());
+ assertSame("Incorrect context bean set", ROOT, ctx.getContextBean());
+
+ NodePointerFactory[] factories = JXPathContextReferenceImpl
+ .getNodePointerFactories();
+ boolean found = false;
+ for (int i = 0; i < factories.length; i++)
+ {
+ if (factories[i] instanceof ConfigurationNodePointerFactory)
+ {
+ found = true;
+ }
+ }
+ assertTrue("No configuration pointer factory found", found);
+ }
+
+ /**
+ * Tests a normal call of nodeKey().
+ */
+ public void testNodeKeyNormal()
+ {
+ assertEquals("Wrong node key", "parent/child", engine.nodeKey(
+ new DefaultConfigurationNode("child"), "parent"));
+ }
+
+ /**
+ * Tests nodeKey() for an attribute node.
+ */
+ public void testNodeKeyAttribute()
+ {
+ ConfigurationNode node = new DefaultConfigurationNode("attr");
+ node.setAttribute(true);
+ assertEquals("Wrong attribute key", "node@attr", engine.nodeKey(node,
+ "node"));
+ }
+
+ /**
+ * Tests nodeKey() for the root node.
+ */
+ public void testNodeKeyForRootNode()
+ {
+ assertEquals("Wrong key for root node", "", engine.nodeKey(ROOT, null));
+ assertEquals("Null name not detected", "test", engine.nodeKey(
+ new DefaultConfigurationNode(), "test"));
+ }
+
+ /**
+ * Tests node key() for direct children of the root node.
+ */
+ public void testNodeKeyForRootChild()
+ {
+ ConfigurationNode node = new DefaultConfigurationNode("child");
+ assertEquals("Wrong key for root child node", "child", engine.nodeKey(
+ node, ""));
+ node.setAttribute(true);
+ assertEquals("Wrong key for root attribute", "@child", engine.nodeKey(
+ node, ""));
+ }
+
+ /**
+ * Tests adding a single child node.
+ */
+ public void testPrepareAddNode()
+ {
+ NodeAddData data = engine.prepareAdd(ROOT, TEST_KEY + " newNode");
+ checkAddPath(data, new String[]
+ { "newNode" }, false);
+ checkSelectCalls(1);
+ }
+
+ /**
+ * Tests adding a new attribute node.
+ */
+ public void testPrepareAddAttribute()
+ {
+ NodeAddData data = engine.prepareAdd(ROOT, TEST_KEY + "\t@newAttr");
+ checkAddPath(data, new String[]
+ { "newAttr" }, true);
+ checkSelectCalls(1);
+ }
+
+ /**
+ * Tests adding a complete path.
+ */
+ public void testPrepareAddPath()
+ {
+ NodeAddData data = engine.prepareAdd(ROOT, TEST_KEY
+ + " \t a/full/path/node");
+ checkAddPath(data, new String[]
+ { "a", "full", "path", "node" }, false);
+ checkSelectCalls(1);
+ }
+
+ /**
+ * Tests adding a complete path whose final node is an attribute.
+ */
+ public void testPrepareAddAttributePath()
+ {
+ NodeAddData data = engine.prepareAdd(ROOT, TEST_KEY
+ + " a/full/path@attr");
+ checkAddPath(data, new String[]
+ { "a", "full", "path", "attr" }, true);
+ checkSelectCalls(1);
+ }
+
+ /**
+ * Tests adding a new node to the root.
+ */
+ public void testPrepareAddRootChild()
+ {
+ NodeAddData data = engine.prepareAdd(ROOT, " newNode");
+ checkAddPath(data, new String[]
+ { "newNode" }, false);
+ checkSelectCalls(0);
+ }
+
+ /**
+ * Tests adding a new attribute to the root.
+ */
+ public void testPrepareAddRootAttribute()
+ {
+ NodeAddData data = engine.prepareAdd(ROOT, " @attr");
+ checkAddPath(data, new String[]
+ { "attr" }, true);
+ checkSelectCalls(0);
+ }
+
+ /**
+ * Tests an add operation with a query that does not return a single node.
+ */
+ public void testPrepareAddInvalidParent()
+ {
+ try
+ {
+ engine.prepareAdd(ROOT, "invalidKey newNode");
+ fail("Could add to invalid parent!");
+ }
+ catch (IllegalArgumentException iex)
+ {
+ // ok
+ }
+ }
+
+ /**
+ * Tests an add operation where the passed in key has an invalid format: it
+ * does not contain a whitspace. This will cause an error.
+ */
+ public void testPrepareAddInvalidFormat()
+ {
+ try
+ {
+ engine.prepareAdd(ROOT, "anInvalidKey");
+ fail("Could add an invalid key!");
+ }
+ catch (IllegalArgumentException iex)
+ {
+ // ok
+ }
+ }
+
+ /**
+ * Tests an add operation with an empty path for the new node.
+ */
+ public void testPrepareAddEmptyPath()
+ {
+ try
+ {
+ engine.prepareAdd(ROOT, TEST_KEY + " ");
+ fail("Could add empty path!");
+ }
+ catch (IllegalArgumentException iex)
+ {
+ // ok
+ }
+ }
+
+ /**
+ * Tests an add operation where the key is null.
+ */
+ public void testPrepareAddNullKey()
+ {
+ try
+ {
+ engine.prepareAdd(ROOT, null);
+ fail("Could add null path!");
+ }
+ catch (IllegalArgumentException iex)
+ {
+ // ok
+ }
+ }
+
+ /**
+ * Tests an add operation where the key is null.
+ */
+ public void testPrepareAddEmptyKey()
+ {
+ try
+ {
+ engine.prepareAdd(ROOT, "");
+ fail("Could add empty path!");
+ }
+ catch (IllegalArgumentException iex)
+ {
+ // ok
+ }
+ }
+
+ /**
+ * Tests an add operation with an invalid path.
+ */
+ public void testPrepareAddInvalidPath()
+ {
+ try
+ {
+ engine.prepareAdd(ROOT, TEST_KEY + " an/invalid//path");
+ fail("Could add invalid path!");
+ }
+ catch (IllegalArgumentException iex)
+ {
+ // ok
+ }
+ }
+
+ /**
+ * Tests an add operation with an invalid path: the path contains an
+ * attribute in the middle part.
+ */
+ public void testPrepareAddInvalidAttributePath()
+ {
+ try
+ {
+ engine.prepareAdd(ROOT, TEST_KEY + " a/path/with@an/attribute");
+ fail("Could add invalid attribute path!");
+ }
+ catch (IllegalArgumentException iex)
+ {
+ // ok
+ }
+ }
+
+ /**
+ * Tests an add operation with an invalid path: the path contains an
+ * attribute after a slash.
+ */
+ public void testPrepareAddInvalidAttributePath2()
+ {
+ try
+ {
+ engine.prepareAdd(ROOT, TEST_KEY + " a/path/with/@attribute");
+ fail("Could add invalid attribute path!");
+ }
+ catch (IllegalArgumentException iex)
+ {
+ // ok
+ }
+ }
+
+ /**
+ * Tests an add operation with an invalid path that starts with a slash.
+ */
+ public void testPrepareAddInvalidPathWithSlash()
+ {
+ try
+ {
+ engine.prepareAdd(ROOT, TEST_KEY + " /a/path/node");
+ fail("Could add path starting with a slash!");
+ }
+ catch (IllegalArgumentException iex)
+ {
+ // ok
+ }
+ }
+
+ /**
+ * Tests an add operation with an invalid path that contains multiple
+ * attribute components.
+ */
+ public void testPrepareAddInvalidPathMultipleAttributes()
+ {
+ try
+ {
+ engine.prepareAdd(ROOT, TEST_KEY + " an@attribute@path");
+ fail("Could add path with multiple attributes!");
+ }
+ catch (IllegalArgumentException iex)
+ {
+ // ok
+ }
+ }
+
+ /**
+ * Helper method for testing the path nodes in the given add data object.
+ *
+ * @param data the data object to check
+ * @param expected an array with the expected path elements
+ * @param attr a flag if the new node is an attribute
+ */
+ private void checkAddPath(NodeAddData data, String[] expected, boolean attr)
+ {
+ assertSame("Wrong parent node", ROOT, data.getParent());
+ List path = data.getPathNodes();
+ assertEquals("Incorrect number of path nodes", expected.length - 1,
+ path.size());
+ Iterator it = path.iterator();
+ for (int idx = 0; idx < expected.length - 1; idx++)
+ {
+ assertEquals("Wrong node at position " + idx, expected[idx], it
+ .next());
+ }
+ assertEquals("Wrong name of new node", expected[expected.length - 1],
+ data.getNewNodeName());
+ assertEquals("Incorrect attribute flag", attr, data.isAttribute());
+ }
+
+ /**
+ * Initializes the mock JXPath context factory. Sets a system property, so
+ * that this implementation will be used.
+ */
+ protected void initMockContextFactory()
+ {
+ System.setProperty(JXPathContextFactory.FACTORY_NAME_PROPERTY,
+ MockJXPathContextFactory.class.getName());
+ }
+
+ /**
+ * Checks if the JXPath context's selectNodes() method was called as often
+ * as expected.
+ *
+ * @param expected the number of expected calls
+ */
+ protected void checkSelectCalls(int expected)
+ {
+ MockJXPathContext ctx = MockJXPathContextFactory.getContext();
+ int calls = (ctx == null) ? 0 : ctx.selectInvocations;
+ assertEquals("Incorrect number of select calls", expected, calls);
+ }
+
+ /**
+ * A mock implementation of the JXPathContext class. This implementation
+ * will overwrite the <code>selectNodes()</code> method that is used by
+ * <code>XPathExpressionEngine</code> to count the invocations of this
+ * method.
+ */
+ static class MockJXPathContext extends JXPathContextReferenceImpl
+ {
+ int selectInvocations;
+
+ public MockJXPathContext(Object bean)
+ {
+ super(null, bean);
+ }
+
+ /**
+ * Dummy implementation of this method. If the passed in string is the
+ * test key, the root node will be returned in the list. Otherwise the
+ * return value is <b>null</b>.
+ */
+ public List selectNodes(String xpath)
+ {
+ selectInvocations++;
+ if (TEST_KEY.equals(xpath))
+ {
+ List result = new ArrayList(1);
+ result.add(ROOT);
+ return result;
+ }
+ else
+ {
+ return null;
+ }
+ }
+ }
+
+ /**
+ * A mock implementation of the JXPathContextFactory class. This class is
+ * used to inject the mock context, so that we can trace the invocations of
+ * selectNodes().
+ */
+ public static class MockJXPathContextFactory extends JXPathContextFactory
+ {
+ /** Stores the context instance. */
+ static MockJXPathContext context;
+
+ public JXPathContext newContext(JXPathContext parentContext,
+ Object contextBean)
+ throws JXPathContextFactoryConfigurationError
+ {
+ context = new MockJXPathContext(contextBean);
+ return context;
+ }
+
+ /**
+ * Returns the context created by the last newContext() call.
+ *
+ * @return the current context
+ */
+ public static MockJXPathContext getContext()
+ {
+ return context;
+ }
+ }
+}
Propchange: jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/TestXPathExpressionEngine.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/TestXPathExpressionEngine.java
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/TestXPathExpressionEngine.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/XPathTest.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/XPathTest.java?rev=369247&view=auto
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/XPathTest.java (added)
+++ jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/XPathTest.java Sun Jan 15 10:26:46 2006
@@ -0,0 +1,144 @@
+/*
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed 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.
+ */
+package org.apache.commons.configuration.tree.xpath;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.commons.configuration.tree.ConfigurationNode;
+import org.apache.commons.configuration.tree.DefaultConfigurationNode;
+import org.apache.commons.jxpath.ri.model.NodeIterator;
+
+import junit.framework.TestCase;
+
+/**
+ * A base class for testing classes of the XPath package. This base class
+ * creates a hierarchy of nodes in its setUp() method that can be used for test
+ * cases.
+ *
+ * @author Oliver Heger
+ * @version $Id$
+ */
+public class XPathTest extends TestCase
+{
+ /** Constant for the name of the counter attribute. */
+ protected static final String ATTR_NAME = "counter";
+
+ /** Constant for the name of the first child. */
+ protected static final String CHILD_NAME1 = "subNode";
+
+ /** Constant for the name of the second child. */
+ protected static final String CHILD_NAME2 = "childNode";
+
+ /** Constant for the number of sub nodes. */
+ protected static final int CHILD_COUNT = 5;
+
+ /** Constant for the number of levels in the hierarchy. */
+ protected static final int LEVEL_COUNT = 4;
+
+ /** Stores the root node of the hierarchy. */
+ protected ConfigurationNode root;
+
+ protected void setUp() throws Exception
+ {
+ super.setUp();
+ root = constructHierarchy(LEVEL_COUNT);
+ }
+
+ /**
+ * Builds up a hierarchy of nodes. Each node has <code>CHILD_COUNT</code>
+ * child nodes having the names <code>CHILD_NAME1</code> or
+ * <code>CHILD_NAME2</code>. Their values are named like their parent
+ * node with an additional index. Each node has an attribute with a counter
+ * value.
+ *
+ * @param levels the number of levels in the hierarchy
+ * @return the root node of the hierarchy
+ */
+ protected ConfigurationNode constructHierarchy(int levels)
+ {
+ ConfigurationNode result = new DefaultConfigurationNode();
+ createLevel(result, levels);
+ return result;
+ }
+
+ /**
+ * Determines the number of elements contained in the given iterator.
+ *
+ * @param iterator the iterator
+ * @return the number of elements in this iteration
+ */
+ protected int iteratorSize(NodeIterator iterator)
+ {
+ int cnt = 0;
+ boolean ok;
+
+ do
+ {
+ ok = iterator.setPosition(cnt + 1);
+ if (ok)
+ {
+ cnt++;
+ }
+ } while (ok);
+
+ return cnt;
+ }
+
+ /**
+ * Returns a list with all configuration nodes contained in the specified
+ * iteration. It is assumed that the iteration contains only elements of
+ * this type.
+ *
+ * @param iterator the iterator
+ * @return a list with configuration nodes obtained from the iterator
+ */
+ protected List iterationElements(NodeIterator iterator)
+ {
+ List result = new ArrayList();
+ for (int pos = 1; iterator.setPosition(pos); pos++)
+ {
+ result.add(iterator.getNodePointer().getNode());
+ }
+ return result;
+ }
+
+ /**
+ * Recursive helper method for creating a level of the node hierarchy.
+ *
+ * @param parent the parent node
+ * @param level the level counter
+ */
+ private void createLevel(ConfigurationNode parent, int level)
+ {
+ if (level >= 0)
+ {
+ String prefix = (parent.getValue() == null) ? "" : parent
+ .getValue()
+ + ".";
+ for (int i = 1; i <= CHILD_COUNT; i++)
+ {
+ ConfigurationNode child = new DefaultConfigurationNode(
+ (i % 2 == 0) ? CHILD_NAME1 : CHILD_NAME2, prefix + i);
+ parent.addChild(child);
+ child.addAttribute(new DefaultConfigurationNode(ATTR_NAME,
+ String.valueOf(i)));
+
+ createLevel(child, level - 1);
+ }
+ }
+ }
+}
Propchange: jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/XPathTest.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/XPathTest.java
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/tree/xpath/XPathTest.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org