Use test harness for image building integration tests

This commit modifies the integration tests for the Maven and Gradle
image building goal and task to use a custom builder as a test harness
to verify that the plugins invoke the builder as expected.

Fixes gh-25838

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/tasks/bundling/BootBuildImageIntegrationTests.java

 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -29,8 +29,6 @@ import org.gradle.testkit.runner.BuildResult;
 import org.gradle.testkit.runner.TaskOutcome;
 import org.junit.jupiter.api.TestTemplate;
 import org.junit.jupiter.api.extension.ExtendWith;
-import org.testcontainers.containers.GenericContainer;
-import org.testcontainers.containers.wait.strategy.Wait;
 
 import org.springframework.boot.buildpack.platform.docker.DockerApi;
 import org.springframework.boot.buildpack.platform.docker.type.ImageName;
@@ -61,14 +59,10 @@ class BootBuildImageIntegrationTests {
 		String projectName = this.gradleBuild.getProjectDir().getName();
 		assertThat(result.task(":bootBuildImage").getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
 		assertThat(result.getOutput()).contains("docker.io/library/" + projectName);
-		assertThat(result.getOutput()).contains("paketo-buildpacks/builder");
-		ImageReference imageReference = ImageReference.of(ImageName.of(projectName));
-		try (GenericContainer<?> container = new GenericContainer<>(imageReference.toString())) {
-			container.waitingFor(Wait.forLogMessage("Launched\\n", 1)).start();
-		}
-		finally {
-			new DockerApi().image().remove(imageReference, false);
-		}
+		assertThat(result.getOutput()).contains("---> Test Info buildpack building");
+		assertThat(result.getOutput()).contains("env: BP_JVM_VERSION=8.*");
+		assertThat(result.getOutput()).contains("---> Test Info buildpack done");
+		removeImage(projectName);
 	}
 
 	@TestTemplate
@@ -78,14 +72,10 @@ class BootBuildImageIntegrationTests {
 		BuildResult result = this.gradleBuild.build("bootBuildImage");
 		assertThat(result.task(":bootBuildImage").getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
 		assertThat(result.getOutput()).contains("example/test-image-name");
-		assertThat(result.getOutput()).contains("paketo-buildpacks/builder");
-		ImageReference imageReference = ImageReference.of(ImageName.of("example/test-image-name"));
-		try (GenericContainer<?> container = new GenericContainer<>(imageReference.toString())) {
-			container.waitingFor(Wait.forLogMessage("Launched\\n", 1)).start();
-		}
-		finally {
-			new DockerApi().image().remove(imageReference, false);
-		}
+		assertThat(result.getOutput()).contains("---> Test Info buildpack building");
+		assertThat(result.getOutput()).contains("env: BP_JVM_VERSION=8.*");
+		assertThat(result.getOutput()).contains("---> Test Info buildpack done");
+		removeImage("example/test-image-name");
 	}
 
 	@TestTemplate
@@ -95,15 +85,11 @@ class BootBuildImageIntegrationTests {
 		BuildResult result = this.gradleBuild.build("bootBuildImage");
 		assertThat(result.task(":bootBuildImage").getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
 		assertThat(result.getOutput()).contains("example/test-image-custom");
-		assertThat(result.getOutput()).contains("paketobuildpacks/builder:full");
-		assertThat(result.getOutput()).contains("paketobuildpacks/run:full-cnb");
-		ImageReference imageReference = ImageReference.of(ImageName.of("example/test-image-custom"));
-		try (GenericContainer<?> container = new GenericContainer<>(imageReference.toString())) {
-			container.waitingFor(Wait.forLogMessage("Launched\\n", 1)).start();
-		}
-		finally {
-			new DockerApi().image().remove(imageReference, false);
-		}
+		assertThat(result.getOutput()).contains("springci/spring-boot-cnb-builder:0.0.1");
+		assertThat(result.getOutput()).contains("paketobuildpacks/run:tiny-cnb");
+		assertThat(result.getOutput()).contains("---> Test Info buildpack building");
+		assertThat(result.getOutput()).contains("---> Test Info buildpack done");
+		removeImage("example/test-image-custom");
 	}
 
 	@TestTemplate
@@ -111,18 +97,14 @@ class BootBuildImageIntegrationTests {
 		writeMainClass();
 		writeLongNameResource();
 		BuildResult result = this.gradleBuild.build("bootBuildImage", "--imageName=example/test-image-cmd",
-				"--builder=paketobuildpacks/builder:full", "--runImage=paketobuildpacks/run:full-cnb");
+				"--builder=springci/spring-boot-cnb-builder:0.0.1", "--runImage=paketobuildpacks/run:tiny-cnb");
 		assertThat(result.task(":bootBuildImage").getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
 		assertThat(result.getOutput()).contains("example/test-image-cmd");
-		assertThat(result.getOutput()).contains("paketobuildpacks/builder:full");
-		assertThat(result.getOutput()).contains("paketobuildpacks/run:full-cnb");
-		ImageReference imageReference = ImageReference.of(ImageName.of("example/test-image-cmd"));
-		try (GenericContainer<?> container = new GenericContainer<>(imageReference.toString())) {
-			container.waitingFor(Wait.forLogMessage("Launched\\n", 1)).start();
-		}
-		finally {
-			new DockerApi().image().remove(imageReference, false);
-		}
+		assertThat(result.getOutput()).contains("springci/spring-boot-cnb-builder:0.0.1");
+		assertThat(result.getOutput()).contains("paketobuildpacks/run:tiny-cnb");
+		assertThat(result.getOutput()).contains("---> Test Info buildpack building");
+		assertThat(result.getOutput()).contains("---> Test Info buildpack done");
+		removeImage("example/test-image-cmd");
 	}
 
 	@TestTemplate
@@ -140,6 +122,7 @@ class BootBuildImageIntegrationTests {
 		writeLongNameResource();
 		BuildResult result = this.gradleBuild.buildAndFail("bootBuildImage");
 		assertThat(result.task(":bootBuildImage").getOutcome()).isEqualTo(TaskOutcome.FAILED);
+		assertThat(result.getOutput()).contains("Forced builder failure");
 		assertThat(result.getOutput()).containsPattern("Builder lifecycle '.*' failed with status code");
 	}
 
@@ -170,17 +153,12 @@ class BootBuildImageIntegrationTests {
 		String projectName = this.gradleBuild.getProjectDir().getName();
 		assertThat(result.task(":bootBuildImage").getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
 		assertThat(result.getOutput()).contains("docker.io/library/" + projectName);
-		assertThat(result.getOutput()).contains("paketo-buildpacks/builder");
+		assertThat(result.getOutput()).contains("---> Test Info buildpack building");
+		assertThat(result.getOutput()).contains("---> Test Info buildpack done");
 		File buildLibs = new File(this.gradleBuild.getProjectDir(), "build/libs");
 		assertThat(buildLibs.listFiles())
 				.containsExactly(new File(buildLibs, this.gradleBuild.getProjectDir().getName() + ".war"));
-		ImageReference imageReference = ImageReference.of(ImageName.of(projectName));
-		try (GenericContainer<?> container = new GenericContainer<>(imageReference.toString())) {
-			container.waitingFor(Wait.forLogMessage("Launched\\n", 1)).start();
-		}
-		finally {
-			new DockerApi().image().remove(imageReference, false);
-		}
+		removeImage(projectName);
 	}
 
 	private void writeMainClass() {
@@ -222,4 +200,9 @@ class BootBuildImageIntegrationTests {
 		}
 	}
 
+	private void removeImage(String name) throws IOException {
+		ImageReference imageReference = ImageReference.of(ImageName.of(name));
+		new DockerApi().image().remove(imageReference, false);
+	}
+
 }

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/resources/org/springframework/boot/gradle/tasks/bundling/BootBuildImageIntegrationTests-buildsImageWithCommandLineOptions.gradle

+plugins {
+	id 'java'
+	id 'org.springframework.boot' version '{version}'
+}
+
+sourceCompatibility = '1.8'
+targetCompatibility = '1.8'

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/resources/org/springframework/boot/gradle/tasks/bundling/BootBuildImageIntegrationTests-buildsImageWithCustomBuilderAndRunImage.gradle

@@ -8,6 +8,6 @@ targetCompatibility = '1.8'
 
 bootBuildImage {
 	imageName = "example/test-image-custom"
-	builder = "paketobuildpacks/builder:full"
-	runImage = "paketobuildpacks/run:full-cnb"
+	builder = "springci/spring-boot-cnb-builder:0.0.1"
+	runImage = "paketobuildpacks/run:tiny-cnb"
 }

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/resources/org/springframework/boot/gradle/tasks/bundling/BootBuildImageIntegrationTests-buildsImageWithCustomName.gradle

@@ -8,4 +8,5 @@ targetCompatibility = '1.8'
 
 bootBuildImage {
 	imageName = "example/test-image-name"
+	builder = "springci/spring-boot-cnb-builder:0.0.1"
 }

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/resources/org/springframework/boot/gradle/tasks/bundling/BootBuildImageIntegrationTests-buildsImageWithWarPackagingAndJarConfiguration.gradle

@@ -9,3 +9,7 @@ bootBuildImage {
 
 sourceCompatibility = '1.8'
 targetCompatibility = '1.8'
+
+bootBuildImage {
+	builder = "springci/spring-boot-cnb-builder:0.0.1"
+}
\ No newline at end of file

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/resources/org/springframework/boot/gradle/tasks/bundling/BootBuildImageIntegrationTests-failsWithBuilderError.gradle

@@ -7,5 +7,6 @@ sourceCompatibility = '1.8'
 targetCompatibility = '1.8'
 
 bootBuildImage {
-	environment = ["BP_JVM_VERSION": "13.9.9"]
+	builder = "springci/spring-boot-cnb-builder:0.0.1"
+	environment = ["FORCE_FAILURE": "true"]
 }

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/resources/org/springframework/boot/gradle/tasks/bundling/BootBuildImageIntegrationTests.gradle

@@ -9,3 +9,7 @@ if (project.hasProperty('applyWarPlugin')) {
 
 sourceCompatibility = '1.8'
 targetCompatibility = '1.8'
+
+bootBuildImage {
+	builder = "springci/spring-boot-cnb-builder:0.0.1"
+}

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-builder-error/pom.xml

@@ -23,8 +23,9 @@
 						</goals>
 						<configuration>
 							<image>
+								<builder>springci/spring-boot-cnb-builder:0.0.1</builder>
 								<env>
-									<BP_JVM_VERSION>13.9.9</BP_JVM_VERSION>
+									<FORCE_FAILURE>true</FORCE_FAILURE>
 								</env>
 							</image>
 						</configuration>

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-classifier-source-with-repackage/pom.xml

@@ -43,6 +43,11 @@
 						<goals>
 							<goal>build-image</goal>
 						</goals>
+						<configuration>
+							<image>
+								<builder>springci/spring-boot-cnb-builder:0.0.1</builder>
+							</image>
+						</configuration>
 					</execution>
 				</executions>
 				<configuration>

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-classifier-source/pom.xml

@@ -37,6 +37,11 @@
 						<goals>
 							<goal>build-image</goal>
 						</goals>
+						<configuration>
+							<image>
+								<builder>springci/spring-boot-cnb-builder:0.0.1</builder>
+							</image>
+						</configuration>
 					</execution>
 				</executions>
 				<configuration>

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-classifier-with-repackage/pom.xml

@@ -27,6 +27,11 @@
 						<goals>
 							<goal>build-image</goal>
 						</goals>
+						<configuration>
+							<image>
+								<builder>springci/spring-boot-cnb-builder:0.0.1</builder>
+							</image>
+						</configuration>
 					</execution>
 				</executions>
 				<configuration>

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-classifier/pom.xml

@@ -21,6 +21,11 @@
 						<goals>
 							<goal>build-image</goal>
 						</goals>
+						<configuration>
+							<image>
+								<builder>springci/spring-boot-cnb-builder:0.0.1</builder>
+							</image>
+						</configuration>
 					</execution>
 				</executions>
 				<configuration>

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-cmd-line/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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<groupId>org.springframework.boot.maven.it</groupId>
+	<artifactId>build-image</artifactId>
+	<version>0.0.1.BUILD-SNAPSHOT</version>
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		<maven.compiler.source>@java.version@</maven.compiler.source>
+		<maven.compiler.target>@java.version@</maven.compiler.target>
+	</properties>
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>@project.groupId@</groupId>
+				<artifactId>@project.artifactId@</artifactId>
+				<version>@project.version@</version>
+				<executions>
+					<execution>
+						<goals>
+							<goal>build-image</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+		</plugins>
+	</build>
+</project>

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-cmd-line/src/main/java/org/test/SampleApplication.java

+/*
+ * Copyright 2012-2021 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
+ *
+ *      https://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.test;
+
+public class SampleApplication {
+
+	public static void main(String[] args) throws Exception {
+		System.out.println("Launched");
+		synchronized(args) {
+			args.wait(); // Prevent exit"
+		}
+	}
+
+}

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-custom-builder/pom.xml

@@ -23,8 +23,8 @@
 						</goals>
 						<configuration>
 							<image>
-								<builder>paketobuildpacks/builder:full</builder>
-								<runImage>paketobuildpacks/run:full-cnb</runImage>
+								<builder>springci/spring-boot-cnb-builder:0.0.1</builder>
+								<runImage>paketobuildpacks/run:tiny-cnb</runImage>
 							</image>
 						</configuration>
 					</execution>

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-custom-name/pom.xml

@@ -23,6 +23,7 @@
 						</goals>
 						<configuration>
 							<image>
+								<builder>springci/spring-boot-cnb-builder:0.0.1</builder>
 								<name>example.com/test/build-image:${project.version}</name>
 							</image>
 						</configuration>

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-empty-env-entry/pom.xml

@@ -23,6 +23,7 @@
 						</goals>
 						<configuration>
 							<image>
+								<builder>springci/spring-boot-cnb-builder:0.0.1</builder>
 								<env>
 									<EMPTY_KEY></EMPTY_KEY>
 								</env>

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-final-name/pom.xml

@@ -24,6 +24,9 @@
 						</goals>
 						<configuration>
 							<finalName>final-name</finalName>
+							<image>
+								<builder>springci/spring-boot-cnb-builder:0.0.1</builder>
+							</image>
 						</configuration>
 					</execution>
 				</executions>

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image-with-repackage/pom.xml

@@ -27,6 +27,11 @@
 						<goals>
 							<goal>build-image</goal>
 						</goals>
+						<configuration>
+							<image>
+								<builder>springci/spring-boot-cnb-builder:0.0.1</builder>
+							</image>
+						</configuration>
 					</execution>
 				</executions>
 			</plugin>

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/build-image/pom.xml

@@ -21,6 +21,11 @@
 						<goals>
 							<goal>build-image</goal>
 						</goals>
+						<configuration>
+							<image>
+								<builder>springci/spring-boot-cnb-builder:0.0.1</builder>
+							</image>
+						</configuration>
 					</execution>
 				</executions>
 			</plugin>

src/spring-boot-builder/README.adoc

+= Spring Boot Test Builder
+
+This directory contains a Cloud Native Buildpacks https://buildpacks.io/docs/concepts/components/builder/[builder] and https://buildpacks.io/docs/concepts/components/buildpack/[buildpack] that is used by integration tests to verify the behavior of the Spring Boot build plugins.
+
+== Creating the builder
+
+* Install the https://buildpacks.io/docs/install-pack/[pack CLI]
+* Authenticate to Docker Hub via `docker login` using the `springci` repository credentials
+* Use `pack` to create the builder image and publish it to Docker Hub:
+
+[source,bash]
+----
+$ cd builder
+$ pack builder create springci/spring-boot-cnb-builder:0.0.1 --config builder.toml --publish
+----

src/spring-boot-builder/builder/builder.toml

+# Buildpacks to include in builder
+[[buildpacks]]
+id = "spring-boot/test-info"
+version = "0.0.1"
+uri = "../buildpacks/test-info"
+
+# Order used for detection
+[[order]]
+[[order.group]]
+id = "spring-boot/test-info"
+version = "0.0.1"
+
+# Stack that will be used by the builder
+[stack]
+id = "io.paketo.stacks.tiny"
+build-image = "index.docker.io/paketobuildpacks/build:1.2.2-tiny-cnb"
+run-image = "index.docker.io/paketobuildpacks/run:tiny-cnb"
+run-image-mirrors = ["gcr.io/paketo-buildpacks/run:tiny-cnb"]

src/spring-boot-builder/buildpacks/test-info/bin/build

+#!/usr/bin/env bash
+set -eo pipefail
+
+echo "---> Test Info buildpack building"
+
+# INPUT ARGUMENTS
+platform_dir=$2
+env_dir=${platform_dir}/env
+bindings_dir=${platform_dir}/bindings
+
+if [[ -f ${env_dir}/FORCE_FAILURE ]]; then
+  echo "Forced builder failure"
+  exit 1
+fi
+
+if compgen -G "${env_dir}/*" > /dev/null; then
+  for var in ${env_dir}/*; do
+    echo "env: $(basename ${var})=$(<${var})"
+  done
+fi
+
+if compgen -G "${bindings_dir}/*" > /dev/null; then
+  for binding in ${bindings_dir}/*; do
+    for f in ${binding}/*; do
+      echo "binding: $(basename ${binding})/$(basename ${f})=$(<${f})"
+    done
+  done
+fi
+
+echo "---> Test Info buildpack done"

src/spring-boot-builder/buildpacks/test-info/bin/detect

+#!/usr/bin/env bash
+set -eo pipefail
+
+# 1. CHECK IF APPLICABLE
+if [[ ! -f META-INF/MANIFEST.MF ]]; then
+    exit 100
+fi
+
+# 2. GET ARGS
+plan_path=$2
+
+# 3. DECLARE DEPENDENCIES (OPTIONAL)
+cat >> "${plan_path}" <<EOL
+# Buildpack provides this dependency
+#
+# NOTE: The dependency is provided during the 'build' process.
+#
+[[provides]]
+name = "test-info"
+
+# Buildpack requires this dependency
+#
+# NOTE: Everything aside from 'name' is simply additional information that the providing buildpack can use to resolve
+#       the dependency.
+#
+[[requires]]
+name = "test-info"
+EOL
\ No newline at end of file

src/spring-boot-builder/buildpacks/test-info/buildpack.toml

+# Buildpack API version
+api = "0.2"
+
+# Buildpack ID and metadata
+[buildpack]
+id = "spring-boot/test-info"
+version = "0.0.1"
+name = "Spring Boot Test Info Buildpack"
+homepage = "https://github.com/spring-projects/spring-boot"
+
+# Stacks that the buildpack will work with
+[[stacks]]
+id = "io.paketo.stacks.tiny"