2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.netconf.api.xml;
10 import static org.hamcrest.CoreMatchers.both;
11 import static org.hamcrest.CoreMatchers.containsString;
12 import static org.hamcrest.MatcherAssert.assertThat;
13 import static org.junit.Assert.assertEquals;
14 import static org.junit.Assert.assertFalse;
15 import static org.junit.Assert.assertNotNull;
16 import static org.junit.Assert.assertThrows;
17 import static org.junit.Assert.assertTrue;
19 import java.util.Map.Entry;
20 import java.util.Optional;
21 import org.junit.Before;
22 import org.junit.Test;
23 import org.opendaylight.netconf.api.DocumentedException;
24 import org.w3c.dom.Document;
25 import org.w3c.dom.Element;
27 public class XmlElementTest {
29 private final String elementAsString =
30 "<top xmlns=\"namespace\" xmlns:a=\"attrNamespace\" a:attr1=\"value1\" attr2=\"value2\">"
31 + "<inner>" + "<deepInner>deepValue</deepInner>" + "</inner>"
32 + "<innerNamespace xmlns=\"innerNamespace\">innerNamespaceValue</innerNamespace>"
33 + "<innerPrefixed xmlns:b=\"prefixedValueNamespace\">b:valueWithPrefix</innerPrefixed>" + "</top>";
34 private Document document;
35 private Element element;
36 private XmlElement xmlElement;
39 public void setUp() throws Exception {
40 document = XmlUtil.readXmlToDocument(elementAsString);
41 element = document.getDocumentElement();
42 xmlElement = XmlElement.fromDomElement(element);
46 public void testConstruct() throws Exception {
47 final XmlElement fromString = XmlElement.fromString(elementAsString);
48 assertEquals(fromString, xmlElement);
49 XmlElement.fromDomDocument(document);
50 XmlElement.fromDomElement(element);
51 XmlElement.fromDomElementWithExpected(element, "top");
52 XmlElement.fromDomElementWithExpected(element, "top", "namespace");
54 assertThrows(DocumentedException.class, () -> XmlElement.fromString("notXml"));
55 assertThrows(DocumentedException.class, () -> XmlElement.fromDomElementWithExpected(element, "notTop"));
56 assertThrows(DocumentedException.class,
57 () -> XmlElement.fromDomElementWithExpected(element, "top", "notNamespace"));
61 public void testGetters() throws Exception {
62 assertEquals(element, xmlElement.getDomElement());
63 assertEquals(element.getElementsByTagName("inner").getLength(),
64 xmlElement.getElementsByTagName("inner").getLength());
66 assertEquals("top", xmlElement.getName());
67 assertTrue(xmlElement.hasNamespace());
68 assertEquals("namespace", xmlElement.getNamespace());
69 assertEquals("namespace", xmlElement.getNamespaceAttribute());
70 assertEquals(Optional.of("namespace"), xmlElement.getNamespaceOptionally());
72 assertEquals("value1", xmlElement.getAttribute("attr1", "attrNamespace"));
73 assertEquals("value2", xmlElement.getAttribute("attr2"));
74 assertEquals(2 + 2/*Namespace definition*/, xmlElement.getAttributes().size());
76 assertEquals(3, xmlElement.getChildElements().size());
77 assertEquals(1, xmlElement.getChildElements("inner").size());
78 assertTrue(xmlElement.getOnlyChildElementOptionally("inner").isPresent());
79 assertTrue(xmlElement.getOnlyChildElementWithSameNamespaceOptionally("inner").isPresent());
80 assertEquals(0, xmlElement.getChildElements("unknown").size());
81 assertFalse(xmlElement.getOnlyChildElementOptionally("unknown").isPresent());
82 assertEquals(1, xmlElement.getChildElementsWithSameNamespace("inner").size());
83 assertEquals(0, xmlElement.getChildElementsWithSameNamespace("innerNamespace").size());
84 assertEquals(1, xmlElement.getChildElementsWithinNamespace("innerNamespace", "innerNamespace").size());
85 assertTrue(xmlElement.getOnlyChildElementOptionally("innerNamespace", "innerNamespace").isPresent());
86 assertFalse(xmlElement.getOnlyChildElementOptionally("innerNamespace", "unknownNamespace").isPresent());
88 final XmlElement noNamespaceElement = XmlElement.fromString("<noNamespace/>");
89 assertFalse(noNamespaceElement.hasNamespace());
91 assertThrows(MissingNameSpaceException.class, () -> noNamespaceElement.getNamespace());
93 final XmlElement inner = xmlElement.getOnlyChildElement("inner");
94 final XmlElement deepInner = inner.getOnlyChildElementWithSameNamespaceOptionally().orElseThrow();
95 assertEquals(deepInner, inner.getOnlyChildElementWithSameNamespace());
96 assertEquals(Optional.empty(), xmlElement.getOnlyChildElementOptionally("unknown"));
97 assertEquals("deepValue", deepInner.getTextContent());
98 assertEquals("deepValue", deepInner.getOnlyTextContentOptionally().orElseThrow());
99 assertEquals("deepValue", deepInner.getOnlyTextContentOptionally().orElseThrow());
103 public void testExtractNamespaces() throws Exception {
104 final XmlElement innerPrefixed = xmlElement.getOnlyChildElement("innerPrefixed");
105 Entry<String, String> namespaceOfTextContent = innerPrefixed.findNamespaceOfTextContent();
107 assertNotNull(namespaceOfTextContent);
108 assertEquals("b", namespaceOfTextContent.getKey());
109 assertEquals("prefixedValueNamespace", namespaceOfTextContent.getValue());
110 final XmlElement innerNamespace = xmlElement.getOnlyChildElement("innerNamespace");
111 namespaceOfTextContent = innerNamespace.findNamespaceOfTextContent();
113 assertEquals("", namespaceOfTextContent.getKey());
114 assertEquals("innerNamespace", namespaceOfTextContent.getValue());
118 public void testUnrecognisedElements() throws Exception {
119 xmlElement.checkUnrecognisedElements(xmlElement.getOnlyChildElement("inner"),
120 xmlElement.getOnlyChildElement("innerPrefixed"), xmlElement.getOnlyChildElement("innerNamespace"));
122 final DocumentedException e = assertThrows(DocumentedException.class,
123 () -> xmlElement.checkUnrecognisedElements(xmlElement.getOnlyChildElement("inner")));
124 assertThat(e.getMessage(),
125 // FIXME: this looks very suspect
126 both(containsString("innerNamespace")).and(containsString("innerNamespace")));