Fixing tests and docs

Author: lazar-mitrovic

.github/workflows/test-native-gradle-plugin.yml

@@ -53,7 +53,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        gradle-version: ["current", "7.3.3", "7.2", "7.1", "6.8.3","6.7.1"]
+        gradle-version: ["current", "7.3.3", "6.7.1"]
         graalvm-version: [ dev ]
         java-version: [ 11 ]
         os: [ ubuntu-20.04 ]

docs/src/docs/asciidoc/gradle-plugin.adoc

@@ -67,7 +67,7 @@ include::../snippets/gradle/kotlin/settings.gradle.kts[tags=pre-release, indent=
 ----
 ====
 
-=== Installing GraalVM native image tool
+=== Installing GraalVM Native Image tool
 
 The plugin relies on Gradle's https://docs.gradle.org/7.1.1/userguide/toolchains.html[JVM toolchain support], allowing to decorrelate the tool used to run Gradle, the compiler used to build your application, and eventually the SDK used to generate a native image.
 

docs/src/docs/asciidoc/index.adoc

@@ -23,13 +23,17 @@ If you are interested in contributing, please refer to our https://github.com/gr
 * Introduced the `metadataCopy` task.
 * Introduced the concept of agent modes.
 ** Under the hood, the agent mode dictates what options are passed to the agent and how metadata produced by multiple runs get merged.
-* Added `excludeConfig` configuration option that allows skipping of configuration files that are present in classpath `jar` s.
+* Added `excludeConfig` configuration option that allows skipping of configuration files that are present in dependencies.
 * `useArgFile` is now set to true by default only on Windows.
+* Added `quickBuild` configuration option.
 
 ==== Maven plugin
 * Completely reworked Maven plugin (should fix many of previous issues and inconsistencies between main and test builds).
-* Added `classesDirectory`, `debug`, `fallback`, `verbose`, `sharedLibrary`, `configurationFileDirectories`, `excludeConfig` and `jvmArgs` properties in order to match those present in the Gradle plugin.
+* Added `classesDirectory`, `debug`, `fallback`, `verbose`, `sharedLibrary`, `configurationFileDirectories`, `excludeConfig`, `quickBuild`, and `jvmArgs` properties in order to match those present in the Gradle plugin. +
++
+See <<maven-plugin.adoc#,docs>> for more information.
 * `useArgFile` is now set to true by default only on Windows.
+* Changed lookup order for `native-image` discovery -- `GRAALVM_HOME`, `JAVA_HOME`, `PATH`.
 
 === Release 0.9.11
 

docs/src/docs/asciidoc/maven-plugin.adoc

@@ -114,10 +114,118 @@ Build Configuration]. It is also possible to customize the plugin within a
    image name is not supplied, the artifact ID of the project will be used by default.
 `<buildArgs>`::
    If you want to pass additional arguments to the native image builder, use `<buildArgs>`
-   in the configuration of the plugin.
+   in the configuration of the plugin:
+[source,xml]
+----
+<buildArgs>
+    <arg>--argument</arg>
+</buildArgs>
+----
 `<skipNativeBuild>`::
-   To skip generation of the native image, supply
-   `<skipNativeBuild>true</skipNativeBuild>` in the configuration of the plugin.
+   To skip generation of the native image, supply the following in the configuration of the plugin:
+[source,xml]
+----
+<skipNativeBuild>true</skipNativeBuild>
+----
+`<skipNativeTests>`::
+   To skip generation and execution of the native image compiled tests, supply the following in the configuration of the plugin:
+[source,xml]
+----
+<skipNativeTests>true</skipNativeTests>
+----
+`<debug>`::
+   If you want to enable generation of debugging information supply the following in the configuration of the plugin:
+[source,xml]
+----
+<debug>true</debug>
+----
+`<verbose>`::
+   If you want to enable verbose output during native-image building supply the following in the configuration of the plugin:
+[source,xml]
+----
+<verbose>true</verbose>
+----
+`<sharedLibrary>`::
+   If you want to build image as a shared library supply the following in the configuration of the plugin:
+[source,xml]
+----
+<sharedLibrary>true</sharedLibrary>
+----
+`<useArgFile>`::
+   If you want to use argument file for native-image building supply the following in the configuration of the plugin:
+[source,xml]
+----
+<useArgFile>true</useArgFile>
+----
+`<quickBuild>`::
+   If you want to build the image using https://blogs.oracle.com/java/post/graalvm-enterprise-221--faster-smarter-leaner[quick build mode], supply the following in the configuration of the plugin:
+[source,xml]
+----
+<quickBuild>true</quickBuild>
+----
+`<excludeConfig>`::
+   In order to exclude configuration from present jar files, specify:
+[source,xml]
+----
+<excludeConfig>
+    <entry>
+        <jarPath>dummy/path/to/file.jar</jarPath>
+        <resourcePattern>*</resourcePattern>
+    </entry>
+</excludeConfig>
+----
+`<environment>`::
+   To set environment options for native-image building supply the following in the configuration of the plugin:
+[source,xml]
+----
+<environment>
+    <variable>value</variable>
+</environment>
+----
+`<systemPropertyVariables>`::
+   To specify system properties used for native-image building supply the following in the configuration of the plugin:
+[source,xml]
+----
+<systemPropertyVariables>
+    <propertyName>value</propertyName>
+</systemPropertyVariables>
+----
+`<jvmArgs>`::
+   To specify JVM arguments used for native-image building supply the following in the configuration of the plugin:
+[source,xml]
+----
+<jvmArgs>
+    <arg>argument1</arg>
+    <arg>argument2</arg>
+</jvmArgs>
+----
+`<configurationFileDirectories>`::
+   If you want to specify custom directories where configuration files should be looked up, supply the following in the configuration of the plugin:
+[source,xml]
+----
+<configurationFileDirectories>
+    <dir>path/to/dir</dir>
+</configurationFileDirectories>
+----
+`<classpath`::
+   Sets a custom classpath instead of plugin generated one. Usage:
+[source,xml]
+----
+<classpath>
+    <entry>path/to/file.jar</entry>
+    <entry>path/to/classes</entry>
+</classpath>
+----
+`<classesDirectory>`::
+   If you want to specify custom path to packed JAR, or a custom directory that contains
+only application classes, but want the plugin to still automatically add classpath entries for
+dependencies, simply add:
+[source,xml]
+----
+<classesDirectory>
+    path/to/dir
+</classesDirectory>
+----
 `<agent>`::
    Configuration of the <<agent-support, native agent>>. See <<agent-support-enabling>>
    and <<agent-support-configuring-options>> for details.
@@ -126,15 +234,17 @@ For example, to build a native image named `executable-name` that uses
 `org.example.ClassName` as its main class with assertions enabled, add the following
 `<configuration>` block for the `native-maven-plugin`.
 
-```xml
+[source,xml]
+----
 <configuration>
   <imageName>executable-name</imageName>
   <mainClass>org.example.ClassName</mainClass>
-  <buildArgs>
-    <buildArg>--no-fallback</buildArg>
-  </buildArgs>
+  <fallback>false</fallback>
+  <verbose>true</verbose>
 </configuration>
-```
+----
+
+NOTE: Most of the aforementioned properties can also be set from command line as a part of Maven invocation -- for example if you want to temporarily enable verbose mode you can append `-Dverbose` to your Maven invocation.
 
 NOTE: If you use GraalVM Enterprise as the `JAVA_HOME` environment, the plugin builds a native image with enterprise features enabled -- for example, an executable will automatically be built with https://medium.com/graalvm/isolates-and-compressed-references-more-flexible-and-efficient-memory-management-for-graalvm-a044cc50b67e[compressed references] and other optimizations enabled.
 
@@ -152,7 +262,7 @@ The `<buildArgs>` element can be combined between parent and children POMs. Supp
     <imageName>${project.artifactId}</imageName>
     <mainClass>${exec.mainClass}</mainClass>
     <buildArgs>
-      <buildArg>--no-fallback<buildArg>
+      <buildArg>--no-fallback</buildArg>
     </buildArgs>
   </configuration>
 </plugin>
@@ -323,7 +433,6 @@ Depending on the other plugins your build uses (typically the Spring Boot plugin
 ...
 ----
 
-
 To be able to <<testing-support,execute tests in native mode>>, you will need more setup:
 
 - Create a `src/assembly/test-jar-with-dependencies.xml` file with the following contents:

docs/src/docs/snippets/gradle/groovy/build.gradle

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2021 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2022 Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * The Universal Permissive License (UPL), Version 1.0
@@ -119,9 +119,11 @@ graalvmNative {
             verbose = true // Add verbose output, defaults to false
             fallback = true // Sets the fallback mode of native-image, defaults to false
             sharedLibrary = false // Determines if image is a shared library, defaults to false if `java-library` plugin isn't included
+            quickBuild = false // Determines if image is being built in quick build mode
 
             systemProperties = [name1: 'value1', name2: 'value2'] // Sets the system properties to use for the native image builder
             configurationFileDirectories.from(file('src/my-config')) // Adds a native image configuration file directory, containing files like reflection configuration
+            excludeConfig.put("org.example.test", ["META-INF/native-image/*", "config/*"]) // Excludes configuration that matches one of given regexes from JAR of dependency with said coordinates.
 
             // Advanced options
             buildArgs.add('-H:Extra') // Passes '-H:Extra' to the native image builder options. This can be used to pass parameters which are not directly supported by this extension

docs/src/docs/snippets/gradle/kotlin/build.gradle.kts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2021 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2022 Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * The Universal Permissive License (UPL), Version 1.0
@@ -77,9 +77,11 @@ graalvmNative {
             verbose.set(true) // Add verbose output, defaults to false
             fallback.set(true) // Sets the fallback mode of native-image, defaults to false
             sharedLibrary.set(false) // Determines if image is a shared library, defaults to false if `java-library` plugin isn't included
+            quickBuild.set(false) // Determines if image is being built in quick build mode
 
             systemProperties.putAll(mapOf("name1" to "value1", "name2" to "value2")) // Sets the system properties to use for the native image builder
             configurationFileDirectories.from(file("src/my-config")) // Adds a native image configuration file directory, containing files like reflection configuration
+            excludeConfig.put("org.example.test", listOf("META-INF/native-image/*", "config/*")) // Excludes configuration that matches one of given regexes from JAR of dependency with said coordinates.
 
             // Advanced options
             buildArgs.add("-H:Extra") // Passes '-H:Extra' to the native image builder options. This can be used to pass parameters which are not directly supported by this extension

native-gradle-plugin/src/main/java/org/graalvm/buildtools/gradle/dsl/NativeImageOptions.java

@@ -56,6 +56,7 @@
 import org.gradle.api.tasks.Optional;
 import org.gradle.jvm.toolchain.JavaLauncher;
 
+import java.util.List;
 import java.util.Map;
 
 
@@ -162,6 +163,14 @@ public interface NativeImageOptions extends Named {
     @Input
     Property<Boolean> getSharedLibrary();
 
+    /**
+     * Gets the value which determines if image is being built in quick build mode.
+     *
+     * @return The value which determines if image is being built in quick build mode.
+     */
+    @Input
+    Property<Boolean> getQuickBuild();
+
     /**
      * Returns the toolchain used to invoke native-image. Currently pointing
      * to a Java launcher due to Gradle limitations.
@@ -180,14 +189,14 @@ public interface NativeImageOptions extends Named {
     ConfigurableFileCollection getConfigurationFileDirectories();
 
     /**
-     * Returns the map that as contains information about configuration that should be excluded
-     * during image building. It consists of a jar regular expression as a key and a resource
-     * regular expression as a value.
+     * Returns the MapProperty that contains information about configuration that should be excluded
+     * during image building. It consists of a dependency coordinates and a list of
+     * regular expressions that match resources that should be excluded as a value.
      *
      * @return a map of filters for configuration exclusion
      */
     @Input
-    MapProperty<String, String> getExcludeConfig();
+    MapProperty<String, List<String>> getExcludeConfig();
 
     @Nested
     NativeResourcesOptions getResources();

native-gradle-plugin/src/main/java/org/graalvm/buildtools/gradle/internal/BaseNativeImageOptions.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2021, 2022, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * The Universal Permissive License (UPL), Version 1.0
@@ -64,6 +64,7 @@
 
 import javax.inject.Inject;
 import java.util.Arrays;
+import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
 import java.util.stream.StreamSupport;
@@ -178,7 +179,15 @@ public String getName() {
     public abstract Property<Boolean> getSharedLibrary();
 
     /**
-     * Returns the toolchain used to invoke native-image. Currently pointing
+     * Gets the value which determines if image is being built in quick build mode.
+     *
+     * @return The value which determines if image is being built in quick build mode.
+     */
+    @Input
+    public abstract Property<Boolean> getQuickBuild();
+
+    /**
+     * Returns the toolchain used to invoke native-image. Currently, pointing
      * to a Java launcher due to Gradle limitations.
      */
     @Nested
@@ -194,6 +203,16 @@ public String getName() {
     @InputFiles
     public abstract ConfigurableFileCollection getConfigurationFileDirectories();
 
+    /**
+     * Returns the MapProperty that contains information about configuration that should be excluded
+     * during image building. It consists of a dependency coordinates and a list of
+     * regular expressions that match resources that should be excluded as a value.
+     *
+     * @return a map of filters for configuration exclusion
+     */
+    @Input
+    public abstract MapProperty<String, List<String>> getExcludeConfig();
+
     @Nested
     public abstract NativeResourcesOptions getResources();
 
@@ -212,6 +231,7 @@ public BaseNativeImageOptions(String name,
         getDebug().convention(false);
         getFallback().convention(false);
         getVerbose().convention(false);
+        getQuickBuild().convention(false);
         getSharedLibrary().convention(false);
         getImageName().convention(defaultImageName);
         getUseFatJar().convention(false);