XMLElementTestCase.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 *
 */
package org.apache.vysper.xml.fragment;

import java.util.Collections;
import java.util.List;
import java.util.Map;

import junit.framework.TestCase;

import org.junit.Assert;

/**
 */
public class XMLElementTestCase extends TestCase {

    public void testBasicGetters() {
        XMLElement xmlElement = new XMLElementBuilder("message", "urn:test").addAttribute("lang", "de").addAttribute(
                Namespaces.XML, "lang", "cn").addAttribute("xmllang", "en").build();

        assertEquals("message", xmlElement.getName());
        assertEquals("urn:test", xmlElement.getNamespaceURI());
        assertEquals("cn", xmlElement.getXMLLang());

        assertSame(Collections.emptyList(), xmlElement.getInnerElements());
        List<Attribute> list = xmlElement.getAttributes();
        assertNotNull(list);

        assertEquals(3, list.size());
    }

    public void testInnerTextGetters() {

        XMLElement xmlElement = new XMLElementBuilder("message", "jabber:test").addText("t1").startInnerElement("i1")
                .endInnerElement().addText("t2").addText("t3").startInnerElement("i2").endInnerElement().addText("t4")
                .build();

        List<XMLText> list = xmlElement.getInnerTexts();
        assertEquals(4, list.size());
        assertEquals("t1", list.get(0).getText());
        assertEquals("t2", list.get(1).getText());
        assertEquals("t3", list.get(2).getText());
        assertEquals("t4", list.get(3).getText());

        assertEquals("t1", xmlElement.getFirstInnerText().getText());
        try {
            xmlElement.getSingleInnerText();
            fail("must raise exception");
        } catch (XMLSemanticError xmlSemanticError) {
            // test succeeded
        }

        xmlElement = new XMLElementBuilder("message", "jabber:test").startInnerElement("i1").endInnerElement().build();
        try {
            assertNull(xmlElement.getSingleInnerText());
        } catch (XMLSemanticError xmlSemanticError) {
            fail("must not raise error");
        }
    }

    public void testInnerElementGetters() {

        XMLElement xmlElement = new XMLElementBuilder("message", "jabber:test").addText("t1").startInnerElement("i1")
                .endInnerElement().startInnerElement("i2").addAttribute("order", "1").endInnerElement()
                .startInnerElement("i2").addAttribute("order", "2").endInnerElement().addText("t2").addText("t3")
                .startInnerElement("i3").endInnerElement().addText("t4").build();

        List<XMLElement> list = xmlElement.getInnerElements();
        assertEquals(4, list.size());

        assertEquals("i1", xmlElement.getFirstInnerElement().getName());
        try {
            xmlElement.getSingleInnerElementsNamed("i2");
            fail("must raise exception");
        } catch (XMLSemanticError xmlSemanticError) {
            // test succeeded
        }

        try {
            XMLElement xmlElement1 = xmlElement.getSingleInnerElementsNamed("i3");
            assertEquals("i3", xmlElement1.getName());
        } catch (XMLSemanticError xmlSemanticError) {
            fail("must not raise exception");
        }

        xmlElement = new XMLElementBuilder("message", "jabber:test").addText("t1").build();
        try {
            assertNull(xmlElement.getSingleInnerElementsNamed("none"));
        } catch (XMLSemanticError xmlSemanticError) {
            fail("must not raise error");
        }

        xmlElement = new XMLElementBuilder("message", "jabber:test").startInnerElement("i").addAttribute("order", "1")
                .endInnerElement().startInnerElement("another").endInnerElement().build();
        try {
            XMLElement singleXmlElement = xmlElement.getSingleInnerElementsNamed("i");
            assertEquals("i", singleXmlElement.getName());
        } catch (XMLSemanticError xmlSemanticError) {
            fail("must not raise error");
        }

        xmlElement = new XMLElementBuilder("message", "jabber:test").startInnerElement("i").addAttribute("order", "1")
                .endInnerElement().startInnerElement("i").addAttribute("order", "2").endInnerElement().build();
        try {
            xmlElement.getSingleInnerElementsNamed("i");
            fail("must raise error, more than one i-element");
        } catch (XMLSemanticError xmlSemanticError) {
            // test succeeded
        }
    }

    public void testInnerElementsNamed() {

        XMLElement xmlElement = new XMLElementBuilder("message", "jabber:test").addText("t1").startInnerElement("body")
                .endInnerElement().startInnerElement("body").addAttribute("order", "1").endInnerElement()
                .startInnerElement("body").addAttribute("order", "2").endInnerElement().addText("body").addText("t3")
                .startInnerElement("single").endInnerElement().addText("t4").build();

        List<XMLElement> list = xmlElement.getInnerElementsNamed("no-exist");
        assertEquals(0, list.size());

        list = xmlElement.getInnerElementsNamed("single");
        assertEquals(1, list.size());

        try {
            XMLElement xmlElementInner = xmlElement.getSingleInnerElementsNamed("single");
            assertNotNull(xmlElementInner);
        } catch (XMLSemanticError xmlSemanticError) {
            fail("single element not found");
        }

        List<XMLElement> named = xmlElement.getInnerElementsNamed("body");
        assertEquals(3, named.size());

        try {
            xmlElement.getSingleInnerElementsNamed("body");
            fail("no single element");
        } catch (XMLSemanticError xmlSemanticError) {
            // success
        }
    }

    public void testPrefixWithColon() {
        try {
            new XMLElementBuilder("message", "http://example.com", "pre:fix");
            fail("Must throw IllegalArgumentException");
        } catch (IllegalArgumentException e) {
            // ok
        }
    }
    
    public void testLanguageMapping() {

        XMLElement xmlElement = new XMLElementBuilder("message", "jabber:test").addText("t1").startInnerElement("body")
                .endInnerElement().startInnerElement("body").addAttribute(Namespaces.XML, "lang", "en")
                .endInnerElement().startInnerElement("body").addAttribute(Namespaces.XML, "lang", "de")
                .endInnerElement().addText("body").addText("t3").startInnerElement("single").addAttribute(
                        Namespaces.XML, "lang", "ru").endInnerElement().startInnerElement("body_inconsistent")
                .addAttribute(Namespaces.XML, "lang", "ru").endInnerElement().startInnerElement("body_inconsistent")
                .addAttribute(Namespaces.XML, "lang", "ru").endInnerElement().startInnerElement("body_lang_null")
                .addAttribute("order", "1").endInnerElement().startInnerElement("body_lang_null").addAttribute("order",
                        "2").endInnerElement().addText("t4").build();

        try {
            Map<String, XMLElement> map = xmlElement.getInnerElementsByXMLLangNamed("body");
            assertEquals(3, map.size());
            XMLElement element = map.get("en");
            assertEquals("en", element.getXMLLang());
            element = map.get("de");
            assertEquals("de", element.getXMLLang());
            element = map.get(null);
            assertEquals(null, element.getXMLLang());

        } catch (XMLSemanticError xmlSemanticError) {
            fail("no error expected");
        }

        try {
            Map<String, XMLElement> map = xmlElement.getInnerElementsByXMLLangNamed("body_lang_null");
            fail("semantic error expected, same language occurs 2 times");
        } catch (XMLSemanticError xmlSemanticError) {
            // success
        }
        try {
            Map<String, XMLElement> map = xmlElement.getInnerElementsByXMLLangNamed("body_lang_null");
            fail("semantic error expected, language does not occur 2 times");
        } catch (XMLSemanticError xmlSemanticError) {
            // success
        }
    }

    public void testGetAttribute() {
        XMLElement xmlElement = new XMLElementBuilder("test").addAttribute("foo", "bar").addAttribute(Namespaces.XML,
                "lang", "cn").build();

        assertEquals("bar", xmlElement.getAttribute("foo").getValue());
        assertNull(xmlElement.getAttribute("http://example.com", "foo"));
        assertNull(xmlElement.getAttribute("lang"));
        assertEquals("cn", xmlElement.getAttribute(Namespaces.XML, "lang").getValue());

        assertEquals("bar", xmlElement.getAttributeValue("foo"));
        assertNull(xmlElement.getAttributeValue("http://example.com", "foo"));
        assertNull(xmlElement.getAttributeValue("lang"));
        assertEquals("cn", xmlElement.getAttributeValue(Namespaces.XML, "lang"));
    }

    public void testAddAttributeMultiple() {
        XMLElement xmlElement = new XMLElementBuilder("test")
            .addAttribute("foo", "bar")
            .addAttribute("foo", "fez")
            .build();

        assertEquals(1, xmlElement.getAttributes().size());
        assertEquals("fez", xmlElement.getAttribute("foo").getValue());
    }

    public void testAddAttributeMultipleDifferentNamespaces() {
        XMLElement xmlElement = new XMLElementBuilder("test")
        .addAttribute("foo", "bar")
        .addAttribute("http://example.com", "foo", "fez")
        .build();
        
        assertEquals(2, xmlElement.getAttributes().size());
        assertEquals("bar", xmlElement.getAttribute("foo").getValue());
        assertEquals("fez", xmlElement.getAttribute("http://example.com", "foo").getValue());
    }

    
    public void testEqualsAttributeOrder() {
        XMLElement elm1 = new XMLElementBuilder("test")
            .addAttribute("attr1", "foo")
            .addAttribute("attr2", "foo")
            .build();

        XMLElement elm2 = new XMLElementBuilder("test")
        .addAttribute("attr2", "foo")
        .addAttribute("attr1", "foo")
        .build();
        
        Assert.assertTrue("Equals must be true", elm1.equals(elm2));
    }

    public void testEqualsAttributeValue() {
        XMLElement elm1 = new XMLElementBuilder("test")
            .addAttribute("attr1", "foo")
            .addAttribute("attr2", "bar")
            .build();

        XMLElement elm2 = new XMLElementBuilder("test")
            .addAttribute("attr1", "foo")
            .addAttribute("attr2", "foo")
            .build();
        
        Assert.assertFalse("Equals must be false", elm1.equals(elm2));
    }

    public void testEqualsAttributeMissing() {
        XMLElement elm1 = new XMLElementBuilder("test")
            .addAttribute("attr1", "foo")
            .addAttribute("attr2", "bar")
            .build();

        XMLElement elm2 = new XMLElementBuilder("test")
            .addAttribute("attr1", "foo")
            .build();
        
        Assert.assertFalse("Equals must be false", elm1.equals(elm2));
    }

    public void testEqualsNoAttributes() {
        XMLElement elm1 = new XMLElementBuilder("test")
            .addAttribute("attr1", "foo")
            .addAttribute("attr2", "bar")
            .build();

        XMLElement elm2 = new XMLElementBuilder("test")
            .build();
        
        Assert.assertFalse("Equals must be false", elm1.equals(elm2));
    }

}