Skip to content

Validation of deprecated io.buildpacks.stack.id is too aggressive #51390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
scottfrederick wants to merge 1 commit into
base: 4.0.x
Choose a base branch
from
+27 −9
Open

Validation of deprecated io.buildpacks.stack.id is too aggressive #51390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions ...orm/src/main/java/org/springframework/boot/buildpack/platform/build/AbstractBuildLog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,13 @@ public void sensitiveTargetBindingDetected(Binding binding) {
log();
}

@Override
public void stackIdsDoNotMatch(String runImageStackId, String builderImageStackId) {
log("Warning: Run image stack '%s' does not match builder stack '%s'. Stack IDs are deprecated, but the images may not be compatible."
.formatted(runImageStackId, builderImageStackId));
log();
}

private String getDigest(Image image) {
List<String> digests = image.getDigests();
return (digests.isEmpty() ? "" : digests.get(0));
Expand Down
10 changes: 10 additions & 0 deletions ...ck-platform/src/main/java/org/springframework/boot/buildpack/platform/build/BuildLog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,16 @@ Consumer<TotalProgressEvent> pullingImage(ImageReference imageReference, @Nullab
*/
void sensitiveTargetBindingDetected(Binding binding);

/**
* Log that the stack ID of the run image does not match the stack ID of the builder
* image.
* @param runImageStackId the stack ID of the run image
* @param builderImageStackId the stack ID of the builder image
* @since 4.0.8
*/
default void stackIdsDoNotMatch(String runImageStackId, String builderImageStackId) {
}

/**
* Factory method that returns a {@link BuildLog} the outputs to {@link System#out}.
* @return a build log instance that logs to system out
Expand Down
9 changes: 4 additions & 5 deletions ...ack-platform/src/main/java/org/springframework/boot/buildpack/platform/build/Builder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ public void build(BuildRequest request) throws DockerEngineException, IOExceptio
request = request.withRunImage(request.getRunImage().withDigest(runImage.getPrimaryDigest()));
runImage = imageFetcher.fetchImage(ImageType.RUNNER, request.getRunImage(), platform);
}
assertStackIdsMatch(runImage, builderImage);
warnIfStackIdsDoNotMatch(runImage, builderImage);
BuildOwner buildOwner = BuildOwner.fromEnv(builderImage.getConfig().getEnv());
BuildpackLayersMetadata buildpackLayersMetadata = BuildpackLayersMetadata.fromImage(builderImage);
Buildpacks buildpacks = getBuildpacks(request, imageFetcher, platform, builderMetadata,
Expand Down Expand Up @@ -159,12 +159,11 @@ private ImageReference getRunImageReference(BuilderMetadata metadata) {
return ImageReference.of(runImageName).inTaggedOrDigestForm();
}

private void assertStackIdsMatch(Image runImage, Image builderImage) {
private void warnIfStackIdsDoNotMatch(Image runImage, Image builderImage) {
StackId runImageStackId = StackId.fromImage(runImage);
StackId builderImageStackId = StackId.fromImage(builderImage);
if (runImageStackId.hasId() && builderImageStackId.hasId()) {
Assert.state(runImageStackId.equals(builderImageStackId), () -> "Run image stack '" + runImageStackId
+ "' does not match builder stack '" + builderImageStackId + "'");
if (runImageStackId.hasId() && builderImageStackId.hasId() && !runImageStackId.equals(builderImageStackId)) {
this.log.stackIdsDoNotMatch(runImageStackId.toString(), builderImageStackId.toString());
}
}

Expand Down
10 changes: 6 additions & 4 deletions ...latform/src/test/java/org/springframework/boot/buildpack/platform/build/BuilderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ void buildInvokesBuilderWithPlatform() throws Exception {
}

@Test
void buildWhenStackIdDoesNotMatchThrowsException() throws Exception {
void buildWhenStackIdDoesNotMatchLogsWarning() throws Exception {
TestPrintStream out = new TestPrintStream();
DockerApi docker = mockDockerApi();
Image builderImage = loadImage("image.json");
Expand All @@ -458,9 +458,11 @@ void buildWhenStackIdDoesNotMatchThrowsException() throws Exception {
.willAnswer(withPulledImage(runImage));
Builder builder = new Builder(BuildLog.to(out), docker, null);
BuildRequest request = getTestRequest();
assertThatIllegalStateException().isThrownBy(() -> builder.build(request))
.withMessage(
"Run image stack 'org.cloudfoundry.stacks.cfwindowsfs3' does not match builder stack 'io.buildpacks.stacks.bionic'");
builder.build(request);
assertThat(out.toString()).contains(
"Warning: Run image stack 'org.cloudfoundry.stacks.cfwindowsfs3' does not match builder stack 'io.buildpacks.stacks.bionic'");
assertThat(out.toString()).contains("Running creator");
assertThat(out.toString()).contains("Successfully built image 'docker.io/library/my-application:latest'");
}

@Test
Expand Down
Loading