Add integration tests for default launch script

This commit adds a suit of integration tests for the launch script. See
the accompanying README.adoc for further details.

Closes gh-4872

spring-boot-integration-tests/pom.xml

@@ -19,9 +19,11 @@
 	<properties>
 		<main.basedir>${basedir}/..</main.basedir>
 		<java.version>1.8</java.version>
+		<jackson.version>2.1.2</jackson.version> <!-- Align with docker-java -->
 	</properties>
 	<modules>
 		<module>spring-boot-gradle-tests</module>
+		<module>spring-boot-launch-script-tests</module>
 		<module>spring-boot-security-tests</module>
 	</modules>
 	<profiles>

spring-boot-integration-tests/spring-boot-launch-script-tests/README.adoc

+= Spring Boot Launch Script Tests
+
+This module contains integration tests for the default launch script that is used
+to make a jar file fully executable on Linux. The tests use Docker to verify the
+functionality in a variety of Linux distributions.
+
+== Setting up Docker
+
+The setup that's required varies depending on your operating system.
+
+=== Docker on OS X
+
+Docker relies on Linux kernel features so the Docker Daemon must be run inside a Linux VM.
+Following the https://docs.docker.com/engine/installation/mac/[OS X installation
+instructions] to install Docker Toolbox which uses VirtualBox to host the required VM.
+
+=== Docker on Linux
+
+Install Docker as appropriate for your Linux distribution. See the
+https://docs.docker.com/engine/installation/[Linux installation instructions] for more
+information.
+
+Next, add your user to the `docker` group. For example:
+
+----
+$ sudo usermod -a -G docker awilkinson
+----
+
+You may need to log out and back in again for this change to take affect and for your
+user to be able to connect to the daemon.
+
+== Preparing to run the tests
+
+Before running the tests, you must prepare your environment according to your operating
+system.
+
+=== Preparation on OS X
+
+The tests must be run in an environment where various environment variables including
+`DOCKER_HOST` and `DOCKER_CERT_PATH` have been set:
+
+----
+$ eval $(docker-machine env default)
+----
+
+=== Preparation on Linux
+
+Docker Daemon's default configuration on Linux uses a Unix socket for communication.
+However, Docker's Java client uses HTTP by default. Docker Java's client can be configured
+to use the Unix socket via the `DOCKER_URL` environment variable:
+
+----
+$ export DOCKER_URL=unix:///var/run/docker.sock
+----
+
+== Running the tests
+
+You're now ready to run the tests. Assuming that you're in the same directory as this
+README, the tests can be launched as follows:
+
+----
+$ mvn -Pdocker clean verify
+----
+
+The first time the tests are run, Docker will create the container images that are used to
+run the tests. This can take several minutes, particularly if you have a slow network
+connection. Subsequent runs will be faster as the images are cached locally. You can run
+`docker images` to see a list of the cached images.
+
+== Cleaning up
+
+If you want to reclaim the disk space used by the cached images (at the expense of having
+to wait for them to be downloaded and rebuilt the next time you run the tests), you can
+use `docker images` to list the images and `docker rmi <image>` to delete them. See
+`docker rmi --help` for further details.
\ No newline at end of file

spring-boot-integration-tests/spring-boot-launch-script-tests/pom.xml

+<?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>
+	<parent>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-integration-tests</artifactId>
+		<version>1.3.2.BUILD-SNAPSHOT</version>
+	</parent>
+	<artifactId>spring-boot-launch-script-tests</artifactId>
+	<packaging>jar</packaging>
+	<name>Spring Boot Launch Script Integration Tests</name>
+	<description>Spring Boot Launch Script Integration Tests</description>
+	<url>http://projects.spring.io/spring-boot/</url>
+	<organization>
+		<name>Pivotal Software, Inc.</name>
+		<url>http://www.spring.io</url>
+	</organization>
+	<properties>
+		<main.basedir>${basedir}/../..</main.basedir>
+	</properties>
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>org.springframework.boot</groupId>
+					<artifactId>spring-boot-starter-tomcat</artifactId>
+				</exclusion>
+			</exclusions>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-undertow</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>com.github.docker-java</groupId>
+			<artifactId>docker-java</artifactId>
+			<version>2.1.4</version>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+	<profiles>
+		<profile>
+			<id>docker</id>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.springframework.boot</groupId>
+						<artifactId>spring-boot-maven-plugin</artifactId>
+						<configuration>
+							<executable>true</executable>
+						</configuration>
+						<executions>
+							<execution>
+								<goals>
+									<goal>repackage</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-failsafe-plugin</artifactId>
+						<executions>
+							<execution>
+								<goals>
+									<goal>integration-test</goal>
+									<goal>verify</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+	</profiles>
+</project>

spring-boot-integration-tests/spring-boot-launch-script-tests/src/main/java/org/springframework/boot/launchscript/LaunchScriptTestApplication.java

+/*
+ * Copyright 2012-2016 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.launchscript;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class LaunchScriptTestApplication {
+
+	public static void main(String[] args) {
+		SpringApplication.run(LaunchScriptTestApplication.class, args);
+	}
+
+}

spring-boot-integration-tests/spring-boot-launch-script-tests/src/main/java/org/springframework/boot/launchscript/LaunchVerficationController.java

+/*
+ * Copyright 2012-2016 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.launchscript;
+
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class LaunchVerficationController {
+
+	@RequestMapping("/")
+	public String verifyLaunch() {
+		return "Launched";
+	}
+
+}

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/conf/CentOS/5.11/Dockerfile

+FROM centos:5.11
+RUN yum install -y wget && \
+    yum install -y system-config-services && \
+    yum install -y curl && \
+    wget --no-cookies \
+        --no-check-certificate \
+        --header  "Cookie: gpw_e24=http%3A%2F%2Fwww.oracle.com%2F; oraclelicense=accept-securebackup-cookie" \
+        --output-document jdk.rpm \
+        http://download.oracle.com/otn-pub/java/jdk/8u66-b17/jdk-8u66-linux-x64.rpm && \
+    yum --nogpg localinstall -y jdk.rpm && \
+    rm -f jdk.rpm

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/conf/CentOS/6.7/Dockerfile

+FROM centos:6.7
+RUN yum install -y wget && \
+    yum install -y system-config-services && \
+    yum install -y curl && \
+    wget --no-cookies \
+        --no-check-certificate \
+        --header  "Cookie: gpw_e24=http%3A%2F%2Fwww.oracle.com%2F; oraclelicense=accept-securebackup-cookie" \
+        --output-document jdk.rpm \
+        http://download.oracle.com/otn-pub/java/jdk/8u66-b17/jdk-8u66-linux-x64.rpm && \
+    yum --nogpg localinstall -y jdk.rpm && \
+    rm -f jdk.rpm

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/conf/Ubuntu/14.04.3/Dockerfile

+FROM ubuntu:14.04.3
+RUN apt-get install -y software-properties-common && \
+    add-apt-repository ppa:webupd8team/java -y && \
+    apt-get update && \
+    echo oracle-java7-installer shared/accepted-oracle-license-v1-1 select true | /usr/bin/debconf-set-selections && \
+    apt-get install -y oracle-java8-installer && \
+    apt-get install -y curl && \
+    apt-get clean

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/logback.xml

+<configuration>
+
+	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+		<encoder>
+			<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+		</encoder>
+	</appender>
+
+	<root level="INFO">
+		<appender-ref ref="STDOUT" />
+	</root>
+
+</configuration>

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/basic-launch.sh

+source ./test-functions.sh
+install_service
+start_service
+await_app
+curl -s http://127.0.0.1:8080/

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/launch-with-multiple-command-line-arguments.sh

+source ./test-functions.sh
+install_service
+start_service --server.port=8081 --server.context-path=/test
+await_app http://127.0.0.1:8081/test/
+curl -s http://127.0.0.1:8081/test/

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/launch-with-multiple-java-opts.sh

+source ./test-functions.sh
+echo 'JAVA_OPTS="-Dserver.port=8081 -Dserver.context-path=/test"' > /spring-boot-app.conf
+install_service
+start_service
+await_app http://127.0.0.1:8081/test/
+curl -s http://127.0.0.1:8081/test/

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/launch-with-multiple-run-args.sh

+source ./test-functions.sh
+echo 'RUN_ARGS="--server.port=8081 --server.context-path=/test"' > /spring-boot-app.conf
+install_service
+start_service
+await_app http://127.0.0.1:8081/test/
+curl -s http://127.0.0.1:8081/test/

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/launch-with-single-command-line-argument.sh

+source ./test-functions.sh
+install_service
+start_service --server.port=8081
+await_app http://127.0.0.1:8081/
+curl -s http://127.0.0.1:8081/

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/launch-with-single-java-opt.sh

+source ./test-functions.sh
+echo 'JAVA_OPTS=-Dserver.port=8081' > /spring-boot-app.conf
+install_service
+start_service
+await_app http://127.0.0.1:8081/
+curl -s http://127.0.0.1:8081/

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/launch-with-single-run-arg.sh

+source ./test-functions.sh
+echo 'RUN_ARGS=--server.port=8081' > /spring-boot-app.conf
+install_service
+start_service
+await_app http://127.0.0.1:8081/
+curl -s http://127.0.0.1:8081/

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/restart-when-started.sh

+source ./test-functions.sh
+install_service
+start_service
+echo "PID1: $(cat /var/run/spring-boot-app/spring-boot-app.pid)"
+restart_service
+echo "Status: $?"
+echo "PID2: $(cat /var/run/spring-boot-app/spring-boot-app.pid)"

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/restart-when-stopped.sh

+source ./test-functions.sh
+install_service
+restart_service
+echo "Status: $?"
+echo "PID: $(cat /var/run/spring-boot-app/spring-boot-app.pid)"

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/start-when-started.sh

+source ./test-functions.sh
+install_service
+start_service
+echo "PID: $(cat /var/run/spring-boot-app/spring-boot-app.pid)"
+start_service
+echo "Status: $?"

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/start-when-stopped.sh

+source ./test-functions.sh
+install_service
+start_service
+echo "Status: $?"
+echo "PID: $(cat /var/run/spring-boot-app/spring-boot-app.pid)"

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/status-when-killed.sh

+source ./test-functions.sh
+install_service
+start_service
+pid=$(cat /var/run/spring-boot-app/spring-boot-app.pid)
+echo "PID: $pid"
+kill -9 $pid
+status_service
+echo "Status: $?"

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/status-when-started.sh

+source ./test-functions.sh
+install_service
+start_service
+status_service
+echo "Status: $?"
+echo "PID: $(cat /var/run/spring-boot-app/spring-boot-app.pid)"

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/status-when-stopped.sh

+source ./test-functions.sh
+install_service
+status_service
+echo "Status: $?"

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/stop-when-stopped.sh

+source ./test-functions.sh
+install_service
+stop_service
+echo "Status: $?"

spring-boot-integration-tests/spring-boot-launch-script-tests/src/test/resources/scripts/test-functions.sh

+install_service() {
+  mv /spring-boot-launch-script-tests-*.jar /spring-boot-app.jar
+  chmod +x /spring-boot-app.jar
+  ln -s /spring-boot-app.jar /etc/init.d/spring-boot-app
+}
+
+start_service() {
+  service spring-boot-app start $@
+}
+
+restart_service() {
+  service spring-boot-app restart
+}
+
+status_service() {
+  service spring-boot-app status
+}
+
+stop_service() {
+  service spring-boot-app stop
+}
+
+await_app() {
+  if [ -z $1 ]
+  then
+    url=http://127.0.0.1:8080
+  else
+    url=$1
+  fi
+  end=$(date +%s)
+  let "end+=30"
+  until curl -s $url > /dev/null
+  do
+    now=$(date +%s)
+    if [[ $now -ge $end ]]; then
+      break
+    fi
+    sleep 1
+  done
+}

spring-boot-parent/src/checkstyle/checkstyle-suppressions.xml

@@ -5,6 +5,7 @@
 <suppressions>
 	<suppress files="SpringApplicationTests\.java" checks="FinalClass" />
 	<suppress files=".+Configuration\.java" checks="HideUtilityClassConstructor" />
+	<suppress files="LaunchScriptTestApplication\.java" checks="HideUtilityClassConstructor" />
 	<suppress files="SignalUtils\.java" checks="IllegalImport" />
 	<suppress files="[\\/]src[\\/]test[\\/]java[\\/]cli[\\/]command[\\/]" checks="ImportControl" />
 	<suppress files="[\\/]src[\\/]main[\\/]java[\\/]sample[\\/]" checks="ImportControl" />