joerg/gradle-plugins
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add more options, add jrun task

Browse source
This commit is contained in:
Jörg Prante 2024-11-08 17:40:22 +01:00
parent ac147ef72e
commit 816dd9d6ab
8 changed files with 273 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
gradle-plugin-jlink/src/main/java/org/xbib/gradle/plugin/jlink/JDepsExtension.java Normal file
View file

@ -0,0 +1,4 @@
package org.xbib.gradle.plugin.jlink;
public class JDepsExtension {
}

33
gradle-plugin-jlink/src/main/java/org/xbib/gradle/plugin/jlink/JLinkPlugin.java
View file

@ -42,6 +42,8 @@ public abstract class JLinkPlugin implements Plugin<Project> {
jModExtension.getCompress().convention(6); // zip-6, default
jModExtension.getCmds().unsetConvention();
jModExtension.getConfigs().unsetConvention();
jModExtension.getHeaderFiles().unsetConvention();
jModExtension.getLibs().unsetConvention();
JLinkExtension jLinkExtension = project.getExtensions().create("jlink", JLinkExtension.class);
jLinkExtension.getJavaCompiler().convention(service.compilerFor(toolchain));
@ -60,7 +62,7 @@ public abstract class JLinkPlugin implements Plugin<Project> {
jLinkExtension.getAddModules().convention(List.of("java.base"));
jLinkExtension.getLimitModules().convention(List.of());
jLinkExtension.getBindServices().convention(false);
jLinkExtension.getLauncher().unsetConvention();
jLinkExtension.getLauncher().convention(project.getName());
jLinkExtension.getCompress().convention(6); // zip-6, default
jLinkExtension.getStripDebug().convention(true); // same as jpackage default
jLinkExtension.getStripNativeCommands().convention(false); // keep commands
@ -75,8 +77,14 @@ public abstract class JLinkPlugin implements Plugin<Project> {
jPackageExtension.getModule().unsetConvention();
jPackageExtension.getInput().convention(project.getLayout().getBuildDirectory().dir("jlink"));
jPackageExtension.getType().convention("rpm"); // Fedora/Red Hat Linux
jPackageExtension.getjLinkOptions().convention(List.of("--strip-native-commands", "--strip-debug", "--no-man-pages", "--no-header-files")); // same as jpackage default
jPackageExtension.getAppName().convention(project.getName());
jPackageExtension.getAppVersion().convention(project.getVersion().toString());
jPackageExtension.getAppVendor().unsetConvention();
jPackageExtension.getAppCopyright().unsetConvention();
jPackageExtension.getAppDescription().unsetConvention();
jPackageExtension.getAppIcon().unsetConvention();
jPackageExtension.getAppImage().unsetConvention();
// install the jmod task
TaskProvider<JModTask> jModTask = project.getTasks().register("jmod", JModTask.class);
@ -90,6 +98,8 @@ public abstract class JLinkPlugin implements Plugin<Project> {
it.compress.set(jModExtension.getCompress());
it.cmds.set(jModExtension.getCmds());
it.configs.set(jModExtension.getConfigs());
it.headerFiles.set(jModExtension.getHeaderFiles());
it.libs.set(jModExtension.getLibs());
});
// install the jdeps task
@ -120,6 +130,7 @@ public abstract class JLinkPlugin implements Plugin<Project> {
it.noManPages.set(jLinkExtension.getNoManPages());
it.endian.set(jLinkExtension.getEndian());
});
// depend jpackage on jlink task
TaskProvider<JPackageTask> jPackageTask = project.getTasks().register("jpackage", JPackageTask.class);
project.getTasks().withType(JPackageTask.class).forEach(it -> {
@ -132,9 +143,24 @@ public abstract class JLinkPlugin implements Plugin<Project> {
it.module.set(jPackageExtension.getModule());
it.input.set(jPackageExtension.getInput());
it.type.set(jPackageExtension.getType());
it.jLinkOptions.set(jPackageExtension.getjLinkOptions());
it.appName.set(jPackageExtension.getAppName());
it.appVersion.set(jPackageExtension.getAppVersion());
it.appCopyright.set(jPackageExtension.getAppCopyright());
it.appVendor.set(jPackageExtension.getAppVendor());
it.appDescription.set(jPackageExtension.getAppDescription());
it.appIcon.set(jPackageExtension.getAppIcon());
it.appImage.set(jPackageExtension.getAppImage());
});
TaskProvider<JRunTask> jRunTask = project.getTasks().register("jrun", JRunTask.class);
project.getTasks().withType(JRunTask.class).forEach(it -> {
it.setGroup("run");
it.dependsOn(jLinkTask);
it.exec.set(jLinkExtension.getjLinkOutputDirectory().file("bin/" +
prefix("=", jLinkExtension.getLauncher().get())));
});
Configuration jLinkConfiguration = project.getConfigurations().create("jlink");
jLinkConfiguration.setCanBeConsumed(true);
jLinkConfiguration.setCanBeResolved(false);
@ -150,4 +176,9 @@ public abstract class JLinkPlugin implements Plugin<Project> {
project.getObjects().named(Usage.class, "jpackage")));
jPackageConfiguration.outgoing(o -> o.artifact(jPackageTask.flatMap(t -> t.jPackageOutputDirectory)));
}
private static String prefix(String delimiter, String string) {
String[] s = string.split(delimiter);
return s.length > 0 ? s[0] : string;
}
}

24
gradle-plugin-jlink/src/main/java/org/xbib/gradle/plugin/jlink/JModExtension.java
View file

@ -5,6 +5,8 @@ import org.gradle.api.file.Directory;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.provider.ListProperty;
import org.gradle.api.provider.Property;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Optional;
import java.util.List;
@ -20,12 +22,18 @@ public class JModExtension {
private final ListProperty<String> configs;
private final ListProperty<String> headerFiles;
private final ListProperty<String> libs;
public JModExtension(Project project) {
jModDirectory = project.getObjects().directoryProperty();
moduleVersion = project.getObjects().property(String.class);
compress = project.getObjects().property(Integer.class);
cmds = project.getObjects().listProperty(String.class);
configs = project.getObjects().listProperty(String.class);
headerFiles = project.getObjects().listProperty(String.class);
libs = project.getObjects().listProperty(String.class);
}
public void setjModDirectory(Directory jModDirectory) {
@ -67,4 +75,20 @@ public class JModExtension {
public ListProperty<String> getConfigs() {
return configs;
}
public void setHeaderFiles(List<String> headerFiles) {
this.headerFiles.set(headerFiles);
}
public ListProperty<String> getHeaderFiles() {
return headerFiles;
}
public void setLibs(List<String> libs) {
this.libs.set(libs);
}
public ListProperty<String> getLibs() {
return libs;
}
}

68
gradle-plugin-jlink/src/main/java/org/xbib/gradle/plugin/jlink/JPackageExtension.java
View file

@ -6,6 +6,8 @@ import org.gradle.api.file.Directory;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.provider.ListProperty;
import org.gradle.api.provider.Property;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Optional;
import org.gradle.jvm.toolchain.JavaCompiler;
public class JPackageExtension {
@ -20,18 +22,36 @@ public class JPackageExtension {
private final Property<String> type;
private final ListProperty<String> jLinkOptions;
private final Property<String> appName;
private final Property<String> appVersion;
private final Property<String> appCopyright;
private final Property<String> appVendor;
private final Property<String> appDescription;
private final Property<String> appIcon;
private final DirectoryProperty appImage;
public JPackageExtension(Project project) {
jPackageOutputDirectory = project.getObjects().directoryProperty();
addModules = project.getObjects().listProperty(String.class);
module = project.getObjects().property(String.class);
input = project.getObjects().directoryProperty();
type = project.getObjects().property(String.class);
jLinkOptions = project.getObjects().listProperty(String.class);
appName = project.getObjects().property(String.class);
appVersion = project.getObjects().property(String.class);
appCopyright = project.getObjects().property(String.class);
appVendor = project.getObjects().property(String.class);
appDescription = project.getObjects().property(String.class);
appIcon = project.getObjects().property(String.class);
appImage = project.getObjects().directoryProperty();
}
public void setjPackageOutputDirectory(Directory jPackageOutputDirectory) {
@ -74,6 +94,14 @@ public class JPackageExtension {
return type;
}
public void setjLinkOptions(List<String> jLinkOptions) {
this.jLinkOptions.set(jLinkOptions);
}
public ListProperty<String> getjLinkOptions() {
return jLinkOptions;
}
public void setAppName(String appName) {
this.appName.set(appName);
}
@ -89,4 +117,44 @@ public class JPackageExtension {
public Property<String> getAppVersion() {
return appVersion;
}
public void setAppCopyright(String appCopyright) {
this.appCopyright.set(appCopyright);
}
public Property<String> getAppCopyright() {
return appCopyright;
}
public void setAppVendor(String appVendor) {
this.appVendor.set(appVendor);
}
public Property<String> getAppVendor() {
return appVendor;
}
public void setAppDescription(String appDescription) {
this.appDescription.set(appDescription);
}
public Property<String> getAppDescription() {
return appDescription;
}
public void setAppIcon(String appIcon) {
this.appIcon.set(appIcon);
}
public Property<String> getAppIcon() {
return appIcon;
}
public void setAppImage(Directory appImage) {
this.appImage .set(appImage);
}
public DirectoryProperty getAppImage() {
return appImage;
}
}

100
gradle-plugin-jlink/src/main/java/org/xbib/gradle/plugin/jlink/JPackageTask.java
View file

@ -43,10 +43,6 @@ public class JPackageTask extends AbstractExecTask<JPackageTask> {
@Input
Property<String> module;
@Input
@Optional
Property<String> appImage;
@InputDirectory
@Optional
DirectoryProperty input;
@ -55,6 +51,10 @@ public class JPackageTask extends AbstractExecTask<JPackageTask> {
@Optional
Property<String> type;
@Input
@Optional
ListProperty<String> jLinkOptions;
@Input
@Optional
Property<String> appName;
@ -65,7 +65,11 @@ public class JPackageTask extends AbstractExecTask<JPackageTask> {
@Input
@Optional
Property<String> copyright;
Property<String> appCopyright;
@Input
@Optional
Property<String> appVendor;
@Input
@Optional
@ -73,7 +77,11 @@ public class JPackageTask extends AbstractExecTask<JPackageTask> {
@Input
@Optional
Property<String> icon;
Property<String> appIcon;
@InputDirectory
@Optional
DirectoryProperty appImage;
@Inject
public JPackageTask() {
@ -84,14 +92,16 @@ public class JPackageTask extends AbstractExecTask<JPackageTask> {
jPackageOutputDirectory = getProject().getObjects().directoryProperty();
addModules = getProject().getObjects().listProperty(String.class);
module = getProject().getObjects().property(String.class);
appImage = getProject().getObjects().property(String.class);
input = getProject().getObjects().directoryProperty();
type = getProject().getObjects().property(String.class);
jLinkOptions = getProject().getObjects().listProperty(String.class);
appName = getProject().getObjects().property(String.class);
appVersion = getProject().getObjects().property(String.class);
copyright = getProject().getObjects().property(String.class);
appCopyright = getProject().getObjects().property(String.class);
appVendor = getProject().getObjects().property(String.class);
appDescription = getProject().getObjects().property(String.class);
icon = getProject().getObjects().property(String.class);
appIcon = getProject().getObjects().property(String.class);
appImage = getProject().getObjects().directoryProperty();
}
@Override
@ -120,12 +130,12 @@ public class JPackageTask extends AbstractExecTask<JPackageTask> {
args.add("--input");
args.add(input.getAsFile().get().getAbsolutePath());
}
if (appImage.isPresent()) {
args.add("--app-image");
args.add(appImage.get());
}
args.add("--type");
args.add(type.get());
if (jLinkOptions.isPresent() && !jLinkOptions.get().isEmpty()) {
args.add("--jlink-options");
args.add(String.join(" ", jLinkOptions.get()));
}
if (appName.isPresent()) {
args.add("--name");
args.add(appName.get());
@ -134,17 +144,25 @@ public class JPackageTask extends AbstractExecTask<JPackageTask> {
args.add("--app-version");
args.add(appVersion.get());
}
if (copyright.isPresent()) {
if (appVendor.isPresent()) {
args.add("--vendor");
args.add(appVendor.get());
}
if (appCopyright.isPresent()) {
args.add("--copyright");
args.add(copyright.get());
args.add(appCopyright.get());
}
if (appDescription.isPresent()) {
args.add("--description");
args.add(appDescription.get());
}
if (icon.isPresent()) {
if (appIcon.isPresent()) {
args.add("--icon");
args.add(icon.get());
args.add(appIcon.get());
}
if (appImage.isPresent()) {
args.add("--app-image");
args.add(appImage.getAsFile().get().getAbsolutePath());
}
setArgs(args);
getLogger().log(LogLevel.INFO, "executing " + getExecutable() + " with " + getArgs());
@ -191,14 +209,6 @@ public class JPackageTask extends AbstractExecTask<JPackageTask> {
return module;
}
public void setAppImage(String appImage) {
this.appImage .set(appImage);
}
public Property<String> getAppImage() {
return appImage;
}
public DirectoryProperty getInput() {
return input;
}
@ -211,6 +221,14 @@ public class JPackageTask extends AbstractExecTask<JPackageTask> {
return type;
}
public void setjLinkOptions(List<String> jLinkOptions) {
this.jLinkOptions.set(jLinkOptions);
}
public ListProperty<String> getjLinkOptions() {
return jLinkOptions;
}
public void setAppName(String appName) {
this.appName.set(appName);
}
@ -227,12 +245,20 @@ public class JPackageTask extends AbstractExecTask<JPackageTask> {
return appVersion;
}
public void setCopyright(String copyright) {
this.copyright.set(copyright);
public void setAppCopyright(String appCopyright) {
this.appCopyright.set(appCopyright);
}
public Property<String> getCopyright() {
return copyright;
public Property<String> getAppCopyright() {
return appCopyright;
}
public void setAppVendor(String appVendor) {
this.appVendor.set(appVendor);
}
public Property<String> getAppVendor() {
return appVendor;
}
public void setAppDescription(String appDescription) {
@ -243,12 +269,20 @@ public class JPackageTask extends AbstractExecTask<JPackageTask> {
return appDescription;
}
public void setIcon(String icon) {
this.icon.set(icon);
public void setAppIcon(String appIcon) {
this.appIcon.set(appIcon);
}
public Property<String> getIcon() {
return icon;
public Property<String> getAppIcon() {
return appIcon;
}
public void setAppImage(Directory appImage) {
this.appImage .set(appImage);
}
public DirectoryProperty getAppImage() {
return appImage;
}
private static void createDirectory(Path path) throws IOException {

34
gradle-plugin-jlink/src/main/java/org/xbib/gradle/plugin/jlink/JRunTask.java Normal file
View file

@ -0,0 +1,34 @@
package org.xbib.gradle.plugin.jlink;
import org.gradle.api.file.RegularFile;
import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.tasks.AbstractExecTask;
import org.gradle.api.tasks.InputFile;
import javax.inject.Inject;
public class JRunTask extends AbstractExecTask<JRunTask> {
@InputFile
RegularFileProperty exec;
@Inject
public JRunTask() {
super(JRunTask.class);
exec = getProject().getObjects().fileProperty();
}
@Override
public void exec() {
setExecutable(exec.get());
super.exec();
}
public void setExec(RegularFile exec) {
this.exec.set(exec);
}
public RegularFileProperty getExec() {
return exec;
}
}

1
gradle-plugin-jlink/src/test/groovy/org/xbib/gradle/plugin/jlink/JLinkTest.groovy
View file

@ -21,7 +21,6 @@ class JLinkTest extends Specification {
jlink {
addModules.set(List.of("org.example.app"))
launcher.set("app=org.example.app/org.example.app.Main")
stripDebug.set(true)
}
"""
appModuleInfoFile << """

44
gradle-plugin-jlink/src/test/groovy/org/xbib/gradle/plugin/jlink/JRunTest.groovy Normal file
View file

@ -0,0 +1,44 @@
package org.xbib.gradle.plugin.jlink
import spock.lang.Specification
import static org.gradle.testkit.runner.TaskOutcome.FAILED
import static org.gradle.testkit.runner.TaskOutcome.SUCCESS
import static org.xbib.gradle.plugin.jlink.JLinkGradleBuild.runsOnLinux
class JRunTest extends Specification {
@Delegate
JLinkGradleBuild build = new JLinkGradleBuild()
def "can use jlink plugin with jrun task"() {
given:
def taskToRun = ":app:jrun"
appBuildFile << """
dependencies {
api "org.junit.jupiter:junit-jupiter-engine:5.10.2"
}
jlink {
addModules.set(List.of("org.example.app"))
launcher.set("app=org.example.app/org.example.app.Main")
}
"""
appModuleInfoFile << """
module org.example.app {
exports org.example.app;
}
"""
when:
def result = success ? build(taskToRun) : fail(taskToRun)
then:
println result.output
result.task(taskToRun).outcome == (success ? SUCCESS : FAILED)
success
where:
label | os | success
'fedora' | 'linux' | runsOnLinux()
}
}