Adapt to Spring Boot 4.0 changes regarding war deployments

Closes gh-1728

Author: mhalbritter

initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/build/WarPackagingWebStarterBuildCustomizer.java

@@ -17,6 +17,7 @@
 package io.spring.initializr.generator.spring.build;
 
 import io.spring.initializr.generator.buildsystem.Build;
+import io.spring.initializr.generator.buildsystem.gradle.GradleBuild;
 import io.spring.initializr.generator.project.ProjectDescription;
 import io.spring.initializr.generator.version.Version;
 import io.spring.initializr.generator.version.VersionParser;
@@ -37,7 +38,7 @@
  */
 public class WarPackagingWebStarterBuildCustomizer implements BuildCustomizer<Build> {
 
-	private static final VersionRange SPRING_BOOT_4_RC1_OR_LATER = VersionParser.DEFAULT.parseRange("4.0.0-RC1");
+	private static final VersionRange SPRING_BOOT_4_OR_LATER = VersionParser.DEFAULT.parseRange("4.0.0");
 
 	private final InitializrMetadata metadata;
 
@@ -53,19 +54,45 @@ public WarPackagingWebStarterBuildCustomizer(InitializrMetadata metadata, Projec
 
 	@Override
 	public void customize(Build build) {
+		addWebDependency(build);
+		if (isBoot4OrLater() && isGradleBuild(build)) {
+			customizeGradle(build);
+			return;
+		}
+		addTomcatInProvidedScope(build);
+	}
+
+	private boolean isGradleBuild(Build build) {
+		return build instanceof GradleBuild;
+	}
+
+	private boolean isBoot4OrLater() {
+		return SPRING_BOOT_4_OR_LATER.match(this.platformVersion);
+	}
+
+	private void addWebDependency(Build build) {
 		if (!this.buildMetadataResolver.hasFacet(build, "web")) {
 			// Need to be able to bootstrap the web app
 			Dependency dependency = determineWebDependency(this.metadata);
 			build.dependencies()
 				.add(dependency.getId(),
 						MetadataBuildItemMapper.toDependency(dependency.resolve(this.platformVersion)));
 		}
-		// Add the tomcat starter in provided scope
+	}
+
+	private void addTomcatInProvidedScope(Build build) {
 		Dependency tomcat = determineTomcatDependency(this.metadata);
 		tomcat.setScope(Dependency.SCOPE_PROVIDED);
 		build.dependencies().add("tomcat", MetadataBuildItemMapper.toDependency(tomcat.resolve(this.platformVersion)));
 	}
 
+	private void customizeGradle(Build build) {
+		build.dependencies().remove("tomcat");
+		build.dependencies()
+			.add("tomcat-runtime", MetadataBuildItemMapper.toDependency(Dependency.create("org.springframework.boot",
+					"spring-boot-starter-tomcat-runtime", null, Dependency.SCOPE_PROVIDED)));
+	}
+
 	@Override
 	public int getOrder() {
 		return Ordered.LOWEST_PRECEDENCE - 10;
@@ -78,14 +105,7 @@ private Dependency determineWebDependency(InitializrMetadata metadata) {
 
 	private Dependency determineTomcatDependency(InitializrMetadata metadata) {
 		Dependency tomcat = metadata.getDependencies().get("tomcat");
-		if (tomcat != null) {
-			return tomcat;
-		}
-		if (SPRING_BOOT_4_RC1_OR_LATER.match(this.platformVersion)) {
-			return Dependency.create("org.springframework.boot", "spring-boot-tomcat-runtime", null,
-					Dependency.SCOPE_PROVIDED);
-		}
-		return Dependency.createSpringBootStarter("tomcat");
+		return (tomcat != null) ? tomcat : Dependency.createSpringBootStarter("tomcat");
 	}
 
 }

initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/WarPackagingWebStarterBuildCustomizerTests.java

@@ -19,6 +19,8 @@
 import java.util.Collections;
 
 import io.spring.initializr.generator.buildsystem.Build;
+import io.spring.initializr.generator.buildsystem.DependencyScope;
+import io.spring.initializr.generator.buildsystem.gradle.GradleBuild;
 import io.spring.initializr.generator.buildsystem.maven.MavenBuild;
 import io.spring.initializr.generator.project.MutableProjectDescription;
 import io.spring.initializr.generator.test.InitializrMetadataTestBuilder;
@@ -28,8 +30,6 @@
 import io.spring.initializr.metadata.support.MetadataBuildItemResolver;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.CsvSource;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -114,24 +114,22 @@ void shouldUseResolvedDependencies() {
 		assertThat(tomcatDependency.getArtifactId()).isEqualTo("mapped-tomcat");
 	}
 
-	@ParameterizedTest
-	@CsvSource(textBlock = """
-			3.4.0,org.springframework.boot:spring-boot-starter-tomcat
-			3.5.0,org.springframework.boot:spring-boot-starter-tomcat
-			4.0.0-M1,org.springframework.boot:spring-boot-starter-tomcat
-			4.0.0-M2,org.springframework.boot:spring-boot-starter-tomcat
-			4.0.0-M3,org.springframework.boot:spring-boot-starter-tomcat
-			4.0.0-RC1,org.springframework.boot:spring-boot-tomcat-runtime
-			4.0.0,org.springframework.boot:spring-boot-tomcat-runtime
-			""")
-	void shouldAddSpringBootTomcatRuntimeForBoot4Rc1(String bootVersion, String coordinates) {
+	@Test
+	void shouldCustomizeGradleBuildForBoot4() {
 		InitializrMetadata metadata = InitializrMetadataTestBuilder.withDefaults().build();
-		this.projectDescription.setPlatformVersion(Version.parse(bootVersion));
-		Build build = createBuild(metadata);
+		Build build = createGradleBuild(metadata, "4.0.0");
 		new WarPackagingWebStarterBuildCustomizer(metadata, this.projectDescription).customize(build);
-		io.spring.initializr.generator.buildsystem.Dependency tomcat = build.dependencies().get("tomcat");
-		String actualCoordinates = tomcat.getGroupId() + ":" + tomcat.getArtifactId();
-		assertThat(actualCoordinates).isEqualTo(coordinates);
+		assertThat(build.dependencies().has("tomcat")).isFalse();
+		io.spring.initializr.generator.buildsystem.Dependency dependency = build.dependencies().get("tomcat-runtime");
+		assertThat(dependency.getGroupId()).isEqualTo("org.springframework.boot");
+		assertThat(dependency.getArtifactId()).isEqualTo("spring-boot-starter-tomcat-runtime");
+		assertThat(dependency.getScope()).isEqualTo(DependencyScope.PROVIDED_RUNTIME);
+	}
+
+	private Build createGradleBuild(InitializrMetadata metadata, String bootVersion) {
+		Version version = Version.parse(bootVersion);
+		this.projectDescription.setPlatformVersion(version);
+		return new GradleBuild(new MetadataBuildItemResolver(metadata, version));
 	}
 
 	private Build createBuild(InitializrMetadata metadata) {