Refine documentation for bootBuildImage and use the additive form for lists and maps

[bitbaggi]

Hello,

i have the normal vanilla Spring Boot 3.0.0-RC1 with only org.graalvm.buildtools.native as extra plugin.
You can download it from here Spring Initializr

When i try to build with gradlew bootBuildImage with buildpacks and environment it gives me an error.

Running creator
    [creator]     Restoring data for SBOM from previous image 
    [creator]     ===> DETECTING                              
    [creator]     ERROR: No buildpack groups passed detection.
    [creator]     ERROR: Please check that you are running against the correct path.
    [creator]     ERROR: failed to detect: no buildpacks participating

My bootBuildImage task is configured in build.gradle:

tasks.named('bootBuildImage') {
    builder = 'docker.io/paketobuildpacks/builder:tiny'
    runImage = 'docker.io/paketobuildpacks/run:tiny-cnb'
    buildpacks = ['gcr.io/paketo-buildpacks/bellsoft-liberica:9.9.0-ea', 'gcr.io/paketo-buildpacks/java-native-image']
    environment = [
            'BP_NATIVE_IMAGE_BUILD_ARGUMENTS': '--verbose'
    ]
}

The --verbose is only a test, i try to add a reflection-config.json to native image.

When i remove the environment part from task configuration everything is fine.

plugins {
    id 'org.springframework.boot' version '3.0.0-RC1'
    id 'io.spring.dependency-management' version '1.1.0'
    id 'org.graalvm.buildtools.native' version '0.9.16'
    id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'

repositories {
    mavenCentral()
    maven { url 'https://repo.spring.io/milestone' }
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

tasks.named('bootBuildImage') {
    builder = 'docker.io/paketobuildpacks/builder:tiny'
    runImage = 'docker.io/paketobuildpacks/run:tiny-cnb'
    buildpacks = ['gcr.io/paketo-buildpacks/bellsoft-liberica:9.9.0-ea', 'gcr.io/paketo-buildpacks/java-native-image']
    environment = [
            'BP_NATIVE_IMAGE_BUILD_ARGUMENTS': '--verbose'
    ]
}

tasks.named('test') {
    useJUnitPlatform()
}

Did i anything wrong?
Can i not use environment and buildpacks in combination?

Thank you.

[scottfrederick]

@bitbaggi This should work if you also add 'BP_NATIVE_IMAGE': 'true' to the environment in your build configuration. The Spring Boot Gradle plugin adds that by default, but it appears your configuration is overriding all environment variables set by default.

[wilkinsona]

I don't think this is a bug. The syntax used is assigning a new Map to the environment rather than adding an entry to it. You can add an entry like this:

tasks.named('bootBuildImage') {
    environment['BP_NATIVE_IMAGE_BUILD_ARGUMENTS'] = '--verbose'
}

Or add multiple entries like this:

environment.putAll([
    'BP_NATIVE_IMAGE_BUILD_ARGUMENTS': '--verbose',
    'EXAMPLE': 'VALUE'
])

I think it's important that we support assignment replacing our defaults so that users can take complete control of the environment if needs be.

[scottfrederick]

We should review the documentation for bootBuildImage and use the additive form for lists and maps in our examples then, to prevent this type of problem (and so everyone doesn't have to figure out the Groovy or Kotlin syntax).

[bitbaggi]

Yeah, thank you @wilkinsona

environment['BP_NATIVE_IMAGE_BUILD_ARGUMENTS'] = '--verbose' is working

[wilkinsona]

Thanks for the confirmation, @bitbaggi. I'm going to re-open this issue so that we can review the documentation.

[candrews]

I've submitted an MR to update the documentation as discussed in this issue: #33424

[philwebb]

Closing in favor of PR #33424. Thanks @candrews!