Reduce appearance of duplicate entries in dependency list report.

openrewrite · Sep 27, 2024 · d009531 · d009531
1 parent 52401d9
commit d009531
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 13 deletions.
diff --git a/src/main/java/org/openrewrite/java/dependencies/DependencyList.java b/src/main/java/org/openrewrite/java/dependencies/DependencyList.java
@@ -23,8 +23,13 @@
 import org.openrewrite.gradle.marker.GradleProject;
 import org.openrewrite.java.dependencies.table.DependencyListReport;
 import org.openrewrite.marker.Markers;
+import org.openrewrite.maven.tree.GroupArtifactVersion;
 import org.openrewrite.maven.tree.MavenResolutionResult;
 import org.openrewrite.maven.tree.ResolvedDependency;
+import org.openrewrite.maven.tree.ResolvedGroupArtifactVersion;
+
+import java.util.HashSet;
+import java.util.Set;
 
 @Value
 @EqualsAndHashCode(callSuper = false)
@@ -40,10 +45,16 @@ public class DependencyList extends Recipe {
 
     @Option(displayName = "Include transitive dependencies",
             description = "Whether or not to include transitive dependencies in the report. " +
-                    "Defaults to including only direct dependencies.",
+                          "Defaults to including only direct dependencies.",
             example = "true")
     boolean includeTransitive;
 
+    /**
+     * Freestanding gradle script plugins get assigned the same GradleProject marker with the build script in the project.
+     * Keep track of the ones which have been seen to minimize duplicate entries in the report.
+     */
+    transient Set<GroupArtifactVersion> seenGradleProjects = new HashSet<>();
+
     @Override
     public String getDisplayName() {
         return "Dependency report";
@@ -52,7 +63,7 @@ public String getDisplayName() {
     @Override
     public String getDescription() {
         return "Emits a data table detailing all Gradle and Maven dependencies." +
-                "This recipe makes no changes to any source file.";
+               "This recipe makes no changes to any source file.";
     }
 
     @Override
@@ -64,43 +75,52 @@ public TreeVisitor<?, ExecutionContext> getVisitor() {
                     return null;
                 }
                 Markers m = tree.getMarkers();
-                m.findFirst(GradleProject.class).ifPresent(gradle -> {
+                Set<ResolvedGroupArtifactVersion> seen = new HashSet<>();
+                m.findFirst(GradleProject.class)
+                        .filter(gradle -> seenGradleProjects.add(new GroupArtifactVersion(gradle.getGroup(), gradle.getName(), gradle.getVersion())))
+                        .ifPresent(gradle -> {
                     GradleDependencyConfiguration conf = gradle.getConfiguration(scope.asGradleConfigurationName());
                     if (conf != null) {
                         for (ResolvedDependency dep : conf.getResolved()) {
-                            insertDependency(ctx, gradle, dep, true);
+                            insertDependency(ctx, gradle, seen, dep, true);
                         }
                     }
                 });
                 m.findFirst(MavenResolutionResult.class).ifPresent(maven -> {
                     for (ResolvedDependency dep : maven.getDependencies().get(scope.asMavenScope())) {
-                        insertDependency(ctx, maven, dep, true);
+                        insertDependency(ctx, maven, seen, dep, true);
                     }
                 });
                 return tree;
             }
         };
     }
 
-    private void insertDependency(ExecutionContext ctx, GradleProject gradle, ResolvedDependency dep, boolean direct) {
+    private void insertDependency(ExecutionContext ctx, GradleProject gradle, Set<ResolvedGroupArtifactVersion> seen, ResolvedDependency dep, boolean direct) {
+        if (!seen.add(dep.getGav())) {
+            return;
+        }
         report.insertRow(ctx, new DependencyListReport.Row(
                 "Gradle",
-                "",
+                gradle.getGroup(),
                 gradle.getName(),
-                "",
+                gradle.getVersion(),
                 dep.getGroupId(),
                 dep.getArtifactId(),
                 dep.getVersion(),
                 direct
         ));
         if (includeTransitive) {
             for (ResolvedDependency transitive : dep.getDependencies()) {
-                insertDependency(ctx, gradle, transitive, false);
+                insertDependency(ctx, gradle, seen, transitive, false);
             }
         }
     }
 
-    private void insertDependency(ExecutionContext ctx, MavenResolutionResult maven, ResolvedDependency dep, boolean direct) {
+    private void insertDependency(ExecutionContext ctx, MavenResolutionResult maven, Set<ResolvedGroupArtifactVersion> seen, ResolvedDependency dep, boolean direct) {
+        if (!seen.add(dep.getGav())) {
+            return;
+        }
         report.insertRow(ctx, new DependencyListReport.Row(
                 "Maven",
                 maven.getPom().getGroupId(),
@@ -113,7 +133,7 @@ private void insertDependency(ExecutionContext ctx, MavenResolutionResult maven,
         ));
         if (includeTransitive) {
             for (ResolvedDependency transitive : dep.getDependencies()) {
-                insertDependency(ctx, maven, transitive, false);
+                insertDependency(ctx, maven, seen, transitive, false);
             }
         }
     }

diff --git a/src/test/java/org/openrewrite/java/dependencies/DependencyListTest.java b/src/test/java/org/openrewrite/java/dependencies/DependencyListTest.java
@@ -51,11 +51,9 @@ void basic() {
               plugins {
                   id 'java'
               }
-                            
               repositories {
                   mavenCentral()
               }
-                            
               dependencies {
                   implementation('org.openrewrite:rewrite-core:7.39.0')
               }