Carefully add nested archives from JAR in PropertiesLauncher

If user runs an executable archive then it and its lib directory will be
on the classpath. Entries from loader.path take precedence in a way that
should make sense to users (earlier wins like in CLASSPATH env var).

Also added new integration tests to verify the behaviour (big improvement
on the old ones, which probably aought to be beefed up to the same
standard).

Fixes spring-projectsgh-2314

spring-boot-docs/src/main/asciidoc/appendix-executable-jar-format.adoc

@@ -142,7 +142,7 @@ Their purpose is to load resources (`.class` files etc.) from nested jar files o
 files in directories (as opposed to explicitly on the classpath). In the case of the
 `[Jar|War]Launcher` the nested paths are fixed (`+lib/*.jar+` and `+lib-provided/*.jar+` for
 the war case) so you just add extra jars in those locations if you want more. The
-`PropertiesLauncher` looks in `lib/` by default, but you can add additional locations by
+`PropertiesLauncher` looks in `lib/` in your application archive by default, but you can add additional locations by
 setting an environment variable `LOADER_PATH` or `loader.path` in `application.properties`
 (comma-separated list of directories or archives).
 

spring-boot-tools/spring-boot-loader/pom.xml

@@ -30,6 +30,11 @@
 			<artifactId>logback-classic</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-webmvc</artifactId>
+			<scope>test</scope>
+		</dependency>
 		<!-- Used to provide a signed jar -->
 		<dependency>
 			<groupId>org.bouncycastle</groupId>
@@ -57,6 +62,7 @@
 							<addTestClassPath>true</addTestClassPath>
 							<skipInvocation>${skipTests}</skipInvocation>
 							<streamLogs>true</streamLogs>
+							<parallelThreads>4</parallelThreads>
 						</configuration>
 						<executions>
 							<execution>

spring-boot-tools/spring-boot-loader/src/it/executable-props/pom.xml

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<groupId>org.springframework.boot.launcher.it</groupId>
+	<artifactId>executable-props</artifactId>
+	<version>0.0.1.BUILD-SNAPSHOT</version>
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+	</properties>
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<version>3.1</version>
+				<configuration>
+					<source>1.6</source>
+					<target>1.6</target>
+				</configuration>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-dependency-plugin</artifactId>
+				<version>2.9</version>
+				<executions>
+					<execution>
+						<id>unpack</id>
+						<phase>prepare-package</phase>
+						<goals>
+							<goal>unpack</goal>
+						</goals>
+						<configuration>
+							<artifactItems>
+								<artifactItem>
+									<groupId>@project.groupId@</groupId>
+									<artifactId>@project.artifactId@</artifactId>
+									<version>@project.version@</version>
+									<type>jar</type>
+								</artifactItem>
+							</artifactItems>
+							<outputDirectory>${project.build.directory}/assembly</outputDirectory>
+						</configuration>
+					</execution>
+					<execution>
+						<id>copy</id>
+						<phase>prepare-package</phase>
+						<goals>
+							<goal>copy-dependencies</goal>
+						</goals>
+						<configuration>
+							<outputDirectory>${project.build.directory}/assembly/lib</outputDirectory>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<artifactId>maven-assembly-plugin</artifactId>
+				<version>2.4</version>
+				<configuration>
+					<descriptors>
+						<descriptor>src/main/assembly/jar-with-dependencies.xml</descriptor>
+					</descriptors>
+					<archive>
+						<manifest>
+							<mainClass>org.springframework.boot.loader.PropertiesLauncher</mainClass>
+						</manifest>
+						<manifestEntries>
+							<Start-Class>org.springframework.boot.load.it.props.EmbeddedJarStarter</Start-Class>
+						</manifestEntries>
+					</archive>
+				</configuration>
+				<executions>
+					<execution>
+						<id>jar-with-dependencies</id>
+						<phase>package</phase>
+						<goals>
+							<goal>single</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+		</plugins>
+	</build>
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-context</artifactId>
+			<version>4.1.4.RELEASE</version>
+		</dependency>
+	</dependencies>
+</project>

spring-boot-tools/spring-boot-loader/src/it/executable-props/src/main/assembly/jar-with-dependencies.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<assembly
+	xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
+	<id>full</id>
+	<formats>
+		<format>jar</format>
+	</formats>
+	<includeBaseDirectory>false</includeBaseDirectory>
+	<dependencySets>
+		<dependencySet>
+			<useProjectArtifact/>
+			<includes>
+				<include>${project.groupId}:${project.artifactId}</include>
+			</includes>
+			<unpack>true</unpack>
+		</dependencySet>
+	</dependencySets>
+	<fileSets>
+		<fileSet>
+			<directory>${project.build.directory}/assembly</directory>
+			<outputDirectory>/</outputDirectory>
+		</fileSet>
+	</fileSets>
+</assembly>

spring-boot-tools/spring-boot-loader/src/it/executable-props/src/main/java/org/springframework/launcher/it/props/EmbeddedJarStarter.java

@@ -0,0 +1,33 @@
+/*
+ * 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.load.it.props;
+
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+
+/**
+ * Main class to start the embedded server.
+ *
+ * @author Phillip Webb
+ */
+public final class EmbeddedJarStarter {
+
+	public static void main(String[] args) throws Exception {
+		AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringConfiguration.class);
+		context.getBean(SpringConfiguration.class).run(args);
+		context.close();
+	}
+}

spring-boot-tools/spring-boot-loader/src/it/executable-props/src/main/java/org/springframework/launcher/it/props/SpringConfiguration.java

@@ -0,0 +1,53 @@
+/*
+ * 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.load.it.props;
+
+import java.io.IOException;
+
+import javax.annotation.PostConstruct;
+
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.io.support.PropertiesLoaderUtils;
+
+/**
+ * Spring configuration.
+ *
+ * @author Phillip Webb
+ */
+@Configuration
+@ComponentScan
+public class SpringConfiguration {
+
+	private String message = "Jar";
+
+	@PostConstruct
+	public void init() throws IOException {
+		String value = PropertiesLoaderUtils.loadAllProperties("application.properties").getProperty("message");
+		if (value!=null) {
+			this.message = value; 
+		}
+
+	}
+
+	public void run(String... args) {
+		System.err.println("Hello Embedded " + this.message + "!");
+	}
+
+
+
+}

spring-boot-tools/spring-boot-loader/src/it/executable-props/src/main/resources/application.properties

@@ -0,0 +1 @@
+message: World

spring-boot-tools/spring-boot-loader/src/it/executable-props/verify.groovy

@@ -0,0 +1,32 @@
+def jarfile = './target/executable-props-0.0.1.BUILD-SNAPSHOT-full.jar'
+
+new File("${basedir}/application.properties").delete()
+
+String exec(String command) {
+	def proc = command.execute([], basedir)
+	proc.waitFor()
+	proc.err.text
+}
+
+String out = exec("java -jar ${jarfile}")
+assert out.contains('Hello Embedded World!'),
+	'Using -jar my.jar should use the application.properties from the jar\n' + out
+
+out = exec("java -cp ${jarfile} org.springframework.boot.loader.PropertiesLauncher")
+assert out.contains('Hello Embedded World!'),
+	'Using -cp my.jar with PropertiesLauncher should use the application.properties from the jar\n' + out
+
+new File("${basedir}/application.properties").withWriter { it -> it << "message: Foo" }
+out = exec("java -jar ${jarfile}")
+assert out.contains('Hello Embedded World!'),
+	'Should use the application.properties from the jar in preference to local filesystem\n' + out
+
+out = exec("java -Dloader.path=.,lib -jar ${jarfile}")
+assert out.contains('Hello Embedded Foo!'),
+	'With loader.path=.,lib should use the application.properties from the local filesystem\n' + out
+
+new File("${basedir}/target/application.properties").withWriter { it -> it << "message: Spam" }
+
+out = exec("java -Dloader.path=target,.,lib -jar ${jarfile}")
+assert out.contains('Hello Embedded Spam!'),
+	'With loader.path=target,.,lib should use the application.properties from the target directory\n' + out