diff --git a/src/main/resources/META-INF/rewrite/java-version-17.yml b/src/main/resources/META-INF/rewrite/java-version-17.yml index ff5e73db31..d80478cdfc 100644 --- a/src/main/resources/META-INF/rewrite/java-version-17.yml +++ b/src/main/resources/META-INF/rewrite/java-version-17.yml @@ -327,13 +327,25 @@ recipeList: version: 0.2.0 configuration: annotationProcessor acceptTransitive: false - - org.openrewrite.maven.AddDependency: + - org.openrewrite.java.migrate.AddLombokMapstructBindingMavenDependencyOnly + - org.openrewrite.maven.AddAnnotationProcessor: groupId: org.projectlombok artifactId: lombok-mapstruct-binding version: 0.2.0 - acceptTransitive: false - - org.openrewrite.maven.AddAnnotationProcessor: +--- +type: specs.openrewrite.org/v1beta/recipe +name: org.openrewrite.java.migrate.AddLombokMapstructBindingMavenDependencyOnly +displayName: Add `lombok-mapstruct-binding` dependency for Maven when both MapStruct and Lombok are used +description: >- + Add the `lombok-mapstruct-binding` when both MapStruct and Lombok are used, and the dependency does not already exist. + Only to be called from `org.openrewrite.java.migrate.AddLombokMapstructBinding` to reduce redundant checks +preconditions: + - org.openrewrite.java.dependencies.search.DoesNotIncludeDependency: + groupId: org.projectlombok + artifactId: lombok-mapstruct-binding +recipeList: + - org.openrewrite.maven.AddDependency: groupId: org.projectlombok artifactId: lombok-mapstruct-binding version: 0.2.0 - + acceptTransitive: false diff --git a/src/test/java/org/openrewrite/java/migrate/AddLombokMapstructBindingTest.java b/src/test/java/org/openrewrite/java/migrate/AddLombokMapstructBindingTest.java new file mode 100644 index 0000000000..1b02fd7227 --- /dev/null +++ b/src/test/java/org/openrewrite/java/migrate/AddLombokMapstructBindingTest.java @@ -0,0 +1,253 @@ +/* + * Copyright 2025 the original author or authors. + *

+ * Licensed under the Moderne Source Available License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://docs.moderne.io/licensing/moderne-source-available-license + *

+ * 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 org.openrewrite.java.migrate; + +import org.junit.jupiter.api.Test; +import org.openrewrite.DocumentExample; +import org.openrewrite.test.RecipeSpec; +import org.openrewrite.test.RewriteTest; + +import static org.openrewrite.gradle.Assertions.buildGradle; +import static org.openrewrite.gradle.toolingapi.Assertions.withToolingApi; +import static org.openrewrite.java.Assertions.mavenProject; +import static org.openrewrite.maven.Assertions.pomXml; + +class AddLombokMapstructBindingTest implements RewriteTest { + @Override + public void defaults(RecipeSpec spec) { + spec.recipeFromResources("org.openrewrite.java.migrate.AddLombokMapstructBinding"); + } + + @DocumentExample + @Test + void addForGradle() { + rewriteRun( + spec -> spec.beforeRecipe(withToolingApi()), + mavenProject("project", + //language=groovy + buildGradle( + """ + plugins { id 'java' } + repositories { mavenCentral() } + dependencies { + implementation "org.projectlombok:lombok:1.18.42" + implementation "org.mapstruct:mapstruct:1.6.3" + } + """, + """ + plugins { id 'java' } + repositories { mavenCentral() } + dependencies { + annotationProcessor "org.projectlombok:lombok-mapstruct-binding:0.2.0" + + implementation "org.projectlombok:lombok:1.18.42" + implementation "org.mapstruct:mapstruct:1.6.3" + } + """ + ) + ) + ); + } + + @Test + void doesNotDuplicateGradle() { + rewriteRun( + spec -> spec.beforeRecipe(withToolingApi()), + mavenProject("project", + //language=groovy + buildGradle( + """ + plugins { id 'java' } + repositories { mavenCentral() } + dependencies { + annotationProcessor "org.projectlombok:lombok-mapstruct-binding:0.2.0" + + implementation "org.projectlombok:lombok:1.18.42" + implementation "org.mapstruct:mapstruct:1.6.3" + } + """ + ) + ) + ); + } + + @Test + void addForMaven() { + rewriteRun( + mavenProject("project", + //language=xml + pomXml( + """ + + com.mycompany.app + my-app + 1 + + + org.projectlombok + lombok + 1.18.42 + + + org.mapstruct + mapstruct + 1.6.3 + + + + + org.apache.maven.plugins + maven-compiler-plugin + + + + org.projectlombok + lombok + + + + 3.14.1 + + + + """, + """ + + com.mycompany.app + my-app + 1 + + + org.projectlombok + lombok + 1.18.42 + + + org.projectlombok + lombok-mapstruct-binding + 0.2.0 + + + org.mapstruct + mapstruct + 1.6.3 + + + + + org.apache.maven.plugins + maven-compiler-plugin + + + + org.projectlombok + lombok + + + org.projectlombok + lombok-mapstruct-binding + 0.2.0 + + + + 3.14.1 + + + + """ + ), + mavenProject("anotherProject", + //language=xml + pomXml( + """ + + org.someother + anotherproject + 1.0.0 + + 17 + + + + + """ + ) + ) + ) + ); + } + + @Test + void doesNotDuplicateMaven() { + rewriteRun( + mavenProject("project", + //language=xml + pomXml( + """ + + com.mycompany.app + my-app + 1 + + 17 + 0.2.0 + + + + org.projectlombok + lombok + 1.18.42 + provided + + + org.projectlombok + lombok-mapstruct-binding + ${lombok.mapstruct.binding.version} + provided + + + org.mapstruct + mapstruct + 1.6.3 + + + + + org.apache.maven.plugins + maven-compiler-plugin + + + + org.projectlombok + lombok + + + org.projectlombok + lombok-mapstruct-binding + 0.2.0 + + + + 3.14.1 + + + + """ + ) + ) + ); + } +}