Application: gvSIG desktop » Library: org.gvsig.tools

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 * 

 * This program 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 General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

 * MA  02110-1301, USA.

 * 

 */

package org.gvsig.tools.library;

import java.util.LinkedHashSet;

import java.util.List;

import java.util.Set;

import junit.framework.TestCase;

/**

 * Tests for the {@link AbstractLibrariesInitializer} class.

 * 

 * @author gvSIG Team

 * @version $Id$

 */

public class AbstractLibrariesInitializerTest extends TestCase {

    private Library lib1api = new Lib1API();

    private Library lib1impl = new Lib1Impl();

    private Library lib1prov1 = new Lib1Prov1();

    private Library lib1prov2 = new Lib1Prov2();

    private Library lib2api = new Lib2API();

    private Library lib2impl = new Lib2Impl();

    private Library lib2prov1 = new Lib2Prov1();

    private Library lib3api = new Lib3API();

    private Library lib3impl = new Lib3Impl();

    private Library lib4api = new Lib4API();

    private Library lib4impl1 = new Lib4Impl1();

    private Library lib4impl2 = new Lib4Impl2();

    protected void setUp() throws Exception {

        super.setUp();

    }

    public void testInitialize() {

        // Test with 3 different libs orders just in case

        testInitializer(new TestLibrariesInitializer1());

        testInitializer(new TestLibrariesInitializer2());

        testInitializer(new TestLibrariesInitializer3());

    }

    private void testInitializer(AbstractLibrariesInitializer init) {

        // This is an ordered set

        List libs = init.getLibraries();

        checkOrder(libs);

    }

    private void checkOrder(List libs) {

        int ilib1api = libs.indexOf(lib1api);

        int ilib1impl = libs.indexOf(lib1impl);

        int ilib1prov1 = libs.indexOf(lib1prov1);

        int ilib1prov2 = libs.indexOf(lib1prov2);

        int ilib2api = libs.indexOf(lib2api);

        int ilib2impl = libs.indexOf(lib2impl);

        int ilib2prov1 = libs.indexOf(lib2prov1);

        int ilib3api = libs.indexOf(lib3api);

        int ilib3impl = libs.indexOf(lib3impl);

        int ilib4api = libs.indexOf(lib4api);

        int ilib4impl1 = libs.indexOf(lib4impl1);

        int ilib4impl2 = libs.indexOf(lib4impl2);

        // Check all needed libraries have been included into the list

        assertTrue("Lib1API is not included in the list", ilib1api > -1);

        assertTrue("Lib1Impl is not included in the list", ilib1impl > -1);

        assertTrue("Lib1Prov1 is not included in the list", ilib1prov1 > -1);

        assertTrue("Lib1Prov2 is not included in the list", ilib1prov2 > -1);

        assertTrue("Lib2API is not included in the list", ilib2api > -1);

        assertTrue("Lib2Impl is not included in the list", ilib2impl > -1);

        assertTrue("Lib2Prov1 is not included in the list", ilib2prov1 > -1);

        assertTrue("Lib3API is not included in the list", ilib3api > -1);

        assertTrue("Lib3Impl is not included in the list", ilib3impl > -1);

        assertTrue("Lib4API is not included in the list", ilib4api > -1);

        // Check implementation priorities

        assertEquals(

            "Lib4Impl1 has less priority than Lib4Impl2, it must not be initialized",

            ilib4impl1, -1);

        assertTrue(

            "Lib4Impl2 has more priority than Lib4Impl1, it must have been initialized",

            ilib4impl2 > -1);

        // Check api-impl-service(provider) relationships:

        // first API, next Impl and then services (providers)

        assertTrue("Lib1API must be initialized before Lib1Impl",

            ilib1api < ilib1impl);

        assertTrue("Lib1Impl must be initialized before Lib1Prov1",

            ilib1impl < ilib1prov1);

        assertTrue("Lib1Impl must be initialized before Lib1Prov2",

            ilib1impl < ilib1prov2);

        assertTrue("Lib2API must be initialized before Lib2Impl",

            ilib2api < ilib2impl);

        assertTrue("Lib2Impl must be initialized before Lib2Prov1",

            ilib2impl < ilib2prov1);

        assertTrue("Lib3API must be initialized before Lib3Impl",

            ilib3api < ilib3impl);

        assertTrue("Lib4API must be initialized before Lib4Impl",

            ilib4api < ilib4impl2);

        // Check dependencies between libraries

        assertTrue(

            "Lib2Impl dependends on Lib1API, must be initialized after it",

            ilib1api < ilib2impl);

        assertTrue(

            "Lib2Impl dependends on Lib1API, must be initialized after Lib1Impl",

            ilib1impl < ilib2impl);

        assertTrue(

            "Lib2Impl dependends on Lib1API, must be initialized after Lib1Prov1",

            ilib1prov1 < ilib2impl);

        assertTrue(

            "Lib2Impl dependends on Lib1API, must be initialized after Lib1Prov2",

            ilib1prov2 < ilib2impl);

        assertTrue(

            "Lib2Prov1 dependends on Lib3API, must be initialized afterwards",

            ilib3api < ilib2prov1);

        assertTrue(

            "Lib2Prov1 dependends on Lib3Impl, must be initialized after it",

            ilib3impl < ilib2prov1);

        assertTrue(

            "Lib4API dependends on Lib2Prov1, must be initialized after it",

            ilib4api > ilib2prov1);

    }

    private class TestLibrariesInitializer1 extends

        AbstractLibrariesInitializer {

        protected Set findLibraries(Class libraryClass, ClassLoader classLoader) {

            Set libs = new LinkedHashSet();

            libs.add(lib4impl1);

            libs.add(lib2api);

            libs.add(lib2impl);

            libs.add(lib2prov1);

            libs.add(lib1api);

            libs.add(lib1impl);

            libs.add(lib4impl2);

            libs.add(lib1prov1);

            libs.add(lib1prov2);

            libs.add(lib3api);

            libs.add(lib3impl);

            libs.add(lib4api);

            return libs;

        }

    }

    private class TestLibrariesInitializer2 extends

        AbstractLibrariesInitializer {

        protected Set findLibraries(Class libraryClass, ClassLoader classLoader) {

            Set libs = new LinkedHashSet();

            libs.add(lib2api);

            libs.add(lib4impl1);

            libs.add(lib2prov1);

            libs.add(lib1impl);

            libs.add(lib4impl2);

            libs.add(lib3impl);

            libs.add(lib2impl);

            libs.add(lib1api);

            libs.add(lib1prov2);

            libs.add(lib3api);

            libs.add(lib1prov1);

            libs.add(lib4api);

            return libs;

        }

    }

    private class TestLibrariesInitializer3 extends

        AbstractLibrariesInitializer {

        protected Set findLibraries(Class libraryClass, ClassLoader classLoader) {

            Set libs = new LinkedHashSet();

            libs.add(lib4api);

            libs.add(lib2prov1);

            libs.add(lib2api);

            libs.add(lib4impl2);

            libs.add(lib3api);

            libs.add(lib1api);

            libs.add(lib4impl1);

            libs.add(lib2impl);

            libs.add(lib1prov2);

            libs.add(lib3impl);

            libs.add(lib1impl);

            libs.add(lib1prov1);

            return libs;

        }

    }

    private class DummyLibrary extends AbstractLibrary {

        protected void doInitialize() throws LibraryException {

            // Nothing to do

        }

        protected void doPostInitialize() throws LibraryException {

            // Nothing to do

        }

    }

    private class Lib1API extends DummyLibrary {

        public void doRegistration() {

            registerAsAPI(Lib1API.class);

        }

    }

    private class Lib1Impl extends DummyLibrary {

        public void doRegistration() {

            registerAsImplementationOf(Lib1API.class);

        }

    }

    private class Lib1Prov1 extends DummyLibrary {

        public void doRegistration() {

            registerAsServiceOf(Lib1API.class);

        }

    }

    private class Lib1Prov2 extends DummyLibrary {

        public void doRegistration() {

            registerAsServiceOf(Lib1API.class);

        }

    }

    private class Lib2API extends DummyLibrary {

        public void doRegistration() {

            registerAsAPI(Lib2API.class);

        }

    }

    private class Lib2Impl extends DummyLibrary {

        public void doRegistration() {

            registerAsImplementationOf(Lib2API.class);

            require(Lib1API.class);

        }

    }

    private class Lib2Prov1 extends DummyLibrary {

        public void doRegistration() {

            registerAsServiceOf(Lib2API.class);

            require(Lib3API.class);

        }

    }

    private class Lib3API extends DummyLibrary {

        public void doRegistration() {

            registerAsAPI(Lib3API.class);

        }

    }

    private class Lib3Impl extends DummyLibrary {

        public void doRegistration() {

            registerAsImplementationOf(Lib3API.class);

        }

    }

    private class Lib4API extends DummyLibrary {

        public void doRegistration() {

            registerAsAPI(Lib4API.class);

            require(Lib2Prov1.class);

        }

    }

    private class Lib4Impl1 extends DummyLibrary {

        public void doRegistration() {

            registerAsImplementationOf(Lib4API.class);

        }

    }

    private class Lib4Impl2 extends DummyLibrary {

        public void doRegistration() {

            registerAsImplementationOf(Lib4API.class, 10);

        }

    }

}