XmlNamespaceDictionaryTest.java

/*
 * Copyright (c) 2010 Google Inc.
 *
 * Licensed 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 com.google.api.client.xml;

import com.google.api.client.util.Key;
import com.google.api.client.xml.atom.Atom;
import com.google.common.collect.ImmutableMap;

import junit.framework.TestCase;
import org.xmlpull.v1.XmlSerializer;

import java.io.StringWriter;
import java.util.Collection;
import java.util.TreeSet;

/**
 * Tests {@link XmlNamespaceDictionary}.
 *
 * @author Yaniv Inbar
 */
public class XmlNamespaceDictionaryTest extends TestCase {

  public XmlNamespaceDictionaryTest() {
  }

  public XmlNamespaceDictionaryTest(String name) {
    super(name);
  }

  private static final String EXPECTED =
      "<?xml version=\"1.0\"?>" + "<feed xmlns=\"http://www.w3.org/2005/Atom\" "
          + "xmlns:gd=\"http://schemas.google.com/g/2005\">"
          + "<entry gd:etag=\"abc\"><title>One</title></entry>"
          + "<entry gd:etag=\"def\"><title>Two</title></entry></feed>";

  private static final String EXPECTED_EMPTY_MAP =
      "<?xml version=\"1.0\"?>" + "<entry xmlns=\"http://www.w3.org/2005/Atom\" />";

  private static final String EXPECTED_EMPTY_MAP_NS_UNDECLARED =
      "<?xml version=\"1.0\"?>" + "<n1:entry xmlns:n1=\"http://www.w3.org/2005/Atom\" />";

  private static final String EXPECTED_EMPTY_MAP_ATOM_NS =
    "<?xml version=\"1.0\"?>" + "<atom:entry xmlns:atom=\"http://www.w3.org/2005/Atom\" />";

  private static final String EXPECTED_UNKNOWN_NS =
      "<?xml version=\"1.0\"?>" + "<feed xmlns=\"http://unknown/\" "
          + "xmlns:gd=\"http://unknown/gd\">" + "<entry gd:etag=\"abc\"><title>One</title></entry>"
          + "<entry gd:etag=\"def\"><title>Two</title></entry></feed>";

  public void testSet() {
    XmlNamespaceDictionary dictionary = new XmlNamespaceDictionary();
    dictionary.set("", "http://www.w3.org/2005/Atom").set("gd", "http://schemas.google.com/g/2005");
    assertEquals("http://www.w3.org/2005/Atom", dictionary.getUriForAlias(""));
    assertEquals("", dictionary.getAliasForUri("http://www.w3.org/2005/Atom"));
    dictionary.set("", "http://www.w3.org/2006/Atom");
    assertEquals("http://www.w3.org/2006/Atom", dictionary.getUriForAlias(""));
    assertNull(dictionary.getAliasForUri("http://www.w3.org/2005/Atom"));
    assertEquals("", dictionary.getAliasForUri("http://www.w3.org/2006/Atom"));
    dictionary.set("foo", "http://www.w3.org/2006/Atom");
    assertEquals("http://www.w3.org/2006/Atom", dictionary.getUriForAlias("foo"));
    assertNull(dictionary.getUriForAlias(""));
    assertEquals("foo", dictionary.getAliasForUri("http://www.w3.org/2006/Atom"));
    dictionary.set("foo", "http://schemas.google.com/g/2005");
    assertEquals("http://schemas.google.com/g/2005", dictionary.getUriForAlias("foo"));
    assertNull(dictionary.getUriForAlias("gd"));
    assertNull(dictionary.getAliasForUri("http://www.w3.org/2006/Atom"));
    dictionary.set(null, null);
    assertEquals("http://schemas.google.com/g/2005", dictionary.getUriForAlias("foo"));
    dictionary.set("foo", null);
    assertTrue(dictionary.getAliasToUriMap().isEmpty());
    dictionary.set("foo", "http://schemas.google.com/g/2005").set(
        null, "http://schemas.google.com/g/2005");
    assertTrue(dictionary.getAliasToUriMap().isEmpty());
  }

  public void testSerialize() throws Exception {
    Feed feed = new Feed();
    feed.entries = new TreeSet<Entry>();
    feed.entries.add(new Entry("One", "abc"));
    feed.entries.add(new Entry("Two", "def"));
    StringWriter writer = new StringWriter();
    XmlSerializer serializer = Xml.createSerializer();
    serializer.setOutput(writer);
    XmlNamespaceDictionary namespaceDictionary = new XmlNamespaceDictionary();
    namespaceDictionary.set("", Atom.ATOM_NAMESPACE);
    namespaceDictionary.set("gd", "http://schemas.google.com/g/2005");
    namespaceDictionary.serialize(serializer, Atom.ATOM_NAMESPACE, "feed", feed);
    assertEquals(EXPECTED, writer.toString());
  }

  public void testSerializeByName() throws Exception {
    Feed feed = new Feed();
    feed.entries = new TreeSet<Entry>();
    feed.entries.add(new Entry("One", "abc"));
    feed.entries.add(new Entry("Two", "def"));
    StringWriter writer = new StringWriter();
    XmlSerializer serializer = Xml.createSerializer();
    serializer.setOutput(writer);
    XmlNamespaceDictionary namespaceDictionary = new XmlNamespaceDictionary();
    namespaceDictionary.set("", Atom.ATOM_NAMESPACE);
    namespaceDictionary.set("gd", "http://schemas.google.com/g/2005");
    namespaceDictionary.serialize(serializer, "feed", feed);
    assertEquals(EXPECTED, writer.toString());
  }

  public void testSerialize_emptyMap() throws Exception {
    ImmutableMap<String, String> map = ImmutableMap.of();
    StringWriter writer = new StringWriter();
    XmlSerializer serializer = Xml.createSerializer();
    serializer.setOutput(writer);
    XmlNamespaceDictionary namespaceDictionary = new XmlNamespaceDictionary();
    namespaceDictionary.set("", Atom.ATOM_NAMESPACE);
    namespaceDictionary.serialize(serializer, Atom.ATOM_NAMESPACE, "entry", map);
    assertEquals(EXPECTED_EMPTY_MAP, writer.toString());
  }

  public void testSerializeByName_emptyMap() throws Exception {
    ImmutableMap<String, String> map = ImmutableMap.of();
    StringWriter writer = new StringWriter();
    XmlSerializer serializer = Xml.createSerializer();
    serializer.setOutput(writer);
    XmlNamespaceDictionary namespaceDictionary = new XmlNamespaceDictionary();
    namespaceDictionary.set("", Atom.ATOM_NAMESPACE);
    namespaceDictionary.serialize(serializer, "entry", map);
    assertEquals(EXPECTED_EMPTY_MAP, writer.toString());
  }

  public void testSerializeByName_emptyMapAtomNs() throws Exception {
    ImmutableMap<String, String> map = ImmutableMap.of();
    StringWriter writer = new StringWriter();
    XmlSerializer serializer = Xml.createSerializer();
    serializer.setOutput(writer);
    XmlNamespaceDictionary namespaceDictionary = new XmlNamespaceDictionary();
    namespaceDictionary.set("atom", Atom.ATOM_NAMESPACE);
    namespaceDictionary.serialize(serializer, "atom:entry", map);
    assertEquals(EXPECTED_EMPTY_MAP_ATOM_NS, writer.toString());
  }

  public void testSerialize_emptyMapNsUndeclared() throws Exception {
    ImmutableMap<String, String> map = ImmutableMap.of();
    StringWriter writer = new StringWriter();
    XmlSerializer serializer = Xml.createSerializer();
    serializer.setOutput(writer);
    XmlNamespaceDictionary namespaceDictionary = new XmlNamespaceDictionary();
    namespaceDictionary.serialize(serializer, Atom.ATOM_NAMESPACE, "entry", map);
    assertEquals(EXPECTED_EMPTY_MAP_NS_UNDECLARED, writer.toString());
  }

  public static class Entry implements Comparable<Entry> {
    @Key
    public String title;

    @Key("@gd:etag")
    public String etag;

    public Entry(String title, String etag) {
      super();
      this.title = title;
      this.etag = etag;
    }

    public int compareTo(Entry other) {
      return title.compareTo(other.title);
    }
  }

  public static class Feed {
    @Key("entry")
    public Collection<Entry> entries;

  }

  public void testSerialize_errorOnUnknown() throws Exception {
    Entry entry = new Entry("One", "abc");
    StringWriter writer = new StringWriter();
    XmlSerializer serializer = Xml.createSerializer();
    serializer.setOutput(writer);
    XmlNamespaceDictionary namespaceDictionary = new XmlNamespaceDictionary();
    try {
      namespaceDictionary.serialize(serializer, Atom.ATOM_NAMESPACE, "entry", entry);
      fail("expected IllegalArgumentException");
    } catch (IllegalArgumentException e) {
      // expected
      assertEquals("unrecognized alias: (default)", e.getMessage());
    }
  }

  public void testSerializeByName_errorOnUnknown() throws Exception {
    Entry entry = new Entry("One", "abc");
    StringWriter writer = new StringWriter();
    XmlSerializer serializer = Xml.createSerializer();
    serializer.setOutput(writer);
    XmlNamespaceDictionary namespaceDictionary = new XmlNamespaceDictionary();
    try {
      namespaceDictionary.serialize(serializer, "entry", entry);
      fail("expected IllegalArgumentException");
    } catch (IllegalArgumentException e) {
      // expected
      assertEquals("unrecognized alias: (default)", e.getMessage());
    }
  }

  public void testSerialize_unknown() throws Exception {
    Feed feed = new Feed();
    feed.entries = new TreeSet<Entry>();
    feed.entries.add(new Entry("One", "abc"));
    feed.entries.add(new Entry("Two", "def"));
    StringWriter writer = new StringWriter();
    XmlSerializer serializer = Xml.createSerializer();
    serializer.setOutput(writer);
    XmlNamespaceDictionary namespaceDictionary = new XmlNamespaceDictionary();
    assertEquals(EXPECTED_UNKNOWN_NS, namespaceDictionary.toStringOf("feed", feed));
  }

}