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