[MDEP-644] Add tgf, dot, graphml support for verboseGraphSerializer

src/main/java/org/apache/maven/plugins/dependency/tree/VerboseGraphSerializer.java → src/main/java/org/apache/maven/plugins/dependency/tree/AbstractVerboseGraphSerializer.java

@@ -33,45 +33,17 @@
 import java.util.Set;
 
 /**
- * Parses dependency graph and outputs in text format for end user to review.
+ * Base class for verbose Serializers
  */
-final class VerboseGraphSerializer
+abstract class AbstractVerboseGraphSerializer
 {
-    private static final String LINE_START_LAST_CHILD = "\\- ", LINE_START_CHILD = "+- ";
-    private static final String PRE_MANAGED_SCOPE = "preManagedScope", PRE_MANAGED_VERSION = "preManagedVersion",
+    protected static final String LINE_START_LAST_CHILD = "\\- ", LINE_START_CHILD = "+- ";
+    protected static final String PRE_MANAGED_SCOPE = "preManagedScope", PRE_MANAGED_VERSION = "preManagedVersion",
             MANAGED_SCOPE = "managedScope";
 
-    public String serialize( DependencyNode root )
-    {
-        Set<String> coordinateStrings = new HashSet<>();
-        Map<String, String> coordinateVersionMap = new HashMap<>();
-        StringBuilder builder = new StringBuilder();
-
-        // Use BFS to mirror how Maven resolves dependencies and use DFS to print the tree easily
-        Map<DependencyNode, String> nodeErrors = getNodeConflictMessagesBfs( root, coordinateStrings,
-                coordinateVersionMap );
-
-        // deal with root first
-        Artifact rootArtifact = root.getArtifact();
-        builder.append( rootArtifact.getGroupId() ).append( ":" ).append( rootArtifact.getArtifactId() ).append( ":" )
-                .append( rootArtifact.getExtension() ).append( ":" ).append( rootArtifact.getVersion() ).append(
-                        System.lineSeparator() );
+    public abstract String serialize( DependencyNode root );
 
-        for ( int i = 0; i < root.getChildren().size(); i++ )
-        {
-            if ( i == root.getChildren().size() - 1 )
-            {
-                dfsPrint( root.getChildren().get( i ), LINE_START_LAST_CHILD, false, builder, nodeErrors );
-            }
-            else
-            {
-                dfsPrint( root.getChildren().get( i ), LINE_START_CHILD, false, builder, nodeErrors );
-            }
-        }
-        return builder.toString();
-    }
-
-    private static String getDependencyCoordinate( DependencyNode node )
+    protected static String getDependencyCoordinate( DependencyNode node )
     {
         Artifact artifact = node.getArtifact();
 
@@ -140,7 +112,7 @@ private static String scopeConflict( DependencyNode node, Set<String> coordinate
         return null;
     }
 
-    private Map<DependencyNode, String> getNodeConflictMessagesBfs( DependencyNode root, Set<String> coordinateStrings
+    protected Map<DependencyNode, String> getNodeConflictMessagesBfs( DependencyNode root, Set<String> coordinateStrings
             , Map<String, String> coordinateVersionMap )
     {
         Map<DependencyNode, String> nodeErrors = new HashMap<>();
@@ -166,8 +138,11 @@ private Map<DependencyNode, String> getNodeConflictMessagesBfs( DependencyNode r
             }
             else if ( scopeConflict( node, coordinateStrings ) != null )
             {
-                nodeErrors.put( node, "omitted for conflict with "
-                        + scopeConflict( node, coordinateStrings ) );
+                nodeErrors.put( node, "omitted for conflict with " + scopeConflict( node, coordinateStrings ) );
+            }
+            else if ( versionConflict( node, coordinateVersionMap ) != null )
+            {
+                nodeErrors.put( node, "omitted for conflict with " + versionConflict( node, coordinateVersionMap ) );
             }
             else if ( versionConflict( node, coordinateVersionMap ) != null )
             {
@@ -219,106 +194,4 @@ else if ( node.getDependency() != null && node.getDependency().isOptional() )
         }
         return nodeErrors;
     }
-
-    private void dfsPrint( DependencyNode node, String start, boolean transitive, StringBuilder builder,
-                           Map<DependencyNode, String> nodeErrors )
-    {
-        builder.append( start );
-        if ( node.getArtifact() == null )
-        {
-            // Should never hit this condition with a proper graph sent in
-            builder.append( "Null Artifact Node" ).append( System.lineSeparator() );
-            callDfsPrint( node, start, builder, nodeErrors );
-        }
-
-        String coordString = "";
-        boolean messageAdded = false;
-
-        if ( transitive && node.getArtifact().getProperties().containsKey( PRE_MANAGED_VERSION ) )
-        {
-            coordString = coordString.concat( " - version managed from "
-                    + node.getArtifact().getProperties().get( PRE_MANAGED_VERSION ) );
-            messageAdded = true;
-        }
-
-        if ( transitive && node.getArtifact().getProperties().containsKey( PRE_MANAGED_SCOPE ) )
-        {
-            if ( messageAdded )
-            {
-                coordString = coordString.concat( "; " );
-            }
-            else
-            {
-                coordString = coordString.concat( " - " );
-                messageAdded = true;
-            }
-            coordString = coordString.concat( "scope managed from "
-                    + node.getArtifact().getProperties().get( PRE_MANAGED_SCOPE ) );
-        }
-
-        coordString = getDependencyCoordinate( node ) + coordString;
-
-        if ( !( node.getDependency().getScope().equals( "test" ) && transitive ) )
-        {
-            if ( node.getArtifact().getProperties().containsKey( "Cycle" ) )
-            {
-                if ( messageAdded )
-                {
-                    coordString = coordString.concat( "; " );
-                }
-                else
-                {
-                    coordString = coordString.concat( " - " );
-                }
-                coordString = coordString.concat( "omitted for cycle" );
-                builder.append( "(" ).append( coordString ).append( ")" ).append( System.lineSeparator() );
-            }
-            else if ( nodeErrors.get( node ) != null )
-            {
-                builder.append( "(" );
-                if ( messageAdded )
-                {
-                    builder.append( coordString ).append( "; " ).append( nodeErrors.get( node ) );
-                }
-                else
-                {
-                    builder.append( coordString ).append( " - " ).append( nodeErrors.get( node ) );
-                }
-                builder.append( ")" );
-                builder.append( System.lineSeparator() );
-            }
-            else
-            {
-                builder.append( coordString ).append( System.lineSeparator() );
-                callDfsPrint( node, start, builder, nodeErrors );
-            }
-        }
-    }
-
-    private void callDfsPrint( DependencyNode node, String start, StringBuilder builder,
-                               Map<DependencyNode, String> nodeErrors )
-    {
-        for ( int i = 0; i < node.getChildren().size(); i++ )
-        {
-            if ( start.endsWith( LINE_START_CHILD ) )
-            {
-                start = start.replace( LINE_START_CHILD, "|  " );
-            }
-            else if ( start.endsWith( LINE_START_LAST_CHILD ) )
-            {
-                start = start.replace( LINE_START_LAST_CHILD, "   " );
-            }
-
-            if ( i == node.getChildren().size() - 1 )
-            {
-                dfsPrint( node.getChildren().get( i ), start.concat( LINE_START_LAST_CHILD ), true, builder,
-                        nodeErrors );
-            }
-            else
-            {
-                dfsPrint( node.getChildren().get( i ), start.concat( LINE_START_CHILD ), true, builder,
-                        nodeErrors );
-            }
-        }
-    }
 }

src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java

@@ -268,7 +268,7 @@ public void execute()
                 // verboseGraphBuilder needs MavenProject project, RepositorySystemSession session,
                 // ProjectDependenciesResolver resolver
                 VerboseDependencyGraphBuilder builder = new VerboseDependencyGraphBuilder();
-                VerboseGraphSerializer serializer = new VerboseGraphSerializer();
+                AbstractVerboseGraphSerializer serializer = getSerializer();
 
                 org.eclipse.aether.graph.DependencyNode verboseRootNode = builder.buildVerboseGraph(
                         project, resolver, repoSession );
@@ -350,6 +350,25 @@ public void setSkip( boolean skip )
 
     // private methods --------------------------------------------------------
 
+    private AbstractVerboseGraphSerializer getSerializer( )
+    {
+        if ( "graphml".equals( outputType ) )
+        {
+            return new VerboseGraphGraphmlSerializer();
+        }
+        else if ( "tgf".equals( outputType ) )
+        {
+            return new VerboseGraphTgfSerializer();
+        }
+        else if ( "dot".equals( outputType ) )
+        {
+            return new VerboseGraphDotSerializer();
+        }
+        else
+        {
+            return new VerboseGraphTextSerializer();
+        }
+    }
 
     private DependencyNode convertToCustomDependencyNode( org.eclipse.aether.graph.DependencyNode node )
     {

src/main/java/org/apache/maven/plugins/dependency/tree/VerboseDependencyGraphBuilder.java

@@ -57,7 +57,7 @@ class VerboseDependencyGraphBuilder
             MANAGED_SCOPE = "managedScope";
 
     public DependencyNode buildVerboseGraph( MavenProject project, ProjectDependenciesResolver resolver,
-                                                         RepositorySystemSession repositorySystemSession )
+                                             RepositorySystemSession repositorySystemSession )
             throws DependencyResolutionException
     {
         DefaultRepositorySystemSession session = MavenRepositorySystemUtils.newSession();
@@ -66,13 +66,12 @@ public DependencyNode buildVerboseGraph( MavenProject project, ProjectDependenci
         DependencySelector dependencySelector = new AndDependencySelector(
                 // ScopeDependencySelector takes exclusions. 'Provided' scope is not here to avoid
                 // false positive in LinkageChecker.
-                new ScopeDependencySelector(),
-                new ExclusionDependencySelector() );
+                new ScopeDependencySelector(), new ExclusionDependencySelector() );
 
         session.setDependencySelector( dependencySelector );
-        session.setDependencyGraphTransformer( new ChainedDependencyGraphTransformer(
-                new CycleBreakerGraphTransformer(), // Avoids StackOverflowError
-                new JavaDependencyContextRefiner() ) );
+        session.setDependencyGraphTransformer(
+                new ChainedDependencyGraphTransformer( new CycleBreakerGraphTransformer(), // Avoids StackOverflowError
+                        new JavaDependencyContextRefiner() ) );
         session.setDependencyManager( null );
 
         DependencyResolutionRequest request = new DefaultDependencyResolutionRequest();
@@ -152,26 +151,26 @@ private static Map<String, org.apache.maven.model.Dependency> createDependencyMa
 
     private static String getDependencyManagementCoordinate( org.apache.maven.model.Dependency dependency )
     {
-        StringBuilder string = new StringBuilder();
-        string.append( dependency.getGroupId() ).append( ":" ).append( dependency.getArtifactId() )
-                .append( ":" ).append( dependency.getType() );
+        StringBuilder builder = new StringBuilder();
+        builder.append( dependency.getGroupId() ).append( ":" ).append( dependency.getArtifactId() ).append( ":" )
+                .append( dependency.getType() );
         if ( dependency.getClassifier() != null && !dependency.getClassifier().equals( "" ) )
         {
-            string.append( ":" ).append( dependency.getClassifier() );
+            builder.append( ":" ).append( dependency.getClassifier() );
         }
-        return string.toString();
+        return builder.toString();
     }
 
     private static String getDependencyManagementCoordinate( Artifact artifact )
     {
-        StringBuilder string = new StringBuilder();
-        string.append( artifact.getGroupId() ).append( ":" ).append( artifact.getArtifactId() ).append( ":" )
-                .append( artifact.getExtension() );
+        StringBuilder builder = new StringBuilder();
+        builder.append( artifact.getGroupId() ).append( ":" ).append( artifact.getArtifactId() ).append( ":" ).append(
+                artifact.getExtension() );
         if ( artifact.getClassifier() != null && !artifact.getClassifier().equals( "" ) )
         {
-            string.append( ":" ).append( artifact.getClassifier() );
+            builder.append( ":" ).append( artifact.getClassifier() );
         }
-        return string.toString();
+        return builder.toString();
     }
 
     private Dependency getProjectDependency( MavenProject project )
@@ -199,7 +198,7 @@ private DependencyNode pruneTransitiveTestDependencies( DependencyNode rootNode,
         return newRoot;
     }
 
-    private void pruneTransitiveTestDependenciesDfs( DependencyNode node , Set<DependencyNode> visitedNodes )
+    private void pruneTransitiveTestDependenciesDfs( DependencyNode node, Set<DependencyNode> visitedNodes )
     {
         if ( !visitedNodes.contains( node ) )
         {