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