netconf/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
   9 package org.opendaylight.netconf.api.xml;
  10
  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;
  19
  20 import com.google.common.base.Optional;
  21 import java.util.Map;
  22 import org.junit.Before;
  23 import org.junit.Test;
  24 import org.opendaylight.netconf.api.DocumentedException;
  25 import org.w3c.dom.Document;
  26 import org.w3c.dom.Element;
  27
  28 public class XmlElementTest {
  29
  30     private final String elementAsString =
  31             "<top xmlns=\"namespace\" xmlns:a=\"attrNamespace\" a:attr1=\"value1\" attr2=\"value2\">"
  32             + "<inner>" + "<deepInner>deepValue</deepInner>" + "</inner>"
  33             + "<innerNamespace xmlns=\"innerNamespace\">innerNamespaceValue</innerNamespace>"
  34             + "<innerPrefixed xmlns:b=\"prefixedValueNamespace\">b:valueWithPrefix</innerPrefixed>" + "</top>";
  35     private Document document;
  36     private Element element;
  37     private XmlElement xmlElement;
  38
  39     @Before
  40     public void setUp() throws Exception {
  41         document = XmlUtil.readXmlToDocument(elementAsString);
  42         element = document.getDocumentElement();
  43         xmlElement = XmlElement.fromDomElement(element);
  44     }
  45
  46     @Test
  47     public void testConstruct() throws Exception {
  48         final XmlElement fromString = XmlElement.fromString(elementAsString);
  49         assertEquals(fromString, xmlElement);
  50         XmlElement.fromDomDocument(document);
  51         XmlElement.fromDomElement(element);
  52         XmlElement.fromDomElementWithExpected(element, "top");
  53         XmlElement.fromDomElementWithExpected(element, "top", "namespace");
  54
  55         try {
  56             XmlElement.fromString("notXml");
  57             fail();
  58         } catch (final DocumentedException e) {
  59             // expected
  60         }
  61
  62         try {
  63             XmlElement.fromDomElementWithExpected(element, "notTop");
  64             fail();
  65         } catch (final DocumentedException e) {
  66             // expected
  67         }
  68
  69         try {
  70             XmlElement.fromDomElementWithExpected(element, "top", "notNamespace");
  71             fail();
  72         } catch (final DocumentedException e) {
  73             // expected
  74         }
  75     }
  76
  77     @Test
  78     public void testGetters() throws Exception {
  79         assertEquals(element, xmlElement.getDomElement());
  80         assertEquals(element.getElementsByTagName("inner").getLength(),
  81                 xmlElement.getElementsByTagName("inner").getLength());
  82
  83         assertEquals("top", xmlElement.getName());
  84         assertTrue(xmlElement.hasNamespace());
  85         assertEquals("namespace", xmlElement.getNamespace());
  86         assertEquals("namespace", xmlElement.getNamespaceAttribute());
  87         assertEquals(Optional.of("namespace"), xmlElement.getNamespaceOptionally());
  88
  89         assertEquals("value1", xmlElement.getAttribute("attr1", "attrNamespace"));
  90         assertEquals("value2", xmlElement.getAttribute("attr2"));
  91         assertEquals(2 + 2/*Namespace definition*/, xmlElement.getAttributes().size());
  92
  93         assertEquals(3, xmlElement.getChildElements().size());
  94         assertEquals(1, xmlElement.getChildElements("inner").size());
  95         assertTrue(xmlElement.getOnlyChildElementOptionally("inner").isPresent());
  96         assertTrue(xmlElement.getOnlyChildElementWithSameNamespaceOptionally("inner").isPresent());
  97         assertEquals(0, xmlElement.getChildElements("unknown").size());
  98         assertFalse(xmlElement.getOnlyChildElementOptionally("unknown").isPresent());
  99         assertEquals(1, xmlElement.getChildElementsWithSameNamespace("inner").size());
 100         assertEquals(0, xmlElement.getChildElementsWithSameNamespace("innerNamespace").size());
 101         assertEquals(1, xmlElement.getChildElementsWithinNamespace("innerNamespace", "innerNamespace").size());
 102         assertTrue(xmlElement.getOnlyChildElementOptionally("innerNamespace", "innerNamespace").isPresent());
 103         assertFalse(xmlElement.getOnlyChildElementOptionally("innerNamespace", "unknownNamespace").isPresent());
 104
 105         final XmlElement noNamespaceElement = XmlElement.fromString("<noNamespace/>");
 106         assertFalse(noNamespaceElement.hasNamespace());
 107         try {
 108             noNamespaceElement.getNamespace();
 109             fail();
 110         } catch (final MissingNameSpaceException e) {
 111             // expected
 112         }
 113
 114         final XmlElement inner = xmlElement.getOnlyChildElement("inner");
 115         final XmlElement deepInner = inner.getOnlyChildElementWithSameNamespaceOptionally().get();
 116         assertEquals(deepInner, inner.getOnlyChildElementWithSameNamespace());
 117         assertEquals(Optional.<XmlElement>absent(), xmlElement.getOnlyChildElementOptionally("unknown"));
 118         assertEquals("deepValue", deepInner.getTextContent());
 119         assertEquals("deepValue", deepInner.getOnlyTextContentOptionally().get());
 120         assertEquals("deepValue", deepInner.getOnlyTextContentOptionally().get());
 121     }
 122
 123     @Test
 124     public void testExtractNamespaces() throws Exception {
 125         final XmlElement innerPrefixed = xmlElement.getOnlyChildElement("innerPrefixed");
 126         Map.Entry<String, String> namespaceOfTextContent = innerPrefixed.findNamespaceOfTextContent();
 127
 128         assertNotNull(namespaceOfTextContent);
 129         assertEquals("b", namespaceOfTextContent.getKey());
 130         assertEquals("prefixedValueNamespace", namespaceOfTextContent.getValue());
 131         final XmlElement innerNamespace = xmlElement.getOnlyChildElement("innerNamespace");
 132         namespaceOfTextContent = innerNamespace.findNamespaceOfTextContent();
 133
 134         assertEquals("", namespaceOfTextContent.getKey());
 135         assertEquals("innerNamespace", namespaceOfTextContent.getValue());
 136     }
 137
 138     @Test
 139     public void testUnrecognisedElements() throws Exception {
 140         xmlElement.checkUnrecognisedElements(xmlElement.getOnlyChildElement("inner"),
 141                 xmlElement.getOnlyChildElement("innerPrefixed"), xmlElement.getOnlyChildElement("innerNamespace"));
 142
 143         try {
 144             xmlElement.checkUnrecognisedElements(xmlElement.getOnlyChildElement("inner"));
 145             fail();
 146         } catch (final DocumentedException e) {
 147             assertThat(e.getMessage(), both(containsString("innerNamespace")).and(containsString("innerNamespace")));
 148         }
 149     }
 150 }