Make the plugin work (#4)

Makes the plugin functionally usable and provide sample usages

Author: SamCarlberg

.travis.yml

@@ -0,0 +1,6 @@
+language: java
+jdk:
+  - openjdk10
+  - openjdk11
+
+script: ./gradlew check --console=plain --stacktrace

README.md

@@ -0,0 +1,59 @@
+# simple-jlink
+
+A simple Gradle plugin for generating native Java runtime images with the jlink tool introduced in Java 9.
+Your applications can be modular, unmodular, and use modular or unomdular libraries. The
+plugin will automatically determine which modules to include in the generated image.
+
+Note: this plugin must be run on JDK 10 or higher. JDK 9 is not supported.
+
+See [the jlink Reference Page](https://docs.oracle.com/javase/10/tools/jlink.htm) for details on the
+jlink tool and its options, most of which are exposed to plugin users.
+
+```kotlin
+plugins {
+  application
+  id("org.gradleweaver.plugins.jlink")
+}
+
+jlink {
+  "configuration name" {
+    applicationJar.set(provider { tasks.getByName<Jar>("jar").archivePath }) // No default value
+    
+    // jlink executable options. See the reference page for details
+    bindServices.set(false)
+    compressionLevel.set(JLinkTask.CompressionLevel.NONE)
+    endianess.set(JLinkTask.Endianness.SYSTEM_DEFAULT)
+    ignoreSigningInformation.set(false)
+    excludeHeaderFiles.set(false)
+    excludeManPages.set(false)
+    stripDebug.set(false)
+    optimizeClassForName.set(false)
+    
+    // Extra modules to link that are not discovered by jdeps
+    extraModules.addAll("module1", "module2", ...)
+    
+    // Single method to exclude header files, man pages, and debug symbols
+    // Also sets the compression level to ZIP (maximum)
+    useMinimalImage()
+    
+    // Generate a launcher script
+    launcher {
+      launcherName.set("LauncherName")
+      vmOptions.addAll("-Xms512m", "-Xmx4G")
+      
+      // Only required if the app and all its dependencies are modular
+      applicationModuleName.set("com.example.app")
+      mainClassName.set("com.example.app.Main")
+    }
+  }
+}
+```
+
+See the [samples](samples) directory for more examples on the jlink plugin in action.
+
+## Unavailable Options
+
+`--disable-plugin pluginname`  
+`--limit-modules`  
+`--save-opts`  
+`@filename`

build.gradle.kts

@@ -1,8 +1,13 @@
+import org.gradleweaver.plugins.jlink.JLinkTask
+
 buildscript {
     dependencies {
         classpath("org.gradleweaver.plugins:simple-jlink:+")
     }
 }
+plugins {
+    `lifecycle-base`
+}
 
 allprojects {
     repositories {
@@ -16,4 +21,12 @@ project(":samples") {
     }
 }
 
+tasks.named<Task>("check") {
+    dependsOn(gradle.includedBuild("simple-jlink").task(":check"))
+    dependsOn(findProject(":samples:javafx-app")!!.tasks.withType<JLinkTask>())
+    dependsOn(findProject(":samples:simple-jar")!!.tasks.withType<JLinkTask>())
+    dependsOn(findProject(":samples:groovy-dsl")!!.tasks.withType<JLinkTask>())
+    dependsOn(findProject(":samples:modular-app")!!.tasks.withType<JLinkTask>())
+}
+
 apply(from = "gradle/wrapper.gradle.kts")

plugin/build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
     // Makes sure to update the kotlin version below in the test resources as well.
     kotlin("jvm") version "1.2.51"
     `maven-publish`
-    id ("com.gradle.plugin-publish") version "0.9.10"
+    id("com.gradle.plugin-publish") version "0.9.10"
 }
 
 group = "org.gradleweaver.plugins"
@@ -20,7 +20,6 @@ repositories {
 
 dependencies {
     compileOnly(gradleApi())
-    compile(kotlin("stdlib-jdk8"))
     testCompileOnly(gradleTestKit())
 
     fun junitJupiter(name: String, version: String = "5.2.0") =
@@ -49,39 +48,33 @@ publishing {
 }
 
 
-configure<JavaPluginConvention> {
+java {
     sourceCompatibility = JavaVersion.VERSION_1_8
 }
 
-tasks.withType<KotlinCompile> {
+tasks.withType<KotlinCompile>().configureEach {
     kotlinOptions.jvmTarget = "1.8"
 }
 
-tasks.withType<Test> {
+tasks.withType<Test>().configureEach {
     useJUnitPlatform()
 }
 
-gradlePlugin {
-    plugins {
-        register("jlink-plugin") {
-            id = "${project.group}.${project.name}"
-            implementationClass = "org.gradleweaver.plugins.jlink.JLinkPlugin"
-            description = "A Gradle plugin for handling platform-specific dependencies and releases."
-        }
-    }
+val registeredPlugin = gradlePlugin.plugins.register("jlink-plugin") {
+    id = "${project.group}.${project.name}"
+    implementationClass = "org.gradleweaver.plugins.jlink.JLinkPlugin"
+    description = "A Gradle plugin for handling platform-specific dependencies and releases."
 }
 
 pluginBundle {
-    val plugin = gradlePlugin.plugins["jlink-plugin"]
-
     website = "https://github.com/gradleweaver/jlink-plugin"
     vcsUrl = "https://github.com/gradleweaver/jlink-plugin"
     tags = listOf("jlink")
 
     plugins {
         create("jlink-plugin") {
-            id = plugin.id
-            displayName = plugin.displayName
+            id = registeredPlugin.get().id
+            displayName = registeredPlugin.get().displayName
         }
     }
 }
@@ -94,7 +87,7 @@ tasks {
     val writeTestProperties by creating(WriteProperties::class) {
         outputFile = processTestResources.destinationDir.resolve("test.properties")
         property("version", version)
-        property("kotlinVersion", "1.2.51")
+        property("kotlinVersion", KotlinVersion.CURRENT)
     }
     processTestResources.dependsOn(writeTestProperties)
     "test" {

plugin/src/main/kotlin/org/gradleweaver/plugins/jlink/CompressionLevel.kt

@@ -0,0 +1,23 @@
+package org.gradleweaver.plugins.jlink
+
+/**
+ * Options for the levels of compression available for generated runtime images.
+ *
+ * @param jlinkValue the integer value corresponding to the compression level expected by `jlink`
+ */
+enum class CompressionLevel(val jlinkValue: Int) {
+    /**
+     * Do no compression on the generated image.
+     */
+    NONE(0),
+
+    /**
+     * Share constant string objects.
+     */
+    CONSTANT_STRING_SHARING(1),
+
+    /**
+     * ZIP compression on the generated image.
+     */
+    ZIP(2)
+}

plugin/src/main/kotlin/org/gradleweaver/plugins/jlink/Endianness.kt

@@ -0,0 +1,21 @@
+package org.gradleweaver.plugins.jlink
+
+/**
+ * Options for the available byte orders of generated runtime images.
+ */
+enum class Endianness {
+    /**
+     * Use the endianness of the build system.
+     */
+    SYSTEM_DEFAULT,
+
+    /**
+     * Force little-endian byte order in the generated image.
+     */
+    LITTLE,
+
+    /**
+     * Force big-endian byte order in the generated image.
+     */
+    BIG
+}

plugin/src/main/kotlin/org/gradleweaver/plugins/jlink/GradleHelpers.kt

@@ -0,0 +1,17 @@
+package org.gradleweaver.plugins.jlink
+
+import org.gradle.api.model.ObjectFactory
+import org.gradle.api.provider.ListProperty
+import org.gradle.api.provider.Property
+
+internal inline fun <reified T : Any> ObjectFactory.property(): Property<T> = property(T::class.java)
+internal inline fun <reified T : Any> ObjectFactory.property(initialValue: T): Property<T> {
+    val prop = property(T::class.java)
+    prop.set(initialValue)
+    return prop
+}
+
+internal inline fun <reified T : Any> ObjectFactory.listProperty(): ListProperty<T> = listProperty(T::class.java)
+
+internal val Property<*>.isNotPresent
+    get() = !isPresent

plugin/src/main/kotlin/org/gradleweaver/plugins/jlink/JLinkExtension.kt

@@ -1,6 +1,7 @@
 package org.gradleweaver.plugins.jlink
 
-import org.gradle.api.NamedDomainObjectCollection
+import org.gradle.api.Action
+import org.gradle.api.NamedDomainObjectContainer
 import org.gradle.api.Project
 import javax.inject.Inject
 
@@ -9,7 +10,39 @@ open class JLinkExtension
 internal constructor(
         project: Project
 ) {
-    val configure: NamedDomainObjectCollection<JLinkOptions> = project.container(JLinkOptions::class.java) { name ->
-        JLinkOptions(name = name)
+    val jlinkConfigurations: NamedDomainObjectContainer<JLinkOptions> = project.container(JLinkOptions::class.java) { name ->
+        JLinkOptions(project = project, name = name)
     }
-}
+
+    /**
+     * Registers a new jlink configuration.
+     *
+     * ```
+     * jlink {
+     *   "example" {
+     *     // options...
+     *   }
+     * }
+     * ```
+     *
+     * is equivalent to
+     * ```
+     * jlink {
+     *   register("example") {
+     *     // options...
+     *   }
+     * }
+     * ```
+     */
+    operator fun String.invoke(configurationAction: Action<in JLinkOptions>) = register(this, configurationAction)
+
+    /**
+     * Registers a new jlink configuration.
+     *
+     * @param name                the name of the configuration
+     * @param configurationAction the action to use to set up the configuration
+     */
+    fun register(name: String, configurationAction: Action<in JLinkOptions>)
+            = jlinkConfigurations.register(name, configurationAction)
+
+}

plugin/src/main/kotlin/org/gradleweaver/plugins/jlink/JLinkLauncherOptions.kt

@@ -0,0 +1,29 @@
+package org.gradleweaver.plugins.jlink
+
+import org.gradle.api.Project
+
+class JLinkLauncherOptions(project: Project) {
+
+    private val objectFactory = project.objects
+
+    /**
+     * Runtime options for the JVM.
+     */
+    val vmOptions = objectFactory.listProperty<String>()
+
+    /**
+     * The name of the generated launcher script. If not set, the launcher name will be the name of the
+     * corresponding project.
+     */
+    val launcherName = objectFactory.property(project.name)
+
+    // For Groovy DSL support
+    fun setLauncherName(launcherName: String) {
+        this.launcherName.set(launcherName)
+    }
+
+    fun setVmOptions(options: Iterable<String>) {
+        vmOptions.set(options.toList())
+    }
+
+}