diff --git a/initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/build/gradle/GradleAnnotationProcessorScopeBuildCustomizer.java b/initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/build/gradle/GradleAnnotationProcessorScopeBuildCustomizer.java new file mode 100644 index 00000000..3a3dbb8c --- /dev/null +++ b/initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/build/gradle/GradleAnnotationProcessorScopeBuildCustomizer.java @@ -0,0 +1,50 @@ +/* + * Copyright 2012-2019 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.spring.initializr.generator.spring.build.gradle; + +import io.spring.initializr.generator.buildsystem.DependencyScope; +import io.spring.initializr.generator.buildsystem.gradle.GradleBuild; +import io.spring.initializr.generator.spring.build.BuildCustomizer; + +import org.springframework.core.Ordered; + +/** + * Gradle {@link BuildCustomizer} that adds a workaround so that annotation processors are + * properly detected when using the `annotationProcessor` scope. + * + * @author Stephane Nicoll + */ +public class GradleAnnotationProcessorScopeBuildCustomizer + implements BuildCustomizer { + + @Override + public void customize(GradleBuild build) { + boolean annotationProcessorUsed = build.dependencies().items() + .anyMatch((dependency) -> dependency + .getScope() == DependencyScope.ANNOTATION_PROCESSOR); + if (annotationProcessorUsed) { + build.customizeConfiguration("compileOnly", + (configuration) -> configuration.extendsFrom("annotationProcessor")); + } + } + + @Override + public int getOrder() { + return Ordered.LOWEST_PRECEDENCE; + } + +} diff --git a/initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfiguration.java b/initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfiguration.java index b34e16ee..4ffde2cf 100644 --- a/initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfiguration.java +++ b/initializr-generator-spring/src/main/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfiguration.java @@ -200,6 +200,11 @@ public class GradleProjectGenerationConfiguration { projectDescription.getPlatformVersion().toString()); } + @Bean + public GradleAnnotationProcessorScopeBuildCustomizer gradleAnnotationProcessorScopeBuildCustomizer() { + return new GradleAnnotationProcessorScopeBuildCustomizer(); + } + } } diff --git a/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleAnnotationProcessorScopeBuildCustomizerTests.java b/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleAnnotationProcessorScopeBuildCustomizerTests.java new file mode 100644 index 00000000..9f3211a3 --- /dev/null +++ b/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleAnnotationProcessorScopeBuildCustomizerTests.java @@ -0,0 +1,61 @@ +/* + * Copyright 2012-2019 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.spring.initializr.generator.spring.build.gradle; + +import io.spring.initializr.generator.buildsystem.DependencyScope; +import io.spring.initializr.generator.buildsystem.gradle.GradleBuild; +import io.spring.initializr.generator.buildsystem.gradle.GradleBuild.ConfigurationCustomization; +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link GradleAnnotationProcessorScopeBuildCustomizer}. + * + * @author Stephane Nicoll + */ +class GradleAnnotationProcessorScopeBuildCustomizerTests { + + @Test + void compileOnlyConfigurationIsAddedWithAnnotationProcessorDependency() { + GradleBuild build = new GradleBuild(); + build.dependencies().add("lib", "com.example", "lib", DependencyScope.COMPILE); + build.dependencies().add("ap", "com.example", "model-generator", + DependencyScope.ANNOTATION_PROCESSOR); + customize(build); + assertThat(build.getConfigurationCustomizations()) + .containsOnlyKeys("compileOnly"); + ConfigurationCustomization compileOnly = build.getConfigurationCustomizations() + .get("compileOnly"); + assertThat(compileOnly.getExtendsFrom()).containsOnly("annotationProcessor"); + } + + @Test + void compileOnlyConfigurationIsNotAddedWithNonMatchingDependency() { + GradleBuild build = new GradleBuild(); + build.dependencies().add("lib", "com.example", "lib", DependencyScope.COMPILE); + build.dependencies().add("another", "com.example", "another", + DependencyScope.RUNTIME); + customize(build); + assertThat(build.getConfigurationCustomizations()).isEmpty(); + } + + private void customize(GradleBuild build) { + new GradleAnnotationProcessorScopeBuildCustomizer().customize(build); + } + +} diff --git a/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleConfigurationBuildCustomizerTests.java b/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleConfigurationBuildCustomizerTests.java index 56e09b52..4431514f 100644 --- a/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleConfigurationBuildCustomizerTests.java +++ b/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleConfigurationBuildCustomizerTests.java @@ -65,30 +65,6 @@ class GradleConfigurationBuildCustomizerTests { assertThat(build.getConfigurationCustomizations()).isEmpty(); } - @Test - void compileOnlyConfigurationIsAddedWithAnnotationProcessorDependency() { - GradleBuild build = new GradleBuild(); - build.dependencies().add("lib", "com.example", "lib", DependencyScope.COMPILE); - build.dependencies().add("ap", "com.example", "model-generator", - DependencyScope.ANNOTATION_PROCESSOR); - customize(build); - assertThat(build.getConfigurationCustomizations()) - .containsOnlyKeys("compileOnly"); - ConfigurationCustomization compileOnly = build.getConfigurationCustomizations() - .get("compileOnly"); - assertThat(compileOnly.getExtendsFrom()).containsOnly("annotationProcessor"); - } - - @Test - void compileOnlyConfigurationIsNotAddedWithNonMatchingDependency() { - GradleBuild build = new GradleBuild(); - build.dependencies().add("lib", "com.example", "lib", DependencyScope.COMPILE); - build.dependencies().add("another", "com.example", "another", - DependencyScope.RUNTIME); - customize(build); - assertThat(build.getConfigurationCustomizations()).isEmpty(); - } - private void customize(GradleBuild build) { new GradleConfigurationBuildCustomizer().customize(build); } diff --git a/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfigurationTests.java b/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfigurationTests.java index 27ac2d3f..7dfd5924 100644 --- a/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfigurationTests.java +++ b/initializr-generator-spring/src/test/java/io/spring/initializr/generator/spring/build/gradle/GradleProjectGenerationConfigurationTests.java @@ -23,6 +23,7 @@ import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.Path; import java.util.List; +import java.util.Map; import java.util.stream.Stream; import io.spring.initializr.generator.buildsystem.Dependency; @@ -153,6 +154,25 @@ class GradleProjectGenerationConfigurationTests { } } + static Stream annotationProcessorScopeBuildParameters() { + return Stream.of(Arguments.arguments("1.5.17.RELEASE", false), + Arguments.arguments("2.0.6.RELEASE", true), + Arguments.arguments("2.1.3.RELEASE", true)); + } + + @ParameterizedTest(name = "Spring Boot {0}") + @MethodSource("annotationProcessorScopeBuildParameters") + void gradleAnnotationProcessorScopeCustomizerIsContributedIfNecessary( + String platformVersion, boolean contributorExpected) { + ProjectDescription description = new ProjectDescription(); + description.setPlatformVersion(Version.parse(platformVersion)); + description.setLanguage(new JavaLanguage()); + Map generate = this.projectTester + .generate(description, (context) -> context.getBeansOfType( + GradleAnnotationProcessorScopeBuildCustomizer.class)); + assertThat(generate).hasSize((contributorExpected) ? 1 : 0); + } + private static String[] readAllLines(Path file) throws IOException { String content = StreamUtils.copyToString( new FileInputStream(new File(file.toString())), StandardCharsets.UTF_8);