Allow annotation processors to be made available to tests when using Gradle

Closes gh-1380

Author: mhalbritter

initializr-generator/src/main/java/io/spring/initializr/generator/buildsystem/DependencyScope.java

@@ -24,7 +24,8 @@
 public enum DependencyScope {
 
 	/**
-	 * A dependency that is used as an annotation processor when compiling a project.
+	 * A dependency that is used as an annotation processor when compiling the main
+	 * sources of a project.
 	 */
 	ANNOTATION_PROCESSOR,
 
@@ -61,6 +62,12 @@ public enum DependencyScope {
 	/**
 	 * A dependency this is used to run a project's tests.
 	 */
-	TEST_RUNTIME
+	TEST_RUNTIME,
+
+	/**
+	 * A dependency that is used as an annotation processor when compiling the test
+	 * sources of a project.
+	 */
+	TEST_ANNOTATION_PROCESSOR
 
 }

initializr-generator/src/main/java/io/spring/initializr/generator/buildsystem/gradle/GradleBuildWriter.java

@@ -179,6 +179,8 @@ private void writeDependencies(IndentingWriter writer, GradleBuild build) {
 		sortedDependencies.addAll(filterDependencies(dependencies, hasScope(DependencyScope.TEST_COMPILE)));
 		sortedDependencies.addAll(filterDependencies(dependencies, hasScope(DependencyScope.TEST_COMPILE_ONLY)));
 		sortedDependencies.addAll(filterDependencies(dependencies, hasScope(DependencyScope.TEST_RUNTIME)));
+		sortedDependencies
+			.addAll(filterDependencies(dependencies, hasScope(DependencyScope.TEST_ANNOTATION_PROCESSOR)));
 		if (!sortedDependencies.isEmpty()) {
 			writer.println();
 			writer.println("dependencies" + " {");
@@ -214,6 +216,7 @@ protected String configurationForDependency(Dependency dependency) {
 		}
 		return switch (type) {
 			case ANNOTATION_PROCESSOR -> "annotationProcessor";
+			case TEST_ANNOTATION_PROCESSOR -> "testAnnotationProcessor";
 			case COMPILE -> "implementation";
 			case COMPILE_ONLY -> "compileOnly";
 			case PROVIDED_RUNTIME -> "providedRuntime";

initializr-generator/src/main/java/io/spring/initializr/generator/buildsystem/maven/MavenBuildWriter.java

@@ -265,7 +265,8 @@ private void writeDependencies(IndentingWriter writer, DependencyContainer depen
 			}
 			writeDependencies(writer, dependencies, hasScope(DependencyScope.RUNTIME));
 			writeDependencies(writer, dependencies, hasScope(DependencyScope.COMPILE_ONLY));
-			writeDependencies(writer, dependencies, hasScope(DependencyScope.ANNOTATION_PROCESSOR));
+			writeDependencies(writer, dependencies,
+					hasScope(DependencyScope.ANNOTATION_PROCESSOR, DependencyScope.TEST_ANNOTATION_PROCESSOR));
 			writeDependencies(writer, dependencies, hasScope(DependencyScope.PROVIDED_RUNTIME));
 			writeDependencies(writer, dependencies, hasScope(DependencyScope.TEST_COMPILE,
 					DependencyScope.TEST_COMPILE_ONLY, DependencyScope.TEST_RUNTIME));
@@ -313,7 +314,7 @@ private void writeDependencyExclusion(IndentingWriter writer, Exclusion exclusio
 			return null;
 		}
 		return switch (type) {
-			case ANNOTATION_PROCESSOR, COMPILE, COMPILE_ONLY -> null;
+			case ANNOTATION_PROCESSOR, TEST_ANNOTATION_PROCESSOR, COMPILE, COMPILE_ONLY -> null;
 			case PROVIDED_RUNTIME -> "provided";
 			case RUNTIME -> "runtime";
 			case TEST_COMPILE, TEST_COMPILE_ONLY, TEST_RUNTIME -> "test";
@@ -325,6 +326,7 @@ private boolean isOptional(Dependency dependency) {
 			return true;
 		}
 		return (dependency.getScope() == DependencyScope.ANNOTATION_PROCESSOR
+				|| dependency.getScope() == DependencyScope.TEST_ANNOTATION_PROCESSOR
 				|| dependency.getScope() == DependencyScope.COMPILE_ONLY);
 	}
 

initializr-generator/src/test/java/io/spring/initializr/generator/buildsystem/gradle/GroovyDslGradleBuildWriterTests.java

@@ -360,6 +360,18 @@ void gradleBuildWithAnnotationProcessorDependency() {
 				}""");
 	}
 
+	@Test
+	void gradleBuildWithTestAnnotationProcessorDependency() {
+		GradleBuild build = new GradleBuild();
+		build.dependencies()
+			.add("test-annotation-processor", "org.springframework.boot", "spring-boot-configuration-processor",
+					DependencyScope.TEST_ANNOTATION_PROCESSOR);
+		assertThat(write(build)).contains("""
+				dependencies {
+					testAnnotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
+				}""");
+	}
+
 	@Test
 	void gradleBuildWithCompileDependency() {
 		GradleBuild build = new GradleBuild();

initializr-generator/src/test/java/io/spring/initializr/generator/buildsystem/gradle/KotlinDslGradleBuildWriterTests.java

@@ -364,6 +364,18 @@ void gradleBuildWithAnnotationProcessorDependency() {
 				}""");
 	}
 
+	@Test
+	void gradleBuildWithTestAnnotationProcessorDependency() {
+		GradleBuild build = new GradleBuild();
+		build.dependencies()
+			.add("test-annotation-processor", "org.springframework.boot", "spring-boot-configuration-processor",
+					DependencyScope.TEST_ANNOTATION_PROCESSOR);
+		assertThat(write(build)).contains("""
+				dependencies {
+					testAnnotationProcessor("org.springframework.boot:spring-boot-configuration-processor")
+				}""");
+	}
+
 	@Test
 	void gradleBuildWithCompileDependency() {
 		GradleBuild build = new GradleBuild();

initializr-generator/src/test/java/io/spring/initializr/generator/buildsystem/maven/MavenBuildWriterTests.java

@@ -313,6 +313,23 @@ void pomWithAnnotationProcessorDependency() {
 		});
 	}
 
+	@Test
+	void pomWithTestAnnotationProcessorDependency() {
+		MavenBuild build = new MavenBuild();
+		build.settings().coordinates("com.example.demo", "demo");
+		build.dependencies()
+			.add("test-annotation-processor", "org.springframework.boot", "spring-boot-configuration-processor",
+					DependencyScope.TEST_ANNOTATION_PROCESSOR);
+		generatePom(build, (pom) -> {
+			NodeAssert dependency = pom.nodeAtPath("/project/dependencies/dependency");
+			assertThat(dependency).textAtPath("groupId").isEqualTo("org.springframework.boot");
+			assertThat(dependency).textAtPath("artifactId").isEqualTo("spring-boot-configuration-processor");
+			assertThat(dependency).textAtPath("version").isNullOrEmpty();
+			assertThat(dependency).textAtPath("scope").isNullOrEmpty();
+			assertThat(dependency).textAtPath("optional").isEqualTo("true");
+		});
+	}
+
 	@Test
 	void pomWithCompileOnlyDependency() {
 		MavenBuild build = new MavenBuild();