-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
JavaBasePlugin.java
510 lines (439 loc) · 28.3 KB
/
JavaBasePlugin.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
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
/*
* Copyright 2023 the original author or authors.
*
* Licensed 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.gradle.api.plugins;
import com.google.common.collect.Lists;
import org.gradle.api.JavaVersion;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.ConfigurationContainer;
import org.gradle.api.attributes.LibraryElements;
import org.gradle.api.file.Directory;
import org.gradle.api.file.SourceDirectorySet;
import org.gradle.api.internal.ConventionMapping;
import org.gradle.api.internal.GeneratedSubclasses;
import org.gradle.api.internal.IConventionAware;
import org.gradle.api.internal.artifacts.configurations.RoleBasedConfigurationCreationRequest;
import org.gradle.api.internal.artifacts.configurations.ConfigurationRole;
import org.gradle.api.internal.artifacts.configurations.ConfigurationRoles;
import org.gradle.api.internal.artifacts.configurations.RoleBasedConfigurationContainerInternal;
import org.gradle.api.internal.artifacts.configurations.UsageDescriber;
import org.gradle.api.internal.file.FileTreeInternal;
import org.gradle.api.internal.plugins.DslObject;
import org.gradle.api.internal.tasks.DefaultSourceSetOutput;
import org.gradle.api.internal.tasks.JvmConstants;
import org.gradle.api.internal.tasks.compile.CompilationSourceDirs;
import org.gradle.api.internal.tasks.compile.JavaCompileExecutableUtils;
import org.gradle.api.internal.tasks.testing.TestExecutableUtils;
import org.gradle.api.model.ObjectFactory;
import org.gradle.api.plugins.internal.DefaultJavaPluginConvention;
import org.gradle.api.plugins.internal.DefaultJavaPluginExtension;
import org.gradle.api.plugins.internal.JavaConfigurationVariantMapping;
import org.gradle.api.plugins.internal.JvmPluginsHelper;
import org.gradle.api.plugins.internal.NaggingJavaPluginConvention;
import org.gradle.api.plugins.jvm.internal.JvmLanguageUtilities;
import org.gradle.api.plugins.jvm.internal.JvmPluginServices;
import org.gradle.api.provider.Provider;
import org.gradle.api.reporting.DirectoryReport;
import org.gradle.api.reporting.ReportingExtension;
import org.gradle.api.tasks.Copy;
import org.gradle.api.tasks.SourceSet;
import org.gradle.api.tasks.SourceSetContainer;
import org.gradle.api.tasks.TaskProvider;
import org.gradle.api.tasks.compile.AbstractCompile;
import org.gradle.api.tasks.compile.JavaCompile;
import org.gradle.api.tasks.javadoc.Javadoc;
import org.gradle.api.tasks.javadoc.internal.JavadocExecutableUtils;
import org.gradle.api.tasks.testing.JUnitXmlReport;
import org.gradle.api.tasks.testing.Test;
import org.gradle.internal.Cast;
import org.gradle.internal.artifacts.configurations.AbstractRoleBasedConfigurationCreationRequest;
import org.gradle.internal.deprecation.DeprecatableConfiguration;
import org.gradle.internal.deprecation.DeprecationLogger;
import org.gradle.internal.jvm.JavaModuleDetector;
import org.gradle.jvm.tasks.Jar;
import org.gradle.jvm.toolchain.JavaToolchainService;
import org.gradle.jvm.toolchain.JavaToolchainSpec;
import org.gradle.jvm.toolchain.internal.DefaultToolchainSpec;
import org.gradle.language.base.plugins.LifecycleBasePlugin;
import org.gradle.language.jvm.tasks.ProcessResources;
import javax.annotation.Nullable;
import javax.inject.Inject;
import java.io.File;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Set;
import java.util.concurrent.Callable;
import java.util.function.BiFunction;
import java.util.function.Supplier;
/**
* <p>A {@link org.gradle.api.Plugin} which compiles and tests Java source, and assembles it into a JAR file.</p>
*
* This plugin is automatically applied to most projects that build any JVM language source. It creates a {@link JavaPluginExtension}
* extension named {@code java} that is used to configure all jvm-related components in the project.
*
* It is responsible for configuring the conventions of any {@link SourceSet}s that are present and used by
* (for example) the Java, Groovy, or Kotlin plugins.
*
* @see <a href="https://docs.gradle.org/current/userguide/java_plugin.html">Java plugin reference</a>
*/
public abstract class JavaBasePlugin implements Plugin<Project> {
public static final String CHECK_TASK_NAME = LifecycleBasePlugin.CHECK_TASK_NAME;
@SuppressWarnings("unused")
public static final String VERIFICATION_GROUP = LifecycleBasePlugin.VERIFICATION_GROUP;
public static final String BUILD_TASK_NAME = LifecycleBasePlugin.BUILD_TASK_NAME;
public static final String BUILD_DEPENDENTS_TASK_NAME = "buildDependents";
public static final String BUILD_NEEDED_TASK_NAME = "buildNeeded";
/**
* Task group name for documentation-related tasks.
*/
public static final String DOCUMENTATION_GROUP = JvmConstants.DOCUMENTATION_GROUP;
/**
* Set this property to use JARs build from subprojects, instead of the classes folder from these project, on the compile classpath.
* The main use case for this is to mitigate performance issues on very large multi-projects building on Windows.
* Setting this property will cause the 'jar' task of all subprojects in the dependency tree to always run during compilation.
*
* @since 5.6
*/
public static final String COMPILE_CLASSPATH_PACKAGING_SYSTEM_PROPERTY = "org.gradle.java.compile-classpath-packaging";
/**
* A list of known artifact types which are known to prevent from
* publication.
*
* @since 5.3
*/
@SuppressWarnings("unused")
public static final Set<String> UNPUBLISHABLE_VARIANT_ARTIFACTS = JavaConfigurationVariantMapping.UNPUBLISHABLE_VARIANT_ARTIFACTS;
private final boolean javaClasspathPackaging;
private final ObjectFactory objectFactory;
private final JvmPluginServices jvmPluginServices;
@Inject
public JavaBasePlugin(ObjectFactory objectFactory, JvmPluginServices jvmPluginServices) {
this.objectFactory = objectFactory;
this.javaClasspathPackaging = Boolean.getBoolean(COMPILE_CLASSPATH_PACKAGING_SYSTEM_PROPERTY);
this.jvmPluginServices = jvmPluginServices;
}
@Inject
protected abstract JvmLanguageUtilities getJvmLanguageUtils();
@Override
public void apply(final Project project) {
project.getPluginManager().apply(BasePlugin.class);
project.getPluginManager().apply(JvmEcosystemPlugin.class);
project.getPluginManager().apply(ReportingBasePlugin.class);
project.getPluginManager().apply(JvmToolchainsPlugin.class);
DefaultJavaPluginExtension javaPluginExtension = addExtensions(project);
configureCompileDefaults(project, javaPluginExtension);
configureSourceSetDefaults(project, javaPluginExtension);
configureJavaDoc(project, javaPluginExtension);
configureTest(project, javaPluginExtension);
configureBuildNeeded(project);
configureBuildDependents(project);
configureArchiveDefaults(project);
}
@SuppressWarnings("deprecation")
private DefaultJavaPluginExtension addExtensions(final Project project) {
DefaultToolchainSpec toolchainSpec = objectFactory.newInstance(DefaultToolchainSpec.class);
SourceSetContainer sourceSets = (SourceSetContainer) project.getExtensions().getByName("sourceSets");
DefaultJavaPluginExtension javaPluginExtension = (DefaultJavaPluginExtension) project.getExtensions().create(JavaPluginExtension.class, "java", DefaultJavaPluginExtension.class, project, sourceSets, toolchainSpec);
DeprecationLogger.whileDisabled(() ->
project.getConvention().getPlugins().put("java", new NaggingJavaPluginConvention(objectFactory.newInstance(DefaultJavaPluginConvention.class, project, javaPluginExtension))));
return javaPluginExtension;
}
private void configureSourceSetDefaults(Project project, final JavaPluginExtension javaPluginExtension) {
javaPluginExtension.getSourceSets().all(sourceSet -> {
ConfigurationContainer configurations = project.getConfigurations();
defineConfigurationsForSourceSet(sourceSet, (RoleBasedConfigurationContainerInternal) configurations);
definePathsForSourceSet(sourceSet, project);
createProcessResourcesTask(sourceSet, sourceSet.getResources(), project);
TaskProvider<JavaCompile> compileTask = createCompileJavaTask(sourceSet, sourceSet.getJava(), project);
createClassesTask(sourceSet, project);
configureLibraryElements(compileTask, sourceSet, configurations, objectFactory);
configureTargetPlatform(compileTask, sourceSet, configurations);
});
}
private void configureLibraryElements(TaskProvider<JavaCompile> compileJava, SourceSet sourceSet, ConfigurationContainer configurations, ObjectFactory objectFactory) {
Provider<LibraryElements> libraryElements = compileJava.flatMap(x -> x.getModularity().getInferModulePath())
.map(inferModulePath -> {
if (javaClasspathPackaging) {
return LibraryElements.JAR;
}
// If we are compiling a module, we require JARs of all dependencies as they may potentially include an Automatic-Module-Name
List<File> sourcesRoots = CompilationSourceDirs.inferSourceRoots((FileTreeInternal) sourceSet.getJava().getAsFileTree());
if (JavaModuleDetector.isModuleSource(inferModulePath, sourcesRoots)) {
return LibraryElements.JAR;
} else {
return LibraryElements.CLASSES;
}
})
.map(value -> objectFactory.named(LibraryElements.class, value));
Configuration compileClasspath = configurations.getByName(sourceSet.getCompileClasspathConfigurationName());
compileClasspath.getAttributes().attributeProvider(
LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE,
libraryElements
);
}
private void configureTargetPlatform(TaskProvider<JavaCompile> compileTask, SourceSet sourceSet, ConfigurationContainer configurations) {
getJvmLanguageUtils().useDefaultTargetPlatformInference(configurations.getByName(sourceSet.getCompileClasspathConfigurationName()), compileTask);
getJvmLanguageUtils().useDefaultTargetPlatformInference(configurations.getByName(sourceSet.getRuntimeClasspathConfigurationName()), compileTask);
}
private TaskProvider<JavaCompile> createCompileJavaTask(final SourceSet sourceSet, final SourceDirectorySet javaSource, final Project project) {
final TaskProvider<JavaCompile> compileTask = project.getTasks().register(sourceSet.getCompileJavaTaskName(), JavaCompile.class, javaCompile -> {
ConventionMapping conventionMapping = javaCompile.getConventionMapping();
conventionMapping.map("classpath", sourceSet::getCompileClasspath);
JvmPluginsHelper.configureAnnotationProcessorPath(sourceSet, javaSource, javaCompile.getOptions(), project);
javaCompile.setDescription("Compiles " + javaSource + ".");
javaCompile.setSource(javaSource);
Provider<JavaToolchainSpec> toolchainOverrideSpec = project.provider(() ->
JavaCompileExecutableUtils.getExecutableOverrideToolchainSpec(javaCompile, objectFactory));
javaCompile.getJavaCompiler().convention(getToolchainTool(project, JavaToolchainService::compilerFor, toolchainOverrideSpec));
String generatedHeadersDir = "generated/sources/headers/" + javaSource.getName() + "/" + sourceSet.getName();
javaCompile.getOptions().getHeaderOutputDirectory().convention(project.getLayout().getBuildDirectory().dir(generatedHeadersDir));
JavaPluginExtension javaPluginExtension = project.getExtensions().getByType(JavaPluginExtension.class);
javaCompile.getModularity().getInferModulePath().convention(javaPluginExtension.getModularity().getInferModulePath());
});
JvmPluginsHelper.configureOutputDirectoryForSourceSet(sourceSet, javaSource, project, compileTask, compileTask.map(JavaCompile::getOptions));
return compileTask;
}
private void createProcessResourcesTask(final SourceSet sourceSet, final SourceDirectorySet resourceSet, final Project target) {
TaskProvider<ProcessResources> processResources = target.getTasks().register(sourceSet.getProcessResourcesTaskName(), ProcessResources.class, resourcesTask -> {
resourcesTask.setDescription("Processes " + resourceSet + ".");
new DslObject(resourcesTask.getRootSpec()).getConventionMapping().map("destinationDir", (Callable<File>) () -> sourceSet.getOutput().getResourcesDir());
resourcesTask.from(resourceSet);
});
DefaultSourceSetOutput output = Cast.uncheckedCast(sourceSet.getOutput());
output.setResourcesContributor(processResources.map(Copy::getDestinationDir), processResources);
}
private void createClassesTask(final SourceSet sourceSet, Project target) {
sourceSet.compiledBy(
target.getTasks().register(sourceSet.getClassesTaskName(), classesTask -> {
classesTask.setGroup(LifecycleBasePlugin.BUILD_GROUP);
classesTask.setDescription("Assembles " + sourceSet.getOutput() + ".");
classesTask.dependsOn(sourceSet.getOutput().getDirs());
classesTask.dependsOn(sourceSet.getCompileJavaTaskName());
classesTask.dependsOn(sourceSet.getProcessResourcesTaskName());
})
);
}
private void definePathsForSourceSet(final SourceSet sourceSet, final Project project) {
ConventionMapping outputConventionMapping = ((IConventionAware) sourceSet.getOutput()).getConventionMapping();
outputConventionMapping.map("resourcesDir", () -> {
String classesDirName = "resources/" + sourceSet.getName();
return project.getLayout().getBuildDirectory().dir(classesDirName).get().getAsFile();
});
sourceSet.getJava().srcDir("src/" + sourceSet.getName() + "/java");
sourceSet.getResources().srcDir("src/" + sourceSet.getName() + "/resources");
}
private void defineConfigurationsForSourceSet(SourceSet sourceSet, RoleBasedConfigurationContainerInternal configurations) {
String implementationConfigurationName = sourceSet.getImplementationConfigurationName();
String runtimeOnlyConfigurationName = sourceSet.getRuntimeOnlyConfigurationName();
String compileOnlyConfigurationName = sourceSet.getCompileOnlyConfigurationName();
String compileClasspathConfigurationName = sourceSet.getCompileClasspathConfigurationName();
String annotationProcessorConfigurationName = sourceSet.getAnnotationProcessorConfigurationName();
String runtimeClasspathConfigurationName = sourceSet.getRuntimeClasspathConfigurationName();
String sourceSetName = sourceSet.toString();
SourceSetConfigurationCreationRequest implementationRequest = new SourceSetConfigurationCreationRequest(sourceSet.getName(), implementationConfigurationName, ConfigurationRoles.DEPENDENCY_SCOPE);
Configuration implementationConfiguration = configurations.maybeCreate(implementationRequest);
implementationConfiguration.setVisible(false);
implementationConfiguration.setDescription("Implementation only dependencies for " + sourceSetName + ".");
SourceSetConfigurationCreationRequest compileOnlyRequest = new SourceSetConfigurationCreationRequest(sourceSet.getName(), compileOnlyConfigurationName, ConfigurationRoles.DEPENDENCY_SCOPE);
Configuration compileOnlyConfiguration = configurations.maybeCreate(compileOnlyRequest);
compileOnlyConfiguration.setVisible(false);
compileOnlyConfiguration.setDescription("Compile only dependencies for " + sourceSetName + ".");
SourceSetConfigurationCreationRequest compileClasspathRequest = new SourceSetConfigurationCreationRequest(sourceSet.getName(), compileClasspathConfigurationName, ConfigurationRoles.RESOLVABLE);
Configuration compileClasspathConfiguration = configurations.maybeCreate(compileClasspathRequest);
compileClasspathConfiguration.setVisible(false);
compileClasspathConfiguration.extendsFrom(compileOnlyConfiguration, implementationConfiguration);
compileClasspathConfiguration.setDescription("Compile classpath for " + sourceSetName + ".");
jvmPluginServices.configureAsCompileClasspath(compileClasspathConfiguration);
@SuppressWarnings("deprecation")
SourceSetConfigurationCreationRequest annotationProcessorRequest = new SourceSetConfigurationCreationRequest(sourceSet.getName(), annotationProcessorConfigurationName, ConfigurationRoles.RESOLVABLE_DEPENDENCY_SCOPE);
Configuration annotationProcessorConfiguration = configurations.maybeCreate(annotationProcessorRequest);
annotationProcessorConfiguration.setVisible(false);
annotationProcessorConfiguration.setDescription("Annotation processors and their dependencies for " + sourceSetName + ".");
jvmPluginServices.configureAsRuntimeClasspath(annotationProcessorConfiguration);
SourceSetConfigurationCreationRequest runtimeOnlyRequest = new SourceSetConfigurationCreationRequest(sourceSet.getName(), runtimeOnlyConfigurationName, ConfigurationRoles.DEPENDENCY_SCOPE);
Configuration runtimeOnlyConfiguration = configurations.maybeCreate(runtimeOnlyRequest);
runtimeOnlyConfiguration.setVisible(false);
runtimeOnlyConfiguration.setDescription("Runtime only dependencies for " + sourceSetName + ".");
SourceSetConfigurationCreationRequest runtimeClasspathRequest = new SourceSetConfigurationCreationRequest(sourceSet.getName(), runtimeClasspathConfigurationName, ConfigurationRoles.RESOLVABLE);
Configuration runtimeClasspathConfiguration = configurations.maybeCreate(runtimeClasspathRequest);
runtimeClasspathConfiguration.setVisible(false);
runtimeClasspathConfiguration.setDescription("Runtime classpath of " + sourceSetName + ".");
runtimeClasspathConfiguration.extendsFrom(runtimeOnlyConfiguration, implementationConfiguration);
jvmPluginServices.configureAsRuntimeClasspath(runtimeClasspathConfiguration);
sourceSet.setCompileClasspath(compileClasspathConfiguration);
sourceSet.setRuntimeClasspath(sourceSet.getOutput().plus(runtimeClasspathConfiguration));
sourceSet.setAnnotationProcessorPath(annotationProcessorConfiguration);
}
private void configureCompileDefaults(final Project project, final DefaultJavaPluginExtension javaExtension) {
project.getTasks().withType(AbstractCompile.class).configureEach(compile -> {
JvmPluginsHelper.configureCompileDefaults(compile, javaExtension, (@Nullable JavaVersion rawConvention, Supplier<JavaVersion> javaVersionSupplier) -> {
if (compile instanceof JavaCompile) {
JavaCompile javaCompile = (JavaCompile) compile;
if (javaCompile.getOptions().getRelease().isPresent()) {
return JavaVersion.toVersion(javaCompile.getOptions().getRelease().get());
}
if (rawConvention != null) {
return rawConvention;
}
return JavaVersion.toVersion(javaCompile.getJavaCompiler().get().getMetadata().getLanguageVersion().toString());
}
return javaVersionSupplier.get();
});
compile.getDestinationDirectory().convention(project.getProviders().provider(new BackwardCompatibilityOutputDirectoryConvention(compile)));
});
}
private void configureJavaDoc(final Project project, final JavaPluginExtension javaPluginExtension) {
project.getTasks().withType(Javadoc.class).configureEach(javadoc -> {
javadoc.getConventionMapping().map("destinationDir", () -> new File(javaPluginExtension.getDocsDir().get().getAsFile(), "javadoc"));
javadoc.getConventionMapping().map("title", () -> project.getExtensions().getByType(ReportingExtension.class).getApiDocTitle());
Provider<JavaToolchainSpec> toolchainOverrideSpec = project.provider(() ->
JavadocExecutableUtils.getExecutableOverrideToolchainSpec(javadoc, objectFactory));
javadoc.getJavadocTool().convention(getToolchainTool(project, JavaToolchainService::javadocToolFor, toolchainOverrideSpec));
});
}
private void configureBuildNeeded(Project project) {
project.getTasks().register(BUILD_NEEDED_TASK_NAME, buildTask -> {
buildTask.setDescription("Assembles and tests this project and all projects it depends on.");
buildTask.setGroup(BasePlugin.BUILD_GROUP);
buildTask.dependsOn(BUILD_TASK_NAME);
});
}
private void configureBuildDependents(Project project) {
project.getTasks().register(BUILD_DEPENDENTS_TASK_NAME, buildTask -> {
buildTask.setDescription("Assembles and tests this project and all projects that depend on it.");
buildTask.setGroup(BasePlugin.BUILD_GROUP);
buildTask.dependsOn(BUILD_TASK_NAME);
});
}
private void configureArchiveDefaults(Project project) {
// TODO: Gradle 8.1+: Deprecate `getLibsDirectory` in BasePluginExtension and move it to `JavaPluginExtension`
BasePluginExtension basePluginExtension = project.getExtensions().getByType(BasePluginExtension.class);
project.getTasks().withType(Jar.class).configureEach(task -> task.getDestinationDirectory().convention(basePluginExtension.getLibsDirectory()));
}
private void configureTest(final Project project, final JavaPluginExtension javaPluginExtension) {
project.getTasks().withType(Test.class).configureEach(test -> configureTestDefaults(test, project, javaPluginExtension));
}
private void configureTestDefaults(final Test test, Project project, final JavaPluginExtension javaPluginExtension) {
DirectoryReport htmlReport = test.getReports().getHtml();
JUnitXmlReport xmlReport = test.getReports().getJunitXml();
xmlReport.getOutputLocation().convention(javaPluginExtension.getTestResultsDir().dir(test.getName()));
htmlReport.getOutputLocation().convention(javaPluginExtension.getTestReportDir().dir(test.getName()));
test.getBinaryResultsDirectory().convention(javaPluginExtension.getTestResultsDir().dir(test.getName() + "/binary"));
test.workingDir(project.getProjectDir());
Provider<JavaToolchainSpec> toolchainOverrideSpec = project.provider(() ->
TestExecutableUtils.getExecutableToolchainSpec(test, objectFactory));
test.getJavaLauncher().convention(getToolchainTool(project, JavaToolchainService::launcherFor, toolchainOverrideSpec));
}
private <T> Provider<T> getToolchainTool(
Project project,
BiFunction<JavaToolchainService, JavaToolchainSpec, Provider<T>> toolMapper,
Provider<JavaToolchainSpec> toolchainOverride
) {
JavaToolchainService service = project.getExtensions().getByType(JavaToolchainService.class);
JavaPluginExtension extension = project.getExtensions().getByType(JavaPluginExtension.class);
return toolchainOverride.orElse(extension.getToolchain())
.flatMap(spec -> toolMapper.apply(service, spec));
}
/**
* Convention to fall back to the 'destinationDir' output for backwards compatibility with plugins that extend AbstractCompile
* and override the deprecated methods.
*/
private static class BackwardCompatibilityOutputDirectoryConvention implements Callable<Directory> {
private final AbstractCompile compile;
private boolean recursiveCall;
public BackwardCompatibilityOutputDirectoryConvention(AbstractCompile compile) {
this.compile = compile;
}
@SuppressWarnings("deprecation")
@Override
@Nullable
public Directory call() throws Exception {
Method getter = GeneratedSubclasses.unpackType(compile).getMethod("getDestinationDir");
if (getter.getDeclaringClass() == AbstractCompile.class) {
// Subclass has not overridden the getter, so ignore
return null;
}
// Subclass has overridden the getter, so call it
if (recursiveCall) {
// Already querying AbstractCompile.getDestinationDirectory()
// In that case, this convention should not be used.
return null;
}
recursiveCall = true;
File legacyValue;
try {
// This will call a subclass implementation of getDestinationDir(), which possibly will not call the overridden getter
// In the Kotlin plugin, the subclass manages its own field which will be used here.
// This was to support tasks that extended AbstractCompile and had their own getDestinationDir().
// We actually need to keep this as compile.getDestinationDir to maintain compatibility.
legacyValue = compile.getDestinationDir();
} finally {
recursiveCall = false;
}
if (legacyValue == null) {
return null;
} else {
return compile.getProject().getLayout().getProjectDirectory().dir(legacyValue.getAbsolutePath());
}
}
}
/**
* An {@link AbstractRoleBasedConfigurationCreationRequest} that provides context for error messages and warnings
* emitted when creating the configurations implicitly associated with a {@link SourceSet}.
*/
private static final class SourceSetConfigurationCreationRequest extends AbstractRoleBasedConfigurationCreationRequest {
private final String sourceSetName;
private SourceSetConfigurationCreationRequest(String sourceSetName, String configurationName, ConfigurationRole role) {
super(configurationName, role);
this.sourceSetName = sourceSetName;
}
public String getSourceSetName() {
return sourceSetName;
}
@Override
public void warnAboutNeedToMutateUsage(DeprecatableConfiguration conf) {
String msgDiscovery = getUsageDiscoveryMessage(conf);
String msgExpectation = getUsageExpectationMessage();
DeprecationLogger.deprecate(msgDiscovery + msgExpectation)
.withAdvice(getUsageMutationAdvice())
.willBecomeAnErrorInGradle9()
.withUserManual("building_java_projects", "sec:implicit_sourceset_configurations")
.nagUser();
}
private String getUsageDiscoveryMessage(DeprecatableConfiguration conf) {
String currentUsageDesc = UsageDescriber.describeCurrentUsage(conf);
return String.format("When creating configurations during sourceSet %s setup, Gradle found that configuration %s already exists with permitted usage(s):\n" +
"%s\n", sourceSetName, getConfigurationName(), currentUsageDesc);
}
private String getUsageExpectationMessage() {
String expectedUsageDesc = UsageDescriber.describeRole(getRole());
return String.format("Yet Gradle expected to create it with the usage(s):\n" +
"%s\n" +
"Gradle will mutate the usage of configuration %s to match the expected usage. This may cause unexpected behavior. Creating configurations with reserved names", expectedUsageDesc, getConfigurationName());
}
@Override
public void failOnInabilityToMutateUsage() {
List<String> resolutions = Lists.newArrayList(
RoleBasedConfigurationCreationRequest.getDefaultReservedNameAdvice(getConfigurationName()),
getUsageMutationAdvice());
throw new UnmodifiableUsageException(getConfigurationName(), resolutions);
}
private String getUsageMutationAdvice() {
return String.format("Create source set %s prior to creating or accessing the configurations associated with it.", sourceSetName);
}
}
}