-
Notifications
You must be signed in to change notification settings - Fork 97
/
AbstractExecMojo.java
359 lines (322 loc) · 14.3 KB
/
AbstractExecMojo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
package org.codehaus.mojo.exec;
/*
* 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.File;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import org.apache.maven.RepositoryUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.cli.CommandLineUtils;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.collection.CollectRequest;
import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.graph.DependencyFilter;
import org.eclipse.aether.resolution.ArtifactResult;
import org.eclipse.aether.resolution.DependencyRequest;
import org.eclipse.aether.resolution.DependencyResolutionException;
import org.eclipse.aether.resolution.DependencyResult;
import org.eclipse.aether.util.filter.DependencyFilterUtils;
/**
* This class is used for unifying functionality between the 2 mojo exec plugins ('java' and 'exec'). It handles parsing
* the arguments and adding source/test folders.
*
* @author Philippe Jacot (PJA)
* @author Jerome Lacoste
*/
public abstract class AbstractExecMojo extends AbstractMojo {
@Component
protected RepositorySystem repositorySystem;
/**
* The enclosing project.
*/
@Parameter(defaultValue = "${project}", readonly = true)
protected MavenProject project;
/**
* The current build session instance. This is used for toolchain manager API calls.
*/
@Parameter(defaultValue = "${session}", readonly = true, required = true)
private MavenSession session;
@Parameter(readonly = true, defaultValue = "${plugin.artifacts}")
private List<Artifact> pluginDependencies;
/**
* If provided the ExecutableDependency identifies which of the plugin dependencies contains the executable class.
* This will have the effect of only including plugin dependencies required by the identified ExecutableDependency.
*
* <p>
* If includeProjectDependencies is set to <code>true</code>, all of the project dependencies will be included on
* the executable's classpath. Whether a particular project dependency is a dependency of the identified
* ExecutableDependency will be irrelevant to its inclusion in the classpath.
* </p>
*
* @since 1.1-beta-1
*/
@Parameter
protected ExecutableDependency executableDependency;
/**
* This folder is added to the list of those folders containing source to be compiled. Use this if your plugin
* generates source code.
*/
@Parameter(property = "sourceRoot")
private File sourceRoot;
/**
* This folder is added to the list of those folders containing source to be compiled for testing. Use this if your
* plugin generates test source code.
*/
@Parameter(property = "testSourceRoot")
private File testSourceRoot;
/**
* Arguments separated by space for the executed program. For example: "-j 20"
*/
@Parameter(property = "exec.args")
private String commandlineArgs;
/**
* Defines the scope of the classpath passed to the plugin.
*
* <ul>
* <li><code>runtime</code> (default): Include "compile" and "runtime" scopes</li>
* <li><code>compile</code>: Include "compile", "provided", and "system" scopes</li>
* <li><code>test</code>: Include all scopes</li>
* <li><code>provided</code>: Include "compile", "runtime", "provided", and "system" scopes</li>
* <li><code>system</code>: Include "system" scope</li>
* </ul>
*
* Since 1.1.2, the default value is 'runtime' instead of 'compile'.
*/
@Parameter(property = "exec.classpathScope", defaultValue = "runtime")
protected String classpathScope;
/**
* Skip the execution. Starting with version 1.4.0 the former name <code>skip</code> has been changed into
* <code>exec.skip</code>.
*
* @since 1.0.1
*/
// TODO: Remove the alias in version 1.5.0 of the plugin.
@Parameter(property = "exec.skip", defaultValue = "false", alias = "skip")
private boolean skip;
/**
* Add project resource directories to classpath. This is especially useful if the exec plugin is used for a code
* generator that reads its settings from the classpath.
*
* @since 1.5.1
*/
@Parameter(property = "addResourcesToClasspath", defaultValue = "false")
private boolean addResourcesToClasspath;
/**
* Add project output directory to classpath. This might be undesirable when the exec plugin is run before the
* compile step. Default is <code>true</code>.
*
* @since 1.5.1
*/
@Parameter(property = "addOutputToClasspath", defaultValue = "true")
private boolean addOutputToClasspath;
/**
* Indicates if this plugin's dependencies should be used when executing the main class.
* <p>
* This is useful when project dependencies are not appropriate. Using only the plugin dependencies can be
* particularly useful when the project is not a java project. For example a mvn project using the csharp plugins
* only expects to see dotnet libraries as dependencies.
* </p>
*
* @since 3.4.0
*/
@Parameter(property = "exec.includePluginsDependencies", defaultValue = "false")
protected boolean includePluginDependencies;
/**
* Collects the project artifacts in the specified List and the project specific classpath (build output and build
* test output) Files in the specified List, depending on the plugin classpathScope value.
*
* @param artifacts the list where to collect the scope specific artifacts
* @param theClasspathFiles the list where to collect the scope specific output directories
*/
protected void collectProjectArtifactsAndClasspath(List<Artifact> artifacts, List<Path> theClasspathFiles) {
if (addResourcesToClasspath) {
for (Resource r : project.getBuild().getResources()) {
theClasspathFiles.add(Paths.get(r.getDirectory()));
}
}
if ("compile".equals(classpathScope)) {
artifacts.addAll(project.getCompileArtifacts());
if (addOutputToClasspath) {
theClasspathFiles.add(Paths.get(project.getBuild().getOutputDirectory()));
}
} else if ("test".equals(classpathScope)) {
artifacts.addAll(project.getTestArtifacts());
if (addOutputToClasspath) {
theClasspathFiles.add(Paths.get(project.getBuild().getTestOutputDirectory()));
theClasspathFiles.add(Paths.get(project.getBuild().getOutputDirectory()));
}
} else if ("runtime".equals(classpathScope)) {
artifacts.addAll(project.getRuntimeArtifacts());
if (addOutputToClasspath) {
theClasspathFiles.add(Paths.get(project.getBuild().getOutputDirectory()));
}
} else if ("provided".equals(classpathScope)) {
// "compile" gives compile, provided, and system scopes
// "runtime" gives compile and runtime scopes
Set<Artifact> artifactSet = new HashSet<>(project.getCompileArtifacts());
artifactSet.addAll(project.getRuntimeArtifacts());
artifacts.addAll(artifactSet);
if (addOutputToClasspath) {
theClasspathFiles.add(Paths.get(project.getBuild().getOutputDirectory()));
}
} else if ("system".equals(classpathScope)) {
artifacts.addAll(project.getSystemArtifacts());
} else {
throw new IllegalStateException("Invalid classpath scope: " + classpathScope);
}
getLog().debug("Collected project artifacts " + artifacts);
getLog().debug("Collected project classpath " + theClasspathFiles);
}
/**
* Parses the argument string given by the user. Strings are recognized as everything between STRING_WRAPPER.
* PARAMETER_DELIMITER is ignored inside a string. STRING_WRAPPER and PARAMETER_DELIMITER can be escaped using
* ESCAPE_CHAR.
*
* @return Array of String representing the arguments
* @throws MojoExecutionException for wrong formatted arguments
*/
protected String[] parseCommandlineArgs() throws MojoExecutionException {
if (commandlineArgs == null) {
return null;
} else {
try {
return CommandLineUtils.translateCommandline(commandlineArgs);
} catch (Exception e) {
throw new MojoExecutionException(e.getMessage());
}
}
}
/**
* @return true of the mojo has command line arguments
*/
protected boolean hasCommandlineArgs() {
return (commandlineArgs != null);
}
/**
* Register compile and compile tests source roots if necessary
*/
protected void registerSourceRoots() {
if (sourceRoot != null) {
getLog().info("Registering compile source root " + sourceRoot);
project.addCompileSourceRoot(sourceRoot.toString());
}
if (testSourceRoot != null) {
getLog().info("Registering compile test source root " + testSourceRoot);
project.addTestCompileSourceRoot(testSourceRoot.toString());
}
}
/**
* Check if the execution should be skipped
*
* @return true to skip
*/
protected boolean isSkip() {
return skip;
}
protected final MavenSession getSession() {
return session;
}
protected final List<Artifact> getPluginDependencies() {
return pluginDependencies;
}
/**
* Examine the plugin dependencies to find the executable artifact.
*
* @return an artifact which refers to the actual executable tool (not a POM)
* @throws MojoExecutionException if no executable artifact was found
*/
protected Artifact findExecutableArtifact() throws MojoExecutionException {
// ILimitedArtifactIdentifier execToolAssembly = this.getExecutableToolAssembly();
Artifact executableTool = null;
for (Artifact pluginDep : this.pluginDependencies) {
if (this.executableDependency.matches(pluginDep)) {
executableTool = pluginDep;
break;
}
}
if (executableTool == null) {
throw new MojoExecutionException("No dependency of the plugin matches the specified executableDependency."
+ " Specified executableToolAssembly is: " + executableDependency.toString());
}
return executableTool;
}
/**
* Determine all plugin dependencies relevant to the executable. Takes includePlugins, and the executableDependency
* into consideration.
*
* @return a set of Artifact objects. (Empty set is returned if there are no relevant plugin dependencies.)
* @throws MojoExecutionException if a problem happens resolving the plufin dependencies
*/
protected Set<Artifact> determineRelevantPluginDependencies() throws MojoExecutionException {
Set<Artifact> relevantDependencies;
if (this.includePluginDependencies) {
if (this.executableDependency == null) {
getLog().debug("All Plugin Dependencies will be included.");
relevantDependencies = new HashSet<>(this.getPluginDependencies());
} else {
getLog().debug("Selected plugin Dependencies will be included.");
Artifact executableArtifact = this.findExecutableArtifact();
relevantDependencies = this.resolveExecutableDependencies(executableArtifact);
}
} else {
relevantDependencies = Collections.emptySet();
getLog().debug("Plugin Dependencies will be excluded.");
}
return relevantDependencies;
}
/**
* Resolve the executable dependencies for the specified project
*
* @param executableArtifact the executable plugin dependency
* @return a set of Artifacts
* @throws MojoExecutionException if a failure happens
*/
private Set<Artifact> resolveExecutableDependencies(Artifact executableArtifact) throws MojoExecutionException {
try {
CollectRequest collectRequest = new CollectRequest();
collectRequest.setRoot(new Dependency(RepositoryUtils.toArtifact(executableArtifact), classpathScope));
collectRequest.setRepositories(project.getRemotePluginRepositories());
DependencyFilter classpathFilter = DependencyFilterUtils.classpathFilter(classpathScope);
DependencyRequest dependencyRequest = new DependencyRequest(collectRequest, classpathFilter);
DependencyResult dependencyResult =
repositorySystem.resolveDependencies(getSession().getRepositorySession(), dependencyRequest);
return dependencyResult.getArtifactResults().stream()
.map(ArtifactResult::getArtifact)
.map(RepositoryUtils::toArtifact)
.collect(Collectors.toSet());
} catch (DependencyResolutionException ex) {
throw new MojoExecutionException(
"Encountered problems resolving dependencies of the executable "
+ "in preparation for its execution.",
ex);
}
}
}