Commit 32d378a3 authored by Scott Frederick's avatar Scott Frederick

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
parent b3af6d64
/*
* 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,12 @@ 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("projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1");
assertThat(result.getOutput()).contains("projects.registry.vmware.com/springboot/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 +98,16 @@ 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=projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1",
"--runImage=projects.registry.vmware.com/springboot/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("projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1");
assertThat(result.getOutput()).contains("projects.registry.vmware.com/springboot/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 +125,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 +156,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 +203,9 @@ class BootBuildImageIntegrationTests {
}
}
private void removeImage(String name) throws IOException {
ImageReference imageReference = ImageReference.of(ImageName.of(name));
new DockerApi().image().remove(imageReference, false);
}
}
......@@ -8,6 +8,6 @@ targetCompatibility = '1.8'
bootBuildImage {
imageName = "example/test-image-custom"
builder = "paketobuildpacks/builder:full"
runImage = "paketobuildpacks/run:full-cnb"
builder = "projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1"
runImage = "projects.registry.vmware.com/springboot/run:tiny-cnb"
}
......@@ -8,4 +8,5 @@ targetCompatibility = '1.8'
bootBuildImage {
imageName = "example/test-image-name"
builder = "projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1"
}
......@@ -9,3 +9,7 @@ bootBuildImage {
sourceCompatibility = '1.8'
targetCompatibility = '1.8'
bootBuildImage {
builder = "projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1"
}
\ No newline at end of file
......@@ -7,5 +7,6 @@ sourceCompatibility = '1.8'
targetCompatibility = '1.8'
bootBuildImage {
environment = ["BP_JVM_VERSION": "13.9.9"]
builder = "projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1"
environment = ["FORCE_FAILURE": "true"]
}
......@@ -8,4 +8,8 @@ targetCompatibility = '1.8'
bootJar {
launchScript()
}
\ No newline at end of file
}
bootBuildImage {
builder = "projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1"
}
......@@ -9,3 +9,7 @@ if (project.hasProperty('applyWarPlugin')) {
sourceCompatibility = '1.8'
targetCompatibility = '1.8'
bootBuildImage {
builder = "projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1"
}
......@@ -23,8 +23,9 @@
</goals>
<configuration>
<image>
<builder>projects.registry.vmware.com/springboot/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>
......
......@@ -43,6 +43,11 @@
<goals>
<goal>build-image</goal>
</goals>
<configuration>
<image>
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
</image>
</configuration>
</execution>
</executions>
<configuration>
......
......@@ -37,6 +37,11 @@
<goals>
<goal>build-image</goal>
</goals>
<configuration>
<image>
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
</image>
</configuration>
</execution>
</executions>
<configuration>
......
......@@ -27,6 +27,11 @@
<goals>
<goal>build-image</goal>
</goals>
<configuration>
<image>
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
</image>
</configuration>
</execution>
</executions>
<configuration>
......
......@@ -21,6 +21,11 @@
<goals>
<goal>build-image</goal>
</goals>
<configuration>
<image>
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
</image>
</configuration>
</execution>
</executions>
<configuration>
......
<?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>
/*
* 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"
}
}
}
<?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">
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-v2-builder</artifactId>
......@@ -23,8 +23,8 @@
</goals>
<configuration>
<image>
<builder>paketobuildpacks/builder:full</builder>
<runImage>paketobuildpacks/run:full-cnb</runImage>
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
<runImage>projects.registry.vmware.com/springboot/run:tiny-cnb</runImage>
</image>
</configuration>
</execution>
......
......@@ -23,6 +23,7 @@
</goals>
<configuration>
<image>
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
<name>example.com/test/build-image:${project.version}</name>
</image>
</configuration>
......
......@@ -23,6 +23,7 @@
</goals>
<configuration>
<image>
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
<env>
<EMPTY_KEY></EMPTY_KEY>
</env>
......
......@@ -24,6 +24,9 @@
</goals>
<configuration>
<finalName>final-name</finalName>
<image>
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
</image>
</configuration>
</execution>
</executions>
......
......@@ -27,6 +27,11 @@
<goals>
<goal>build-image</goal>
</goals>
<configuration>
<image>
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
</image>
</configuration>
</execution>
</executions>
</plugin>
......
......@@ -25,6 +25,9 @@
</executions>
<configuration>
<layout>ZIP</layout>
<image>
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
</image>
</configuration>
</plugin>
</plugins>
......
......@@ -21,6 +21,11 @@
<goals>
<goal>build-image</goal>
</goals>
<configuration>
<image>
<builder>projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1</builder>
</image>
</configuration>
</execution>
</executions>
</plugin>
......
= 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 projects.registry.vmware.com via `docker login`
* Use the `build.sh` create the necessary images and push them to the registry
#!/usr/bin/env bash
set -x -eo pipefail
docker pull paketobuildpacks/build:tiny-cnb
docker tag paketobuildpacks/build:tiny-cnb projects.registry.vmware.com/springboot/build:tiny-cnb
docker push projects.registry.vmware.com/springboot/build:tiny-cnb
docker pull paketobuildpacks/run:tiny-cnb
docker tag paketobuildpacks/run:tiny-cnb projects.registry.vmware.com/springboot/run:tiny-cnb
docker push projects.registry.vmware.com/springboot/run:tiny-cnb
cd builder
pack builder create projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1 --config builder.toml
docker push projects.registry.vmware.com/springboot/spring-boot-cnb-builder:0.0.1
cd -
\ No newline at end of file
# 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 = "projects.registry.vmware.com/springboot/build:tiny-cnb"
run-image = "projects.registry.vmware.com/springboot/run:tiny-cnb"
#!/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 "META-INF/MANIFEST.MF: "
if [[ -f META-INF/MANIFEST.MF ]]; then
cat META-INF/MANIFEST.MF
fi
echo "---> Test Info buildpack done"
#!/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
# 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"
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment