Index: build.xml =================================================================== --- build.xml (revision 644587) +++ build.xml (working copy) @@ -353,7 +353,17 @@ debug="${debug.mode}" includeantruntime="no" /> + basedir="${build.dir}/custom-classpath" + includes="org/apache/ivy/plugins/resolver/CustomResolver*"/> + + + Index: doc/configuration/classpath.html =================================================================== --- doc/configuration/classpath.html (revision 644587) +++ doc/configuration/classpath.html (working copy) @@ -27,9 +27,10 @@ Index: src/java/org/apache/ivy/ant/IvyAntClassLoaderManager.java =================================================================== --- src/java/org/apache/ivy/ant/IvyAntClassLoaderManager.java (revision 0) +++ src/java/org/apache/ivy/ant/IvyAntClassLoaderManager.java (revision 0) @@ -0,0 +1,79 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.ivy.ant; + +import org.apache.ivy.core.settings.IvyClassLoaderManager; +import org.apache.ivy.core.settings.IvyClassLoaderManagerImpl; +import org.apache.ivy.util.Message; +import org.apache.tools.ant.AntClassLoader; +import org.apache.tools.ant.Project; +import org.apache.tools.ant.types.Path; + +/** + * Class loader manager implementation to use when running within Ant. + * {@link #addPathId(String)} can be used + * to reference Ant path structures in the Ivy plugin classloader. + * + * @see org.apache.ivy.core.settings.IvySettings#setClassLoaderManager(IvyClassLoaderManager) + */ +public class IvyAntClassLoaderManager extends IvyClassLoaderManagerImpl + implements IvyClassLoaderManager { + + /* + * ClassLoader structure here differs from IvyClassLoaderManagerImpl. In + * parent class, we have a simple scheme with one child ClassLoader: + * + * URLClassLoader -> Ivy ClassLoader + * + * Here, we add a new ClassLoader to the chain every time a path element + * is added: + * + * URLClassLoader -> Ant ClassLoader -> URLClassLoader -> ... -> Ivy ClassLoader + */ + + private Project project; + + public IvyAntClassLoaderManager(Project project) { + super(); + this.project = project; + } + + /** + * Overridden to support references to Ant paths by ID. + */ + public void addPathId(String pathId) { + Object ref = project.getReference(pathId); + if (ref != null) { + //throw an error if the user gave us a fileset id or something like that. + if (!(ref instanceof Path)) { + throw new IllegalArgumentException("Ant id " + pathId + + " should identify a Path, but instead got a " + ref.getClass().getName()); + } + + Path path = (Path) ref; + appendPathInfo(path.toString()); + + //chain a classloader for the new path onto the end of the existing + //classloaders. + ClassLoader parent = getClassLoader(); + setRootClassLoader(new AntClassLoader(parent, project, path, true)); + } else { + Message.debug("Skipping unknown path ID " + pathId); + } + } +} \ No newline at end of file Index: src/java/org/apache/ivy/ant/IvyAntSettings.java =================================================================== --- src/java/org/apache/ivy/ant/IvyAntSettings.java (revision 644587) +++ src/java/org/apache/ivy/ant/IvyAntSettings.java (working copy) @@ -278,9 +278,11 @@ } private void createIvyEngine() { - IvyAntVariableContainer ivyAntVariableContainer = new IvyAntVariableContainer(getProject()); + Project project = getProject(); + IvyAntVariableContainer ivyAntVariableContainer = new IvyAntVariableContainer(project); + IvyAntClassLoaderManager ivyAntClassLoaderManager = new IvyAntClassLoaderManager(project); - IvySettings settings = new IvySettings(ivyAntVariableContainer); + IvySettings settings = new IvySettings(ivyAntVariableContainer, ivyAntClassLoaderManager); if (file == null && url == null) { defineDefaultSettingFile(ivyAntVariableContainer); Index: src/java/org/apache/ivy/core/settings/IvyClassLoaderManager.java =================================================================== --- src/java/org/apache/ivy/core/settings/IvyClassLoaderManager.java (revision 0) +++ src/java/org/apache/ivy/core/settings/IvyClassLoaderManager.java (revision 0) @@ -0,0 +1,66 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.ivy.core.settings; + +import java.net.URL; + +/** + * Manages the ClassLoader used by {@link IvySettings} to load + * plugin classes and other custom typedefs. Methods named add*(...) + * are used to add classpath entries. {@link #getClassLoader()} returns + * a classloader that searches all of the classpath entries in the order + * in which they were added. + * + * @see IvySettings#setClassLoaderManager(IvyClassLoaderManager) + * @see IvyClassLoaderManagerImpl + */ +public interface IvyClassLoaderManager { + + /** Add a JAR URL to the class loader's classpath. */ + public void addURL(URL url); + + /** + * Add a complex path expression (e.g. of the kind used in the system property + * java.class.path) to the class loader's classpath. + * @param separator the path separator to use when interpreting path; + * if null, the platform default is used. + * @throws UnsupportedOperationException if this manager does not support + * complex path expressions + */ + public void addPath(String path, String separator); + + /** + * Add a reference to an externally defined class path. Externally defined paths + * may be available when Ivy is run embedded within another build system like Ant. + * @throws UnsupportedOperationException if this manager does not support + * external path references + */ + public void addPathId(String pathId); + + /** + * Get the ClassLoader that configures all locations configured with {@link #addURL(URL)}, + * {@link #addPath(String)}, or {@link #addPathId(String)}. The returned loader is + * not affected by subsequent calls to add* methods. + */ + public ClassLoader getClassLoader(); + + /** + * Send debug information about the current classloader settings to the Message logger. + */ + public void dumpSettings(); +} Index: src/java/org/apache/ivy/core/settings/IvyClassLoaderManagerImpl.java =================================================================== --- src/java/org/apache/ivy/core/settings/IvyClassLoaderManagerImpl.java (revision 0) +++ src/java/org/apache/ivy/core/settings/IvyClassLoaderManagerImpl.java (revision 0) @@ -0,0 +1,187 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.ivy.core.settings; + +import java.io.File; +import java.net.MalformedURLException; +import java.net.URL; +import java.net.URLClassLoader; +import java.util.ArrayList; +import java.util.List; +import java.util.StringTokenizer; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import org.apache.ivy.Ivy; +import org.apache.ivy.util.Message; + +/** + * Default class loader manager implementation, for Ivy standalone mode. URL classpath entries + * and simple path expressions are supported with {@link #addURL(URL)} + * and {@link #addPath(String, String)}. Attempts to add path ID references with + * {@link #addPathId(String)} will raise an exception. + */ +public class IvyClassLoaderManagerImpl implements IvyClassLoaderManager { + + /** + * regexp recognizes absolute URLs. Parser stores the URL protocol in a capture group to help + * determine whether we have a URL or an absolute file path with a drive letter. + */ + private static final Pattern ABSOLUTE_URL_PATTERN = Pattern.compile("^([\\w.\\-+]+):/.+"); + + /** + * true if we need to recognize classpath entries that begin with a drive letter (e.g. + * "c:/WINDOWS/makes/life/easy") + */ + private final boolean msStylePath; + private final String systemPathSeparator; + + private List classPathURLs = new ArrayList(); + + // parent classloader, searched before URLs added to the path + private ClassLoader parentLoader; + // cached value of the plugin classloader + private ClassLoader classLoader; + + // string representation of the full classpath, for logging purposes. + private StringBuffer string = new StringBuffer("[]"); + + /** + * Initialize the manager using the system default path separator. + */ + public IvyClassLoaderManagerImpl() { + this(File.pathSeparatorChar); + } + + /** + * Initialize the manager with the given default path separator, to use + * when no path separator is passed to {@link #addPath(String, String)}. + * Like Ant's implementation, a path separator of ';' enables + * the use of single-character drive letters in path entries. + */ + public IvyClassLoaderManagerImpl(char systemPathSeparator) { + this.msStylePath = (systemPathSeparator == ';'); + this.systemPathSeparator = String.valueOf(systemPathSeparator); + this.parentLoader = Ivy.class.getClassLoader(); + } + + /** @throws UnsupportedOperationException if called */ + public void addPathId(String pathId) { + throw new UnsupportedOperationException("Cannot add path id '" + pathId + + "': Path ID references are not supported in the standalone Ivy ClassLoader"); + } + + /** + * Basic implementation of {@link IvyClassLoaderManager#addPath(String, String)}. All path + * entries are converted to URLs and appended to the ClassLoader using {@link #addURL(URL)}. + */ + public void addPath(String path, String separator) { + appendPathInfo(path); + + if (separator == null) { + separator = systemPathSeparator; + } + + StringTokenizer strtok = new StringTokenizer(path, separator); + while (strtok.hasMoreTokens()) { + String pathElt = strtok.nextToken().trim(); + if (pathElt.length() > 0) { + URL url = pathToURL(pathElt); + addURL(url); + } + } + } + + public void addURL(URL url) { + appendPathInfo(url.toExternalForm()); + classPathURLs.add(url); + classLoader = null; + } + + public ClassLoader getClassLoader() { + if (classLoader == null) { + if (classPathURLs.isEmpty()) { + //no new URLs to add to the classpath, use the current root loader. + classLoader = parentLoader; + } else { + //chain the configured URLs onto the class loader. + URL[] urls = (URL[]) classPathURLs.toArray(new URL[classPathURLs.size()]); + classLoader = new URLClassLoader(urls, parentLoader); + } + } + return classLoader; + } + + public void dumpSettings() { + Message.verbose("\t-- Ivy plugin classloader path: "); + Message.verbose("\t\t" + toString()); + } + + public String toString() { + return string.toString(); + } + + /** + * Forcibly set the root classloader returned by {@link #getClassLoader()}. + * Resets any prior classloader configuration done on this class. + */ + protected void setRootClassLoader(ClassLoader loader) { + this.parentLoader = loader; + this.classLoader = null; + classPathURLs.clear(); + } + + /** + * Convert the given path element to a URL. + * @throws IllegalArgumentException if the path element is neither + * a valid URL nor file system path. + */ + protected URL pathToURL(String pathElement) { + + try { + // test whether the path is an absolute URL. + Matcher matcher = ABSOLUTE_URL_PATTERN.matcher(pathElement); + if (matcher.matches()) { + String protocol = matcher.group(1); + // we might have an absolute file path instead of a URL. + if (!msStylePath || protocol.length() > 1) { + return new URL(pathElement); + } + } + // must be a file path. + File file = new File(pathElement); + return file.toURL(); + + } catch (MalformedURLException mue) { + throw new IllegalArgumentException("Illegal path expression '" + + pathElement + "'", mue); + } + } + + /** update the string representation with the given path info */ + protected void appendPathInfo(String path) { + //delete the close brace. + string.setLength(string.length() - 1); + //separate the new path from existing entries. + if (string.length() > 1) { + string.append(File.pathSeparatorChar); + } + string.append(path); + string.append(']'); + } +} \ No newline at end of file Index: src/java/org/apache/ivy/core/settings/IvySettings.java =================================================================== --- src/java/org/apache/ivy/core/settings/IvySettings.java (revision 644587) +++ src/java/org/apache/ivy/core/settings/IvySettings.java (working copy) @@ -25,7 +25,6 @@ import java.lang.reflect.Field; import java.net.MalformedURLException; import java.net.URL; -import java.net.URLClassLoader; import java.text.ParseException; import java.util.ArrayList; import java.util.Collection; @@ -35,7 +34,6 @@ import java.util.Map; import java.util.Properties; -import org.apache.ivy.Ivy; import org.apache.ivy.core.IvyPatternHelper; import org.apache.ivy.core.NormalRelativeUrlResolver; import org.apache.ivy.core.RelativeUrlResolver; @@ -179,10 +177,8 @@ private File defaultUserDir; - private List classpathURLs = new ArrayList(); + private IvyClassLoaderManager classLoaderManager = null; - private ClassLoader classloader; - private Boolean debugConflictResolution; private boolean logNotConvertedExclusionRule; @@ -204,11 +200,13 @@ private String defaultResolveMode = ResolveOptions.RESOLVEMODE_DEFAULT; public IvySettings() { - this(new IvyVariableContainerImpl()); + this(new IvyVariableContainerImpl(), new IvyClassLoaderManagerImpl()); } - public IvySettings(IvyVariableContainer variableContainer) { + public IvySettings(IvyVariableContainer variableContainer, + IvyClassLoaderManager classLoaderManager) { setVariableContainer(variableContainer); + setClassLoaderManager(classLoaderManager); setVariable("ivy.default.settings.dir", getDefaultSettingsDir(), true); setDeprecatedVariable("ivy.default.conf.dir", "ivy.default.settings.dir"); @@ -499,12 +497,8 @@ Message.debug("\tvalidate: " + doValidate()); Message.debug("\tcheck up2date: " + isCheckUpToDate()); - if (!classpathURLs.isEmpty()) { - Message.verbose("\t-- " + classpathURLs.size() + " custom classpath urls:"); - for (Iterator iter = classpathURLs.iterator(); iter.hasNext();) { - Message.debug("\t\t" + iter.next()); - } - } + classLoaderManager.dumpSettings(); + Message.verbose("\t-- " + resolversMap.size() + " resolvers:"); for (Iterator iter = resolversMap.values().iterator(); iter.hasNext();) { DependencyResolver resolver = (DependencyResolver) iter.next(); @@ -605,31 +599,38 @@ } catch (ClassNotFoundException e) { if (silentFail) { Message.info("impossible to define new type: class not found: " + className - + " in " + classpathURLs + " nor Ivy classloader"); + + " in " + classLoaderManager + " nor Ivy classloader"); return null; } else { throw new RuntimeException("impossible to define new type: class not found: " - + className + " in " + classpathURLs + " nor Ivy classloader"); + + className + " in " + classLoaderManager + " nor Ivy classloader"); } } } private ClassLoader getClassLoader() { - if (classloader == null) { - if (classpathURLs.isEmpty()) { - classloader = Ivy.class.getClassLoader(); - } else { - classloader = new URLClassLoader((URL[]) classpathURLs - .toArray(new URL[classpathURLs.size()]), Ivy.class.getClassLoader()); - } - } - return classloader; + return classLoaderManager.getClassLoader(); } public void addClasspathURL(URL url) { - classpathURLs.add(url); - classloader = null; + classLoaderManager.addURL(url); } + + public void addClasspath(String path, String separator) { + classLoaderManager.addPath(path, separator); + } + + public void addClasspathId(String pathId) { + classLoaderManager.addPathId(pathId); + } + + /** + * Set a non-default class loader manager (e.g. for integration with + * Ant classpaths). + */ + public void setClassLoaderManager(IvyClassLoaderManager manager) { + this.classLoaderManager = manager; + } public Map getTypeDefs() { return typeDefs; Index: src/java/org/apache/ivy/core/settings/XmlSettingsParser.java =================================================================== --- src/java/org/apache/ivy/core/settings/XmlSettingsParser.java (revision 644587) +++ src/java/org/apache/ivy/core/settings/XmlSettingsParser.java (working copy) @@ -439,20 +439,48 @@ } private void classpathStarted(Map attributes) throws MalformedURLException { - String urlStr = (String) attributes.get("url"); - URL url = null; - if (urlStr == null) { - String file = (String) attributes.get("file"); - if (file == null) { - throw new IllegalArgumentException( - "either url or file should be given for classpath element"); + + //make sure that we have exactly one classpath attribute specified. + switch (attributes.size()) { + case 1: + //exactly one attribute, no problem. + break; + case 2: + //only 'path' allows two attributes + if (attributes.containsKey("path") && attributes.containsKey("pathsep")) { + break; + } + //else fall through to error. + default: + throw new IllegalArgumentException( + "Exactly one of refid, path, url, or file must be specified on "); + } + + String refId = (String) attributes.get("refid"); + if (refId != null) { + ivy.addClasspathId(refId); + } else { + String path = (String) attributes.get("path"); + if (path != null) { + //pathsep is optional + String pathsep = (String) attributes.get("pathsep"); + ivy.addClasspath(path, pathsep); } else { - url = new File(file).toURL(); + String urlStr = (String) attributes.get("url"); + if (urlStr != null) { + ivy.addClasspathURL(new URL(urlStr)); + } else { + String file = (String) attributes.get("file"); + if (file != null) { + ivy.addClasspathURL(new File(file).toURL()); + } else { + //some invalid attribute was specified. + throw new IllegalArgumentException( + "refid, path, url, or file must be specified on "); + } + } } - } else { - url = new URL(urlStr); } - ivy.addClasspathURL(url); } private void inConfiguratorStarted(String qName, Map attributes) { Index: test/custom-classpath/org/apache/ivy/plugins/resolver/ComplexClasspathResolver.java =================================================================== --- test/custom-classpath/org/apache/ivy/plugins/resolver/ComplexClasspathResolver.java (revision 0) +++ test/custom-classpath/org/apache/ivy/plugins/resolver/ComplexClasspathResolver.java (revision 0) @@ -0,0 +1,32 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.ivy.plugins.resolver; + +/** + * A dummy resolver that requires four different classes to load: + * ComplexClasspathResolver, SubclassedCustomResolver, CustomResolver, + * and ResolverUtility. All of these classes should be placed in separate + * jars at build time, so that we can test advanced classloading + * features in Ivy. + */ +public class ComplexClasspathResolver extends SubclassedCustomResolver { + + /** this field exists only to force us to load the ResolverUtility class at runtime */ + ResolverUtility dependency = new ResolverUtility(); + +} Index: test/custom-classpath/org/apache/ivy/plugins/resolver/ResolverUtility.java =================================================================== --- test/custom-classpath/org/apache/ivy/plugins/resolver/ResolverUtility.java (revision 0) +++ test/custom-classpath/org/apache/ivy/plugins/resolver/ResolverUtility.java (revision 0) @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.ivy.plugins.resolver; + +/** a dummy class, required by {@link ComplexClasspathResolver} */ +public class ResolverUtility { +} Index: test/custom-classpath/org/apache/ivy/plugins/resolver/SubclassedCustomResolver.java =================================================================== --- test/custom-classpath/org/apache/ivy/plugins/resolver/SubclassedCustomResolver.java (revision 0) +++ test/custom-classpath/org/apache/ivy/plugins/resolver/SubclassedCustomResolver.java (revision 0) @@ -0,0 +1,26 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.ivy.plugins.resolver; + +/** + * A subclassed custom resolver, to be packaged in a different + * jar from CustomResolver for testing complex classpath configurations. + */ +public class SubclassedCustomResolver extends CustomResolver { + +} Index: test/java/org/apache/ivy/ant/AntCallTriggerTest.java =================================================================== --- test/java/org/apache/ivy/ant/AntCallTriggerTest.java (revision 644587) +++ test/java/org/apache/ivy/ant/AntCallTriggerTest.java (working copy) @@ -18,28 +18,18 @@ package org.apache.ivy.ant; import java.io.File; -import java.io.InputStream; -import java.io.PrintStream; -import java.util.Vector; import junit.framework.TestCase; import org.apache.ivy.util.FileUtil; -import org.apache.tools.ant.BuildException; -import org.apache.tools.ant.BuildLogger; -import org.apache.tools.ant.DefaultLogger; -import org.apache.tools.ant.DemuxInputStream; -import org.apache.tools.ant.DemuxOutputStream; -import org.apache.tools.ant.Main; -import org.apache.tools.ant.Project; -import org.apache.tools.ant.ProjectHelper; -import org.apache.tools.ant.input.DefaultInputHandler; -import org.apache.tools.ant.input.InputHandler; public class AntCallTriggerTest extends TestCase { + + private TestAntRunner antRunner = new TestAntRunner(); + public void test() throws Exception { assertFalse(new File("test/triggers/ant-call/A/out/foo.txt").exists()); - runAnt(new File("test/triggers/ant-call/A/build.xml"), "resolve"); + antRunner.runAnt(new File("test/triggers/ant-call/A/build.xml"), "resolve"); // should have unzipped foo.zip assertTrue(new File("test/triggers/ant-call/A/out/foo.txt").exists()); } @@ -49,175 +39,4 @@ FileUtil.forceDelete(new File("test/triggers/ant-call/cache")); } - private void runAnt(File buildFile, String target) throws BuildException { - runAnt(buildFile, target, Project.MSG_INFO); - } - - private void runAnt(File buildFile, String target, int messageLevel) throws BuildException { - Vector targets = new Vector(); - targets.add(target); - runAnt(buildFile, targets, messageLevel); - } - - private void runAnt(File buildFile, Vector targets, int messageLevel) throws BuildException { - runBuild(buildFile, targets, messageLevel); - - // this exits the jvm at the end of the call - // Main.main(new String[] {"-f", buildFile.getAbsolutePath(), target}); - - // this does not set the good message level - // Ant ant = new Ant(); - // Project project = new Project(); - // project.setBaseDir(buildFile.getParentFile()); - // project.init(); - // - // ant.setProject(project); - // ant.setTaskName("ant"); - // - // ant.setAntfile(buildFile.getAbsolutePath()); - // ant.setInheritAll(false); - // if (target != null) { - // ant.setTarget(target); - // } - // ant.execute(); - } - - // //////////////////////////////////////////////////////////////////////////// - // miserable copy (updated to simple test cases) from ant Main class: - // the only available way I found to easily run ant exits jvm at the end - private void runBuild(File buildFile, Vector targets, int messageLevel) throws BuildException { - - final Project project = new Project(); - project.setCoreLoader(null); - - Throwable error = null; - - try { - addBuildListeners(project, messageLevel); - addInputHandler(project, null); - - PrintStream err = System.err; - PrintStream out = System.out; - InputStream in = System.in; - - // use a system manager that prevents from System.exit() - SecurityManager oldsm = null; - oldsm = System.getSecurityManager(); - - // SecurityManager can not be installed here for backwards - // compatibility reasons (PD). Needs to be loaded prior to - // ant class if we are going to implement it. - // System.setSecurityManager(new NoExitSecurityManager()); - try { - project.setDefaultInputStream(System.in); - System.setIn(new DemuxInputStream(project)); - System.setOut(new PrintStream(new DemuxOutputStream(project, false))); - System.setErr(new PrintStream(new DemuxOutputStream(project, true))); - - project.fireBuildStarted(); - - project.init(); - project.setUserProperty("ant.version", Main.getAntVersion()); - - project.setUserProperty("ant.file", buildFile.getAbsolutePath()); - - ProjectHelper.configureProject(project, buildFile); - - // make sure that we have a target to execute - if (targets.size() == 0) { - if (project.getDefaultTarget() != null) { - targets.addElement(project.getDefaultTarget()); - } - } - - project.executeTargets(targets); - } finally { - // put back the original security manager - // The following will never eval to true. (PD) - if (oldsm != null) { - System.setSecurityManager(oldsm); - } - - System.setOut(out); - System.setErr(err); - System.setIn(in); - } - } catch (RuntimeException exc) { - error = exc; - throw exc; - } catch (Error err) { - error = err; - throw err; - } finally { - project.fireBuildFinished(error); - } - } - - /** - * Adds the listeners specified in the command line arguments, along with the default listener, - * to the specified project. - * - * @param project - * The project to add listeners to. Must not be null. - */ - protected void addBuildListeners(Project project, int level) { - - // Add the default listener - project.addBuildListener(createLogger(level)); - - } - - /** - * Creates the InputHandler and adds it to the project. - * - * @param project - * the project instance. - * @param inputHandlerClassname - * @exception BuildException - * if a specified InputHandler implementation could not be loaded. - */ - private void addInputHandler(Project project, String inputHandlerClassname) - throws BuildException { - InputHandler handler = null; - if (inputHandlerClassname == null) { - handler = new DefaultInputHandler(); - } else { - try { - handler = (InputHandler) (Class.forName(inputHandlerClassname).newInstance()); - if (project != null) { - project.setProjectReference(handler); - } - } catch (ClassCastException e) { - String msg = "The specified input handler class " + inputHandlerClassname - + " does not implement the InputHandler interface"; - throw new BuildException(msg); - } catch (Exception e) { - String msg = "Unable to instantiate specified input handler " + "class " - + inputHandlerClassname + " : " + e.getClass().getName(); - throw new BuildException(msg); - } - } - project.setInputHandler(handler); - } - - // XXX: (Jon Skeet) Any reason for writing a message and then using a bare - // RuntimeException rather than just using a BuildException here? Is it - // in case the message could end up being written to no loggers (as the - // loggers could have failed to be created due to this failure)? - /** - * Creates the default build logger for sending build events to the ant log. - * - * @return the logger instance for this build. - */ - private BuildLogger createLogger(int level) { - BuildLogger logger = null; - logger = new DefaultLogger(); - - logger.setMessageOutputLevel(level); - logger.setOutputPrintStream(System.out); - logger.setErrorPrintStream(System.err); - - return logger; - } - } Index: test/java/org/apache/ivy/ant/IvyAntClassLoaderTest.java =================================================================== --- test/java/org/apache/ivy/ant/IvyAntClassLoaderTest.java (revision 0) +++ test/java/org/apache/ivy/ant/IvyAntClassLoaderTest.java (revision 0) @@ -0,0 +1,77 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.ivy.ant; + +import java.io.File; + +import junit.framework.TestCase; + +import org.apache.ivy.Ivy; +import org.apache.ivy.plugins.resolver.DependencyResolver; +import org.apache.tools.ant.Project; + +/** + * Test that {@link IvyAntClassLoaderManager} can use Ant paths to load + * Ivy plugins. + */ +public class IvyAntClassLoaderTest extends TestCase { + + private TestAntRunner antRunner = new TestAntRunner(); + + /** + * Test that ant paths and path expressions can be used + * in Ivy settings <classpath> elements. + */ + public void testAntClassLoader() { + //first, various sanity checks to make sure this is a valid test. + File buildFile = + new File("test/java/org/apache/ivy/ant/ivysettings-ant-classpath-build.xml"); + assertTrue("found build file " + buildFile.getAbsolutePath(), buildFile.isFile()); + //all of these classes should be loaded using elements, + //not from the test path + assertNotDefined("org.apache.ivy.plugins.resolver.CustomResolver"); + assertNotDefined("org.apache.ivy.plugins.resolver.SubclassedCustomResolver"); + assertNotDefined("org.apache.ivy.plugins.resolver.ComplexClasspathResolver"); + assertNotDefined("org.apache.ivy.plugins.resolver.ResolverUtility"); + + //set test directory location for use by ant script. + System.setProperty("ivy.custom.test.dir", + new File("test/java/org/apache/ivy/core/settings").getAbsolutePath()); + + //run the ant script, which only has to parse the ivy settings file for us. + Project project = antRunner.runAnt(buildFile, "configure", Project.MSG_VERBOSE); + + //inspect the ant ivy environment and verify that it was able to load the custom + //resolver using ant path entries. + IvyAntSettings settings = (IvyAntSettings) project.getReference("ivy.instance"); + Ivy ivy = settings.getConfiguredIvyInstance(); + assertNotNull("ivy configured in project", ivy); + DependencyResolver resolver = ivy.getSettings().getResolver("complex-custom"); + assertNotNull("resolver using ant paths was successfully loaded", resolver); + assertEquals("resolver has correct type", + "org.apache.ivy.plugins.resolver.ComplexClasspathResolver", + resolver.getClass().getName()); + } + + private static void assertNotDefined(String className) { + try { + Class.forName(className); + fail("the class " + className + " should not be reachable from the test classloader"); + } catch (ClassNotFoundException expected) {} + } +} Index: test/java/org/apache/ivy/ant/ivysettings-ant-classpath-build.xml =================================================================== --- test/java/org/apache/ivy/ant/ivysettings-ant-classpath-build.xml (revision 0) +++ test/java/org/apache/ivy/ant/ivysettings-ant-classpath-build.xml (revision 0) @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + \ No newline at end of file Index: test/java/org/apache/ivy/ant/ivysettings-ant-classpath.xml =================================================================== --- test/java/org/apache/ivy/ant/ivysettings-ant-classpath.xml (revision 0) +++ test/java/org/apache/ivy/ant/ivysettings-ant-classpath.xml (revision 0) @@ -0,0 +1,31 @@ + + + + + + + + + + + + + \ No newline at end of file Index: test/java/org/apache/ivy/ant/TestAntRunner.java =================================================================== --- test/java/org/apache/ivy/ant/TestAntRunner.java (revision 0) +++ test/java/org/apache/ivy/ant/TestAntRunner.java (revision 0) @@ -0,0 +1,205 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.ivy.ant; + +import java.io.File; +import java.io.InputStream; +import java.io.PrintStream; +import java.util.Vector; + +import org.apache.tools.ant.BuildException; +import org.apache.tools.ant.BuildLogger; +import org.apache.tools.ant.DefaultLogger; +import org.apache.tools.ant.DemuxInputStream; +import org.apache.tools.ant.DemuxOutputStream; +import org.apache.tools.ant.Main; +import org.apache.tools.ant.Project; +import org.apache.tools.ant.ProjectHelper; +import org.apache.tools.ant.input.DefaultInputHandler; +import org.apache.tools.ant.input.InputHandler; + +/** + * Utility class for unit tests that need to run an Ant script and examine + * the results. + */ +public class TestAntRunner { + + /** + * equivalent to {@link #runAnt(File, String, Project.MSG_INFO) + * runAnt(buildFile, target, Project.MSG_INFO)} + */ + public Project runAnt(File buildFile, String target) throws BuildException { + return runAnt(buildFile, target, Project.MSG_INFO); + } + + /** + * equivalent to {@link #runAnt(File, Vector, int) + * runAnt(buildFile, targets, messageLevel)} with the targets + * vector containing only target. + */ + public Project runAnt(File buildFile, String target, int messageLevel) throws BuildException { + Vector targets = new Vector(); + targets.add(target); + return runAnt(buildFile, targets, messageLevel); + } + + /** + * Run the given Ant build file, executing all of the targets in targets. + * @param the ant log level for the build + * @return the Project used to run the file. + */ + public Project runAnt(File buildFile, Vector targets, int messageLevel) throws BuildException { + // //////////////////////////////////////////////////////////////////////////// + // miserable copy (updated to simple test cases) from ant Main class: + // the only available way I found to easily run ant exits jvm at the end + + final Project project = new Project(); + project.setCoreLoader(null); + + Throwable error = null; + + try { + addBuildListeners(project, messageLevel); + addInputHandler(project, null); + + PrintStream err = System.err; + PrintStream out = System.out; + InputStream in = System.in; + + // use a system manager that prevents from System.exit() + SecurityManager oldsm = null; + oldsm = System.getSecurityManager(); + + // SecurityManager can not be installed here for backwards + // compatibility reasons (PD). Needs to be loaded prior to + // ant class if we are going to implement it. + // System.setSecurityManager(new NoExitSecurityManager()); + try { + project.setDefaultInputStream(System.in); + System.setIn(new DemuxInputStream(project)); + System.setOut(new PrintStream(new DemuxOutputStream(project, false))); + System.setErr(new PrintStream(new DemuxOutputStream(project, true))); + + project.fireBuildStarted(); + + project.init(); + project.setUserProperty("ant.version", Main.getAntVersion()); + + project.setUserProperty("ant.file", buildFile.getAbsolutePath()); + + ProjectHelper.configureProject(project, buildFile); + + // make sure that we have a target to execute + if (targets.size() == 0) { + if (project.getDefaultTarget() != null) { + targets.addElement(project.getDefaultTarget()); + } + } + + project.executeTargets(targets); + } finally { + // put back the original security manager + // The following will never eval to true. (PD) + if (oldsm != null) { + System.setSecurityManager(oldsm); + } + + System.setOut(out); + System.setErr(err); + System.setIn(in); + } + } catch (RuntimeException exc) { + error = exc; + throw exc; + } catch (Error err) { + error = err; + throw err; + } finally { + project.fireBuildFinished(error); + } + return project; + } + + /** + * Adds the listeners specified in the command line arguments, along with the default listener, + * to the specified project. + * + * @param project + * The project to add listeners to. Must not be null. + */ + protected void addBuildListeners(Project project, int level) { + + // Add the default listener + project.addBuildListener(createLogger(level)); + + } + + /** + * Creates the InputHandler and adds it to the project. + * + * @param project + * the project instance. + * @param inputHandlerClassname + * @exception BuildException + * if a specified InputHandler implementation could not be loaded. + */ + protected void addInputHandler(Project project, String inputHandlerClassname) + throws BuildException { + InputHandler handler = null; + if (inputHandlerClassname == null) { + handler = new DefaultInputHandler(); + } else { + try { + handler = (InputHandler) (Class.forName(inputHandlerClassname).newInstance()); + if (project != null) { + project.setProjectReference(handler); + } + } catch (ClassCastException e) { + String msg = "The specified input handler class " + inputHandlerClassname + + " does not implement the InputHandler interface"; + throw new BuildException(msg); + } catch (Exception e) { + String msg = "Unable to instantiate specified input handler " + "class " + + inputHandlerClassname + " : " + e.getClass().getName(); + throw new BuildException(msg); + } + } + project.setInputHandler(handler); + } + + // XXX: (Jon Skeet) Any reason for writing a message and then using a bare + // RuntimeException rather than just using a BuildException here? Is it + // in case the message could end up being written to no loggers (as the + // loggers could have failed to be created due to this failure)? + /** + * Creates the default build logger for sending build events to the ant log. + * + * @return the logger instance for this build. + */ + protected BuildLogger createLogger(int level) { + BuildLogger logger = null; + logger = new DefaultLogger(); + + logger.setMessageOutputLevel(level); + logger.setOutputPrintStream(System.out); + logger.setErrorPrintStream(System.err); + + return logger; + } + +} Index: test/java/org/apache/ivy/core/settings/ConfigureTest.java =================================================================== --- test/java/org/apache/ivy/core/settings/ConfigureTest.java (revision 644587) +++ test/java/org/apache/ivy/core/settings/ConfigureTest.java (working copy) @@ -76,4 +76,15 @@ assertEquals("org.apache.ivy.plugins.resolver.CustomResolver", custom.getClass().getName()); } + public void testTypedefWithComplexClasspath() throws Exception { + Ivy ivy = new Ivy(); + ivy.setVariable("ivy.custom.test.dir", new File("test/java/org/apache/ivy/core/settings") + .toString()); + ivy.configure(ConfigureTest.class.getResource("ivysettings-custom-typedef3.xml")); + + DependencyResolver custom = ivy.getSettings().getResolver("custom"); + assertNotNull(custom); + assertEquals("org.apache.ivy.plugins.resolver.ComplexClasspathResolver", custom.getClass().getName()); + } + } Index: test/java/org/apache/ivy/core/settings/custom-resolver-2.jar =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Property changes on: test\java\org\apache\ivy\core\settings\custom-resolver-2.jar ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Index: test/java/org/apache/ivy/core/settings/custom-resolver-3.jar =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Property changes on: test\java\org\apache\ivy\core\settings\custom-resolver-3.jar ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Index: test/java/org/apache/ivy/core/settings/custom-resolver-4.jar =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Property changes on: test\java\org\apache\ivy\core\settings\custom-resolver-4.jar ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Index: test/java/org/apache/ivy/core/settings/IvyClassLoaderManagerImplTest.java =================================================================== --- test/java/org/apache/ivy/core/settings/IvyClassLoaderManagerImplTest.java (revision 0) +++ test/java/org/apache/ivy/core/settings/IvyClassLoaderManagerImplTest.java (revision 0) @@ -0,0 +1,158 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.ivy.core.settings; + +import java.io.File; +import java.net.MalformedURLException; +import java.net.URL; + +import org.apache.ivy.Ivy; + +import junit.framework.TestCase; + +public class IvyClassLoaderManagerImplTest extends TestCase { + + private static final File TEST_JAR_DIR = new File("test/java/org/apache/ivy/core/settings"); + + /** test trivial case without any dynamic classpath additions */ + public void testEmptyLoader() { + IvyClassLoaderManagerImpl loader = new IvyClassLoaderManagerImpl(); + ClassLoader cl = loader.getClassLoader(); + assertNotNull("classloader is defined", cl); + assertSame("core Ivy classloader is used when no classpath entries are found", Ivy.class.getClassLoader(), cl); + } + + /** test addition of URL to the classpath */ + public void testUrl() throws MalformedURLException, ClassNotFoundException { + + IvyClassLoaderManagerImpl loader = new IvyClassLoaderManagerImpl(); + ClassLoader cl = loader.getClassLoader(); + final String className = "org.apache.ivy.plugins.resolver.CustomResolver"; + try { + cl.loadClass(className); + fail("Sanity check: default test classloader must not have " + + "CustomResolver in the classpath for valid testing"); + } catch (ClassNotFoundException expected) { + } + + //now add the jar where we should be able to find the resolver + URL jarUrl = new File(TEST_JAR_DIR, "custom-resolver.jar").toURL(); + loader.addURL(jarUrl); + //new classloader should be returned now. + cl = loader.getClassLoader(); + + Class clazz = cl.loadClass(className); + assertNotNull("resolver class found", clazz); + assertEquals("correct resolver class was loaded", className, clazz.getName()); + } + + /** test a complex expression with URLs, relative paths, and absolute paths */ + public void testPathExpression() throws MalformedURLException, ClassNotFoundException { + String relative = new File(TEST_JAR_DIR, "custom-resolver.jar").getPath(); + String absolute = new File(TEST_JAR_DIR, "custom-resolver-2.jar").getAbsolutePath(); + String url = new File(TEST_JAR_DIR, "custom-resolver-3.jar").toURL().toExternalForm(); + String relative2 = new File(TEST_JAR_DIR, "custom-resolver-4.jar").getPath(); + + //build the path. include a trailing ';' to test handling of + //blank entries + StringBuffer pathExp = new StringBuffer(); + pathExp.append(relative).append(';') + .append(absolute).append(';') + .append(url).append(';') + .append(relative2).append(';'); + + IvyClassLoaderManagerImpl loader = new IvyClassLoaderManagerImpl(';'); + //pass null for the path separator to use the default value of ';' + loader.addPath(pathExp.toString(), null); + ClassLoader cl = loader.getClassLoader(); + + final String className = "org.apache.ivy.plugins.resolver.ComplexClasspathResolver"; + Class clazz = cl.loadClass(className); + assertNotNull("resolver class requiring multiple path entries found", clazz); + assertEquals("correct type was loaded", className, clazz.getName()); + } + + /** complex test case combining path entries of multiple kinds in a single loader */ + public void testMixedPathEntries() throws MalformedURLException, ClassNotFoundException { + String relative = new File(TEST_JAR_DIR, "custom-resolver.jar").getPath(); + String absolute = new File(TEST_JAR_DIR, "custom-resolver-2.jar").getAbsolutePath(); + String relative2 = new File(TEST_JAR_DIR, "custom-resolver-4.jar").getPath(); + URL url = new File(TEST_JAR_DIR, "custom-resolver-3.jar").toURL(); + + IvyClassLoaderManagerImpl loader = new IvyClassLoaderManagerImpl(':'); + //add a path expression with a default path separator. + StringBuffer pathExp = new StringBuffer(); + pathExp.append(relative) + .append(':').append(relative2); + loader.addPath(pathExp.toString(), null); + + //add a URL to the path + loader.addURL(url); + + //add a path expression with a non-default path separator. + pathExp.setLength(0); + pathExp.append("invalid/path/entries/are/ok.jar") + .append('|').append(absolute); + loader.addPath(pathExp.toString(), "|"); + + //now load the test class. all of the classpath entries should be scanned to + //build the requested class. + ClassLoader cl = loader.getClassLoader(); + final String className = "org.apache.ivy.plugins.resolver.ComplexClasspathResolver"; + Class clazz = cl.loadClass(className); + assertNotNull("resolver class requiring multiple path entries found", clazz); + assertEquals("correct type was loaded", className, clazz.getName()); + } + + /** test that paths with drive letters are recognized on MS-style file systems */ + public void testDriveLetterSupport() throws MalformedURLException, ClassNotFoundException { + //we can't write a bullet-proof platform neutral test, so for now + //we have to satisfy ourselves with not creating an error when single-letter + //drive characters appear in a path. + + //we must make sure that the loader can tell the difference + //between a drive letter expression like c:/my/drive/path (since Java + //users frequently use '/' for windows file paths) and a URL expression + //like http://path/to/jar.jar. + + final String driveLetterPath = "c:/foo/bar.jar"; + final String urlPath = new File(TEST_JAR_DIR, "custom-resolver.jar") + .toURL().toExternalForm(); + final String pathExp = driveLetterPath + ';' + urlPath; + + //the ';' should kick us into MS mode. + IvyClassLoaderManagerImpl loader = new IvyClassLoaderManagerImpl(';'); + loader.addPath(pathExp, null); + + final String className = "org.apache.ivy.plugins.resolver.CustomResolver"; + ClassLoader cl = loader.getClassLoader(); + Class clazz = cl.loadClass(className); + assertNotNull("resolver class found", clazz); + assertEquals("correct resolver class was loaded", className, clazz.getName()); + } + + /** Test addPathId() method, which should throw an exception. */ + public void testAddPathId() { + IvyClassLoaderManagerImpl loader = new IvyClassLoaderManagerImpl(); + try { + loader.addPathId("not.supported.yet"); + fail("attempt to add a path reference to the default loader manager should fail"); + } catch (UnsupportedOperationException expected) { + } + } +} Index: test/java/org/apache/ivy/core/settings/ivysettings-custom-typedef3.xml =================================================================== --- test/java/org/apache/ivy/core/settings/ivysettings-custom-typedef3.xml (revision 0) +++ test/java/org/apache/ivy/core/settings/ivysettings-custom-typedef3.xml (revision 0) @@ -0,0 +1,30 @@ + + + + + + + + + + + + +