protocol/netconf-api/src/test/java/org/opendaylight/netconf/api/xml/XmlElementTest.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.netconf.api.xml;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertFalse;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertThrows;
  14 import static org.junit.Assert.assertTrue;
  15
  16 import java.util.Map.Entry;
  17 import java.util.Optional;
  18 import org.junit.Before;
  19 import org.junit.Test;
  20 import org.opendaylight.netconf.api.DocumentedException;
  21 import org.w3c.dom.Document;
  22 import org.w3c.dom.Element;
  23
  24 public class XmlElementTest {
  25
  26     private final String elementAsString =
  27             "<top xmlns=\"namespace\" xmlns:a=\"attrNamespace\" a:attr1=\"value1\" attr2=\"value2\">"
  28             + "<inner>" + "<deepInner>deepValue</deepInner>" + "</inner>"
  29             + "<innerNamespace xmlns=\"innerNamespace\">innerNamespaceValue</innerNamespace>"
  30             + "<innerPrefixed xmlns:b=\"prefixedValueNamespace\">b:valueWithPrefix</innerPrefixed>" + "</top>";
  31     private Document document;
  32     private Element element;
  33     private XmlElement xmlElement;
  34
  35     @Before
  36     public void setUp() throws Exception {
  37         document = XmlUtil.readXmlToDocument(elementAsString);
  38         element = document.getDocumentElement();
  39         xmlElement = XmlElement.fromDomElement(element);
  40     }
  41
  42     @Test
  43     public void testConstruct() throws Exception {
  44         final XmlElement fromString = XmlElement.fromString(elementAsString);
  45         assertEquals(fromString, xmlElement);
  46         XmlElement.fromDomDocument(document);
  47         XmlElement.fromDomElement(element);
  48         XmlElement.fromDomElementWithExpected(element, "top");
  49         XmlElement.fromDomElementWithExpected(element, "top", "namespace");
  50
  51         assertThrows(DocumentedException.class, () -> XmlElement.fromString("notXml"));
  52         assertThrows(DocumentedException.class, () -> XmlElement.fromDomElementWithExpected(element, "notTop"));
  53         assertThrows(DocumentedException.class,
  54             () -> XmlElement.fromDomElementWithExpected(element, "top", "notNamespace"));
  55     }
  56
  57     @Test
  58     public void testGetters() throws Exception {
  59         assertEquals(element, xmlElement.getDomElement());
  60         assertEquals(element.getElementsByTagName("inner").getLength(),
  61                 xmlElement.getElementsByTagName("inner").getLength());
  62
  63         assertEquals("top", xmlElement.getName());
  64         assertTrue(xmlElement.hasNamespace());
  65         assertEquals("namespace", xmlElement.getNamespace());
  66         assertEquals("namespace", xmlElement.getNamespaceAttribute());
  67
  68         assertEquals("value1", xmlElement.getAttribute("attr1", "attrNamespace"));
  69         assertEquals("value2", xmlElement.getAttribute("attr2"));
  70         assertEquals(2 + 2/*Namespace definition*/, xmlElement.getAttributes().size());
  71
  72         assertEquals(3, xmlElement.getChildElements().size());
  73         assertEquals(1, xmlElement.getChildElements("inner").size());
  74         assertTrue(xmlElement.getOnlyChildElementOptionally("inner").isPresent());
  75         assertTrue(xmlElement.getOnlyChildElementWithSameNamespaceOptionally("inner").isPresent());
  76         assertEquals(0, xmlElement.getChildElements("unknown").size());
  77         assertFalse(xmlElement.getOnlyChildElementOptionally("unknown").isPresent());
  78         assertEquals(1, xmlElement.getChildElementsWithinNamespace("innerNamespace", "innerNamespace").size());
  79         assertTrue(xmlElement.getOnlyChildElementOptionally("innerNamespace", "innerNamespace").isPresent());
  80         assertFalse(xmlElement.getOnlyChildElementOptionally("innerNamespace", "unknownNamespace").isPresent());
  81
  82         final XmlElement noNamespaceElement = XmlElement.fromString("<noNamespace/>");
  83         assertFalse(noNamespaceElement.hasNamespace());
  84
  85         assertThrows(MissingNameSpaceException.class, () -> noNamespaceElement.getNamespace());
  86
  87         final XmlElement inner = xmlElement.getOnlyChildElement("inner");
  88         final XmlElement deepInner = inner.getOnlyChildElementWithSameNamespaceOptionally().orElseThrow();
  89         assertEquals(deepInner, inner.getOnlyChildElementWithSameNamespace());
  90         assertEquals(Optional.empty(), xmlElement.getOnlyChildElementOptionally("unknown"));
  91         assertEquals("deepValue", deepInner.getTextContent());
  92         assertEquals("deepValue", deepInner.getOnlyTextContentOptionally().orElseThrow());
  93         assertEquals("deepValue", deepInner.getOnlyTextContentOptionally().orElseThrow());
  94     }
  95
  96     @Test
  97     public void testExtractNamespaces() throws Exception {
  98         final XmlElement innerPrefixed = xmlElement.getOnlyChildElement("innerPrefixed");
  99         Entry<String, String> namespaceOfTextContent = innerPrefixed.findNamespaceOfTextContent();
 100
 101         assertNotNull(namespaceOfTextContent);
 102         assertEquals("b", namespaceOfTextContent.getKey());
 103         assertEquals("prefixedValueNamespace", namespaceOfTextContent.getValue());
 104         final XmlElement innerNamespace = xmlElement.getOnlyChildElement("innerNamespace");
 105         namespaceOfTextContent = innerNamespace.findNamespaceOfTextContent();
 106
 107         assertEquals("", namespaceOfTextContent.getKey());
 108         assertEquals("innerNamespace", namespaceOfTextContent.getValue());
 109     }
 110 }