opendaylight/netconf/netconf-util/src/test/java/org/opendaylight/controller/netconf/util/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.controller.netconf.util.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.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;
  28
  29 public class XmlElementTest {
  30
  31     private final String elementAsString = "<top xmlns=\"namespace\" xmlns:a=\"attrNamespace\" a:attr1=\"value1\" attr2=\"value2\">" +
  32             "<inner>" +
  33             "<deepInner>deepValue</deepInner>" +
  34             "</inner>" +
  35             "<innerNamespace xmlns=\"innerNamespace\">innerNamespaceValue</innerNamespace>" +
  36             "<innerPrefixed xmlns:b=\"prefixedValueNamespace\">b:valueWithPrefix</innerPrefixed>" +
  37             "</top>";
  38     private Document document;
  39     private Element element;
  40     private XmlElement xmlElement;
  41
  42     @Before
  43     public void setUp() throws Exception {
  44         document = XmlUtil.readXmlToDocument(elementAsString);
  45         element = document.getDocumentElement();
  46         xmlElement = XmlElement.fromDomElement(element);
  47     }
  48
  49     @Test
  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");
  57
  58         try {
  59             XmlElement.fromString("notXml");
  60             fail();
  61         } catch (final NetconfDocumentedException e) {}
  62
  63         try {
  64             XmlElement.fromDomElementWithExpected(element, "notTop");
  65             fail();
  66         } catch (final NetconfDocumentedException e) {}
  67
  68         try {
  69             XmlElement.fromDomElementWithExpected(element, "top", "notNamespace");
  70             fail();
  71         } catch (final NetconfDocumentedException e) {}
  72     }
  73
  74     @Test
  75     public void testGetters() throws Exception {
  76         assertEquals(element, xmlElement.getDomElement());
  77         assertEquals(element.getElementsByTagName("inner").getLength(), xmlElement.getElementsByTagName("inner").getLength());
  78
  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());
  84
  85         assertEquals("value1", xmlElement.getAttribute("attr1", "attrNamespace"));
  86         assertEquals("value2", xmlElement.getAttribute("attr2"));
  87         assertEquals(2 + 2/*Namespace definition*/, xmlElement.getAttributes().size());
  88
  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());
 100
 101         final XmlElement noNamespaceElement = XmlElement.fromString("<noNamespace/>");
 102         assertFalse(noNamespaceElement.hasNamespace());
 103         try {
 104             noNamespaceElement.getNamespace();
 105             fail();
 106         } catch (final MissingNameSpaceException e) {}
 107
 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());
 115     }
 116
 117     @Test
 118     public void testExtractNamespaces() throws Exception {
 119         final XmlElement innerPrefixed = xmlElement.getOnlyChildElement("innerPrefixed");
 120         Map.Entry<String, String> namespaceOfTextContent = innerPrefixed.findNamespaceOfTextContent();
 121
 122         assertNotNull(namespaceOfTextContent);
 123         assertEquals("b", namespaceOfTextContent.getKey());
 124         assertEquals("prefixedValueNamespace", namespaceOfTextContent.getValue());
 125         final XmlElement innerNamespace = xmlElement.getOnlyChildElement("innerNamespace");
 126         namespaceOfTextContent = innerNamespace.findNamespaceOfTextContent();
 127
 128         assertEquals("", namespaceOfTextContent.getKey());
 129         assertEquals("innerNamespace", namespaceOfTextContent.getValue());
 130     }
 131
 132     @Test
 133     public void testUnrecognisedElements() throws Exception {
 134         xmlElement.checkUnrecognisedElements(xmlElement.getOnlyChildElement("inner"), xmlElement.getOnlyChildElement("innerPrefixed"), xmlElement.getOnlyChildElement("innerNamespace"));
 135
 136         try {
 137             xmlElement.checkUnrecognisedElements(xmlElement.getOnlyChildElement("inner"));
 138             fail();
 139         } catch (final NetconfDocumentedException e) {
 140             assertThat(e.getMessage(), both(containsString("innerNamespace")).and(containsString("innerNamespace")));
 141         }
 142     }
 143 }