1 | |
package org.apache.maven.report.projectinfo; |
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | |
|
19 | |
|
20 | |
|
21 | |
|
22 | |
import org.apache.maven.artifact.Artifact; |
23 | |
import org.apache.maven.artifact.factory.ArtifactFactory; |
24 | |
import org.apache.maven.artifact.manager.WagonManager; |
25 | |
import org.apache.maven.artifact.metadata.ArtifactMetadataSource; |
26 | |
import org.apache.maven.artifact.repository.metadata.RepositoryMetadataManager; |
27 | |
import org.apache.maven.artifact.resolver.filter.ArtifactFilter; |
28 | |
import org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter; |
29 | |
import org.apache.maven.plugins.annotations.Component; |
30 | |
import org.apache.maven.plugins.annotations.Mojo; |
31 | |
import org.apache.maven.plugins.annotations.Parameter; |
32 | |
import org.apache.maven.plugins.annotations.ResolutionScope; |
33 | |
import org.apache.maven.project.MavenProjectBuilder; |
34 | |
import org.apache.maven.report.projectinfo.dependencies.Dependencies; |
35 | |
import org.apache.maven.report.projectinfo.dependencies.DependenciesReportConfiguration; |
36 | |
import org.apache.maven.report.projectinfo.dependencies.RepositoryUtils; |
37 | |
import org.apache.maven.report.projectinfo.dependencies.renderer.DependenciesRenderer; |
38 | |
import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder; |
39 | |
import org.apache.maven.shared.dependency.graph.DependencyGraphBuilderException; |
40 | |
import org.apache.maven.shared.dependency.graph.DependencyNode; |
41 | |
import org.apache.maven.shared.jar.classes.JarClassesAnalysis; |
42 | |
import org.codehaus.plexus.util.IOUtil; |
43 | |
import org.codehaus.plexus.util.ReaderFactory; |
44 | |
|
45 | |
import java.io.File; |
46 | |
import java.io.FileOutputStream; |
47 | |
import java.io.IOException; |
48 | |
import java.io.InputStream; |
49 | |
import java.io.InputStreamReader; |
50 | |
import java.io.LineNumberReader; |
51 | |
import java.util.Locale; |
52 | |
|
53 | |
|
54 | |
|
55 | |
|
56 | |
|
57 | |
|
58 | |
|
59 | |
|
60 | |
|
61 | |
@Mojo( name = "dependencies", requiresDependencyResolution = ResolutionScope.TEST ) |
62 | 0 | public class DependenciesReport |
63 | |
extends AbstractProjectInfoReport |
64 | |
{ |
65 | |
|
66 | |
|
67 | |
|
68 | |
private static final String RESOURCES_DIR = "org/apache/maven/report/projectinfo/resources"; |
69 | |
|
70 | |
|
71 | |
|
72 | |
|
73 | |
|
74 | |
|
75 | |
|
76 | |
|
77 | |
@Component |
78 | |
private MavenProjectBuilder mavenProjectBuilder; |
79 | |
|
80 | |
|
81 | |
|
82 | |
|
83 | |
@Component |
84 | |
protected ArtifactMetadataSource artifactMetadataSource; |
85 | |
|
86 | |
|
87 | |
|
88 | |
|
89 | |
|
90 | |
|
91 | |
@Component |
92 | |
private WagonManager wagonManager; |
93 | |
|
94 | |
|
95 | |
|
96 | |
|
97 | |
|
98 | |
|
99 | |
@Component( hint = "default" ) |
100 | |
private DependencyGraphBuilder dependencyGraphBuilder; |
101 | |
|
102 | |
|
103 | |
|
104 | |
|
105 | |
|
106 | |
|
107 | |
@Component |
108 | |
private JarClassesAnalysis classesAnalyzer; |
109 | |
|
110 | |
|
111 | |
|
112 | |
|
113 | |
|
114 | |
|
115 | |
@Component |
116 | |
private RepositoryMetadataManager repositoryMetadataManager; |
117 | |
|
118 | |
|
119 | |
|
120 | |
|
121 | |
|
122 | |
|
123 | |
@Component |
124 | |
private ArtifactFactory artifactFactory; |
125 | |
|
126 | |
|
127 | |
|
128 | |
|
129 | |
|
130 | |
|
131 | |
|
132 | |
|
133 | |
|
134 | |
|
135 | |
|
136 | |
@Parameter( property = "dependency.details.enabled", defaultValue = "true" ) |
137 | |
private boolean dependencyDetailsEnabled; |
138 | |
|
139 | |
|
140 | |
|
141 | |
|
142 | |
|
143 | |
|
144 | |
|
145 | |
@Parameter( property = "dependency.locations.enabled", defaultValue = "true" ) |
146 | |
private boolean dependencyLocationsEnabled; |
147 | |
|
148 | |
|
149 | |
|
150 | |
|
151 | |
|
152 | |
@Override |
153 | |
public void executeReport( Locale locale ) |
154 | |
{ |
155 | 0 | if ( settings.isOffline() && dependencyLocationsEnabled ) |
156 | |
{ |
157 | 0 | getLog().warn( "The parameter 'dependencyLocationsEnabled' is ignored in offline mode." ); |
158 | 0 | dependencyLocationsEnabled = false; |
159 | |
} |
160 | |
|
161 | |
try |
162 | |
{ |
163 | 0 | copyResources( new File( getOutputDirectory() ) ); |
164 | |
} |
165 | 0 | catch ( IOException e ) |
166 | |
{ |
167 | 0 | getLog().error( "Cannot copy ressources", e ); |
168 | 0 | } |
169 | |
|
170 | 0 | @SuppressWarnings( "unchecked" ) RepositoryUtils repoUtils = |
171 | |
new RepositoryUtils( getLog(), wagonManager, settings, mavenProjectBuilder, factory, resolver, |
172 | |
project.getRemoteArtifactRepositories(), project.getPluginArtifactRepositories(), |
173 | |
localRepository, repositoryMetadataManager ); |
174 | |
|
175 | 0 | DependencyNode dependencyNode = resolveProject(); |
176 | |
|
177 | 0 | Dependencies dependencies = new Dependencies( project, dependencyNode, classesAnalyzer ); |
178 | |
|
179 | 0 | DependenciesReportConfiguration config = |
180 | |
new DependenciesReportConfiguration( dependencyDetailsEnabled, dependencyLocationsEnabled ); |
181 | |
|
182 | 0 | DependenciesRenderer r = |
183 | |
new DependenciesRenderer( getSink(), locale, getI18N( locale ), getLog(), settings, dependencies, |
184 | |
dependencyNode, config, repoUtils, artifactFactory, mavenProjectBuilder, |
185 | |
remoteRepositories, localRepository ); |
186 | 0 | r.render(); |
187 | 0 | } |
188 | |
|
189 | |
|
190 | |
|
191 | |
|
192 | |
public String getOutputName() |
193 | |
{ |
194 | 0 | return "dependencies"; |
195 | |
} |
196 | |
|
197 | |
@Override |
198 | |
protected String getI18Nsection() |
199 | |
{ |
200 | 0 | return "dependencies"; |
201 | |
} |
202 | |
|
203 | |
|
204 | |
|
205 | |
|
206 | |
|
207 | |
|
208 | |
|
209 | |
|
210 | |
private DependencyNode resolveProject() |
211 | |
{ |
212 | |
try |
213 | |
{ |
214 | 0 | ArtifactFilter artifactFilter = new ScopeArtifactFilter( Artifact.SCOPE_TEST ); |
215 | 0 | return dependencyGraphBuilder.buildDependencyGraph( project, artifactFilter ); |
216 | |
} |
217 | 0 | catch ( DependencyGraphBuilderException e ) |
218 | |
{ |
219 | 0 | getLog().error( "Unable to build dependency tree.", e ); |
220 | 0 | return null; |
221 | |
} |
222 | |
} |
223 | |
|
224 | |
|
225 | |
|
226 | |
|
227 | |
|
228 | |
private void copyResources( File outputDirectory ) |
229 | |
throws IOException |
230 | |
{ |
231 | 0 | InputStream resourceList = null; |
232 | 0 | LineNumberReader reader = null; |
233 | |
try |
234 | |
{ |
235 | 0 | resourceList = getClass().getClassLoader().getResourceAsStream( RESOURCES_DIR + "/resources.txt" ); |
236 | |
|
237 | 0 | if ( resourceList != null ) |
238 | |
{ |
239 | 0 | reader = new LineNumberReader( new InputStreamReader( resourceList, ReaderFactory.US_ASCII ) ); |
240 | |
|
241 | 0 | String line = reader.readLine(); |
242 | |
|
243 | 0 | while ( line != null ) |
244 | |
{ |
245 | 0 | InputStream is = getClass().getClassLoader().getResourceAsStream( RESOURCES_DIR + "/" + line ); |
246 | |
|
247 | 0 | if ( is == null ) |
248 | |
{ |
249 | 0 | throw new IOException( "The resource " + line + " doesn't exist." ); |
250 | |
} |
251 | |
|
252 | 0 | File outputFile = new File( outputDirectory, line ); |
253 | |
|
254 | 0 | if ( !outputFile.getParentFile().exists() ) |
255 | |
{ |
256 | 0 | outputFile.getParentFile().mkdirs(); |
257 | |
} |
258 | |
|
259 | 0 | FileOutputStream w = null; |
260 | |
try |
261 | |
{ |
262 | 0 | w = new FileOutputStream( outputFile ); |
263 | 0 | IOUtil.copy( is, w ); |
264 | |
} |
265 | |
finally |
266 | |
{ |
267 | 0 | IOUtil.close( is ); |
268 | |
|
269 | 0 | IOUtil.close( w ); |
270 | 0 | } |
271 | |
|
272 | 0 | line = reader.readLine(); |
273 | 0 | } |
274 | |
} |
275 | |
} |
276 | |
finally |
277 | |
{ |
278 | 0 | IOUtil.close( resourceList ); |
279 | 0 | IOUtil.close( reader ); |
280 | 0 | } |
281 | 0 | } |
282 | |
} |