Isolate Aether in a separate class loader

Prior to this commit, the Aether-based GrapeEngine was loaded in the
same class loader as the rest of Boot. This led to Aether's and its
dependencies' types polluting the application's class path. Most
notably, this caused problems with logging as the logging framework
could be permaturely initialized.

This commit isolates AetherGrapeEngine, Aether and its dependencies
into a separate class loader. This is done by customizing the
packaging of the CLI's jar file with the internal directory housing
all of the types that will be loaded by the separate class loader.

spring-boot-cli/src/main/assembly/bin-package.xml

@@ -23,13 +23,11 @@
 			<directoryMode>755</directoryMode>
 		</fileSet>
 	</fileSets>
-	<dependencySets>
-		<dependencySet>
-			<includes>
-				<include>org.springframework.boot:spring-boot-cli:jar:*</include>
-			</includes>
-			<outputDirectory>lib</outputDirectory>
-			<directoryMode>755</directoryMode>
-		</dependencySet>
-	</dependencySets>
+	<files>
+		<file>
+			<source>${project.build.directory}/${project.artifactId}-${project.version}-repackaged.jar</source>
+			<outputDirectory>/lib</outputDirectory>
+			<destName>${project.build.finalName}.jar</destName>
+		</file>
+	</files>
 </assembly>

spring-boot-cli/src/main/assembly/repackage-jar.xml

@@ -0,0 +1,25 @@
+<assembly>
+	<id>repackaged</id>
+	<formats>
+		<format>jar</format>
+	</formats>
+	<includeBaseDirectory>false</includeBaseDirectory>
+	<dependencySets>
+		<dependencySet>
+			<includes>
+				<include>org.springframework.boot:spring-boot-cli:jar:*</include>
+			</includes>
+			<unpack>true</unpack>
+			<directoryMode>755</directoryMode>
+		</dependencySet>
+		<dependencySet>
+			<includes>
+				<include>org.springframework.boot:spring-boot-cli-grape:jar:*</include>
+			</includes>
+			<outputDirectory>internal</outputDirectory>
+			<directoryMode>755</directoryMode>
+			<scope>provided</scope>
+			<unpack>true</unpack>
+		</dependencySet>
+	</dependencySets>
+</assembly>

spring-boot-cli/src/main/java/org/springframework/boot/cli/command/tester/AbstractTester.java

@@ -1,42 +0,0 @@
-/*
- * Copyright 2012-2013 the original author or authors.
- *
- * Licensed 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.springframework.boot.cli.command.tester;
-
-import java.io.FileNotFoundException;
-import java.util.List;
-import java.util.Set;
-
-/**
- * Abstract base class for tester implementations.
- * 
- * @author Greg Turnquist
- */
-public abstract class AbstractTester {
-
-	public TestResults findAndTest(List<Class<?>> compiled) throws FileNotFoundException {
-		Set<Class<?>> testable = findTestableClasses(compiled);
-		if (testable.size() == 0) {
-			return TestResults.NONE;
-		}
-		return test(testable.toArray(new Class<?>[] {}));
-	}
-
-	protected abstract Set<Class<?>> findTestableClasses(List<Class<?>> compiled);
-
-	protected abstract TestResults test(Class<?>[] testable);
-
-}

spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/AetherGrapeEngine.java

@@ -1,326 +0,0 @@
-/*
- * Copyright 2012-2013 the original author or authors.
- *
- * Licensed 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.springframework.boot.cli.compiler;
-
-import groovy.grape.GrapeEngine;
-
-import java.io.File;
-import java.net.MalformedURLException;
-import java.net.URI;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Map;
-import java.util.concurrent.TimeUnit;
-
-import org.apache.maven.repository.internal.MavenRepositorySystemUtils;
-import org.eclipse.aether.AbstractRepositoryListener;
-import org.eclipse.aether.DefaultRepositorySystemSession;
-import org.eclipse.aether.RepositoryEvent;
-import org.eclipse.aether.RepositorySystem;
-import org.eclipse.aether.RepositorySystemSession;
-import org.eclipse.aether.artifact.Artifact;
-import org.eclipse.aether.artifact.DefaultArtifact;
-import org.eclipse.aether.collection.CollectRequest;
-import org.eclipse.aether.connector.basic.BasicRepositoryConnectorFactory;
-import org.eclipse.aether.graph.Dependency;
-import org.eclipse.aether.impl.ArtifactDescriptorReader;
-import org.eclipse.aether.impl.DefaultServiceLocator;
-import org.eclipse.aether.internal.impl.DefaultRepositorySystem;
-import org.eclipse.aether.repository.LocalRepository;
-import org.eclipse.aether.repository.RemoteRepository;
-import org.eclipse.aether.resolution.ArtifactDescriptorException;
-import org.eclipse.aether.resolution.ArtifactDescriptorRequest;
-import org.eclipse.aether.resolution.ArtifactDescriptorResult;
-import org.eclipse.aether.resolution.ArtifactResolutionException;
-import org.eclipse.aether.resolution.ArtifactResult;
-import org.eclipse.aether.resolution.DependencyRequest;
-import org.eclipse.aether.resolution.DependencyResult;
-import org.eclipse.aether.spi.connector.RepositoryConnectorFactory;
-import org.eclipse.aether.spi.connector.transport.TransporterFactory;
-import org.eclipse.aether.spi.log.Logger;
-import org.eclipse.aether.spi.log.LoggerFactory;
-import org.eclipse.aether.transfer.AbstractTransferListener;
-import org.eclipse.aether.transfer.TransferCancelledException;
-import org.eclipse.aether.transfer.TransferEvent;
-import org.eclipse.aether.transport.file.FileTransporterFactory;
-import org.eclipse.aether.transport.http.HttpTransporterFactory;
-import org.eclipse.aether.util.artifact.JavaScopes;
-import org.eclipse.aether.util.filter.DependencyFilterUtils;
-
-/**
- * A {@link GrapeEngine} implementation that uses <a
- * href="http://eclipse.org/aether">Aether</a>, the dependency resolution system used by
- * Maven.
- * 
- * @author Andy Wilkinson
- */
-@SuppressWarnings("rawtypes")
-public class AetherGrapeEngine implements GrapeEngine {
-
-	private static final String DEPENDENCY_MODULE = "module";
-
-	private static final String DEPENDENCY_GROUP = "group";
-
-	private static final String DEPENDENCY_VERSION = "version";
-
-	private final ProgressReporter progressReporter = new ProgressReporter();
-
-	private final ArtifactCoordinatesResolver artifactCoordinatesResolver;
-
-	private final ArtifactDescriptorReader artifactDescriptorReader;
-
-	private final ExtendedGroovyClassLoader defaultClassLoader;
-
-	private final RepositorySystemSession repositorySystemSession;
-
-	private final RepositorySystem repositorySystem;
-
-	private final List<RemoteRepository> repositories;
-
-	public AetherGrapeEngine(ExtendedGroovyClassLoader classLoader,
-			ArtifactCoordinatesResolver artifactCoordinatesResolver) {
-		this.defaultClassLoader = classLoader;
-		this.artifactCoordinatesResolver = artifactCoordinatesResolver;
-
-		DefaultServiceLocator mavenServiceLocator = MavenRepositorySystemUtils
-				.newServiceLocator();
-		mavenServiceLocator.setService(LoggerFactory.class, NopLoggerFactory.class);
-		mavenServiceLocator.addService(RepositorySystem.class,
-				DefaultRepositorySystem.class);
-
-		mavenServiceLocator.addService(RepositoryConnectorFactory.class,
-				BasicRepositoryConnectorFactory.class);
-
-		mavenServiceLocator.addService(TransporterFactory.class,
-				HttpTransporterFactory.class);
-		mavenServiceLocator.addService(TransporterFactory.class,
-				FileTransporterFactory.class);
-
-		this.repositorySystem = mavenServiceLocator.getService(RepositorySystem.class);
-
-		DefaultRepositorySystemSession repositorySystemSession = MavenRepositorySystemUtils
-				.newSession();
-		repositorySystemSession.setTransferListener(new AbstractTransferListener() {
-
-			@Override
-			public void transferStarted(TransferEvent event)
-					throws TransferCancelledException {
-				AetherGrapeEngine.this.progressReporter.reportProgress();
-			}
-
-			@Override
-			public void transferProgressed(TransferEvent event)
-					throws TransferCancelledException {
-				AetherGrapeEngine.this.progressReporter.reportProgress();
-			}
-		});
-
-		repositorySystemSession.setRepositoryListener(new AbstractRepositoryListener() {
-			@Override
-			public void artifactResolved(RepositoryEvent event) {
-				AetherGrapeEngine.this.progressReporter.reportProgress();
-			}
-		});
-
-		LocalRepository localRepo = new LocalRepository(new File(
-				System.getProperty("user.home"), ".m2/repository"));
-		repositorySystemSession.setLocalRepositoryManager(this.repositorySystem
-				.newLocalRepositoryManager(repositorySystemSession, localRepo));
-
-		this.repositorySystemSession = repositorySystemSession;
-
-		this.repositories = Arrays.asList(new RemoteRepository.Builder("central",
-				"default", "http://repo1.maven.org/maven2/").build(),
-				new RemoteRepository.Builder("spring-snapshot", "default",
-						"http://repo.spring.io/snapshot").build(),
-				new RemoteRepository.Builder("spring-milestone", "default",
-						"http://repo.spring.io/milestone").build());
-
-		this.artifactDescriptorReader = mavenServiceLocator
-				.getService(ArtifactDescriptorReader.class);
-	}
-
-	@Override
-	public Object grab(Map args) {
-		return grab(args, args);
-	}
-
-	@Override
-	public Object grab(Map args, Map... dependencyMaps) {
-		List<Dependency> dependencies = createDependencies(dependencyMaps);
-
-		try {
-			List<File> files = resolve(dependencies);
-			ExtendedGroovyClassLoader classLoader = (ExtendedGroovyClassLoader) args
-					.get("classLoader");
-			if (classLoader == null) {
-				classLoader = this.defaultClassLoader;
-			}
-			for (File file : files) {
-				classLoader.addURL(file.toURI().toURL());
-			}
-		}
-		catch (ArtifactResolutionException ex) {
-			throw new DependencyResolutionFailedException(ex);
-		}
-		catch (MalformedURLException ex) {
-			throw new DependencyResolutionFailedException(ex);
-		}
-		return null;
-	}
-
-	private List<Dependency> createDependencies(Map<?, ?>... dependencyMaps) {
-		List<Dependency> dependencies = new ArrayList<Dependency>(dependencyMaps.length);
-		for (Map<?, ?> dependencyMap : dependencyMaps) {
-			dependencies.add(createDependency(dependencyMap));
-		}
-		return dependencies;
-	}
-
-	private Dependency createDependency(Map<?, ?> dependencyMap) {
-		String group = (String) dependencyMap.get(DEPENDENCY_GROUP);
-		String module = (String) dependencyMap.get(DEPENDENCY_MODULE);
-		String version = (String) dependencyMap.get(DEPENDENCY_VERSION);
-
-		// TODO Transitivity
-
-		Artifact artifact = new DefaultArtifact(group, module, "jar", version);
-		return new Dependency(artifact, JavaScopes.COMPILE);
-	}
-
-	private List<File> resolve(List<Dependency> dependencies)
-			throws ArtifactResolutionException {
-
-		CollectRequest collectRequest = new CollectRequest((Dependency) null,
-				dependencies, this.repositories);
-		collectRequest.setManagedDependencies(getManagedDependencies());
-
-		try {
-			DependencyResult dependencyResult = this.repositorySystem
-					.resolveDependencies(
-							this.repositorySystemSession,
-							new DependencyRequest(collectRequest, DependencyFilterUtils
-									.classpathFilter(JavaScopes.COMPILE)));
-			List<File> files = new ArrayList<File>();
-			for (ArtifactResult result : dependencyResult.getArtifactResults()) {
-				files.add(result.getArtifact().getFile());
-			}
-
-			return files;
-		}
-		catch (Exception ex) {
-			throw new DependencyResolutionFailedException(ex);
-		}
-		finally {
-			this.progressReporter.finished();
-		}
-	}
-
-	private List<Dependency> getManagedDependencies() {
-		ArtifactDescriptorRequest parentRequest = new ArtifactDescriptorRequest();
-		Artifact parentArtifact = new DefaultArtifact("org.springframework.boot",
-				"spring-boot-starter-parent", "pom",
-				this.artifactCoordinatesResolver.getVersion("spring-boot"));
-		parentRequest.setArtifact(parentArtifact);
-
-		try {
-			ArtifactDescriptorResult artifactDescriptorResult = this.artifactDescriptorReader
-					.readArtifactDescriptor(this.repositorySystemSession, parentRequest);
-			return artifactDescriptorResult.getManagedDependencies();
-		}
-		catch (ArtifactDescriptorException ex) {
-			throw new DependencyResolutionFailedException(ex);
-		}
-	}
-
-	@Override
-	public Map<String, Map<String, List<String>>> enumerateGrapes() {
-		throw new UnsupportedOperationException();
-	}
-
-	@Override
-	public URI[] resolve(Map args, Map... dependencies) {
-		throw new UnsupportedOperationException();
-	}
-
-	@Override
-	public URI[] resolve(Map args, List depsInfo, Map... dependencies) {
-		throw new UnsupportedOperationException();
-	}
-
-	@Override
-	public Map[] listDependencies(ClassLoader classLoader) {
-		throw new UnsupportedOperationException();
-	}
-
-	@Override
-	public void addResolver(Map<String, Object> args) {
-		throw new UnsupportedOperationException();
-	}
-
-	@Override
-	public Object grab(String endorsedModule) {
-		throw new UnsupportedOperationException("Auto-generated method stub");
-	}
-
-	private static final class NopLoggerFactory implements LoggerFactory {
-
-		@Override
-		public Logger getLogger(String name) {
-			// TODO Something more robust; I'm surprised this doesn't NPE
-			return null;
-		}
-	}
-
-	private static final class ProgressReporter {
-
-		private static final long INITIAL_DELAY = TimeUnit.SECONDS.toMillis(3);
-
-		private static final long PROGRESS_DELAY = TimeUnit.SECONDS.toMillis(1);
-
-		private long startTime = System.currentTimeMillis();
-
-		private long lastProgressTime = System.currentTimeMillis();
-
-		private boolean started;
-
-		private boolean finished;
-
-		void reportProgress() {
-			if (!this.finished
-					&& System.currentTimeMillis() - this.startTime > INITIAL_DELAY) {
-				if (!this.started) {
-					this.started = true;
-					System.out.print("Resolving dependencies..");
-					this.lastProgressTime = System.currentTimeMillis();
-				}
-				else if (System.currentTimeMillis() - this.lastProgressTime > PROGRESS_DELAY) {
-					System.out.print(".");
-					this.lastProgressTime = System.currentTimeMillis();
-				}
-			}
-		}
-
-		void finished() {
-			if (this.started && !this.finished) {
-				this.finished = true;
-				System.out.println("");
-			}
-		}
-	}
-}

spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/DependencyResolutionFailedException.java

@@ -1,34 +0,0 @@
-/*
- * Copyright 2012-2013 the original author or authors.
- *
- * Licensed 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.springframework.boot.cli.compiler;
-
-/**
- * Thrown to indicate a failure during dependency resolution.
- * @author Andy Wilkinson
- */
-public class DependencyResolutionFailedException extends RuntimeException {
-
-	/**
-	 * Creates a new {@code DependencyResolutionFailedException} with the given
-	 * {@code cause}.
-	 * @param cause The cause of the resolution failure
-	 */
-	public DependencyResolutionFailedException(Throwable cause) {
-		super(cause);
-	}
-
-}

spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/GroovyCompiler.java

@@ -16,13 +16,17 @@
 
 package org.springframework.boot.cli.compiler;
 
+import groovy.grape.GrapeEngine;
 import groovy.lang.Grab;
 import groovy.lang.GroovyClassLoader;
 import groovy.lang.GroovyClassLoader.ClassCollector;
 
 import java.io.File;
 import java.io.IOException;
+import java.lang.reflect.Constructor;
 import java.lang.reflect.Field;
+import java.net.URL;
+import java.net.URLClassLoader;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.LinkedList;
@@ -70,6 +74,9 @@ import org.codehaus.groovy.transform.ASTTransformationVisitor;
  */
 public class GroovyCompiler {
 
+	private static final ClassLoader AETHER_CLASS_LOADER = new URLClassLoader(
+			new URL[] { GroovyCompiler.class.getResource("/internal/") });
+
 	private GroovyCompilerConfiguration configuration;
 
 	private ExtendedGroovyClassLoader loader;
@@ -84,6 +91,7 @@ public class GroovyCompiler {
 	 * Create a new {@link GroovyCompiler} instance.
 	 * @param configuration the compiler configuration
 	 */
+	@SuppressWarnings("unchecked")
 	public GroovyCompiler(final GroovyCompilerConfiguration configuration) {
 		this.configuration = configuration;
 		CompilerConfiguration compilerConfiguration = new CompilerConfiguration();
@@ -95,8 +103,20 @@ public class GroovyCompiler {
 		this.artifactCoordinatesResolver = new PropertiesArtifactCoordinatesResolver(
 				this.loader);
 
-		new GrapeEngineInstaller(new AetherGrapeEngine(this.loader,
-				this.artifactCoordinatesResolver)).install();
+		try {
+			Class<GrapeEngine> grapeEngineClass = (Class<GrapeEngine>) AETHER_CLASS_LOADER
+					.loadClass("org.springframework.boot.cli.compiler.AetherGrapeEngine");
+			Constructor<GrapeEngine> constructor = grapeEngineClass.getConstructor(
+					GroovyClassLoader.class, String.class, String.class, String.class);
+			GrapeEngine grapeEngine = constructor.newInstance(this.loader,
+					"org.springframework.boot", "spring-boot-starter-parent",
+					this.artifactCoordinatesResolver.getVersion("spring-boot"));
+
+			new GrapeEngineInstaller(grapeEngine).install();
+		}
+		catch (Exception ex) {
+			throw new IllegalStateException("Failed to install custom GrapeEngine", ex);
+		}
 
 		compilerConfiguration
 				.addCompilationCustomizers(new CompilerAutoConfigureCustomizer());

spring-boot-cli/src/main/resources/org/springframework/boot/git.properties

@@ -0,0 +1,13 @@
+#Generated by Git-Commit-Id-Plugin
+#Tue Oct 22 10:25:04 BST 2013
+git.commit.id.abbrev=040321b
+git.commit.user.email=awilkinson@gopivotal.com
+git.commit.message.full=Isolate Aether in a separate class loader\n\nPrior to this commit, the Aether-based GrapeEngine was loaded in the\nsame class loader as the rest of Boot. This led to Aether's and its\ndependencies' types polluting the application's class path. Most\nnotably, this caused problems with logging as the logging framework\ncould be permaturely initialized.\n\nThis commit isolates AetherGrapeEngine, Aether and its dependencies\ninto a separate class loader. This is done by customizing the\npackaging of the CLI's jar file with the internal directory housing\nall of the types that will be loaded by the separate class loader.\n
+git.commit.id=040321bf153db007290786623d45903cee27fa88
+git.commit.message.short=Isolate Aether in a separate class loader
+git.commit.user.name=Andy Wilkinson
+git.build.user.name=Andy Wilkinson
+git.build.user.email=awilkinson@gopivotal.com
+git.branch=aether-grab
+git.commit.time=2013-10-21T16\:24\:40+0100
+git.build.time=2013-10-22T10\:25\:04+0100