Skip to content

Wrapping the adding of the dependency for org.projectlombok:lombok-mapstruct-binding in a check to make sure you do not already have said dependency (potentially in another scope) #944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
steve-aom-elliott merged 2 commits into from
Nov 17, 2025
Merged

Wrapping the adding of the dependency for org.projectlombok:lombok-mapstruct-binding in a check to make sure you do not already have said dependency (potentially in another scope) #944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4adf19
Wrapping the adding of the dependency for `org.projectlombok:lombok-m…
steve-aom-elliott Nov 14, 2025
4a058da
Create a separate test class with separate tests for Maven and Gradle
timtebeek Nov 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions src/main/resources/META-INF/rewrite/java-version-17.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
253 changes: 253 additions & 0 deletions src/test/java/org/openrewrite/java/migrate/AddLombokMapstructBindingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
/*
* Copyright 2025 the original author or authors.
* <p>
* 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
* <p>
* https://docs.moderne.io/licensing/moderne-source-available-license
* <p>
* 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(
"""
<project>
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
<dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.42</version>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>1.6.3</version>
</dependency>
</dependencies>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</path>
</annotationProcessorPaths>
</configuration>
<version>3.14.1</version>
</plugin>
</plugins>
</project>
""",
"""
<project>
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
<dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.42</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-mapstruct-binding</artifactId>
<version>0.2.0</version>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>1.6.3</version>
</dependency>
</dependencies>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</path>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-mapstruct-binding</artifactId>
<version>0.2.0</version>
</path>
</annotationProcessorPaths>
</configuration>
<version>3.14.1</version>
</plugin>
</plugins>
</project>
"""
),
mavenProject("anotherProject",
//language=xml
pomXml(
"""
<project>
<groupId>org.someother</groupId>
<artifactId>anotherproject</artifactId>
<version>1.0.0</version>
<properties>
<maven.compiler.release>17</maven.compiler.release>
</properties>
<dependencies>
</dependencies>
</project>
"""
)
)
)
);
}

@Test
void doesNotDuplicateMaven() {
rewriteRun(
mavenProject("project",
//language=xml
pomXml(
"""
<project>
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
<properties>
<maven.compiler.release>17</maven.compiler.release>
<lombok.mapstruct.binding.version>0.2.0</lombok.mapstruct.binding.version>
</properties>
<dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.42</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-mapstruct-binding</artifactId>
<version>${lombok.mapstruct.binding.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>1.6.3</version>
</dependency>
</dependencies>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</path>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-mapstruct-binding</artifactId>
<version>0.2.0</version>
</path>
</annotationProcessorPaths>
</configuration>
<version>3.14.1</version>
</plugin>
</plugins>
</project>
"""
)
)
);
}
}