Provide separate documentation (API and reference) for Gradle plugin

spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/GettingStartedDocumentationTests.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2012-2017 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.gradle.docs;
+
+import org.junit.Rule;
+import org.junit.Test;
+
+import org.springframework.boot.gradle.testkit.GradleBuild;
+
+/**
+ * Tests for the getting started documentation.
+ *
+ * @author Andy Wilkinson
+ */
+public class GettingStartedDocumentationTests {
+
+	@Rule
+	public GradleBuild gradleBuild = new GradleBuild();
+
+	@Test
+	public void applyPluginSnapshotExampleEvaluatesSuccessfully() {
+		this.gradleBuild
+				.script("src/main/gradle/getting-started/apply-plugin-snapshot.gradle")
+				.build();
+	}
+
+	@Test
+	public void typicalPluginsAppliesExceptedPlugins() {
+		this.gradleBuild.script("src/main/gradle/getting-started/typical-plugins.gradle")
+				.build("verify");
+	}
+
+}

spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/IntegratingWithActuatorDocumentationTests.java

@@ -0,0 +1,90 @@
+/*
+ * Copyright 2012-2017 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.gradle.docs;
+
+import java.io.File;
+import java.io.FileReader;
+import java.io.IOException;
+import java.util.Properties;
+
+import org.junit.Rule;
+import org.junit.Test;
+
+import org.springframework.boot.gradle.testkit.GradleBuild;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for the generating build info documentation.
+ *
+ * @author Andy Wilkinson
+ */
+public class IntegratingWithActuatorDocumentationTests {
+
+	@Rule
+	public GradleBuild gradleBuild = new GradleBuild();
+
+	@Test
+	public void basicBuildInfo() throws IOException {
+		this.gradleBuild
+				.script("src/main/gradle/integrating-with-actuator/build-info-basic.gradle")
+				.build("bootBuildInfo");
+		assertThat(new File(this.gradleBuild.getProjectDir(),
+				"build/resources/main/META-INF/build-info.properties")).isFile();
+	}
+
+	@Test
+	public void buildInfoCustomValues() throws IOException {
+		this.gradleBuild
+				.script("src/main/gradle/integrating-with-actuator/build-info-custom-values.gradle")
+				.build("bootBuildInfo");
+		File file = new File(this.gradleBuild.getProjectDir(),
+				"build/resources/main/META-INF/build-info.properties");
+		assertThat(file).isFile();
+		Properties properties = buildInfoProperties(file);
+		assertThat(properties).containsEntry("build.artifact", "example-app");
+		assertThat(properties).containsEntry("build.version", "1.2.3");
+		assertThat(properties).containsEntry("build.group", "com.example");
+		assertThat(properties).containsEntry("build.name", "Example application");
+	}
+
+	@Test
+	public void buildInfoAdditional() throws IOException {
+		this.gradleBuild
+				.script("src/main/gradle/integrating-with-actuator/build-info-additional.gradle")
+				.build("bootBuildInfo");
+		File file = new File(this.gradleBuild.getProjectDir(),
+				"build/resources/main/META-INF/build-info.properties");
+		assertThat(file).isFile();
+		Properties properties = buildInfoProperties(file);
+		assertThat(properties).containsEntry("build.a", "alpha");
+		assertThat(properties).containsEntry("build.b", "bravo");
+	}
+
+	private Properties buildInfoProperties(File file) {
+		assertThat(file).isFile();
+		Properties properties = new Properties();
+		try (FileReader reader = new FileReader(file)) {
+			properties.load(reader);
+			return properties;
+		}
+		catch (IOException ex) {
+			throw new RuntimeException(ex);
+		}
+	}
+
+}

spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/ManagingDependenciesDocumentationTests.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2012-2017 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.gradle.docs;
+
+import org.junit.Rule;
+import org.junit.Test;
+
+import org.springframework.boot.gradle.testkit.GradleBuild;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for the managing dependencies documentation.
+ *
+ * @author Andy Wilkinson
+ */
+public class ManagingDependenciesDocumentationTests {
+
+	@Rule
+	public GradleBuild gradleBuild = new GradleBuild();
+
+	@Test
+	public void dependenciesExampleEvaluatesSuccessfully() {
+		this.gradleBuild
+				.script("src/main/gradle/managing-dependencies/dependencies.gradle")
+				.build();
+	}
+
+	@Test
+	public void customManagedVersions() {
+		assertThat(this.gradleBuild
+				.script("src/main/gradle/managing-dependencies/custom-version.gradle")
+				.build("slf4jVersion").getOutput()).contains("1.7.20");
+	}
+
+}

spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/PackagingDocumentationTests.java

@@ -0,0 +1,176 @@
+/*
+ * Copyright 2012-2017 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.gradle.docs;
+
+import java.io.File;
+import java.io.FileReader;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.util.jar.JarEntry;
+import java.util.jar.JarFile;
+
+import org.junit.Rule;
+import org.junit.Test;
+
+import org.springframework.boot.gradle.testkit.GradleBuild;
+import org.springframework.util.FileCopyUtils;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for the packaging documentation.
+ *
+ * @author Andy Wilkinson
+ */
+public class PackagingDocumentationTests {
+
+	@Rule
+	public GradleBuild gradleBuild = new GradleBuild();
+
+	@Test
+	public void warContainerDependencyEvaluatesSuccessfully() {
+		this.gradleBuild
+				.script("src/main/gradle/packaging/war-container-dependency.gradle")
+				.build();
+	}
+
+	@Test
+	public void bootJarMainClass() throws IOException {
+		this.gradleBuild.script("src/main/gradle/packaging/boot-jar-main-class.gradle")
+				.build("bootJar");
+		File file = new File(this.gradleBuild.getProjectDir(),
+				"build/libs/" + this.gradleBuild.getProjectDir().getName() + ".jar");
+		assertThat(file).isFile();
+		try (JarFile jar = new JarFile(file)) {
+			assertThat(jar.getManifest().getMainAttributes().getValue("Start-Class"))
+					.isEqualTo("com.example.ExampleApplication");
+		}
+	}
+
+	@Test
+	public void bootJarManifestMainClass() throws IOException {
+		this.gradleBuild
+				.script("src/main/gradle/packaging/boot-jar-manifest-main-class.gradle")
+				.build("bootJar");
+		File file = new File(this.gradleBuild.getProjectDir(),
+				"build/libs/" + this.gradleBuild.getProjectDir().getName() + ".jar");
+		assertThat(file).isFile();
+		try (JarFile jar = new JarFile(file)) {
+			assertThat(jar.getManifest().getMainAttributes().getValue("Start-Class"))
+					.isEqualTo("com.example.ExampleApplication");
+		}
+	}
+
+	@Test
+	public void applicationPluginMainClass() throws IOException {
+		this.gradleBuild
+				.script("src/main/gradle/packaging/application-plugin-main-class.gradle")
+				.build("bootJar");
+		File file = new File(this.gradleBuild.getProjectDir(),
+				"build/libs/" + this.gradleBuild.getProjectDir().getName() + ".jar");
+		assertThat(file).isFile();
+		try (JarFile jar = new JarFile(file)) {
+			assertThat(jar.getManifest().getMainAttributes().getValue("Start-Class"))
+					.isEqualTo("com.example.ExampleApplication");
+		}
+	}
+
+	@Test
+	public void bootWarIncludeDevtools() throws IOException {
+		new File(this.gradleBuild.getProjectDir(),
+				"spring-boot-devtools-1.2.3.RELEASE.jar").createNewFile();
+		this.gradleBuild
+				.script("src/main/gradle/packaging/boot-war-include-devtools.gradle")
+				.build("bootWar");
+		File file = new File(this.gradleBuild.getProjectDir(),
+				"build/libs/" + this.gradleBuild.getProjectDir().getName() + ".war");
+		assertThat(file).isFile();
+		try (JarFile jar = new JarFile(file)) {
+			assertThat(jar.getEntry("WEB-INF/lib/spring-boot-devtools-1.2.3.RELEASE.jar"))
+					.isNotNull();
+		}
+	}
+
+	@Test
+	public void bootJarRequiresUnpack() throws IOException {
+		this.gradleBuild
+				.script("src/main/gradle/packaging/boot-jar-requires-unpack.gradle")
+				.build("bootJar");
+		File file = new File(this.gradleBuild.getProjectDir(),
+				"build/libs/" + this.gradleBuild.getProjectDir().getName() + ".jar");
+		assertThat(file).isFile();
+		try (JarFile jar = new JarFile(file)) {
+			JarEntry entry = jar.getJarEntry("BOOT-INF/lib/jruby-complete-1.7.25.jar");
+			assertThat(entry).isNotNull();
+			assertThat(entry.getComment()).startsWith("UNPACK:");
+		}
+	}
+
+	@Test
+	public void bootJarIncludeLaunchScript() throws IOException {
+		this.gradleBuild
+				.script("src/main/gradle/packaging/boot-jar-include-launch-script.gradle")
+				.build("bootJar");
+		File file = new File(this.gradleBuild.getProjectDir(),
+				"build/libs/" + this.gradleBuild.getProjectDir().getName() + ".jar");
+		assertThat(file).isFile();
+		assertThat(FileCopyUtils.copyToString(new FileReader(file)))
+				.startsWith("#!/bin/bash");
+	}
+
+	@Test
+	public void bootJarLaunchScriptProperties() throws IOException {
+		this.gradleBuild
+				.script("src/main/gradle/packaging/boot-jar-launch-script-properties.gradle")
+				.build("bootJar");
+		File file = new File(this.gradleBuild.getProjectDir(),
+				"build/libs/" + this.gradleBuild.getProjectDir().getName() + ".jar");
+		assertThat(file).isFile();
+		assertThat(FileCopyUtils.copyToString(new FileReader(file)))
+				.contains("example-app.log");
+	}
+
+	@Test
+	public void bootJarCustomLaunchScript() throws IOException {
+		File customScriptFile = new File(this.gradleBuild.getProjectDir(),
+				"src/custom.script");
+		customScriptFile.getParentFile().mkdirs();
+		FileCopyUtils.copy("custom", new FileWriter(customScriptFile));
+		this.gradleBuild
+				.script("src/main/gradle/packaging/boot-jar-custom-launch-script.gradle")
+				.build("bootJar");
+		File file = new File(this.gradleBuild.getProjectDir(),
+				"build/libs/" + this.gradleBuild.getProjectDir().getName() + ".jar");
+		assertThat(file).isFile();
+		assertThat(FileCopyUtils.copyToString(new FileReader(file))).startsWith("custom");
+	}
+
+	@Test
+	public void bootWarPropertiesLauncher() throws IOException {
+		this.gradleBuild
+				.script("src/main/gradle/packaging/boot-war-properties-launcher.gradle")
+				.build("bootWar");
+		File file = new File(this.gradleBuild.getProjectDir(),
+				"build/libs/" + this.gradleBuild.getProjectDir().getName() + ".war");
+		assertThat(file).isFile();
+		try (JarFile jar = new JarFile(file)) {
+			assertThat(jar.getManifest().getMainAttributes().getValue("Main-Class"))
+					.isEqualTo("org.springframework.boot.loader.PropertiesLauncher");
+		}
+	}
+
+}

spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/PublishingDocumentationTests.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2012-2017 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.gradle.docs;
+
+import java.io.IOException;
+
+import org.junit.Rule;
+import org.junit.Test;
+
+import org.springframework.boot.gradle.testkit.GradleBuild;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for the publishing documentation.
+ *
+ * @author Andy Wilkinson
+ */
+public class PublishingDocumentationTests {
+
+	@Rule
+	public GradleBuild gradleBuild = new GradleBuild();
+
+	@Test
+	public void mavenUpload() throws IOException {
+		assertThat(this.gradleBuild.script("src/main/gradle/publishing/maven.gradle")
+				.build("deployerRepository").getOutput())
+						.contains("https://repo.example.com");
+	}
+
+	@Test
+	public void mavenPublish() throws IOException {
+		assertThat(
+				this.gradleBuild.script("src/main/gradle/publishing/maven-publish.gradle")
+						.build("publishingConfiguration").getOutput())
+								.contains("MavenPublication")
+								.contains("https://repo.example.com");
+	}
+
+}

spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/docs/RunningDocumentationTests.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2012-2017 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.gradle.docs;
+
+import java.io.IOException;
+
+import org.junit.Rule;
+import org.junit.Test;
+
+import org.springframework.boot.gradle.testkit.GradleBuild;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for the integrating with Actuator documentation.
+ *
+ * @author Andy Wilkinson
+ */
+public class RunningDocumentationTests {
+
+	@Rule
+	public GradleBuild gradleBuild = new GradleBuild();
+
+	@Test
+	public void bootRunMain() throws IOException {
+		assertThat(this.gradleBuild.script("src/main/gradle/running/boot-run-main.gradle")
+				.build("configuredMainClass").getOutput())
+						.contains("com.example.ExampleApplication");
+	}
+
+	@Test
+	public void applicationPluginMainClassName() throws IOException {
+		assertThat(this.gradleBuild
+				.script("src/main/gradle/running/application-plugin-main-class-name.gradle")
+				.build("configuredMainClass").getOutput())
+						.contains("com.example.ExampleApplication");
+	}
+
+	@Test
+	public void bootRunSourceResources() throws IOException {
+		assertThat(this.gradleBuild
+				.script("src/main/gradle/running/boot-run-source-resources.gradle")
+				.build("configuredClasspath").getOutput()).contains("src/main/resources");
+	}
+
+}

spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/testkit/GradleBuild.java

@@ -18,10 +18,9 @@ package org.springframework.boot.gradle.testkit;
 
 import java.io.File;
 import java.io.FileReader;
+import java.io.FileWriter;
 import java.io.IOException;
 import java.net.URL;
-import java.nio.file.Files;
-import java.nio.file.StandardCopyOption;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -41,6 +40,7 @@ import org.xml.sax.InputSource;
 
 import org.springframework.asm.ClassVisitor;
 import org.springframework.boot.loader.tools.LaunchScript;
+import org.springframework.util.FileCopyUtils;
 
 /**
  * A {@link TestRule} for running a Gradle build using {@link GradleRunner}.
@@ -143,9 +143,10 @@ public class GradleBuild implements TestRule {
 	}
 
 	public GradleRunner prepareRunner(String... arguments) throws IOException {
-		Files.copy(new File(this.script).toPath(),
-				new File(this.projectDir, "build.gradle").toPath(),
-				StandardCopyOption.REPLACE_EXISTING);
+		String scriptContent = FileCopyUtils.copyToString(new FileReader(this.script))
+				.replace("{version}", getBootVersion());
+		FileCopyUtils.copy(scriptContent,
+				new FileWriter(new File(this.projectDir, "build.gradle")));
 		GradleRunner gradleRunner = GradleRunner.create().withProjectDir(this.projectDir)
 				.forwardOutput();
 		List<String> allArguments = new ArrayList<String>();