Coverage Report

Coverage Report - org.apache.maven.report.projectinfo.dependencies.Dependencies

Classes in this File

Line Coverage

Branch Coverage

Complexity

Dependencies

61%

66/108

45%

33/74

4.8

 package org.apache.maven.report.projectinfo.dependencies;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * 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.
  */
 
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.artifact.ArtifactUtils;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.shared.dependency.tree.DependencyNode;
 import org.apache.maven.shared.jar.JarAnalyzer;
 import org.apache.maven.shared.jar.JarData;
 import org.apache.maven.shared.jar.classes.JarClassesAnalysis;
 
 /**
  * @version $Id: Dependencies.java 890109 2009-12-13 19:57:28Z ltheussl $
  * @since 2.1
  */
 public class Dependencies
 {
     private final MavenProject project;
 
     private final DependencyNode dependencyTreeNode;
 
     private final JarClassesAnalysis classesAnalyzer;
 
     /**
      * @since 2.1
      */
     private List projectDependencies;
 
     /**
      * @since 2.1
      */
     private List projectTransitiveDependencies;
 
     /**
      * @since 2.1
      */
     private List allDependencies;
 
     /**
      * @since 2.1
      */
     private Map dependenciesByScope;
 
     /**
      * @since 2.1
      */
     private Map transitiveDependenciesByScope;
 
     /**
      * @since 2.1
      */
     private Map dependencyDetails;
 
     /**
      * Default constructor
      *
      * @param project the MavenProject.
      * @param dependencyTreeNode the DependencyNode.
      * @param classesAnalyzer the JarClassesAnalysis.
      */
     public Dependencies( MavenProject project, DependencyNode dependencyTreeNode,
                          JarClassesAnalysis classesAnalyzer )
     {
         this.project = project;
         this.dependencyTreeNode = dependencyTreeNode;
         this.classesAnalyzer = classesAnalyzer;
 
         /*
          * Workaround to ensure proper File objects in the Artifacts from the ReportResolutionListener
          */
         Map projectMap = new HashMap();
         Iterator it = project.getArtifacts().iterator();
         while ( it.hasNext() )
         {
             Artifact artifact = (Artifact) it.next();
             projectMap.put( ArtifactUtils.versionlessKey( artifact ), artifact );
         }
 
         mapArtifactFiles( dependencyTreeNode, projectMap );
     }
 
     /**
      * Getter for the project
      *
      * @return the project
      */
     public MavenProject getProject()
     {
         return project;
     }
 
     /**
      * @return <code>true</code> if getProjectDependencies() is not empty, <code>false</code> otherwise.
      */
     public boolean hasDependencies()
     {
         return ( getProjectDependencies() != null ) && ( !getProjectDependencies().isEmpty() );
     }
 
     /**
      * @return a list of <code>Artifact</code> from the project.
      */
     public List getProjectDependencies()
     {
         if ( projectDependencies != null )
         {
             return projectDependencies;
         }
 
         projectDependencies = new ArrayList();
         for ( Iterator i = dependencyTreeNode.getChildren().iterator(); i.hasNext(); )
         {
             DependencyNode dependencyNode = (DependencyNode) i.next();
 
             projectDependencies.add( dependencyNode.getArtifact() );
         }
 
         return projectDependencies;
     }
 
     /**
      * @return a list of transitive <code>Artifact</code> from the project.
      */
     public List getTransitiveDependencies()
     {
         if ( projectTransitiveDependencies != null )
         {
             return projectTransitiveDependencies;
         }
 
         projectTransitiveDependencies = new ArrayList( getAllDependencies() );
         projectTransitiveDependencies.removeAll( getProjectDependencies() );
 
         return projectTransitiveDependencies;
     }
 
     /**
      * @return a list of included <code>Artifact</code> returned by the dependency tree.
      */
     public List getAllDependencies()
     {
         if ( allDependencies != null )
         {
             return allDependencies;
         }
 
         allDependencies = new ArrayList();
         for ( Iterator i = dependencyTreeNode.getChildren().iterator(); i.hasNext(); )
         {
             DependencyNode dependencyNode = (DependencyNode) i.next();
 
             if ( dependencyNode.getState() != DependencyNode.INCLUDED )
             {
                 continue;
             }
 
             if ( dependencyNode.getArtifact().getGroupId().equals( project.getGroupId() )
                 && dependencyNode.getArtifact().getArtifactId().equals( project.getArtifactId() )
                 && dependencyNode.getArtifact().getVersion().equals( project.getVersion() ) )
             {
                 continue;
             }
 
             if ( !allDependencies.contains( dependencyNode.getArtifact() ) )
             {
                 allDependencies.add( dependencyNode.getArtifact() );
             }
             getAllDependencies( dependencyNode );
         }
 
         return allDependencies;
     }
 
     /**
      * @param isTransitively <code>true</code> to return transitive dependencies, <code>false</code> otherwise.
      * @return a map with supported scopes as key and a list of <code>Artifact</code> as values.
      * @see Artifact#SCOPE_COMPILE
      * @see Artifact#SCOPE_PROVIDED
      * @see Artifact#SCOPE_RUNTIME
      * @see Artifact#SCOPE_SYSTEM
      * @see Artifact#SCOPE_TEST
      */
     public Map getDependenciesByScope( boolean isTransitively )
     {
         if ( isTransitively )
         {
             if ( transitiveDependenciesByScope != null )
             {
                 return transitiveDependenciesByScope;
             }
 
             transitiveDependenciesByScope = new HashMap();
             for ( Iterator i = getTransitiveDependencies().iterator(); i.hasNext(); )
             {
                 Artifact artifact = (Artifact) i.next();
 
                 List multiValue = (List) transitiveDependenciesByScope.get( artifact.getScope() );
                 if ( multiValue == null )
                 {
                     multiValue = new ArrayList();
                 }
 
                 if ( !multiValue.contains( artifact ) )
                 {
                     multiValue.add( artifact );
                 }
                 transitiveDependenciesByScope.put( artifact.getScope(), multiValue );
             }
 
             return transitiveDependenciesByScope;
         }
 
         if ( dependenciesByScope != null )
         {
             return dependenciesByScope;
         }
 
         dependenciesByScope = new HashMap();
         for ( Iterator i = getProjectDependencies().iterator(); i.hasNext(); )
         {
             Artifact artifact = (Artifact) i.next();
 
             List multiValue = (List) dependenciesByScope.get( artifact.getScope() );
             if ( multiValue == null )
             {
                 multiValue = new ArrayList();
             }
 
             if ( !multiValue.contains( artifact ) )
             {
                 multiValue.add( artifact );
             }
             dependenciesByScope.put( artifact.getScope(), multiValue );
         }
 
         return dependenciesByScope;
     }
 
     /**
      * @param artifact the artifact.
      * @return the jardata object from the artifact
      * @throws IOException if any
      */
     public JarData getJarDependencyDetails( Artifact artifact )
         throws IOException
     {
         if ( dependencyDetails == null )
         {
             dependencyDetails = new HashMap();
         }
 
         JarData old = (JarData) dependencyDetails.get( artifact.getId() );
         if ( dependencyDetails.get( artifact.getId() ) != null )
         {
             return old;
         }
 
         JarAnalyzer jarAnalyzer = new JarAnalyzer( artifact.getFile() );
         try
         {
             classesAnalyzer.analyze( jarAnalyzer );
         }
         finally
         {
             jarAnalyzer.closeQuietly();
         }
 
         dependencyDetails.put( artifact.getId(), jarAnalyzer.getJarData() );
 
         return jarAnalyzer.getJarData();
     }
 
     // ----------------------------------------------------------------------
     // Private methods
     // ----------------------------------------------------------------------
 
     private void mapArtifactFiles( DependencyNode node, Map projectMap )
     {
         List childs = node.getChildren();
         if ( ( childs == null ) || childs.isEmpty() )
         {
             return;
         }
 
         Iterator it = childs.iterator();
         while ( it.hasNext() )
         {
             DependencyNode anode = (DependencyNode) it.next();
             String key = ArtifactUtils.versionlessKey( anode.getArtifact() );
             Artifact projartifact = (Artifact) projectMap.get( key );
             if ( projartifact != null )
             {
                 anode = new DependencyNode( ArtifactUtils.copyArtifact( projartifact ) );
                 anode.getArtifact().setFile( projartifact.getFile() );
             }
 
             mapArtifactFiles( anode, projectMap );
         }
     }
 
     /**
      * Recursive method to get all dependencies from a given <code>dependencyNode</code>
      *
      * @param dependencyNode not null
      */
     private void getAllDependencies( DependencyNode dependencyNode )
     {
         if ( dependencyNode == null || dependencyNode.getChildren() == null )
         {
             if ( !allDependencies.contains( dependencyNode.getArtifact() ) )
             {
                 allDependencies.add( dependencyNode.getArtifact() );
             }
             return;
         }
 
         for ( Iterator i = dependencyNode.getChildren().iterator(); i.hasNext(); )
         {
             DependencyNode subdependencyNode = (DependencyNode) i.next();
 
             if ( subdependencyNode.getState() != DependencyNode.INCLUDED )
             {
                 continue;
             }
 
             if ( subdependencyNode.getArtifact().getGroupId().equals( project.getGroupId() )
                 && subdependencyNode.getArtifact().getArtifactId().equals( project.getArtifactId() )
                 && subdependencyNode.getArtifact().getVersion().equals( project.getVersion() ) )
             {
                 continue;
             }
 
             if ( !allDependencies.contains( subdependencyNode.getArtifact() ) )
             {
                 allDependencies.add( subdependencyNode.getArtifact() );
             }
             getAllDependencies( subdependencyNode );
         }
     }
 }

1		package org.apache.maven.report.projectinfo.dependencies;
2
3		/*
4		* Licensed to the Apache Software Foundation (ASF) under one
5		* or more contributor license agreements. See the NOTICE file
6		* distributed with this work for additional information
7		* regarding copyright ownership. The ASF licenses this file
8		* to you under the Apache License, Version 2.0 (the
9		* "License"); you may not use this file except in compliance
10		* with the License. You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing,
15		* software distributed under the License is distributed on an
16		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17		* KIND, either express or implied. See the License for the
18		* specific language governing permissions and limitations
19		* under the License.
20		*/
21
22		import java.io.IOException;
23		import java.util.ArrayList;
24		import java.util.HashMap;
25		import java.util.Iterator;
26		import java.util.List;
27		import java.util.Map;
28
29		import org.apache.maven.artifact.Artifact;
30		import org.apache.maven.artifact.ArtifactUtils;
31		import org.apache.maven.project.MavenProject;
32		import org.apache.maven.shared.dependency.tree.DependencyNode;
33		import org.apache.maven.shared.jar.JarAnalyzer;
34		import org.apache.maven.shared.jar.JarData;
35		import org.apache.maven.shared.jar.classes.JarClassesAnalysis;
36
37		/**
38		* @version $Id: Dependencies.java 890109 2009-12-13 19:57:28Z ltheussl $
39		* @since 2.1
40		*/
41		public class Dependencies
42		{
43		private final MavenProject project;
44
45		private final DependencyNode dependencyTreeNode;
46
47		private final JarClassesAnalysis classesAnalyzer;
48
49		/**
50		* @since 2.1
51		*/
52		private List projectDependencies;
53
54		/**
55		* @since 2.1
56		*/
57		private List projectTransitiveDependencies;
58
59		/**
60		* @since 2.1
61		*/
62		private List allDependencies;
63
64		/**
65		* @since 2.1
66		*/
67		private Map dependenciesByScope;
68
69		/**
70		* @since 2.1
71		*/
72		private Map transitiveDependenciesByScope;
73
74		/**
75		* @since 2.1
76		*/
77		private Map dependencyDetails;
78
79		/**
80		* Default constructor
81		*
82		* @param project the MavenProject.
83		* @param dependencyTreeNode the DependencyNode.
84		* @param classesAnalyzer the JarClassesAnalysis.
85		*/
86		public Dependencies( MavenProject project, DependencyNode dependencyTreeNode,
87		JarClassesAnalysis classesAnalyzer )
88	1	{
89	1	this.project = project;
90	1	this.dependencyTreeNode = dependencyTreeNode;
91	1	this.classesAnalyzer = classesAnalyzer;
92
93		/*
94		* Workaround to ensure proper File objects in the Artifacts from the ReportResolutionListener
95		*/
96	1	Map projectMap = new HashMap();
97	1	Iterator it = project.getArtifacts().iterator();
98	1	while ( it.hasNext() )
99		{
100	0	Artifact artifact = (Artifact) it.next();
101	0	projectMap.put( ArtifactUtils.versionlessKey( artifact ), artifact );
102	0	}
103
104	1	mapArtifactFiles( dependencyTreeNode, projectMap );
105	1	}
106
107		/**
108		* Getter for the project
109		*
110		* @return the project
111		*/
112		public MavenProject getProject()
113		{
114	0	return project;
115		}
116
117		/**
118		* @return <code>true</code> if getProjectDependencies() is not empty, <code>false</code> otherwise.
119		*/
120		public boolean hasDependencies()
121		{
122	1	return ( getProjectDependencies() != null ) && ( !getProjectDependencies().isEmpty() );
123		}
124
125		/**
126		* @return a list of <code>Artifact</code> from the project.
127		*/
128		public List getProjectDependencies()
129		{
130	4	if ( projectDependencies != null )
131		{
132	3	return projectDependencies;
133		}
134
135	1	projectDependencies = new ArrayList();
136	1	for ( Iterator i = dependencyTreeNode.getChildren().iterator(); i.hasNext(); )
137		{
138	1	DependencyNode dependencyNode = (DependencyNode) i.next();
139
140	1	projectDependencies.add( dependencyNode.getArtifact() );
141	1	}
142
143	1	return projectDependencies;
144		}
145
146		/**
147		* @return a list of transitive <code>Artifact</code> from the project.
148		*/
149		public List getTransitiveDependencies()
150		{
151	1	if ( projectTransitiveDependencies != null )
152		{
153	0	return projectTransitiveDependencies;
154		}
155
156	1	projectTransitiveDependencies = new ArrayList( getAllDependencies() );
157	1	projectTransitiveDependencies.removeAll( getProjectDependencies() );
158
159	1	return projectTransitiveDependencies;
160		}
161
162		/**
163		* @return a list of included <code>Artifact</code> returned by the dependency tree.
164		*/
165		public List getAllDependencies()
166		{
167	2	if ( allDependencies != null )
168		{
169	1	return allDependencies;
170		}
171
172	1	allDependencies = new ArrayList();
173	1	for ( Iterator i = dependencyTreeNode.getChildren().iterator(); i.hasNext(); )
174		{
175	1	DependencyNode dependencyNode = (DependencyNode) i.next();
176
177	1	if ( dependencyNode.getState() != DependencyNode.INCLUDED )
178		{
179	0	continue;
180		}
181
182	1	if ( dependencyNode.getArtifact().getGroupId().equals( project.getGroupId() )
183		&& dependencyNode.getArtifact().getArtifactId().equals( project.getArtifactId() )
184		&& dependencyNode.getArtifact().getVersion().equals( project.getVersion() ) )
185		{
186	0	continue;
187		}
188
189	1	if ( !allDependencies.contains( dependencyNode.getArtifact() ) )
190		{
191	1	allDependencies.add( dependencyNode.getArtifact() );
192		}
193	1	getAllDependencies( dependencyNode );
194	1	}
195
196	1	return allDependencies;
197		}
198
199		/**
200		* @param isTransitively <code>true</code> to return transitive dependencies, <code>false</code> otherwise.
201		* @return a map with supported scopes as key and a list of <code>Artifact</code> as values.
202		* @see Artifact#SCOPE_COMPILE
203		* @see Artifact#SCOPE_PROVIDED
204		* @see Artifact#SCOPE_RUNTIME
205		* @see Artifact#SCOPE_SYSTEM
206		* @see Artifact#SCOPE_TEST
207		*/
208		public Map getDependenciesByScope( boolean isTransitively )
209		{
210	2	if ( isTransitively )
211		{
212	1	if ( transitiveDependenciesByScope != null )
213		{
214	0	return transitiveDependenciesByScope;
215		}
216
217	1	transitiveDependenciesByScope = new HashMap();
218	1	for ( Iterator i = getTransitiveDependencies().iterator(); i.hasNext(); )
219		{
220	0	Artifact artifact = (Artifact) i.next();
221
222	0	List multiValue = (List) transitiveDependenciesByScope.get( artifact.getScope() );
223	0	if ( multiValue == null )
224		{
225	0	multiValue = new ArrayList();
226		}
227
228	0	if ( !multiValue.contains( artifact ) )
229		{
230	0	multiValue.add( artifact );
231		}
232	0	transitiveDependenciesByScope.put( artifact.getScope(), multiValue );
233	0	}
234
235	1	return transitiveDependenciesByScope;
236		}
237
238	1	if ( dependenciesByScope != null )
239		{
240	0	return dependenciesByScope;
241		}
242
243	1	dependenciesByScope = new HashMap();
244	1	for ( Iterator i = getProjectDependencies().iterator(); i.hasNext(); )
245		{
246	1	Artifact artifact = (Artifact) i.next();
247
248	1	List multiValue = (List) dependenciesByScope.get( artifact.getScope() );
249	1	if ( multiValue == null )
250		{
251	1	multiValue = new ArrayList();
252		}
253
254	1	if ( !multiValue.contains( artifact ) )
255		{
256	1	multiValue.add( artifact );
257		}
258	1	dependenciesByScope.put( artifact.getScope(), multiValue );
259	1	}
260
261	1	return dependenciesByScope;
262		}
263
264		/**
265		* @param artifact the artifact.
266		* @return the jardata object from the artifact
267		* @throws IOException if any
268		*/
269		public JarData getJarDependencyDetails( Artifact artifact )
270		throws IOException
271		{
272	0	if ( dependencyDetails == null )
273		{
274	0	dependencyDetails = new HashMap();
275		}
276
277	0	JarData old = (JarData) dependencyDetails.get( artifact.getId() );
278	0	if ( dependencyDetails.get( artifact.getId() ) != null )
279		{
280	0	return old;
281		}
282
283	0	JarAnalyzer jarAnalyzer = new JarAnalyzer( artifact.getFile() );
284		try
285		{
286	0	classesAnalyzer.analyze( jarAnalyzer );
287		}
288		finally
289		{
290	0	jarAnalyzer.closeQuietly();
291	0	}
292
293	0	dependencyDetails.put( artifact.getId(), jarAnalyzer.getJarData() );
294
295	0	return jarAnalyzer.getJarData();
296		}
297
298		// ----------------------------------------------------------------------
299		// Private methods
300		// ----------------------------------------------------------------------
301
302		private void mapArtifactFiles( DependencyNode node, Map projectMap )
303		{
304	2	List childs = node.getChildren();
305	2	if ( ( childs == null ) \|\| childs.isEmpty() )
306		{
307	1	return;
308		}
309
310	1	Iterator it = childs.iterator();
311	2	while ( it.hasNext() )
312		{
313	1	DependencyNode anode = (DependencyNode) it.next();
314	1	String key = ArtifactUtils.versionlessKey( anode.getArtifact() );
315	1	Artifact projartifact = (Artifact) projectMap.get( key );
316	1	if ( projartifact != null )
317		{
318	0	anode = new DependencyNode( ArtifactUtils.copyArtifact( projartifact ) );
319	0	anode.getArtifact().setFile( projartifact.getFile() );
320		}
321
322	1	mapArtifactFiles( anode, projectMap );
323	1	}
324	1	}
325
326		/**
327		* Recursive method to get all dependencies from a given <code>dependencyNode</code>
328		*
329		* @param dependencyNode not null
330		*/
331		private void getAllDependencies( DependencyNode dependencyNode )
332		{
333	1	if ( dependencyNode == null \|\| dependencyNode.getChildren() == null )
334		{
335	0	if ( !allDependencies.contains( dependencyNode.getArtifact() ) )
336		{
337	0	allDependencies.add( dependencyNode.getArtifact() );
338		}
339	0	return;
340		}
341
342	1	for ( Iterator i = dependencyNode.getChildren().iterator(); i.hasNext(); )
343		{
344	0	DependencyNode subdependencyNode = (DependencyNode) i.next();
345
346	0	if ( subdependencyNode.getState() != DependencyNode.INCLUDED )
347		{
348	0	continue;
349		}
350
351	0	if ( subdependencyNode.getArtifact().getGroupId().equals( project.getGroupId() )
352		&& subdependencyNode.getArtifact().getArtifactId().equals( project.getArtifactId() )
353		&& subdependencyNode.getArtifact().getVersion().equals( project.getVersion() ) )
354		{
355	0	continue;
356		}
357
358	0	if ( !allDependencies.contains( subdependencyNode.getArtifact() ) )
359		{
360	0	allDependencies.add( subdependencyNode.getArtifact() );
361		}
362	0	getAllDependencies( subdependencyNode );
363	0	}
364	1	}
365		}