SorterTest.java

/*
	Milyn - Copyright (C) 2006 - 2010

	This library is free software; you can redistribute it and/or
	modify it under the terms of the GNU Lesser General Public
	License (version 2.1) as published by the Free Software
	Foundation.

	This library 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:
	http://www.gnu.org/licenses/lgpl.txt
*/
package org.milyn.delivery.ordering;

import org.junit.Before;
import org.junit.Test;

import static org.junit.Assert.*;

import org.milyn.delivery.Visitor;
import org.milyn.delivery.ContentHandlerConfigMap;
import org.milyn.delivery.ordering.testvisitors.TestProducer;
import org.milyn.delivery.ordering.testvisitors.TestVisitor;
import org.milyn.delivery.ordering.testvisitors.TestConsumer;
import org.milyn.delivery.ordering.testvisitors.TestProducerConsumer;
import org.milyn.cdr.SmooksResourceConfiguration;
import org.milyn.cdr.SmooksConfigurationException;

import java.util.List;
import java.util.ArrayList;

/**
 * @author <a href="mailto:tom.fennelly@jboss.com">tom.fennelly@jboss.com</a>
 */
public class SorterTest {

    private List<ContentHandlerConfigMap<Visitor>> sortList = new ArrayList<ContentHandlerConfigMap<Visitor>>();
    private List<ContentHandlerConfigMap<Visitor>> originalList = new ArrayList<ContentHandlerConfigMap<Visitor>>();

    @Before
    public void setUp() throws Exception {
        sortList.clear();
        originalList.clear();
    }

    @Test
    public void test_sort_01_producer_first() {
        addVisitor(new TestConsumer("e", "f"));
        addVisitor(new TestProducerConsumer().setProducts("h").setConsumes("g"));
        addVisitor(new TestProducer("a", "b", "c"));
        addVisitor(new TestVisitor());
        addVisitor(new TestConsumer("d", "g"));
        addVisitor(new TestProducer("d", "e"));
        addVisitor(new TestConsumer("b"));
        addVisitor(new TestVisitor());
        addVisitor(new TestProducerConsumer().setProducts("g").setConsumes("c"));

        Sorter.sort(sortList, Sorter.SortOrder.PRODUCERS_FIRST);
        assertEquals(originalList.get(5), sortList.get(0));
        assertEquals(originalList.get(2), sortList.get(1));
        assertEquals(originalList.get(8), sortList.get(2));
        assertEquals(originalList.get(1), sortList.get(3));
        assertEquals(originalList.get(3), sortList.get(4));
        assertEquals(originalList.get(7), sortList.get(5));
        assertEquals(originalList.get(0), sortList.get(6));
        assertEquals(originalList.get(4), sortList.get(7));
        assertEquals(originalList.get(6), sortList.get(8));
    }

    @Test
    public void test_sort_02_producer_first() {
        addVisitor(new TestProducerConsumer().setProducts("h").setConsumes("g"));
        addVisitor(new TestConsumer("e", "f"));
        addVisitor(new TestConsumer("b"));
        addVisitor(new TestProducer("d", "e"));
        addVisitor(new TestProducerConsumer().setProducts("g").setConsumes("c"));
        addVisitor(new TestConsumer("d", "g"));
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestProducer("a", "b", "c"));

        Sorter.sort(sortList, Sorter.SortOrder.PRODUCERS_FIRST);
        assertEquals(originalList.get(8), sortList.get(0));
        assertEquals(originalList.get(3), sortList.get(1));
        assertEquals(originalList.get(4), sortList.get(2));
        assertEquals(originalList.get(0), sortList.get(3));
        assertEquals(originalList.get(6), sortList.get(4));
        assertEquals(originalList.get(7), sortList.get(5));
        assertEquals(originalList.get(1), sortList.get(6));
        assertEquals(originalList.get(2), sortList.get(7));
        assertEquals(originalList.get(5), sortList.get(8));
    }

    @Test
    public void test_sort_01_consumers_first() {
        addVisitor(new TestProducerConsumer().setProducts("h").setConsumes("g"));
        addVisitor(new TestConsumer("e", "f"));
        addVisitor(new TestConsumer("b"));
        addVisitor(new TestProducer("d", "e"));
        addVisitor(new TestProducerConsumer().setProducts("g").setConsumes("c"));
        addVisitor(new TestConsumer("d", "g"));
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestProducer("a", "b", "c"));

        Sorter.sort(sortList, Sorter.SortOrder.CONSUMERS_FIRST);
        assertEquals(originalList.get(8), sortList.get(8));
        assertEquals(originalList.get(3), sortList.get(7));
        assertEquals(originalList.get(4), sortList.get(6));
        assertEquals(originalList.get(0), sortList.get(5));
        assertEquals(originalList.get(6), sortList.get(4));
        assertEquals(originalList.get(7), sortList.get(3));
        assertEquals(originalList.get(1), sortList.get(2));
        assertEquals(originalList.get(2), sortList.get(1));
        assertEquals(originalList.get(5), sortList.get(0));
    }

    @Test
    public void test_sort_no_producers_consumers_producersfirst() {
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());

        Sorter.sort(sortList, Sorter.SortOrder.PRODUCERS_FIRST);
        assertEquals(originalList.get(0), sortList.get(0));
        assertEquals(originalList.get(1), sortList.get(1));
        assertEquals(originalList.get(2), sortList.get(2));
        assertEquals(originalList.get(3), sortList.get(3));
        assertEquals(originalList.get(4), sortList.get(4));
        assertEquals(originalList.get(5), sortList.get(5));
        assertEquals(originalList.get(6), sortList.get(6));
        assertEquals(originalList.get(7), sortList.get(7));
        assertEquals(originalList.get(8), sortList.get(8));
    }

    @Test
    public void test_sort_no_producers_consumers_consumersfirst() {
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());
        addVisitor(new TestVisitor());

        Sorter.sort(sortList, Sorter.SortOrder.CONSUMERS_FIRST);
        assertEquals(originalList.get(0), sortList.get(8));
        assertEquals(originalList.get(1), sortList.get(7));
        assertEquals(originalList.get(2), sortList.get(6));
        assertEquals(originalList.get(3), sortList.get(5));
        assertEquals(originalList.get(4), sortList.get(4));
        assertEquals(originalList.get(5), sortList.get(3));
        assertEquals(originalList.get(6), sortList.get(2));
        assertEquals(originalList.get(7), sortList.get(1));
        assertEquals(originalList.get(8), sortList.get(0));
    }

    @Test
    public void test_sort_2way_dependency_01() {
        addVisitor(new TestProducerConsumer().setProducts("a").setConsumes("b"));
        addVisitor(new TestProducerConsumer().setProducts("b").setConsumes("a"));

        try {
            Sorter.sort(sortList, Sorter.SortOrder.PRODUCERS_FIRST);
            fail("Expected SmooksConfigurationException");
        } catch(SmooksConfigurationException e) {
            assertEquals(("Invalid 2-Way/Circular Visitor Producer/Consumer dependency detected in configuration.\n" +
                    "\tTarget Profile: [[org.milyn.profile.Profile#default_profile]], Selector: [0], Selector Namespace URI: [null], Resource: [org.milyn.delivery.ordering.testvisitors.TestProducerConsumer], Num Params: [0]\n" +
                    "\t\tdepends-on: Target Profile: [[org.milyn.profile.Profile#default_profile]], Selector: [1], Selector Namespace URI: [null], Resource: [org.milyn.delivery.ordering.testvisitors.TestProducerConsumer], Num Params: [0]\n" +
                    "\t\t\tdepends-on: Target Profile: [[org.milyn.profile.Profile#default_profile]], Selector: [0], Selector Namespace URI: [null], Resource: [org.milyn.delivery.ordering.testvisitors.TestProducerConsumer], Num Params: [0]").trim(), e.getMessage().trim());
        }
    }

    @Test
    public void test_sort_2way_dependency_02() {
        addVisitor(new TestProducerConsumer().setProducts("a").setConsumes("b"));
        addVisitor(new TestProducerConsumer().setProducts("b").setConsumes("c"));
        addVisitor(new TestProducerConsumer().setProducts("c").setConsumes("d"));
        addVisitor(new TestProducerConsumer().setProducts("d").setConsumes("a"));

        try {
            Sorter.sort(sortList, Sorter.SortOrder.PRODUCERS_FIRST);
            fail("Expected SmooksConfigurationException");
        } catch(SmooksConfigurationException e) {
            assertEquals(("Invalid 2-Way/Circular Visitor Producer/Consumer dependency detected in configuration.\n" +
                    "\tTarget Profile: [[org.milyn.profile.Profile#default_profile]], Selector: [0], Selector Namespace URI: [null], Resource: [org.milyn.delivery.ordering.testvisitors.TestProducerConsumer], Num Params: [0]\n" +
                    "\t\tdepends-on: Target Profile: [[org.milyn.profile.Profile#default_profile]], Selector: [1], Selector Namespace URI: [null], Resource: [org.milyn.delivery.ordering.testvisitors.TestProducerConsumer], Num Params: [0]\n" +
                    "\t\t\tdepends-on: Target Profile: [[org.milyn.profile.Profile#default_profile]], Selector: [2], Selector Namespace URI: [null], Resource: [org.milyn.delivery.ordering.testvisitors.TestProducerConsumer], Num Params: [0]\n" +
                    "\t\t\t\tdepends-on: Target Profile: [[org.milyn.profile.Profile#default_profile]], Selector: [3], Selector Namespace URI: [null], Resource: [org.milyn.delivery.ordering.testvisitors.TestProducerConsumer], Num Params: [0]\n" +
                    "\t\t\t\t\tdepends-on: Target Profile: [[org.milyn.profile.Profile#default_profile]], Selector: [0], Selector Namespace URI: [null], Resource: [org.milyn.delivery.ordering.testvisitors.TestProducerConsumer], Num Params: [0]").trim(), e.getMessage().trim());
        }
    }

    private void addVisitor(Visitor visitor) {
        ContentHandlerConfigMap<Visitor> listEntry = new ContentHandlerConfigMap<Visitor>(visitor, new SmooksResourceConfiguration("" + sortList.size(), visitor.getClass().getName()));
        sortList.add(listEntry);
        originalList.add(listEntry);
    }
}