| /* |
| * 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. |
| */ |
| package org.apache.commons.configuration2; |
| |
| import static org.junit.Assert.assertEquals; |
| import static org.junit.Assert.assertFalse; |
| import static org.junit.Assert.assertNotNull; |
| import static org.junit.Assert.assertNotSame; |
| import static org.junit.Assert.assertNull; |
| import static org.junit.Assert.assertTrue; |
| import static org.junit.Assert.fail; |
| |
| import javax.xml.parsers.DocumentBuilder; |
| import javax.xml.parsers.DocumentBuilderFactory; |
| import javax.xml.parsers.ParserConfigurationException; |
| import javax.xml.transform.Result; |
| import javax.xml.transform.Source; |
| import javax.xml.transform.Transformer; |
| import javax.xml.transform.TransformerConfigurationException; |
| import javax.xml.transform.TransformerException; |
| import javax.xml.transform.TransformerFactory; |
| import javax.xml.transform.dom.DOMSource; |
| import javax.xml.transform.stream.StreamResult; |
| import java.io.IOException; |
| import java.io.StringWriter; |
| import java.util.Collection; |
| import java.util.HashSet; |
| |
| import org.apache.commons.configuration2.ex.ConfigurationException; |
| import org.easymock.EasyMock; |
| import org.junit.Test; |
| import org.w3c.dom.Document; |
| import org.w3c.dom.Element; |
| import org.w3c.dom.Node; |
| import org.w3c.dom.NodeList; |
| import org.w3c.dom.Text; |
| import org.xml.sax.SAXException; |
| |
| /** |
| * Test class for {@code XMLDocumentHelper}. |
| * |
| * @version $Id$ |
| */ |
| public class TestXMLDocumentHelper |
| { |
| /** Constant for the name of an element. */ |
| private static final String ELEMENT = "testElementName"; |
| |
| /** Constant for the name of the test XML file. */ |
| private static final String TEST_FILE = "testcombine1.xml"; |
| |
| /** |
| * Loads a test XML document. |
| * |
| * @return the test document |
| */ |
| private static Document loadDocument() throws ParserConfigurationException, |
| IOException, SAXException |
| { |
| return loadDocument(TEST_FILE); |
| } |
| |
| /** |
| * Loads the test document with the given name. |
| * |
| * @param name the name of the test document |
| * @return the parsed document |
| */ |
| private static Document loadDocument(String name) throws IOException, |
| SAXException, ParserConfigurationException |
| { |
| DocumentBuilder builder = |
| DocumentBuilderFactory.newInstance().newDocumentBuilder(); |
| return builder.parse(ConfigurationAssert.getTestFile(name)); |
| } |
| |
| /** |
| * Serializes the document wrapped by the given helper to a string. |
| * |
| * @param helper the document helper |
| * @return the document serialized to a string |
| * @throws ConfigurationException if an error occurs |
| */ |
| private static String documentToString(XMLDocumentHelper helper) |
| throws ConfigurationException |
| { |
| return documentToString(helper.getDocument()); |
| } |
| |
| /** |
| * Serializes the specified document to a string. |
| * |
| * @param document the document |
| * @return the document serialized to a string |
| * @throws ConfigurationException if an error occurs |
| */ |
| private static String documentToString(Document document) |
| throws ConfigurationException |
| { |
| Transformer transformer = XMLDocumentHelper.createTransformer(); |
| StringWriter writer = new StringWriter(); |
| Result result = new StreamResult(writer); |
| XMLDocumentHelper.transform(transformer, |
| new DOMSource(document.getDocumentElement()), result); |
| return writer.toString(); |
| } |
| |
| /** |
| * Tests whether a correct transformer factory can be created. |
| */ |
| @Test |
| public void testCreateTransformerFactory() |
| { |
| assertNotNull("No factory", |
| XMLDocumentHelper.createTransformerFactory()); |
| } |
| |
| /** |
| * Tests whether exceptions while creating transformers are correctly |
| * handled. |
| */ |
| @Test |
| public void testCreateTransformerFactoryException() |
| throws TransformerConfigurationException, ConfigurationException |
| { |
| final TransformerFactory factory = |
| EasyMock.createMock(TransformerFactory.class); |
| TransformerConfigurationException cause = |
| new TransformerConfigurationException(); |
| EasyMock.expect(factory.newTransformer()).andThrow(cause); |
| EasyMock.replay(factory); |
| try |
| { |
| XMLDocumentHelper.createTransformer(factory); |
| fail("Exception not detected!"); |
| } |
| catch (ConfigurationException cex) |
| { |
| assertEquals("Wrong cause", cause, cex.getCause()); |
| } |
| } |
| |
| /** |
| * Tests whether transform() handles a TransformerException. |
| */ |
| @Test |
| public void testTransformException() throws TransformerException |
| { |
| Transformer transformer = EasyMock.createMock(Transformer.class); |
| Source src = EasyMock.createMock(Source.class); |
| Result res = EasyMock.createMock(Result.class); |
| TransformerException tex = new TransformerException("Test Exception"); |
| transformer.transform(src, res); |
| EasyMock.expectLastCall().andThrow(tex); |
| EasyMock.replay(transformer, src, res); |
| |
| try |
| { |
| XMLDocumentHelper.transform(transformer, src, res); |
| fail("Exception not detected!"); |
| } |
| catch (ConfigurationException cex) |
| { |
| assertEquals("Wrong cause", tex, cex.getCause()); |
| } |
| } |
| |
| /** |
| * Tests whether an exception thrown by a document builder factory is |
| * handled correctly. |
| */ |
| @Test |
| public void testCreateDocumentBuilderFromFactoryException() |
| throws ParserConfigurationException |
| { |
| DocumentBuilderFactory factory = |
| EasyMock.createMock(DocumentBuilderFactory.class); |
| ParserConfigurationException pcex = new ParserConfigurationException(); |
| EasyMock.expect(factory.newDocumentBuilder()).andThrow(pcex); |
| EasyMock.replay(factory); |
| |
| try |
| { |
| XMLDocumentHelper.createDocumentBuilder(factory); |
| fail("Exception not detected!"); |
| } |
| catch (ConfigurationException cex) |
| { |
| assertEquals("Wrong cause", pcex, cex.getCause()); |
| } |
| } |
| |
| /** |
| * Tests whether an instance can be created wrapping a new document. |
| */ |
| @Test |
| public void testInitForNewDocument() throws ConfigurationException |
| { |
| XMLDocumentHelper helper = XMLDocumentHelper.forNewDocument(ELEMENT); |
| Document doc = helper.getDocument(); |
| Element rootElement = doc.getDocumentElement(); |
| assertEquals("Wrong root element name", ELEMENT, |
| rootElement.getNodeName()); |
| NodeList childNodes = rootElement.getChildNodes(); |
| assertEquals("Got child nodes", 0, childNodes.getLength()); |
| assertNull("Got a public ID", helper.getSourcePublicID()); |
| assertNull("Got a system ID", helper.getSourceSystemID()); |
| } |
| |
| /** |
| * Tests the content of the element mapping for a newly created document. |
| */ |
| @Test |
| public void testElementMappingForNewDocument() |
| throws ConfigurationException |
| { |
| XMLDocumentHelper helper = XMLDocumentHelper.forNewDocument(ELEMENT); |
| assertTrue("Got an element mapping", helper.getElementMapping() |
| .isEmpty()); |
| } |
| |
| /** |
| * Tests whether an instance can be created based on a source document. |
| */ |
| @Test |
| public void testInitForSourceDocument() throws Exception |
| { |
| Document doc = loadDocument(); |
| XMLDocumentHelper helper = XMLDocumentHelper.forSourceDocument(doc); |
| assertNotSame("Same source document", doc, helper.getDocument()); |
| assertEquals("Wrong document content", documentToString(doc), |
| documentToString(helper)); |
| } |
| |
| /** |
| * Tests the content of the element mapping for a source document. |
| */ |
| @Test |
| public void testElementMappingForSourceDocument() throws Exception |
| { |
| Document doc = loadDocument(); |
| XMLDocumentHelper helper = XMLDocumentHelper.forSourceDocument(doc); |
| assertTrue("Got an element mapping", helper.getElementMapping() |
| .isEmpty()); |
| } |
| |
| /** |
| * Tests whether a document can be copied. |
| */ |
| @Test |
| public void testCopyDocument() throws Exception |
| { |
| XMLDocumentHelper helper = |
| XMLDocumentHelper.forSourceDocument(loadDocument()); |
| XMLDocumentHelper copy = helper.createCopy(); |
| assertNotSame("Same documents", helper.getDocument(), |
| copy.getDocument()); |
| String doc1 = documentToString(helper); |
| String doc2 = documentToString(copy); |
| assertEquals("Different document contents", doc1, doc2); |
| } |
| |
| /** |
| * Helper method for testing the element mapping of a copied document. |
| * |
| * @param file the name of the test file |
| */ |
| private void checkCopyElementMapping(String file) throws Exception |
| { |
| XMLDocumentHelper helper = |
| XMLDocumentHelper.forSourceDocument(loadDocument(file)); |
| XMLDocumentHelper copy = helper.createCopy(); |
| Collection<Node> texts = findTextElements(helper.getDocument()); |
| assertFalse("No texts", texts.isEmpty()); |
| for (Node n : texts) |
| { |
| Text txtSrc = (Text) n; |
| Text txtCopy = (Text) copy.getElementMapping().get(n); |
| assertNotNull("No matching element for " + n, txtCopy); |
| assertEquals("Wrong text", txtSrc.getData(), txtCopy.getData()); |
| } |
| } |
| |
| /** |
| * Obtains all text elements contained in the given document. |
| * |
| * @param document the document |
| * @return a collection with all text elements |
| */ |
| private static Collection<Node> findTextElements(Document document) |
| { |
| Collection<Node> texts = new HashSet<Node>(); |
| findTextElementsForNode(document.getDocumentElement(), texts); |
| return texts; |
| } |
| |
| /** |
| * Recursively obtains all text elements for the given node. |
| * |
| * @param node the node |
| * @param texts the collection with text elements |
| */ |
| private static void findTextElementsForNode(Node node, |
| Collection<Node> texts) |
| { |
| if (node instanceof Text) |
| { |
| texts.add(node); |
| } |
| NodeList childNodes = node.getChildNodes(); |
| for (int i = 0; i < childNodes.getLength(); i++) |
| { |
| findTextElementsForNode(childNodes.item(i), texts); |
| } |
| } |
| |
| /** |
| * Tests the element mapping of a copied document. |
| */ |
| @Test |
| public void testCopyElementMapping() throws Exception |
| { |
| checkCopyElementMapping(TEST_FILE); |
| } |
| |
| /** |
| * Tests whether the element is correctly constructed for a more complex |
| * document. |
| */ |
| @Test |
| public void testCopyElementMappingForComplexDocument() throws Exception |
| { |
| checkCopyElementMapping("test.xml"); |
| } |
| } |