1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 package org.apache.maven.lifecycle.internal;
20
21 import javax.inject.Inject;
22 import javax.inject.Named;
23
24 import java.io.File;
25 import java.util.Collection;
26 import java.util.Collections;
27 import java.util.HashMap;
28 import java.util.HashSet;
29 import java.util.LinkedHashSet;
30 import java.util.List;
31 import java.util.Map;
32 import java.util.Set;
33 import java.util.stream.Collectors;
34 import java.util.stream.Stream;
35
36 import org.apache.maven.RepositoryUtils;
37 import org.apache.maven.artifact.Artifact;
38 import org.apache.maven.artifact.ArtifactUtils;
39 import org.apache.maven.eventspy.internal.EventSpyDispatcher;
40 import org.apache.maven.execution.MavenSession;
41 import org.apache.maven.lifecycle.LifecycleExecutionException;
42 import org.apache.maven.project.DefaultDependencyResolutionRequest;
43 import org.apache.maven.project.DependencyResolutionException;
44 import org.apache.maven.project.DependencyResolutionResult;
45 import org.apache.maven.project.MavenProject;
46 import org.apache.maven.project.ProjectDependenciesResolver;
47 import org.apache.maven.project.artifact.InvalidDependencyVersionException;
48 import org.apache.maven.project.artifact.ProjectArtifactsCache;
49 import org.codehaus.plexus.logging.Logger;
50 import org.eclipse.aether.graph.Dependency;
51 import org.eclipse.aether.graph.DependencyFilter;
52 import org.eclipse.aether.graph.DependencyNode;
53 import org.eclipse.aether.util.filter.AndDependencyFilter;
54 import org.eclipse.aether.util.filter.ScopeDependencyFilter;
55
56
57
58
59
60
61
62
63
64
65
66 @Named
67 public class LifecycleDependencyResolver {
68
69 @Inject
70 private ProjectDependenciesResolver dependenciesResolver;
71
72 @Inject
73 private Logger logger;
74
75 @Inject
76 private ProjectArtifactFactory artifactFactory;
77
78 @Inject
79 private EventSpyDispatcher eventSpyDispatcher;
80
81 @Inject
82 private ProjectArtifactsCache projectArtifactsCache;
83
84 public LifecycleDependencyResolver() {}
85
86 public LifecycleDependencyResolver(ProjectDependenciesResolver projectDependenciesResolver, Logger logger) {
87 this.dependenciesResolver = projectDependenciesResolver;
88 this.logger = logger;
89 }
90
91 public static List<MavenProject> getProjects(MavenProject project, MavenSession session, boolean aggregator) {
92 if (aggregator && project.getCollectedProjects() != null) {
93 List<MavenProject> projectAndSubmodules =
94 getProjectAndSubModules(project).collect(Collectors.toList());
95 return session.getProjects().stream()
96 .filter(projectAndSubmodules::contains)
97 .collect(Collectors.toList());
98 } else {
99 return Collections.singletonList(project);
100 }
101 }
102
103 private static Stream<MavenProject> getProjectAndSubModules(MavenProject project) {
104 return Stream.concat(
105 Stream.of(project),
106 project.getCollectedProjects() == null
107 ? Stream.empty()
108 : project.getCollectedProjects().stream()
109 .flatMap(LifecycleDependencyResolver::getProjectAndSubModules));
110 }
111
112 public void resolveProjectDependencies(
113 MavenProject project,
114 Collection<String> scopesToCollect,
115 Collection<String> scopesToResolve,
116 MavenSession session,
117 boolean aggregating,
118 Set<Artifact> projectArtifacts)
119 throws LifecycleExecutionException {
120 ClassLoader tccl = Thread.currentThread().getContextClassLoader();
121 try {
122 ClassLoader projectRealm = project.getClassRealm();
123 if (projectRealm != null && projectRealm != tccl) {
124 Thread.currentThread().setContextClassLoader(projectRealm);
125 }
126
127 if (project.getDependencyArtifacts() == null) {
128 try {
129 project.setDependencyArtifacts(artifactFactory.createArtifacts(project));
130 } catch (InvalidDependencyVersionException e) {
131 throw new LifecycleExecutionException(e);
132 }
133 }
134
135 Set<Artifact> resolvedArtifacts;
136 ProjectArtifactsCache.Key cacheKey = projectArtifactsCache.createKey(
137 project, scopesToCollect, scopesToResolve, aggregating, session.getRepositorySession());
138 ProjectArtifactsCache.CacheRecord recordArtifacts;
139 recordArtifacts = projectArtifactsCache.get(cacheKey);
140
141 if (recordArtifacts != null) {
142 resolvedArtifacts = recordArtifacts.getArtifacts();
143 } else {
144 try {
145 resolvedArtifacts = getDependencies(
146 project, scopesToCollect, scopesToResolve, session, aggregating, projectArtifacts);
147 recordArtifacts = projectArtifactsCache.put(cacheKey, resolvedArtifacts);
148 } catch (LifecycleExecutionException e) {
149 projectArtifactsCache.put(cacheKey, e);
150 projectArtifactsCache.register(project, cacheKey, recordArtifacts);
151 throw e;
152 }
153 }
154 projectArtifactsCache.register(project, cacheKey, recordArtifacts);
155
156 Map<Artifact, File> reactorProjects =
157 new HashMap<>(session.getProjects().size());
158 for (MavenProject reactorProject : session.getProjects()) {
159 reactorProjects.put(
160 reactorProject.getArtifact(),
161 reactorProject.getArtifact().getFile());
162 }
163
164 Map<String, Artifact> map = new HashMap<>();
165 for (Artifact artifact : resolvedArtifacts) {
166
167
168
169
170
171 File reactorProjectFile = reactorProjects.get(artifact);
172 if (reactorProjectFile != null) {
173 artifact.setFile(reactorProjectFile);
174 }
175
176 map.put(artifact.getDependencyConflictId(), artifact);
177 }
178
179 project.setResolvedArtifacts(resolvedArtifacts);
180
181 for (Artifact artifact : project.getDependencyArtifacts()) {
182 if (artifact.getFile() == null) {
183 Artifact resolved = map.get(artifact.getDependencyConflictId());
184 if (resolved != null) {
185 artifact.setFile(resolved.getFile());
186 artifact.setDependencyTrail(resolved.getDependencyTrail());
187 artifact.setResolvedVersion(resolved.getVersion());
188 artifact.setResolved(true);
189 }
190 }
191 }
192 } finally {
193 Thread.currentThread().setContextClassLoader(tccl);
194 }
195 }
196
197 private Set<Artifact> getDependencies(
198 MavenProject project,
199 Collection<String> scopesToCollect,
200 Collection<String> scopesToResolve,
201 MavenSession session,
202 boolean aggregating,
203 Set<Artifact> projectArtifacts)
204 throws LifecycleExecutionException {
205 if (scopesToCollect == null) {
206 scopesToCollect = Collections.emptySet();
207 }
208 if (scopesToResolve == null) {
209 scopesToResolve = Collections.emptySet();
210 }
211
212 if (scopesToCollect.isEmpty() && scopesToResolve.isEmpty()) {
213 return new LinkedHashSet<>();
214 }
215
216 scopesToCollect = new HashSet<>(scopesToCollect);
217 scopesToCollect.addAll(scopesToResolve);
218
219 DependencyFilter collectionFilter = new ScopeDependencyFilter(null, negate(scopesToCollect));
220 DependencyFilter resolutionFilter = new ScopeDependencyFilter(null, negate(scopesToResolve));
221 resolutionFilter = AndDependencyFilter.newInstance(collectionFilter, resolutionFilter);
222 resolutionFilter =
223 AndDependencyFilter.newInstance(resolutionFilter, new ReactorDependencyFilter(projectArtifacts));
224
225 DependencyResolutionResult result;
226 try {
227 DefaultDependencyResolutionRequest request =
228 new DefaultDependencyResolutionRequest(project, session.getRepositorySession());
229 request.setResolutionFilter(resolutionFilter);
230
231 eventSpyDispatcher.onEvent(request);
232
233 result = dependenciesResolver.resolve(request);
234 } catch (DependencyResolutionException e) {
235 result = e.getResult();
236
237
238
239
240
241
242 if (aggregating && areAllDependenciesInReactor(session.getProjects(), result.getUnresolvedDependencies())) {
243 logger.warn("The following dependencies could not be resolved at this point of the build"
244 + " but seem to be part of the reactor:");
245
246 for (Dependency dependency : result.getUnresolvedDependencies()) {
247 logger.warn("o " + dependency);
248 }
249
250 logger.warn("Try running the build up to the lifecycle phase \"package\"");
251 } else {
252 throw new LifecycleExecutionException(null, project, e);
253 }
254 }
255
256 eventSpyDispatcher.onEvent(result);
257
258 Set<Artifact> artifacts = new LinkedHashSet<>();
259 if (result.getDependencyGraph() != null
260 && !result.getDependencyGraph().getChildren().isEmpty()) {
261 RepositoryUtils.toArtifacts(
262 artifacts,
263 result.getDependencyGraph().getChildren(),
264 Collections.singletonList(project.getArtifact().getId()),
265 collectionFilter);
266 }
267 return artifacts;
268 }
269
270 private boolean areAllDependenciesInReactor(
271 Collection<MavenProject> projects, Collection<Dependency> dependencies) {
272 Set<String> projectKeys = getReactorProjectKeys(projects);
273
274 for (Dependency dependency : dependencies) {
275 org.eclipse.aether.artifact.Artifact a = dependency.getArtifact();
276 String key = ArtifactUtils.key(a.getGroupId(), a.getArtifactId(), a.getVersion());
277 if (!projectKeys.contains(key)) {
278 return false;
279 }
280 }
281
282 return true;
283 }
284
285 private Set<String> getReactorProjectKeys(Collection<MavenProject> projects) {
286 Set<String> projectKeys = new HashSet<>(projects.size() * 2);
287 for (MavenProject project : projects) {
288 String key = ArtifactUtils.key(project.getGroupId(), project.getArtifactId(), project.getVersion());
289 projectKeys.add(key);
290 }
291 return projectKeys;
292 }
293
294 private Collection<String> negate(Collection<String> scopes) {
295 Collection<String> result = new HashSet<>();
296 Collections.addAll(result, "system", "compile", "provided", "runtime", "test");
297
298 for (String scope : scopes) {
299 if ("compile".equals(scope)) {
300 result.remove("compile");
301 result.remove("system");
302 result.remove("provided");
303 } else if ("runtime".equals(scope)) {
304 result.remove("compile");
305 result.remove("runtime");
306 } else if ("compile+runtime".equals(scope)) {
307 result.remove("compile");
308 result.remove("system");
309 result.remove("provided");
310 result.remove("runtime");
311 } else if ("runtime+system".equals(scope)) {
312 result.remove("compile");
313 result.remove("system");
314 result.remove("runtime");
315 } else if ("test".equals(scope)) {
316 result.clear();
317 }
318 }
319
320 return result;
321 }
322
323 private static class ReactorDependencyFilter implements DependencyFilter {
324
325 private Set<String> keys = new HashSet<>();
326
327 ReactorDependencyFilter(Collection<Artifact> artifacts) {
328 for (Artifact artifact : artifacts) {
329 String key = ArtifactUtils.key(artifact);
330 keys.add(key);
331 }
332 }
333
334 public boolean accept(DependencyNode node, List<DependencyNode> parents) {
335 Dependency dependency = node.getDependency();
336 if (dependency != null) {
337 org.eclipse.aether.artifact.Artifact a = dependency.getArtifact();
338 String key = ArtifactUtils.key(a.getGroupId(), a.getArtifactId(), a.getVersion());
339 return !keys.contains(key);
340 }
341 return false;
342 }
343 }
344 }