Skip to content

Add RemoveRedundantDependencyVersions.Skip marker #6852

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

Draft
Jenson3210 wants to merge 7 commits into
base: main
Choose a base branch
from
+208 −0
Draft

Add RemoveRedundantDependencyVersions.Skip marker #6852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8fbea18
Add retainExplicitVersion option to UpgradeDependencyVersion
Jenson3210 Mar 2, 2026
ee46e59
Apply suggestion from @timtebeek
Jenson3210 Mar 2, 2026
afc03d2
Revert retainExplicitVersion in favor of marker-based approach
Jenson3210 Mar 3, 2026
b2bda2a
Add RemoveRedundantDependencyVersions.Skip marker
Jenson3210 Mar 3, 2026
b6541ce
Improve Skip marker tests
Jenson3210 Mar 3, 2026
6e3a020
Remove customer-requests @Issue annotation from SkipMarker tests
Jenson3210 Mar 3, 2026
a4a176d
Remove unnecessary Skip marker check from managed dependency branch
Jenson3210 Mar 3, 2026
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
16 changes: 16 additions & 0 deletions rewrite-maven/src/main/java/org/openrewrite/maven/RemoveRedundantDependencyVersions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@
import com.fasterxml.jackson.annotation.JsonCreator;
import lombok.EqualsAndHashCode;
import lombok.Value;
import lombok.With;
import org.jspecify.annotations.Nullable;
import org.openrewrite.*;
import org.openrewrite.marker.Marker;
import org.openrewrite.internal.ListUtils;
import org.openrewrite.internal.StringUtils;
import org.openrewrite.maven.internal.MavenPomDownloader;
Expand Down Expand Up @@ -172,6 +174,9 @@ public Xml.Document visitDocument(Xml.Document document, ExecutionContext ctx) {
@Override
public Xml.@Nullable Tag visitTag(Xml.Tag tag, ExecutionContext ctx) {
if (isDependencyTag()) {
if (tag.getMarkers().findFirst(Skip.class).isPresent()) {
return tag;
}
ResolvedDependency d = findDependency(tag);
if (d != null &&
matchesGroup(d) &&
Expand Down Expand Up @@ -409,4 +414,15 @@ private static class RemoveEmptyPluginsTags extends MavenIsoVisitor<ExecutionCon
return t;
}
}

/**
* A marker that can be placed on a Maven dependency tag to indicate that its explicit
* {@code <version>} should be retained, even when this recipe would otherwise remove it
* as redundant.
*/
@Value
@With
public static class Skip implements Marker {
UUID id;
}
}
192 changes: 192 additions & 0 deletions rewrite-maven/src/test/java/org/openrewrite/maven/RemoveRedundantDependencyVersionsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,22 @@
*/
package org.openrewrite.maven;

import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import org.openrewrite.DocumentExample;
import org.openrewrite.Issue;
import org.openrewrite.Tree;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;
import org.openrewrite.test.SourceSpec;
import org.openrewrite.xml.tree.Xml;

import static java.util.Collections.singletonList;
import static org.openrewrite.java.Assertions.mavenProject;
import static org.openrewrite.maven.Assertions.pomXml;
import static org.openrewrite.test.RewriteTest.toRecipe;

class RemoveRedundantDependencyVersionsTest implements RewriteTest {

Expand Down Expand Up @@ -2282,4 +2286,192 @@ void exceptManagedDependencyShouldNotBeRemoved() {
)
);
}

@Nested
class SkipMarker {

@Test
void dependencyWithSkipMarkerKeepsVersion() {
String pom = """
<project>
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>29.0-jre</version>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>29.0-jre</version>
</dependency>
</dependencies>
</project>
""";
rewriteRun(
spec -> spec.recipe(toRecipe(() -> new MavenIsoVisitor<>() {
@Override
public Xml.Tag visitTag(Xml.Tag tag, org.openrewrite.ExecutionContext ctx) {
Xml.Tag t = super.visitTag(tag, ctx);
if (isDependencyTag("com.google.guava", "guava") &&
!t.getMarkers().findFirst(RemoveRedundantDependencyVersions.Skip.class).isPresent()) {
t = t.withMarkers(t.getMarkers().add(new RemoveRedundantDependencyVersions.Skip(Tree.randomId())));
}
if (isProjectTag()) {
doAfterVisit(new RemoveRedundantDependencyVersions(null, null, null, null).getVisitor());
}
return t;
}
})),
pomXml(pom, pom)
);
}

@Test
void dependencyWithoutSkipMarkerHasVersionRemoved() {
rewriteRun(
pomXml(
"""
<project>
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>29.0-jre</version>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>29.0-jre</version>
</dependency>
</dependencies>
</project>
""",
"""
<project>
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>29.0-jre</version>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
</dependency>
</dependencies>
</project>
"""
)
);
}

@Test
void skipMarkerOnlyAffectsMarkedDependency() {
rewriteRun(
spec -> spec.recipe(toRecipe(() -> new MavenIsoVisitor<>() {
@Override
public Xml.Tag visitTag(Xml.Tag tag, org.openrewrite.ExecutionContext ctx) {
Xml.Tag t = super.visitTag(tag, ctx);
if (isDependencyTag("com.google.guava", "guava") &&
!t.getMarkers().findFirst(RemoveRedundantDependencyVersions.Skip.class).isPresent()) {
t = t.withMarkers(t.getMarkers().add(new RemoveRedundantDependencyVersions.Skip(Tree.randomId())));
}
if (isProjectTag()) {
doAfterVisit(new RemoveRedundantDependencyVersions(null, null, null, null).getVisitor());
}
return t;
}
})),
pomXml(
"""
<project>
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>29.0-jre</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.11.0</version>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>29.0-jre</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.11.0</version>
</dependency>
</dependencies>
</project>
""",
"""
<project>
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>29.0-jre</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.11.0</version>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>29.0-jre</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
</dependency>
</dependencies>
</project>
"""
)
);
}
}
}