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.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;
  18
  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;
  26
  27 public class XmlElementTest {
  28
  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;
  37
  38     @Before
  39     public void setUp() throws Exception {
  40         document = XmlUtil.readXmlToDocument(elementAsString);
  41         element = document.getDocumentElement();
  42         xmlElement = XmlElement.fromDomElement(element);
  43     }
  44
  45     @Test
  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");
  53
  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"));
  58     }
  59
  60     @Test
  61     public void testGetters() throws Exception {
  62         assertEquals(element, xmlElement.getDomElement());
  63         assertEquals(element.getElementsByTagName("inner").getLength(),
  64                 xmlElement.getElementsByTagName("inner").getLength());
  65
  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.findNamespace());
  71
  72         assertEquals("value1", xmlElement.getAttribute("attr1", "attrNamespace"));
  73         assertEquals("value2", xmlElement.getAttribute("attr2"));
  74         assertEquals(2 + 2/*Namespace definition*/, xmlElement.getAttributes().size());
  75
  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.getChildElementsWithinNamespace("innerNamespace", "innerNamespace").size());
  83         assertTrue(xmlElement.getOnlyChildElementOptionally("innerNamespace", "innerNamespace").isPresent());
  84         assertFalse(xmlElement.getOnlyChildElementOptionally("innerNamespace", "unknownNamespace").isPresent());
  85
  86         final XmlElement noNamespaceElement = XmlElement.fromString("<noNamespace/>");
  87         assertFalse(noNamespaceElement.hasNamespace());
  88
  89         assertThrows(MissingNameSpaceException.class, () -> noNamespaceElement.getNamespace());
  90
  91         final XmlElement inner = xmlElement.getOnlyChildElement("inner");
  92         final XmlElement deepInner = inner.getOnlyChildElementWithSameNamespaceOptionally().orElseThrow();
  93         assertEquals(deepInner, inner.getOnlyChildElementWithSameNamespace());
  94         assertEquals(Optional.empty(), xmlElement.getOnlyChildElementOptionally("unknown"));
  95         assertEquals("deepValue", deepInner.getTextContent());
  96         assertEquals("deepValue", deepInner.getOnlyTextContentOptionally().orElseThrow());
  97         assertEquals("deepValue", deepInner.getOnlyTextContentOptionally().orElseThrow());
  98     }
  99
 100     @Test
 101     public void testExtractNamespaces() throws Exception {
 102         final XmlElement innerPrefixed = xmlElement.getOnlyChildElement("innerPrefixed");
 103         Entry<String, String> namespaceOfTextContent = innerPrefixed.findNamespaceOfTextContent();
 104
 105         assertNotNull(namespaceOfTextContent);
 106         assertEquals("b", namespaceOfTextContent.getKey());
 107         assertEquals("prefixedValueNamespace", namespaceOfTextContent.getValue());
 108         final XmlElement innerNamespace = xmlElement.getOnlyChildElement("innerNamespace");
 109         namespaceOfTextContent = innerNamespace.findNamespaceOfTextContent();
 110
 111         assertEquals("", namespaceOfTextContent.getKey());
 112         assertEquals("innerNamespace", namespaceOfTextContent.getValue());
 113     }
 114
 115     @Test
 116     public void testUnrecognisedElements() throws Exception {
 117         xmlElement.checkUnrecognisedElements(xmlElement.getOnlyChildElement("inner"),
 118                 xmlElement.getOnlyChildElement("innerPrefixed"), xmlElement.getOnlyChildElement("innerNamespace"));
 119
 120         final DocumentedException e = assertThrows(DocumentedException.class,
 121             () -> xmlElement.checkUnrecognisedElements(xmlElement.getOnlyChildElement("inner")));
 122         assertThat(e.getMessage(),
 123             // FIXME: this looks very suspect
 124             both(containsString("innerNamespace")).and(containsString("innerNamespace")));
 125     }
 126 }