-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
ApplicationPlugin.java
239 lines (202 loc) · 11.8 KB
/
ApplicationPlugin.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
/*
* Copyright 2010 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 org.gradle.api.Action;
import org.gradle.api.GradleException;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.Task;
import org.gradle.api.UncheckedIOException;
import org.gradle.api.distribution.Distribution;
import org.gradle.api.distribution.DistributionContainer;
import org.gradle.api.distribution.plugins.DistributionPlugin;
import org.gradle.api.file.CopySpec;
import org.gradle.api.file.FileCollection;
import org.gradle.api.model.ObjectFactory;
import org.gradle.api.plugins.internal.DefaultApplicationPluginConvention;
import org.gradle.api.plugins.internal.DefaultJavaApplication;
import org.gradle.api.plugins.internal.JavaPluginHelper;
import org.gradle.api.plugins.jvm.internal.JvmFeatureInternal;
import org.gradle.api.provider.Provider;
import org.gradle.api.provider.ProviderFactory;
import org.gradle.api.tasks.JavaExec;
import org.gradle.api.tasks.Sync;
import org.gradle.api.tasks.TaskContainer;
import org.gradle.api.tasks.TaskProvider;
import org.gradle.api.tasks.application.CreateStartScripts;
import org.gradle.api.tasks.bundling.Jar;
import org.gradle.api.tasks.compile.JavaCompile;
import org.gradle.api.tasks.internal.JavaExecExecutableUtils;
import org.gradle.internal.deprecation.DeprecationLogger;
import org.gradle.jvm.toolchain.JavaToolchainService;
import org.gradle.jvm.toolchain.JavaToolchainSpec;
import java.io.File;
import java.util.concurrent.Callable;
import java.util.function.BiFunction;
import static org.gradle.api.distribution.plugins.DistributionPlugin.TASK_INSTALL_NAME;
/**
* <p>A {@link Plugin} which packages and runs a project as a Java Application.</p>
*
* <p>The plugin can be configured via the {@link JavaApplication} extension.</p>
*
* @see <a href="https://docs.gradle.org/current/userguide/application_plugin.html">Application plugin reference</a>
*/
public abstract class ApplicationPlugin implements Plugin<Project> {
public static final String APPLICATION_PLUGIN_NAME = "application";
public static final String APPLICATION_GROUP = APPLICATION_PLUGIN_NAME;
public static final String TASK_RUN_NAME = "run";
public static final String TASK_START_SCRIPTS_NAME = "startScripts";
public static final String TASK_DIST_ZIP_NAME = "distZip";
public static final String TASK_DIST_TAR_NAME = "distTar";
@Override
public void apply(final Project project) {
TaskContainer tasks = project.getTasks();
project.getPluginManager().apply(JavaPlugin.class);
project.getPluginManager().apply(DistributionPlugin.class);
JvmFeatureInternal mainFeature = JavaPluginHelper.getJavaComponent(project).getMainFeature();
JavaApplication extension = addExtension(project);
addRunTask(project, mainFeature, extension);
addCreateScriptsTask(project, mainFeature, extension);
configureJavaCompileTask(mainFeature.getCompileJavaTask(), extension);
configureInstallTask(project.getProviders(), tasks.named(TASK_INSTALL_NAME, Sync.class), extension);
DistributionContainer distributions = project.getExtensions().getByType(DistributionContainer.class);
Distribution mainDistribution = distributions.getByName(DistributionPlugin.MAIN_DISTRIBUTION_NAME);
configureDistribution(project, mainFeature, mainDistribution, extension);
}
private void configureJavaCompileTask(TaskProvider<JavaCompile> javaCompile, JavaApplication pluginExtension) {
javaCompile.configure(j -> j.getOptions().getJavaModuleMainClass().convention(pluginExtension.getMainClass()));
}
private void configureInstallTask(ProviderFactory providers, TaskProvider<Sync> installTask, JavaApplication pluginExtension) {
installTask.configure(task -> task.doFirst(
"don't overwrite existing directories",
new PreventDestinationOverwrite(
providers.provider(pluginExtension::getApplicationName),
providers.provider(pluginExtension::getExecutableDir)
)
));
}
private static class PreventDestinationOverwrite implements Action<Task> {
private final Provider<String> applicationName;
private final Provider<String> executableDir;
private PreventDestinationOverwrite(Provider<String> applicationName, Provider<String> executableDir) {
this.applicationName = applicationName;
this.executableDir = executableDir;
}
@Override
public void execute(Task task) {
Sync sync = (Sync) task;
File destinationDir = sync.getDestinationDir();
if (destinationDir.isDirectory()) {
String[] children = destinationDir.list();
if (children == null) {
throw new UncheckedIOException("Could not list directory " + destinationDir);
}
if (children.length > 0) {
if (!new File(destinationDir, "lib").isDirectory() || !new File(destinationDir, executableDir.get()).isDirectory()) {
throw new GradleException("The specified installation directory \'"
+ destinationDir
+ "\' is neither empty nor does it contain an installation for \'"
+ applicationName.get()
+ "\'.\n"
+ "If you really want to install to this directory, delete it and run the install task again.\n"
+ "Alternatively, choose a different installation directory.");
}
}
}
}
}
private JavaApplication addExtension(Project project) {
ApplicationPluginConvention pluginConvention = project.getObjects().newInstance(DefaultApplicationPluginConvention.class, project);
DeprecationLogger.whileDisabled(() -> pluginConvention.setApplicationName(project.getName()));
DeprecationLogger.whileDisabled(() -> project.getConvention().getPlugins().put("application", pluginConvention));
return project.getExtensions().create(JavaApplication.class, "application", DefaultJavaApplication.class, pluginConvention);
}
private void addRunTask(Project project, JvmFeatureInternal mainFeature, JavaApplication pluginExtension) {
project.getTasks().register(TASK_RUN_NAME, JavaExec.class, run -> {
run.setDescription("Runs this project as a JVM application");
run.setGroup(APPLICATION_GROUP);
FileCollection runtimeClasspath = project.files().from((Callable<FileCollection>) () -> {
if (run.getMainModule().isPresent()) {
return jarsOnlyRuntimeClasspath(mainFeature);
} else {
return runtimeClasspath(mainFeature);
}
});
run.setClasspath(runtimeClasspath);
run.getMainModule().set(pluginExtension.getMainModule());
run.getMainClass().set(pluginExtension.getMainClass());
run.getJvmArguments().convention(project.provider(pluginExtension::getApplicationDefaultJvmArgs));
JavaPluginExtension javaPluginExtension = project.getExtensions().getByType(JavaPluginExtension.class);
run.getModularity().getInferModulePath().convention(javaPluginExtension.getModularity().getInferModulePath());
ObjectFactory objectFactory = project.getObjects();
Provider<JavaToolchainSpec> toolchainOverrideSpec = project.provider(() ->
JavaExecExecutableUtils.getExecutableOverrideToolchainSpec(run, objectFactory));
run.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));
}
// @Todo: refactor this task configuration to extend a copy task and use replace tokens
private void addCreateScriptsTask(Project project, JvmFeatureInternal mainFeature, JavaApplication pluginExtension) {
project.getTasks().register(TASK_START_SCRIPTS_NAME, CreateStartScripts.class, startScripts -> {
startScripts.setDescription("Creates OS specific scripts to run the project as a JVM application.");
startScripts.setClasspath(jarsOnlyRuntimeClasspath(mainFeature));
startScripts.getMainModule().set(pluginExtension.getMainModule());
startScripts.getMainClass().set(pluginExtension.getMainClass());
startScripts.getConventionMapping().map("applicationName", pluginExtension::getApplicationName);
startScripts.getConventionMapping().map("outputDir", () -> new File(project.getBuildDir(), "scripts"));
startScripts.getConventionMapping().map("executableDir", pluginExtension::getExecutableDir);
startScripts.getConventionMapping().map("defaultJvmOpts", pluginExtension::getApplicationDefaultJvmArgs);
JavaPluginExtension javaPluginExtension = project.getExtensions().getByType(JavaPluginExtension.class);
startScripts.getModularity().getInferModulePath().convention(javaPluginExtension.getModularity().getInferModulePath());
});
}
private FileCollection runtimeClasspath(JvmFeatureInternal mainFeature) {
return mainFeature.getSourceSet().getRuntimeClasspath();
}
private FileCollection jarsOnlyRuntimeClasspath(JvmFeatureInternal mainFeature) {
return mainFeature.getJarTask().get().getOutputs().getFiles().plus(mainFeature.getRuntimeClasspathConfiguration());
}
private CopySpec configureDistribution(Project project, JvmFeatureInternal mainFeature, Distribution mainDistribution, JavaApplication pluginExtension) {
mainDistribution.getDistributionBaseName().convention(project.provider(pluginExtension::getApplicationName));
CopySpec distSpec = mainDistribution.getContents();
TaskProvider<Jar> jar = mainFeature.getJarTask();
TaskProvider<Task> startScripts = project.getTasks().named(TASK_START_SCRIPTS_NAME);
CopySpec libChildSpec = project.copySpec();
libChildSpec.into("lib");
libChildSpec.from(jar);
libChildSpec.from(mainFeature.getRuntimeClasspathConfiguration());
CopySpec binChildSpec = project.copySpec();
binChildSpec.into((Callable<Object>) pluginExtension::getExecutableDir);
binChildSpec.from(startScripts);
binChildSpec.filePermissions(permissions -> permissions.unix("rwxr-xr-x"));
CopySpec childSpec = project.copySpec();
childSpec.from(project.file("src/dist"));
childSpec.with(libChildSpec);
childSpec.with(binChildSpec);
distSpec.with(childSpec);
distSpec.with(pluginExtension.getApplicationDistribution());
return distSpec;
}
}