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
9 package org.opendaylight.controller.netconf.util.xml;
11 import static org.hamcrest.CoreMatchers.both;
12 import static org.hamcrest.CoreMatchers.containsString;
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.assertThat;
17 import static org.junit.Assert.assertTrue;
18 import static org.junit.Assert.fail;
20 import com.google.common.base.Optional;
22 import org.junit.Before;
23 import org.junit.Test;
24 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
25 import org.opendaylight.controller.netconf.util.exception.MissingNameSpaceException;
26 import org.w3c.dom.Document;
27 import org.w3c.dom.Element;
29 public class XmlElementTest {
31 private final String elementAsString = "<top xmlns=\"namespace\" xmlns:a=\"attrNamespace\" a:attr1=\"value1\" attr2=\"value2\">" +
33 "<deepInner>deepValue</deepInner>" +
35 "<innerNamespace xmlns=\"innerNamespace\">innerNamespaceValue</innerNamespace>" +
36 "<innerPrefixed xmlns:b=\"prefixedValueNamespace\">b:valueWithPrefix</innerPrefixed>" +
38 private Document document;
39 private Element element;
40 private XmlElement xmlElement;
43 public void setUp() throws Exception {
44 document = XmlUtil.readXmlToDocument(elementAsString);
45 element = document.getDocumentElement();
46 xmlElement = XmlElement.fromDomElement(element);
50 public void testConstruct() throws Exception {
51 final XmlElement fromString = XmlElement.fromString(elementAsString);
52 assertEquals(fromString, xmlElement);
53 XmlElement.fromDomDocument(document);
54 XmlElement.fromDomElement(element);
55 XmlElement.fromDomElementWithExpected(element, "top");
56 XmlElement.fromDomElementWithExpected(element, "top", "namespace");
59 XmlElement.fromString("notXml");
61 } catch (final NetconfDocumentedException e) {}
64 XmlElement.fromDomElementWithExpected(element, "notTop");
66 } catch (final NetconfDocumentedException e) {}
69 XmlElement.fromDomElementWithExpected(element, "top", "notNamespace");
71 } catch (final NetconfDocumentedException e) {}
75 public void testGetters() throws Exception {
76 assertEquals(element, xmlElement.getDomElement());
77 assertEquals(element.getElementsByTagName("inner").getLength(), xmlElement.getElementsByTagName("inner").getLength());
79 assertEquals("top", xmlElement.getName());
80 assertTrue(xmlElement.hasNamespace());
81 assertEquals("namespace", xmlElement.getNamespace());
82 assertEquals("namespace", xmlElement.getNamespaceAttribute());
83 assertEquals(Optional.of("namespace"), xmlElement.getNamespaceOptionally());
85 assertEquals("value1", xmlElement.getAttribute("attr1", "attrNamespace"));
86 assertEquals("value2", xmlElement.getAttribute("attr2"));
87 assertEquals(2 + 2/*Namespace definition*/, xmlElement.getAttributes().size());
89 assertEquals(3, xmlElement.getChildElements().size());
90 assertEquals(1, xmlElement.getChildElements("inner").size());
91 assertTrue(xmlElement.getOnlyChildElementOptionally("inner").isPresent());
92 assertTrue(xmlElement.getOnlyChildElementWithSameNamespaceOptionally("inner").isPresent());
93 assertEquals(0, xmlElement.getChildElements("unknown").size());
94 assertFalse(xmlElement.getOnlyChildElementOptionally("unknown").isPresent());
95 assertEquals(1, xmlElement.getChildElementsWithSameNamespace("inner").size());
96 assertEquals(0, xmlElement.getChildElementsWithSameNamespace("innerNamespace").size());
97 assertEquals(1, xmlElement.getChildElementsWithinNamespace("innerNamespace", "innerNamespace").size());
98 assertTrue(xmlElement.getOnlyChildElementOptionally("innerNamespace", "innerNamespace").isPresent());
99 assertFalse(xmlElement.getOnlyChildElementOptionally("innerNamespace", "unknownNamespace").isPresent());
101 final XmlElement noNamespaceElement = XmlElement.fromString("<noNamespace/>");
102 assertFalse(noNamespaceElement.hasNamespace());
104 noNamespaceElement.getNamespace();
106 } catch (final MissingNameSpaceException e) {}
108 final XmlElement inner = xmlElement.getOnlyChildElement("inner");
109 final XmlElement deepInner = inner.getOnlyChildElementWithSameNamespaceOptionally().get();
110 assertEquals(deepInner, inner.getOnlyChildElementWithSameNamespace());
111 assertEquals(Optional.<XmlElement>absent(), xmlElement.getOnlyChildElementOptionally("unknown"));
112 assertEquals("deepValue", deepInner.getTextContent());
113 assertEquals("deepValue", deepInner.getOnlyTextContentOptionally().get());
114 assertEquals("deepValue", deepInner.getOnlyTextContentOptionally().get());
118 public void testExtractNamespaces() throws Exception {
119 final XmlElement innerPrefixed = xmlElement.getOnlyChildElement("innerPrefixed");
120 Map.Entry<String, String> namespaceOfTextContent = innerPrefixed.findNamespaceOfTextContent();
122 assertNotNull(namespaceOfTextContent);
123 assertEquals("b", namespaceOfTextContent.getKey());
124 assertEquals("prefixedValueNamespace", namespaceOfTextContent.getValue());
125 final XmlElement innerNamespace = xmlElement.getOnlyChildElement("innerNamespace");
126 namespaceOfTextContent = innerNamespace.findNamespaceOfTextContent();
128 assertEquals("", namespaceOfTextContent.getKey());
129 assertEquals("innerNamespace", namespaceOfTextContent.getValue());
133 public void testUnrecognisedElements() throws Exception {
134 xmlElement.checkUnrecognisedElements(xmlElement.getOnlyChildElement("inner"), xmlElement.getOnlyChildElement("innerPrefixed"), xmlElement.getOnlyChildElement("innerNamespace"));
137 xmlElement.checkUnrecognisedElements(xmlElement.getOnlyChildElement("inner"));
139 } catch (final NetconfDocumentedException e) {
140 assertThat(e.getMessage(), both(containsString("innerNamespace")).and(containsString("innerNamespace")));