From 68b83a8f0023c453e319bca1863d978349323f8b Mon Sep 17 00:00:00 2001
From: Andy Wilkinson <awilkinson@pivotal.io>
Date: Thu, 31 Mar 2016 10:33:03 +0100
Subject: [PATCH] Improve handling of loader.path in PropertiesLauncher
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Previously, if loader.path directly specified a jar file that contained
nested archives (.zip or .jar), launching would fail unless those
nested archives were uncompressed. However, if loader.path specified a
directory that contained such a jar file the launch would succeed. This
was because the nested archives within the jar were ignored.

This commit updates PropertiesLauncher so that its behaviour in the
scenarios described above is consistent by not looking for archives
nested with a jar that’s be specified on loader.path. The javadoc for
loader.path has also been updated to make it clear that loader.path
can points to directories or jar files, bringing it into line with
the reference guide.

Closes gh-3701
---
 .../boot/loader/PropertiesLauncher.java       | 26 ++++++++++++-------
 .../boot/loader/PropertiesLauncherTests.java  | 19 ++++++++++++++
 2 files changed, 35 insertions(+), 10 deletions(-)

diff --git a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java
index 5607a4048d2..ab5a0322c79 100644
--- a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java
+++ b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java
@@ -55,9 +55,10 @@ import org.springframework.boot.loader.util.SystemPropertyUtils;
  * extracts optional values (which can also be provided overridden as System properties in
  * case the file doesn't exist):
  * <ul>
- * <li>{@code loader.path}: a comma-separated list of directories to append to the
- * classpath (containing file resources and/or nested archives in *.jar or *.zip).
- * Defaults to {@code BOOT-INF/classes,BOOT-INF/lib} in your application archive</li>
+ * <li>{@code loader.path}: a comma-separated list of directories (containing file
+ * resources and/or nested archives in *.jar or *.zip or archives) or archives to append
+ * to the classpath. {@code BOOT-INF/classes,BOOT-INF/lib} in the application archive are
+ * always used</li>
  * <li>{@code loader.main}: the main method to delegate execution to once the class loader
  * is set up. No default, but will fall back to looking for a {@code Start-Class} in a
  * {@code MANIFEST.MF}, if there is one in <code>${loader.home}/META-INF</code>.</li>
@@ -78,9 +79,9 @@ public class PropertiesLauncher extends Launcher {
 	public static final String MAIN = "loader.main";
 
 	/**
-	 * Properties key for classpath entries (directories possibly containing jars).
-	 * Defaults to "lib/" (relative to {@link #HOME loader home directory}). Multiple
-	 * entries can be specified using a comma-separated list.
+	 * Properties key for classpath entries (directories possibly containing jars or
+	 * jars). Multiple entries can be specified using a comma-separated list. {@code
+	 * BOOT-INF/classes,BOOT-INF/lib} in the application archive are always used.
 	 */
 	public static final String PATH = "loader.path";
 
@@ -407,10 +408,15 @@ public class PropertiesLauncher extends Launcher {
 		List<Archive> lib = new ArrayList<Archive>();
 		for (String path : this.paths) {
 			for (Archive archive : getClassPathArchives(path)) {
-				List<Archive> nested = new ArrayList<Archive>(
-						archive.getNestedArchives(new ArchiveEntryFilter()));
-				nested.add(0, archive);
-				lib.addAll(nested);
+				if (archive instanceof ExplodedArchive) {
+					List<Archive> nested = new ArrayList<Archive>(
+							archive.getNestedArchives(new ArchiveEntryFilter()));
+					nested.add(0, archive);
+					lib.addAll(nested);
+				}
+				else {
+					lib.add(archive);
+				}
 			}
 		}
 		addNestedEntries(lib);
diff --git a/spring-boot-tools/spring-boot-loader/src/test/java/org/springframework/boot/loader/PropertiesLauncherTests.java b/spring-boot-tools/spring-boot-loader/src/test/java/org/springframework/boot/loader/PropertiesLauncherTests.java
index a1e81d0d956..9f29293a108 100644
--- a/spring-boot-tools/spring-boot-loader/src/test/java/org/springframework/boot/loader/PropertiesLauncherTests.java
+++ b/spring-boot-tools/spring-boot-loader/src/test/java/org/springframework/boot/loader/PropertiesLauncherTests.java
@@ -115,6 +115,25 @@ public class PropertiesLauncherTests {
 		waitFor("Hello World");
 	}
 
+	@Test
+	public void testUserSpecifiedJarFileWithNestedArchives() throws Exception {
+		System.setProperty("loader.path", "nested-jars/app.jar");
+		System.setProperty("loader.main", "demo.Application");
+		PropertiesLauncher launcher = new PropertiesLauncher();
+		launcher.launch(new String[0]);
+		waitFor("Hello World");
+	}
+
+	@Test
+	public void testUserSpecifiedDirectoryContainingJarFileWithNestedArchives()
+			throws Exception {
+		System.setProperty("loader.path", "nested-jars");
+		System.setProperty("loader.main", "demo.Application");
+		PropertiesLauncher launcher = new PropertiesLauncher();
+		launcher.launch(new String[0]);
+		waitFor("Hello World");
+	}
+
 	@Test
 	public void testUserSpecifiedJarPathWithDot() throws Exception {
 		System.setProperty("loader.path", "./jars/app.jar");