Add spring-boot-restdocs to Boot 4.0 projects using REST Docs

Closes gh-1996

Author: wilkinsona

start-site/src/main/java/io/spring/start/site/extension/dependency/springrestdocs/SpringRestDocsBuildCustomizer.java

@@ -18,7 +18,11 @@
 
 import io.spring.initializr.generator.buildsystem.Build;
 import io.spring.initializr.generator.buildsystem.DependencyScope;
+import io.spring.initializr.generator.project.ProjectDescription;
 import io.spring.initializr.generator.spring.build.BuildCustomizer;
+import io.spring.initializr.generator.version.Version;
+import io.spring.initializr.generator.version.VersionParser;
+import io.spring.initializr.generator.version.VersionRange;
 
 /**
  * A {@link BuildCustomizer} that tunes the REST Docs dependency based on the web
@@ -28,8 +32,21 @@
  */
 public class SpringRestDocsBuildCustomizer implements BuildCustomizer<Build> {
 
+	private static final VersionRange SPRING_BOOT_4_0_0_OR_LATER = VersionParser.DEFAULT.parseRange("4.0.0");
+
+	private final Version bootVersion;
+
+	public SpringRestDocsBuildCustomizer(ProjectDescription projectDescription) {
+		this.bootVersion = projectDescription.getPlatformVersion();
+	}
+
 	@Override
 	public void customize(Build build) {
+		if (SPRING_BOOT_4_0_0_OR_LATER.match(this.bootVersion)) {
+			build.dependencies()
+				.add("spring-boot-restdocs", "org.springframework.boot", "spring-boot-restdocs",
+						DependencyScope.TEST_COMPILE);
+		}
 		if (switchToWebTestClient(build)) {
 			build.dependencies().remove("restdocs");
 			build.dependencies()

start-site/src/main/java/io/spring/start/site/extension/dependency/springrestdocs/SpringRestDocsProjectGenerationConfiguration.java

@@ -20,6 +20,7 @@
 import io.spring.initializr.generator.buildsystem.maven.MavenBuildSystem;
 import io.spring.initializr.generator.condition.ConditionalOnBuildSystem;
 import io.spring.initializr.generator.condition.ConditionalOnRequestedDependency;
+import io.spring.initializr.generator.project.ProjectDescription;
 import io.spring.initializr.generator.project.ProjectGenerationConfiguration;
 
 import org.springframework.context.annotation.Bean;
@@ -36,8 +37,8 @@
 public class SpringRestDocsProjectGenerationConfiguration {
 
 	@Bean
-	SpringRestDocsBuildCustomizer springRestDocsBuildCustomizer() {
-		return new SpringRestDocsBuildCustomizer();
+	SpringRestDocsBuildCustomizer springRestDocsBuildCustomizer(ProjectDescription projectDescription) {
+		return new SpringRestDocsBuildCustomizer(projectDescription);
 	}
 
 	@Bean

start-site/src/test/java/io/spring/start/site/extension/dependency/springrestdocs/SpringRestDocsBuildCustomizerTests.java

@@ -17,6 +17,7 @@
 package io.spring.start.site.extension.dependency.springrestdocs;
 
 import io.spring.initializr.web.project.ProjectRequest;
+import io.spring.start.site.SupportedBootVersion;
 import io.spring.start.site.extension.AbstractExtensionTests;
 import org.junit.jupiter.api.Test;
 
@@ -31,26 +32,38 @@ class SpringRestDocsBuildCustomizerTests extends AbstractExtensionTests {
 
 	@Test
 	void restDocsWithWebMvc() {
-		ProjectRequest request = createProjectRequest("web", "restdocs");
+		ProjectRequest request = createProjectRequest(SupportedBootVersion.V3_5, "web", "restdocs");
 		assertThat(mavenPom(request))
 			.hasDependency("org.springframework.restdocs", "spring-restdocs-mockmvc", null, "test")
-			.doesNotHaveDependency("org.springframework.restdocs", "spring-restdocs-webtestclient");
+			.doesNotHaveDependency("org.springframework.restdocs", "spring-restdocs-webtestclient")
+			.doesNotHaveDependency("org.springframework.boot", "spring-boot-restdocs");
 	}
 
 	@Test
 	void restDocsWithWebFlux() {
-		ProjectRequest request = createProjectRequest("webflux", "restdocs");
+		ProjectRequest request = createProjectRequest(SupportedBootVersion.V3_5, "webflux", "restdocs");
 		assertThat(mavenPom(request))
 			.hasDependency("org.springframework.restdocs", "spring-restdocs-webtestclient", null, "test")
-			.doesNotHaveDependency("org.springframework.restdocs", "spring-restdocs-mockmvc");
+			.doesNotHaveDependency("org.springframework.restdocs", "spring-restdocs-mockmvc")
+			.doesNotHaveDependency("org.springframework.boot", "spring-boot-restdocs");
 	}
 
 	@Test
 	void restDocsWithJersey() {
-		ProjectRequest request = createProjectRequest("jersey", "restdocs");
+		ProjectRequest request = createProjectRequest(SupportedBootVersion.V3_5, "jersey", "restdocs");
 		assertThat(mavenPom(request))
 			.hasDependency("org.springframework.restdocs", "spring-restdocs-webtestclient", null, "test")
-			.doesNotHaveDependency("org.springframework.restdocs", "spring-restdocs-mockmvc");
+			.doesNotHaveDependency("org.springframework.restdocs", "spring-restdocs-mockmvc")
+			.doesNotHaveDependency("org.springframework.boot", "spring-boot-restdocs");
+	}
+
+	@Test
+	void restDocsWithBoot4() {
+		ProjectRequest request = createProjectRequest(SupportedBootVersion.V4_0, "web", "restdocs");
+		assertThat(mavenPom(request))
+			.hasDependency("org.springframework.restdocs", "spring-restdocs-mockmvc", null, "test")
+			.hasDependency("org.springframework.boot", "spring-boot-restdocs", null, "test")
+			.doesNotHaveDependency("org.springframework.restdocs", "spring-restdocs-webtestclient");
 	}
 
 }