NavigationMarshallerTest.java

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.exoplatform.portal.mop.management.binding.xml;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
import java.util.Date;
import java.util.Locale;
import java.util.TimeZone;

import junit.framework.TestCase;

import org.exoplatform.portal.config.model.I18NString;
import org.exoplatform.portal.config.model.LocalizedString;
import org.exoplatform.portal.config.model.NavigationFragment;
import org.exoplatform.portal.config.model.PageNavigation;
import org.exoplatform.portal.config.model.PageNode;
import org.exoplatform.portal.config.model.Properties;
import org.exoplatform.portal.mop.Visibility;

/**
 * @author <a href="mailto:nscavell@redhat.com">Nick Scavelli</a>
 * @version $Revision$
 */
public class NavigationMarshallerTest extends TestCase {

    private static final Properties EMPTY_PROPS = new Properties();

    private static Properties createNonEmptyProperties() {
        Properties props = new Properties();
        props.put("externalURI", "http://example.com");
        props.put("openInNewWindow", "true");
        props.put("intKey", 256);
        props.put("dblKey", 3.14);
        return props;
    }

    public void testNavigationUnmarshalling() {
        NavigationMarshaller marshaller = new NavigationMarshaller();
        PageNavigation data = marshaller.unmarshal(getClass().getResourceAsStream(
                "/org/exoplatform/portal/mop/management/navigation.xml"));
        assertNotNull(data);
        assertEquals(111, data.getPriority());
        assertNotNull(data.getFragment());
        assertEquals(7, data.getFragment().getNodes().size());
        PageNode node = data.getFragment().getNodes().get(0);


        verifyNode(node, "home", "#{portal.classic.home}", "home", Visibility.DISPLAYED, "portal::classic::homepage", null,
                null, null, createNonEmptyProperties(), 1);
        node = node.getNodes().get(0);
        Date start = createDate(2011, 1, 10, 12, 13, 55);
        Date end = createDate(2011, 1, 17, 17, 14, 0);
        verifyNode(node, "home-1", "Home 1", "home/home-1", Visibility.TEMPORAL, null, start, end, "StarAward", EMPTY_PROPS, 1);
        node = node.getNodes().get(0);
        verifyNode(node, "empty", "Empty", "home/home-1/empty", Visibility.HIDDEN, "portal::classic::empty-page", null, null,
                null, EMPTY_PROPS, 0);

        node = data.getFragment().getNodes().get(5);
        verifyNode(node, "notfound", "NotFound", "notfound", Visibility.SYSTEM, null, null, null, null, EMPTY_PROPS, 0);

        node = data.getFragment().getNodes().get(6);
        verifyNode(node, "n0", "n0", "n0", Visibility.DISPLAYED, "portal::classic::n0", null, null, null, EMPTY_PROPS, 1);
        node = node.getNodes().get(0);
        verifyNode(node, "n0", "n0", "n0/n0", Visibility.DISPLAYED, "portal::classic::n0_n0", null, null, null, EMPTY_PROPS, 10);
        for (int i = 0; i < 10; i++) {
            String name = "n" + i;
            String uri = "n0/n0/n" + i;
            String pageref = uri.replace("/", "_");

            PageNode child = node.getNodes().get(i);
            verifyNode(child, name, name, uri, Visibility.DISPLAYED, "portal::classic::" + pageref, null, null, null, EMPTY_PROPS, 0);
        }
    }

    public void testEmptyNavigationUnmarshalling() {
        NavigationMarshaller marshaller = new NavigationMarshaller();
        PageNavigation data = marshaller.unmarshal(getClass().getResourceAsStream(
                "/org/exoplatform/portal/mop/management/navigation-empty.xml"));
        assertNotNull(data);
        assertEquals(PageNavigation.UNDEFINED_PRIORITY, data.getPriority());
        assertNotNull(data.getFragment().getNodes());
        assertTrue(data.getFragment().getNodes().isEmpty());
    }

    public void testFragmentedNavigationUnmarshalling() {
        NavigationMarshaller marshaller = new NavigationMarshaller();
        PageNavigation data = marshaller.unmarshal(getClass().getResourceAsStream(
                "/org/exoplatform/portal/mop/management/navigation-fragment.xml"));
        assertNotNull(data);
        assertNotNull(data.getFragments());
        assertEquals(2, data.getFragments().size());

        NavigationFragment fragment = data.getFragments().get(0);
        assertNotNull(fragment);
        assertEquals("home", fragment.getParentURI());
        assertNotNull(fragment.getNodes());
        assertEquals(1, fragment.getNodes().size());
        PageNode node = fragment.getNode("home-1");
        assertNotNull(node);
        assertNotNull(node.getNodes());
        assertEquals(2, node.getNodes().size());
        assertNotNull(node.getNode("home-1-1"));
        assertNotNull(node.getNode("home-1-2"));

        fragment = data.getFragments().get(1);
        assertNotNull(fragment);
        assertEquals("foo-bar", fragment.getParentURI());
        assertNotNull(fragment.getNodes());
        assertEquals(2, fragment.getNodes().size());
        assertNotNull(fragment.getNode("foo"));
        assertNotNull(fragment.getNode("bar"));
    }

    public void testLocaleNavigationUnmarshalling() {
        NavigationMarshaller marshaller = new NavigationMarshaller();
        PageNavigation data = marshaller.unmarshal(getClass().getResourceAsStream(
                "/org/exoplatform/portal/mop/management/navigation-extended.xml"));
        assertNotNull(data);
        assertNotNull(data.getFragment().getNodes());

        PageNode node = data.getFragment().getNode("hello-node");
        assertNotNull(node);
        assertNotNull(node.getLabels());
        assertEquals(8, node.getLabels().size());

        Locale locale = Locale.getDefault();

        String cn = "Dobrý den";
        String fr = "Bonjour";
        String en = "Hello";
        String es = "Hola";
        String ja = "こんにちは";
        String it = "Ciào";
        String zh = "你好";
        String zh_tw = "Li-ho";

        assertEquals(cn, node.getLabels().getExtended(locale).get(new Locale("cn")));
        assertEquals(fr, node.getLabels().getExtended(locale).get(new Locale("fr")));
        assertEquals(en, node.getLabels().getExtended(locale).get(new Locale("en")));
        assertEquals(es, node.getLabels().getExtended(locale).get(new Locale("es")));
        assertEquals(ja, node.getLabels().getExtended(locale).get(new Locale("ja")));
        assertEquals(it, node.getLabels().getExtended(locale).get(new Locale("it")));
        assertEquals(zh, node.getLabels().getExtended(locale).get(new Locale("zh")));
        assertEquals(zh_tw, node.getLabels().getExtended(locale).get(Locale.TAIWAN));

        node = data.getFragment().getNode("hello-node2");
        assertNotNull(node);
        assertNotNull(node.getLabels());
        assertEquals(8, node.getLabels().size());

        assertEquals(cn, node.getLabels().getExtended(locale).get(new Locale("cn")));
        assertEquals(fr, node.getLabels().getExtended(locale).get(new Locale("fr")));
        assertEquals(en, node.getLabels().getExtended(locale).get(new Locale("en")));
        assertEquals(es, node.getLabels().getExtended(locale).get(new Locale("es")));
        assertEquals(ja, node.getLabels().getExtended(locale).get(new Locale("ja")));
        assertEquals(it, node.getLabels().getExtended(locale).get(new Locale("it")));
        assertEquals(zh, node.getLabels().getExtended(locale).get(new Locale("zh")));
        assertEquals(zh_tw, node.getLabels().getExtended(locale).get(Locale.TAIWAN));
    }

    public void testNavigationMarshalling() {
        Calendar startCal = Calendar.getInstance();
        startCal.set(Calendar.MILLISECOND, 0);
        Date start = startCal.getTime();
        Calendar endCal = Calendar.getInstance();
        endCal.set(Calendar.MILLISECOND, 0);
        Date end = endCal.getTime();
        Properties props = createNonEmptyProperties();

        PageNode expectedChild1 = newPageNode("node-1", "Icon-1", "Node 1", null, null, Visibility.DISPLAYED, null,
                props,
                new ArrayList<PageNode>());

        I18NString labels = new I18NString(new LocalizedString("Node 2", Locale.ENGLISH), new LocalizedString("Node 2",
                Locale.FRENCH), new LocalizedString("Node 2", Locale.TAIWAN));

        PageNode expectedChild2 = newPageNode("node-2", "Icon-2", labels, createDate(2011, 7, 22, 10, 10, 10),
                createDate(2011, 7, 30, 12, 0, 0), Visibility.SYSTEM, "some:page:ref", EMPTY_PROPS, new ArrayList<PageNode>());

        ArrayList<PageNode> children = new ArrayList<PageNode>(2);
        children.add(expectedChild1);
        children.add(expectedChild2);

        PageNode expectedNode = newPageNode("node", "Icon", "Node", start, end, Visibility.HIDDEN, "page-ref", EMPTY_PROPS, children);

        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        NavigationMarshaller marshaller = new NavigationMarshaller();
        PageNavigation expected = newPageNavigation("", "", 123,
                new ArrayList<PageNode>(Collections.singletonList(expectedNode)));
        marshaller.marshal(expected, baos, false);

        PageNavigation actual = marshaller.unmarshal(new ByteArrayInputStream(baos.toByteArray()));

        assertNotNull(actual);
        assertNull(actual.getOwnerType());
        assertNull(actual.getOwnerId());
        assertEquals(expected.getPriority(), actual.getPriority());
        assertNotNull(expected.getFragment().getNodes());
        assertEquals(expected.getFragment().getNodes().size(), actual.getFragment().getNodes().size());

        PageNode actualNode = actual.getFragment().getNodes().get(0);
        compareNode(expectedNode, actualNode);

        assertNotNull(actualNode.getNodes());
        assertEquals(expectedNode.getNodes().size(), actualNode.getNodes().size());
        compareNode(expectedChild1, actualNode.getNodes().get(0));
        compareNode(expectedChild2, actualNode.getNodes().get(1));
    }

    private PageNavigation newPageNavigation(String ownerType, String ownerId, int priority, ArrayList<PageNode> children) {
        PageNavigation pageNavigation = new PageNavigation();
        pageNavigation.setOwnerType(ownerType);
        pageNavigation.setOwnerId(ownerId);
        pageNavigation.setPriority(priority);
        NavigationFragment fragment = new NavigationFragment();
        fragment.setNodes(children);
        pageNavigation.addFragment(fragment);

        return pageNavigation;
    }

    private void verifyNode(PageNode node, String name, String label, String uri, Visibility visibility, String pageRef,
            Date start, Date end, String icon, Properties properties, int children) {
        assertNotNull(node);
        assertEquals(name, node.getName());
        assertEquals(label, node.getLabel());
        assertEquals(visibility, node.getVisibility());
        assertEquals(pageRef, node.getPageReference());
        assertEquals(start, node.getStartPublicationDate());
        assertEquals(end, node.getEndPublicationDate());
        assertEquals(icon, node.getIcon());
        assertEquals(properties, node.getProperties());
        assertNotNull(node.getNodes());
        assertEquals(children, node.getNodes().size());
    }

    private void compareNode(PageNode expected, PageNode actual) {
        if (expected.getLabel() != null) {
            assertEquals(expected.getLabel(), actual.getLabel());
        } else if (expected.getLabels() != null) {
            assertNotNull(actual.getLabels());
            assertEquals(actual.getLabels().size(), expected.getLabels().size());

            for (int i = 0; i < actual.getLabels().size(); i++) {
                LocalizedString actualLocalizedString = expected.getLabels().get(i);
                LocalizedString expectedLocalizedString = expected.getLabels().get(i);
                assertEquals(actualLocalizedString.getValue(), expectedLocalizedString.getValue());
                assertEquals(actualLocalizedString.getLang(), expectedLocalizedString.getLang());
            }
        } else {
            assertNull(actual.getLabel());
            assertNull(actual.getLabels());
        }

        assertEquals(expected.getIcon(), actual.getIcon());
        assertEquals(expected.getName(), actual.getName());
        assertEquals(expected.getStartPublicationDate(), actual.getStartPublicationDate());
        assertEquals(expected.getEndPublicationDate(), actual.getEndPublicationDate());
        assertEquals(expected.getVisibility(), actual.getVisibility());
        assertEquals(expected.getPageReference(), actual.getPageReference());
        assertEquals(expected.getProperties(), actual.getProperties());
        assertEquals(expected.getNodes().size(), actual.getNodes().size());
    }

    private Date createDate(int year, int month, int day, int hour, int minute, int seconds) {
        Calendar cal = Calendar.getInstance(TimeZone.getTimeZone("US/Eastern"));
        cal.set(Calendar.YEAR, year);
        cal.set(Calendar.MONTH, month - 1);
        cal.set(Calendar.DAY_OF_MONTH, day);
        cal.set(Calendar.HOUR_OF_DAY, hour);
        cal.set(Calendar.MINUTE, minute);
        cal.set(Calendar.SECOND, seconds);
        cal.set(Calendar.MILLISECOND, 0);

        return cal.getTime();
    }

    private PageNode newPageNode(String name, String icon, String label, Date start, Date end, Visibility visibility,
            String pageref, Properties properties, ArrayList<PageNode> pageNodes) {
        PageNode pageNode = new PageNode();
        pageNode.setName(name);
        pageNode.setIcon(icon);
        pageNode.setLabel(label);
        pageNode.setStartPublicationDate(start);
        pageNode.setEndPublicationDate(end);
        pageNode.setVisibility(visibility);
        pageNode.setPageReference(pageref);
        pageNode.setProperties(properties);
        pageNode.setChildren(pageNodes);

        return pageNode;
    }

    private PageNode newPageNode(String name, String icon, I18NString labels, Date start, Date end, Visibility visibility,
            String pageref, Properties properties, ArrayList<PageNode> pageNodes) {
        PageNode pageNode = new PageNode();
        pageNode.setName(name);
        pageNode.setIcon(icon);
        pageNode.setLabels(labels);
        pageNode.setStartPublicationDate(start);
        pageNode.setEndPublicationDate(end);
        pageNode.setVisibility(visibility);
        pageNode.setPageReference(pageref);
        pageNode.setProperties(properties);
        pageNode.setChildren(pageNodes);

        return pageNode;
    }
}