001/**
002 * Copyright 2005-2014 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.plugin;
017
018import org.apache.commons.io.FileUtils;
019import org.junit.Test;
020import org.kuali.rice.core.api.config.property.Config;
021import org.kuali.rice.core.api.util.ClasspathOrFileResourceLoader;
022import org.kuali.rice.kew.test.KEWTestCase;
023import org.kuali.rice.kew.test.TestUtilities;
024
025import java.io.File;
026import java.util.List;
027
028import static org.junit.Assert.*;
029
030/**
031 * Tests that the extra classpath features of the plugin work as advertised.
032 *
033 * <p>Adds the test/src/org/kuali/rice/kew/plugin/classes directory to the extra classes on
034 * the classpath.  Adds the test/src/org/kuali/rice/kew/plugin/lib directory to the extra
035 * libs on the classpath.  Within the lib directory is a jar called extraclasspath.jar.
036 * Inside this jar is a single resource called extraclasspath-lib.txt.
037 *
038 * @author Kuali Rice Team (rice.collab@kuali.org)
039 */
040public class ExtraClassPathTest extends KEWTestCase {
041    
042    private PluginRegistry registry;
043
044        @Override
045        public void setUp() throws Exception {
046                // we want to copy the ziptest plugin into the plugin directories before the
047                // test harness starts up.  That way the plugin will be loaded at startup time.
048        super.setUp();
049                TestUtilities.initializePluginDirectories();
050                String pluginZipFileLocation = new ClasspathOrFileResourceLoader().getResource("classpath:org/kuali/rice/kew/plugin/extraclasspathtest.zip").getURL().getPath();
051                File pluginZipFile = new File(pluginZipFileLocation);
052                assertTrue("File " + pluginZipFileLocation + " should exist", pluginZipFile.exists());
053                assertTrue("File " + pluginZipFileLocation + " should be a file", pluginZipFile.isFile());
054                FileUtils.copyFileToDirectory(pluginZipFile, TestUtilities.getPluginsDirectory());
055                pluginZipFile = new File(TestUtilities.getPluginsDirectory(), pluginZipFile.getName());
056                FileUtils.forceDeleteOnExit(pluginZipFile);
057        registry = new PluginRegistryFactory().createPluginRegistry();
058        registry.start();
059        }
060        
061        @Override
062        public void tearDown() throws Exception {
063                super.tearDown();
064                if (registry != null) {
065                    registry.stop();
066                }
067                TestUtilities.cleanupPluginDirectories();
068        }
069        
070        @Test public void testExtraClassPath() throws Exception {
071                // first of all, let's check that the plugin was loaded when the test harness started up
072                List<PluginEnvironment> environments = registry.getPluginEnvironments();
073                assertEquals("There should be 1 plugin environment.", 1, environments.size());
074
075                PluginEnvironment environment = environments.get(0);
076                assertEquals("Should be the extraclasspathtest plugin.", "extraclasspathtest", environment.getPlugin().getName().getLocalPart());
077
078                // check that the properties were configured correctly
079        String extraClassesDirName = environment.getPlugin().getConfig().getProperty(Config.EXTRA_CLASSES_DIR);
080        String extraLibDirName = environment.getPlugin().getConfig().getProperty(Config.EXTRA_LIB_DIR);
081
082        File extraClassesDir = new ClasspathOrFileResourceLoader().getResource(extraClassesDirName).getFile();
083                assertTrue("extra classes dir (" + extraClassesDirName + ") should exist.", extraClassesDir.exists());
084                assertTrue("extra classes dir (" + extraClassesDirName + ") should be a directory.", extraClassesDir.isDirectory());
085                File extraLibDir = new File(extraLibDirName);
086                assertTrue("extra lib dir (" + extraLibDirName + ") should exist.", extraLibDir.exists());
087                assertTrue("extra lib dir (" + extraLibDirName + ") should be a directory.", extraLibDir.isDirectory());
088
089                // now verify that the resources from the extra classes and extra lib dirs got loaded
090                ClassLoader classLoader = environment.getPlugin().getClassLoader();
091                assertNotNull("Resource should exist.", classLoader.getResource("extraclasspath-classes.txt"));
092                assertNotNull("Resource should exist.", classLoader.getResource("extraclasspath-lib.txt"));
093        }
094
095}