Only allow Gradle AddDependency to add dependencies to the top-leve…

…l `dependencies` block (#4181) Fixes gh-4094
openrewrite · May 9, 2024 · 6db9201 · 6db9201
1 parent 264e8e8
commit 6db9201
Show file tree

Hide file tree

Showing 3 changed files with 64 additions and 1 deletion.
diff --git a/rewrite-gradle/src/main/java/org/openrewrite/gradle/AddDependency.java b/rewrite-gradle/src/main/java/org/openrewrite/gradle/AddDependency.java
@@ -241,11 +241,15 @@ public TreeVisitor<?, ExecutionContext> getVisitor(Scanned acc) {
                         G.CompilationUnit g = (G.CompilationUnit) s;
                         for (String resolvedConfiguration : resolvedConfigurations) {
                             g = (G.CompilationUnit) new AddDependencyVisitor(groupId, artifactId, version, versionPattern, resolvedConfiguration,
-                                    classifier, extension, metadataFailures).visitNonNull(g, ctx);
+                                    classifier, extension, metadataFailures, this::isTopLevel).visitNonNull(g, ctx);
                         }
 
                         return g;
                     }
+
+                    private boolean isTopLevel(Cursor cursor) {
+                        return cursor.getParent().firstEnclosing(J.MethodInvocation.class) == null;
+                    }
                 })
         );
     }

diff --git a/rewrite-gradle/src/main/java/org/openrewrite/gradle/AddDependencyVisitor.java b/rewrite-gradle/src/main/java/org/openrewrite/gradle/AddDependencyVisitor.java
@@ -41,6 +41,7 @@
 import org.openrewrite.tree.ParseError;
 
 import java.util.*;
+import java.util.function.Predicate;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -76,6 +77,9 @@ public class AddDependencyVisitor extends GroovyIsoVisitor<ExecutionContext> {
     @Nullable
     private String resolvedVersion;
 
+    @Nullable
+    private final Predicate<Cursor> insertPredicate;
+
     @Override
     public G.CompilationUnit visitCompilationUnit(G.CompilationUnit cu, ExecutionContext ctx) {
         Optional<GradleProject> maybeGp = cu.getMarkers().findFirst(GradleProject.class);
@@ -220,6 +224,10 @@ public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, Execu
                 return m;
             }
 
+            if (!insertPredicate.test(getCursor())) {
+                return m;
+            }
+
             J.Lambda dependenciesBlock = (J.Lambda) m.getArguments().get(0);
             if (!(dependenciesBlock.getBody() instanceof J.Block)) {
                 return m;

diff --git a/rewrite-gradle/src/test/java/org/openrewrite/gradle/AddDependencyTest.java b/rewrite-gradle/src/test/java/org/openrewrite/gradle/AddDependencyTest.java
@@ -1261,6 +1261,57 @@ void defaultConfigurationEscaped() {
         );
     }
 
+    @Test
+    @Issue("https://github.com/openrewrite/rewrite/issues/4094")
+    void doNotAddToIncorrectBlocks() {
+        rewriteRun(
+          spec -> spec.recipe(addDependency("com.google.guava:guava:29.0-jre", "com.google.common.math.IntMath", null)),
+          mavenProject("project",
+            srcMainJava(
+              java(usingGuavaIntMath)
+            ),
+            buildGradle(
+              """
+                plugins {
+                    id 'java'
+                    id 'io.spring.dependency-management' version '1.1.5'
+                }
+                
+                repositories {
+                    mavenCentral()
+                }
+                
+                dependencyManagement {
+                    dependencies {
+                        dependency "org.openrewrite:rewrite-core:8.0.0"
+                    }
+                }
+                """,
+              """
+                plugins {
+                    id 'java'
+                    id 'io.spring.dependency-management' version '1.1.5'
+                }
+                
+                repositories {
+                    mavenCentral()
+                }
+                
+                dependencyManagement {
+                    dependencies {
+                        dependency "org.openrewrite:rewrite-core:8.0.0"
+                    }
+                }
+                
+                dependencies {
+                    implementation "com.google.guava:guava:29.0-jre"
+                }
+                """
+            )
+          )
+        );
+    }
+
     private AddDependency addDependency(String gav, String onlyIfUsing) {
         return addDependency(gav, onlyIfUsing, null);
     }