Support CNB builder platform API 0.3

This commit adds support for Cloud Native Buildpacks builder platform
API 0.3, which is the latest platform API available currently. Support
for platform API 0.1 has been removed, adopting the policy of the pack
CLI to support the current platform API version and one version prior.

Fixes gh-20757

Author: scottfrederick

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/ApiVersion.java

@@ -29,8 +29,6 @@
  */
 final class ApiVersion {
 
-	private static final ApiVersion PLATFORM_0_1 = new ApiVersion(0, 1);
-
 	private static final Pattern PATTERN = Pattern.compile("^v?(\\d+)\\.(\\d*)$");
 
 	private final int major;
@@ -88,25 +86,6 @@ boolean supports(ApiVersion other) {
 		return this.minor >= other.minor;
 	}
 
-	/**
-	 * Returns a value indicating whether the API version has a separate cache phase, or
-	 * caching is distributed across other stages.
-	 * @return {@code true} if the API has a separate cache phase, {@code false} otherwise
-	 */
-	boolean hasCachePhase() {
-		return supports(PLATFORM_0_1);
-	}
-
-	/**
-	 * Returns a value indicating whether the API version requires that the analyze phase
-	 * must follow the restore phase, or if the reverse order is required.
-	 * @return {@code true} if the analyze phase follows restore, {@code false} if restore
-	 * follows analyze
-	 */
-	boolean analyzeFollowsRestore() {
-		return supports(PLATFORM_0_1);
-	}
-
 	@Override
 	public boolean equals(Object obj) {
 		if (this == obj) {

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/ApiVersions.java

@@ -32,7 +32,7 @@ final class ApiVersions {
 	/**
 	 * The platform API versions supported by this release.
 	 */
-	static final ApiVersions SUPPORTED_PLATFORMS = new ApiVersions(ApiVersion.of(0, 1), ApiVersion.of(0, 2));
+	static final ApiVersions SUPPORTED_PLATFORMS = new ApiVersions(ApiVersion.of(0, 2), ApiVersion.of(0, 3));
 
 	private final ApiVersion[] apiVersions;
 

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/Lifecycle.java

@@ -115,19 +115,10 @@ void execute() throws IOException {
 			deleteVolume(this.buildCacheVolume);
 		}
 		run(detectPhase());
-		if (this.platformVersion.analyzeFollowsRestore()) {
-			run(restorePhase());
-			run(analyzePhase());
-		}
-		else {
-			run(analyzePhase());
-			run(restorePhase());
-		}
+		run(analyzePhase());
+		run(restorePhase());
 		run(buildPhase());
 		run(exportPhase());
-		if (this.platformVersion.hasCachePhase()) {
-			run(cachePhase());
-		}
 		this.log.executedLifecycle(this.request);
 	}
 
@@ -140,10 +131,9 @@ private Phase detectPhase() {
 	}
 
 	private Phase restorePhase() {
-		String cacheDirArg = this.platformVersion.hasCachePhase() ? "-path" : "-cache-dir";
 		Phase phase = createPhase("restorer");
 		phase.withDaemonAccess();
-		phase.withArgs(cacheDirArg, Folder.CACHE);
+		phase.withArgs("-cache-dir", Folder.CACHE);
 		phase.withArgs("-layers", Folder.LAYERS);
 		phase.withLogLevelArg();
 		phase.withBinds(this.buildCacheVolume, Folder.CACHE);
@@ -159,13 +149,9 @@ private Phase analyzePhase() {
 		}
 		phase.withArgs("-daemon");
 		phase.withArgs("-layers", Folder.LAYERS);
-		if (!this.platformVersion.hasCachePhase()) {
-			phase.withArgs("-cache-dir", Folder.CACHE);
-		}
+		phase.withArgs("-cache-dir", Folder.CACHE);
 		phase.withArgs(this.request.getName());
-		if (!this.platformVersion.hasCachePhase()) {
-			phase.withBinds(this.buildCacheVolume, Folder.CACHE);
-		}
+		phase.withBinds(this.buildCacheVolume, Folder.CACHE);
 		return phase;
 	}
 
@@ -186,23 +172,9 @@ private Phase exportPhase() {
 		phase.withArgs("-app", Folder.APPLICATION);
 		phase.withArgs("-daemon");
 		phase.withArgs("-launch-cache", Folder.LAUNCH_CACHE);
-		if (!this.platformVersion.hasCachePhase()) {
-			phase.withArgs("-cache-dir", Folder.CACHE);
-		}
+		phase.withArgs("-cache-dir", Folder.CACHE);
 		phase.withArgs(this.request.getName());
 		phase.withBinds(this.launchCacheVolume, Folder.LAUNCH_CACHE);
-		if (!this.platformVersion.hasCachePhase()) {
-			phase.withBinds(this.buildCacheVolume, Folder.CACHE);
-		}
-		return phase;
-	}
-
-	private Phase cachePhase() {
-		Phase phase = createPhase("cacher");
-		phase.withDaemonAccess();
-		phase.withArgs("-path", Folder.CACHE);
-		phase.withArgs("-layers", Folder.LAYERS);
-		phase.withLogLevelArg();
 		phase.withBinds(this.buildCacheVolume, Folder.CACHE);
 		return phase;
 	}

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/build/BuilderMetadataTests.java

@@ -33,21 +33,22 @@
  * Tests for {@link BuilderMetadata}.
  *
  * @author Phillip Webb
+ * @author Scott Frederick
  */
 class BuilderMetadataTests extends AbstractJsonTests {
 
 	@Test
 	void fromImageLoadsMetadata() throws IOException {
 		Image image = Image.of(getContent("image.json"));
 		BuilderMetadata metadata = BuilderMetadata.fromImage(image);
-		assertThat(metadata.getStack().getRunImage().getImage()).isEqualTo("cloudfoundry/run:full-cnb");
+		assertThat(metadata.getStack().getRunImage().getImage()).isEqualTo("cloudfoundry/run:base-cnb");
 		assertThat(metadata.getStack().getRunImage().getMirrors()).isEmpty();
-		assertThat(metadata.getLifecycle().getVersion()).isEqualTo("0.5.0");
+		assertThat(metadata.getLifecycle().getVersion()).isEqualTo("0.7.2");
 		assertThat(metadata.getLifecycle().getApi().getBuildpack()).isEqualTo("0.2");
-		assertThat(metadata.getLifecycle().getApi().getPlatform()).isEqualTo("0.1");
+		assertThat(metadata.getLifecycle().getApi().getPlatform()).isEqualTo("0.3");
 		assertThat(metadata.getCreatedBy().getName()).isEqualTo("Pack CLI");
 		assertThat(metadata.getCreatedBy().getVersion())
-				.isEqualTo("v0.5.0 (git sha: c9cfac75b49609524e1ea33f809c12071406547c)");
+				.isEqualTo("v0.9.0 (git sha: d42c384a39f367588f2653f2a99702db910e5ad7)");
 	}
 
 	@Test

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/build/BuilderTests.java

@@ -74,7 +74,7 @@ void buildInvokesBuilder() throws Exception {
 		Image runImage = loadImage("run-image.json");
 		given(docker.image().pull(eq(ImageReference.of("docker.io/" + BuildRequest.DEFAULT_BUILDER_IMAGE_NAME)), any()))
 				.willAnswer(withPulledImage(builderImage));
-		given(docker.image().pull(eq(ImageReference.of("docker.io/cloudfoundry/run:full-cnb")), any()))
+		given(docker.image().pull(eq(ImageReference.of("docker.io/cloudfoundry/run:base-cnb")), any()))
 				.willAnswer(withPulledImage(runImage));
 		Builder builder = new Builder(BuildLog.to(out), docker);
 		BuildRequest request = getTestRequest();
@@ -84,7 +84,6 @@ void buildInvokesBuilder() throws Exception {
 		assertThat(out.toString()).contains("Running analyzer");
 		assertThat(out.toString()).contains("Running builder");
 		assertThat(out.toString()).contains("Running exporter");
-		assertThat(out.toString()).contains("Running cacher");
 		assertThat(out.toString()).contains("Successfully built image 'docker.io/library/my-application:latest'");
 		ArgumentCaptor<ImageArchive> archive = ArgumentCaptor.forClass(ImageArchive.class);
 		verify(docker.image()).load(archive.capture(), any());
@@ -99,12 +98,12 @@ void buildWhenStackIdDoesNotMatchThrowsException() throws Exception {
 		Image runImage = loadImage("run-image-with-bad-stack.json");
 		given(docker.image().pull(eq(ImageReference.of("docker.io/" + BuildRequest.DEFAULT_BUILDER_IMAGE_NAME)), any()))
 				.willAnswer(withPulledImage(builderImage));
-		given(docker.image().pull(eq(ImageReference.of("docker.io/cloudfoundry/run:full-cnb")), any()))
+		given(docker.image().pull(eq(ImageReference.of("docker.io/cloudfoundry/run:base-cnb")), any()))
 				.willAnswer(withPulledImage(runImage));
 		Builder builder = new Builder(BuildLog.to(out), docker);
 		BuildRequest request = getTestRequest();
 		assertThatIllegalStateException().isThrownBy(() -> builder.build(request)).withMessage(
-				"Run image stack 'org.cloudfoundry.stacks.cfwindowsfs3' does not match builder stack 'org.cloudfoundry.stacks.cflinuxfs3'");
+				"Run image stack 'org.cloudfoundry.stacks.cfwindowsfs3' does not match builder stack 'io.buildpacks.stacks.bionic'");
 	}
 
 	@Test
@@ -115,7 +114,7 @@ void buildWhenBuilderReturnsErrorThrowsException() throws Exception {
 		Image runImage = loadImage("run-image.json");
 		given(docker.image().pull(eq(ImageReference.of("docker.io/" + BuildRequest.DEFAULT_BUILDER_IMAGE_NAME)), any()))
 				.willAnswer(withPulledImage(builderImage));
-		given(docker.image().pull(eq(ImageReference.of("docker.io/cloudfoundry/run:full-cnb")), any()))
+		given(docker.image().pull(eq(ImageReference.of("docker.io/cloudfoundry/run:base-cnb")), any()))
 				.willAnswer(withPulledImage(runImage));
 		Builder builder = new Builder(BuildLog.to(out), docker);
 		BuildRequest request = getTestRequest();

spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/build/LifecycleTests.java

@@ -79,32 +79,16 @@ void setup() {
 	}
 
 	@Test
-	void executeExecutesPhasesWithCacherPhase() throws Exception {
+	void executeExecutesPhases() throws Exception {
 		given(this.docker.container().create(any())).willAnswer(answerWithGeneratedContainerId());
 		given(this.docker.container().create(any(), any())).willAnswer(answerWithGeneratedContainerId());
 		given(this.docker.container().wait(any())).willReturn(ContainerStatus.of(0, null));
-		createLifecycle("0.5").execute();
-		assertPhaseWasRun("detector", withExpectedConfig("lifecycle-detector.json"));
-		assertPhaseWasRun("restorer", withExpectedConfig("lifecycle-restorer-0.1.json"));
-		assertPhaseWasRun("analyzer", withExpectedConfig("lifecycle-analyzer-0.1.json"));
-		assertPhaseWasRun("builder", withExpectedConfig("lifecycle-builder.json"));
-		assertPhaseWasRun("exporter", withExpectedConfig("lifecycle-exporter-0.1.json"));
-		assertPhaseWasRun("cacher", withExpectedConfig("lifecycle-cacher.json"));
-		assertThat(this.out.toString()).contains("Successfully built image 'docker.io/library/my-application:latest'");
-	}
-
-	@Test
-	void executeExecutesPhasesWithEmbeddedCaching() throws Exception {
-		given(this.docker.container().create(any())).willAnswer(answerWithGeneratedContainerId());
-		given(this.docker.container().create(any(), any())).willAnswer(answerWithGeneratedContainerId());
-		given(this.docker.container().wait(any())).willReturn(ContainerStatus.of(0, null));
-		createLifecycle("0.6").execute();
+		createLifecycle().execute();
 		assertPhaseWasRun("detector", withExpectedConfig("lifecycle-detector.json"));
-		assertPhaseWasRun("analyzer", withExpectedConfig("lifecycle-analyzer-0.2.json"));
-		assertPhaseWasRun("restorer", withExpectedConfig("lifecycle-restorer-0.2.json"));
+		assertPhaseWasRun("analyzer", withExpectedConfig("lifecycle-analyzer.json"));
+		assertPhaseWasRun("restorer", withExpectedConfig("lifecycle-restorer.json"));
 		assertPhaseWasRun("builder", withExpectedConfig("lifecycle-builder.json"));
-		assertPhaseWasRun("exporter", withExpectedConfig("lifecycle-exporter-0.2.json"));
-		assertPhaseWasNotRun("cacher");
+		assertPhaseWasRun("exporter", withExpectedConfig("lifecycle-exporter.json"));
 		assertThat(this.out.toString()).contains("Successfully built image 'docker.io/library/my-application:latest'");
 	}
 
@@ -173,27 +157,18 @@ private BuildRequest getTestRequest() {
 	}
 
 	private Lifecycle createLifecycle() throws IOException {
-		return createLifecycle("0.6");
-	}
-
-	private Lifecycle createLifecycle(String version) throws IOException {
-		return createLifecycle(getTestRequest(), version);
+		return createLifecycle(getTestRequest());
 	}
 
 	private Lifecycle createLifecycle(BuildRequest request) throws IOException {
-		return createLifecycle(request, "0.6");
-	}
-
-	private Lifecycle createLifecycle(BuildRequest request, String version) throws IOException {
-		EphemeralBuilder builder = mockEphemeralBuilder((version != null) ? version : "0.5");
+		EphemeralBuilder builder = mockEphemeralBuilder();
 		return new TestLifecycle(BuildLog.to(this.out), this.docker, request, ImageReference.of("cloudfoundry/run"),
 				builder);
 	}
 
-	private EphemeralBuilder mockEphemeralBuilder(String version) throws IOException {
+	private EphemeralBuilder mockEphemeralBuilder() throws IOException {
 		EphemeralBuilder builder = mock(EphemeralBuilder.class);
-		byte[] metadataContent = FileCopyUtils
-				.copyToByteArray(getClass().getResourceAsStream("builder-metadata-version-" + version + ".json"));
+		byte[] metadataContent = FileCopyUtils.copyToByteArray(getClass().getResourceAsStream("builder-metadata.json"));
 		BuilderMetadata metadata = BuilderMetadata.fromJson(new String(metadataContent, StandardCharsets.UTF_8));
 		given(builder.getName()).willReturn(ImageReference.of("pack.local/ephemeral-builder"));
 		given(builder.getBuilderMetadata()).willReturn(metadata);
@@ -226,11 +201,6 @@ private void assertPhaseWasRun(String name, IOConsumer<ContainerConfig> configCo
 		configConsumer.accept(this.configs.get(containerReference.toString()));
 	}
 
-	private void assertPhaseWasNotRun(String name) {
-		ContainerReference containerReference = ContainerReference.of("lifecycle-" + name);
-		assertThat(this.configs.get(containerReference.toString())).isNull();
-	}
-
 	private IOConsumer<ContainerConfig> withExpectedConfig(String name) {
 		return (config) -> {
 			InputStream in = getClass().getResourceAsStream(name);