-
Notifications
You must be signed in to change notification settings - Fork 164
/
TestCompilerMojo.java
491 lines (418 loc) · 17.3 KB
/
TestCompilerMojo.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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
/*
* 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.
*/
package org.apache.maven.plugin.compiler;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.shared.utils.StringUtils;
import org.apache.maven.toolchain.Toolchain;
import org.apache.maven.toolchain.java.DefaultJavaToolChain;
import org.codehaus.plexus.compiler.util.scan.SimpleSourceInclusionScanner;
import org.codehaus.plexus.compiler.util.scan.SourceInclusionScanner;
import org.codehaus.plexus.compiler.util.scan.StaleSourceScanner;
import org.codehaus.plexus.languages.java.jpms.JavaModuleDescriptor;
import org.codehaus.plexus.languages.java.jpms.LocationManager;
import org.codehaus.plexus.languages.java.jpms.ResolvePathsRequest;
import org.codehaus.plexus.languages.java.jpms.ResolvePathsResult;
/**
* Compiles application test sources.
* By default uses the <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html">javac</a> compiler
* of the JDK used to execute Maven. This can be overwritten through <a href="https://maven.apache.org/guides/mini/guide-using-toolchains.html">Toolchains</a>
* or parameter {@link AbstractCompilerMojo#compilerId}.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @since 2.0
* @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html">javac Command</a>
*/
@Mojo(
name = "testCompile",
defaultPhase = LifecyclePhase.TEST_COMPILE,
threadSafe = true,
requiresDependencyResolution = ResolutionScope.TEST)
public class TestCompilerMojo extends AbstractCompilerMojo {
/**
* Set this to 'true' to bypass compilation of test sources.
* Its use is NOT RECOMMENDED, but quite convenient on occasion.
*/
@Parameter(property = "maven.test.skip")
private boolean skip;
/**
* The source directories containing the test-source to be compiled.
*/
@Parameter(defaultValue = "${project.testCompileSourceRoots}", readonly = false, required = true)
private List<String> compileSourceRoots;
/**
* The directory where compiled test classes go.
* <p>
* This parameter should only be modified in special cases.
* See the {@link CompilerMojo#outputDirectory} for more information.
*
* @see CompilerMojo#outputDirectory
*/
@Parameter(defaultValue = "${project.build.testOutputDirectory}", required = true, readonly = false)
private File outputDirectory;
/**
* A list of inclusion filters for the compiler.
*/
@Parameter
private Set<String> testIncludes = new HashSet<>();
/**
* A list of exclusion filters for the compiler.
*/
@Parameter
private Set<String> testExcludes = new HashSet<>();
/**
* A list of exclusion filters for the incremental calculation.
* @since 3.11
*/
@Parameter
private Set<String> testIncrementalExcludes = new HashSet<>();
/**
* The -source argument for the test Java compiler.
*
* @since 2.1
*/
@Parameter(property = "maven.compiler.testSource")
private String testSource;
/**
* The -target argument for the test Java compiler.
*
* @since 2.1
*/
@Parameter(property = "maven.compiler.testTarget")
private String testTarget;
/**
* the -release argument for the test Java compiler
*
* @since 3.6
*/
@Parameter(property = "maven.compiler.testRelease")
private String testRelease;
/**
* <p>
* Sets the arguments to be passed to test compiler (prepending a dash) if fork is set to true.
* </p>
* <p>
* This is because the list of valid arguments passed to a Java compiler
* varies based on the compiler version.
* </p>
*
* @since 2.1
*/
@Parameter
private Map<String, String> testCompilerArguments;
/**
* <p>
* Sets the unformatted argument string to be passed to test compiler if fork is set to true.
* </p>
* <p>
* This is because the list of valid arguments passed to a Java compiler
* varies based on the compiler version.
* </p>
*
* @since 2.1
*/
@Parameter
private String testCompilerArgument;
/**
* <p>
* Specify where to place generated source files created by annotation processing.
* Only applies to JDK 1.6+
* </p>
*
* @since 2.2
*/
@Parameter(defaultValue = "${project.build.directory}/generated-test-sources/test-annotations")
private File generatedTestSourcesDirectory;
/**
* <p>
* When {@code true}, uses the module path when compiling with a release or target of 9+ and
* <em>module-info.java</em> or <em>module-info.class</em> is present.
* When {@code false}, always uses the class path.
* </p>
*
* @since 3.11
*/
@Parameter(defaultValue = "true")
private boolean useModulePath;
@Parameter(defaultValue = "${project.testClasspathElements}", readonly = true)
private List<String> testPath;
/**
* when forking and debug activated the commandline used will be dumped in this file
* @since 3.10.0
*/
@Parameter(defaultValue = "javac-test")
private String debugFileName;
final LocationManager locationManager = new LocationManager();
private Map<String, JavaModuleDescriptor> pathElements;
private Collection<String> classpathElements;
private Collection<String> modulepathElements;
public void execute() throws MojoExecutionException, CompilationFailureException {
if (skip) {
getLog().info("Not compiling test sources");
return;
}
super.execute();
}
protected List<String> getCompileSourceRoots() {
return compileSourceRoots;
}
@Override
protected Map<String, JavaModuleDescriptor> getPathElements() {
return pathElements;
}
protected List<String> getClasspathElements() {
return new ArrayList<>(classpathElements);
}
@Override
protected List<String> getModulepathElements() {
return new ArrayList<>(modulepathElements);
}
protected File getOutputDirectory() {
return outputDirectory;
}
@Override
protected void preparePaths(Set<File> sourceFiles) {
File mainOutputDirectory = new File(getProject().getBuild().getOutputDirectory());
File mainModuleDescriptorClassFile = new File(mainOutputDirectory, "module-info.class");
JavaModuleDescriptor mainModuleDescriptor = null;
File testModuleDescriptorJavaFile = new File("module-info.java");
JavaModuleDescriptor testModuleDescriptor = null;
// Go through the source files to respect includes/excludes
for (File sourceFile : sourceFiles) {
// @todo verify if it is the root of a sourcedirectory?
if ("module-info.java".equals(sourceFile.getName())) {
testModuleDescriptorJavaFile = sourceFile;
break;
}
}
// Get additional information from the main module descriptor, if available
if (mainModuleDescriptorClassFile.exists()) {
ResolvePathsResult<String> result;
try {
ResolvePathsRequest<String> request = ResolvePathsRequest.ofStrings(testPath)
.setIncludeStatic(true)
.setMainModuleDescriptor(mainModuleDescriptorClassFile.getAbsolutePath());
Toolchain toolchain = getToolchain();
if (toolchain instanceof DefaultJavaToolChain) {
request.setJdkHome(((DefaultJavaToolChain) toolchain).getJavaHome());
}
result = locationManager.resolvePaths(request);
for (Entry<String, Exception> pathException :
result.getPathExceptions().entrySet()) {
Throwable cause = pathException.getValue();
while (cause.getCause() != null) {
cause = cause.getCause();
}
String fileName =
Paths.get(pathException.getKey()).getFileName().toString();
getLog().warn("Can't extract module name from " + fileName + ": " + cause.getMessage());
}
} catch (IOException e) {
throw new RuntimeException(e);
}
mainModuleDescriptor = result.getMainModuleDescriptor();
pathElements = new LinkedHashMap<>(result.getPathElements().size());
pathElements.putAll(result.getPathElements());
modulepathElements = result.getModulepathElements().keySet();
classpathElements = result.getClasspathElements();
}
// Get additional information from the test module descriptor, if available
if (testModuleDescriptorJavaFile.exists()) {
ResolvePathsResult<String> result;
try {
ResolvePathsRequest<String> request = ResolvePathsRequest.ofStrings(testPath)
.setMainModuleDescriptor(testModuleDescriptorJavaFile.getAbsolutePath());
Toolchain toolchain = getToolchain();
if (toolchain instanceof DefaultJavaToolChain) {
request.setJdkHome(((DefaultJavaToolChain) toolchain).getJavaHome());
}
result = locationManager.resolvePaths(request);
} catch (IOException e) {
throw new RuntimeException(e);
}
testModuleDescriptor = result.getMainModuleDescriptor();
}
if (!useModulePath) {
pathElements = Collections.emptyMap();
modulepathElements = Collections.emptyList();
classpathElements = testPath;
return;
}
if (StringUtils.isNotEmpty(getRelease())) {
if (isOlderThanJDK9(getRelease())) {
pathElements = Collections.emptyMap();
modulepathElements = Collections.emptyList();
classpathElements = testPath;
return;
}
} else if (isOlderThanJDK9(getTarget())) {
pathElements = Collections.emptyMap();
modulepathElements = Collections.emptyList();
classpathElements = testPath;
return;
}
if (testModuleDescriptor != null) {
modulepathElements = testPath;
classpathElements = Collections.emptyList();
if (mainModuleDescriptor != null) {
if (getLog().isDebugEnabled()) {
getLog().debug("Main and test module descriptors exist:");
getLog().debug(" main module = " + mainModuleDescriptor.name());
getLog().debug(" test module = " + testModuleDescriptor.name());
}
if (testModuleDescriptor.name().equals(mainModuleDescriptor.name())) {
if (compilerArgs == null) {
compilerArgs = new ArrayList<>();
}
compilerArgs.add("--patch-module");
StringBuilder patchModuleValue = new StringBuilder();
patchModuleValue.append(testModuleDescriptor.name());
patchModuleValue.append('=');
for (String root : getProject().getCompileSourceRoots()) {
if (Files.exists(Paths.get(root))) {
patchModuleValue.append(root).append(PS);
}
}
compilerArgs.add(patchModuleValue.toString());
} else {
getLog().debug("Black-box testing - all is ready to compile");
}
} else {
// No main binaries available? Means we're a test-only project.
if (!mainOutputDirectory.exists()) {
return;
}
// very odd
// Means that main sources must be compiled with -modulesource and -Xmodule:<moduleName>
// However, this has a huge impact since you can't simply use it as a classpathEntry
// due to extra folder in between
throw new UnsupportedOperationException(
"Can't compile test sources " + "when main sources are missing a module descriptor");
}
} else {
if (mainModuleDescriptor != null) {
if (compilerArgs == null) {
compilerArgs = new ArrayList<>();
}
compilerArgs.add("--patch-module");
StringBuilder patchModuleValue = new StringBuilder(mainModuleDescriptor.name())
.append('=')
.append(mainOutputDirectory)
.append(PS);
for (String root : compileSourceRoots) {
patchModuleValue.append(root).append(PS);
}
compilerArgs.add(patchModuleValue.toString());
compilerArgs.add("--add-reads");
compilerArgs.add(mainModuleDescriptor.name() + "=ALL-UNNAMED");
} else {
modulepathElements = Collections.emptyList();
classpathElements = testPath;
}
}
}
protected SourceInclusionScanner getSourceInclusionScanner(int staleMillis) {
SourceInclusionScanner scanner;
if (testIncludes.isEmpty() && testExcludes.isEmpty() && testIncrementalExcludes.isEmpty()) {
scanner = new StaleSourceScanner(staleMillis);
} else {
if (testIncludes.isEmpty()) {
testIncludes.add("**/*.java");
}
Set<String> excludesIncr = new HashSet<>(testExcludes);
excludesIncr.addAll(this.testIncrementalExcludes);
scanner = new StaleSourceScanner(staleMillis, testIncludes, excludesIncr);
}
return scanner;
}
protected SourceInclusionScanner getSourceInclusionScanner(String inputFileEnding) {
SourceInclusionScanner scanner;
// it's not defined if we get the ending with or without the dot '.'
String defaultIncludePattern = "**/*" + (inputFileEnding.startsWith(".") ? "" : ".") + inputFileEnding;
if (testIncludes.isEmpty() && testExcludes.isEmpty() && testIncrementalExcludes.isEmpty()) {
testIncludes = Collections.singleton(defaultIncludePattern);
scanner = new SimpleSourceInclusionScanner(testIncludes, Collections.emptySet());
} else {
if (testIncludes.isEmpty()) {
testIncludes.add(defaultIncludePattern);
}
Set<String> excludesIncr = new HashSet<>(testExcludes);
excludesIncr.addAll(this.testIncrementalExcludes);
scanner = new SimpleSourceInclusionScanner(testIncludes, excludesIncr);
}
return scanner;
}
static boolean isOlderThanJDK9(String version) {
if (version.startsWith("1.")) {
return Integer.parseInt(version.substring(2)) < 9;
}
return Integer.parseInt(version) < 9;
}
protected String getSource() {
return testSource == null ? source : testSource;
}
protected String getTarget() {
return testTarget == null ? target : testTarget;
}
@Override
protected String getRelease() {
return testRelease == null ? release : testRelease;
}
protected String getCompilerArgument() {
return testCompilerArgument == null ? compilerArgument : testCompilerArgument;
}
protected Map<String, String> getCompilerArguments() {
return testCompilerArguments == null ? compilerArguments : testCompilerArguments;
}
protected File getGeneratedSourcesDirectory() {
return generatedTestSourcesDirectory;
}
@Override
protected String getDebugFileName() {
return debugFileName;
}
@Override
protected boolean isTestCompile() {
return true;
}
@Override
protected Set<String> getIncludes() {
return testIncludes;
}
@Override
protected Set<String> getExcludes() {
return testExcludes;
}
}