Fix compile task out of date when runtime args change (#372)

* Fix compile task out of date when runtime args change The `NativeImageOptions` domain object is used in the DSL to configure both compile and runtime arguments for native images: the compile options are used to invoke `native-image` and build a binary, while the runtime args are used to pass extra arguments when executing the native image. The full `NativeImageOptions` domain object was passed to the native image compilation task as a `@Nested` input, which meant in practice that if the _runtime_ arguments changed, then we would rebuild the image although it isn't necessary. This commit fixes the problem in a binary compatible way, by introducing a couple of interfaces: one for the compile options, the other for the runtime options. It makes the "options" internal on the compile task, and uses a delegated view of compile options for input snapshotting. Fixes #371 * Remove pre-Gradle 7 tests With the removal of the Java 11 variant of GraalVM, we're not in capacity of testing this on pre-Gradle 7 since the spec won't let us specify that we need a GraalVM vendor.

Author: melix

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

@@ -53,7 +53,7 @@ jobs:
  strategy:
  fail-fast: false
  matrix:
- gradle-version: ["current", "6.7.1"]
+ gradle-version: ["current", "7.1"]
  # Following versions are disabled temporarily in order to speed up PR testing
  # "7.3.3", "7.2", "7.1", "6.8.3"
  graalvm-version: [ latest ] # dev

build-logic/gradle-functional-testing/src/main/groovy/org.graalvm.build.functional-testing.gradle

@@ -82,7 +82,7 @@ def graalVm = javaToolchains.launcherFor {
 def fullFunctionalTest = tasks.register("fullFunctionalTest")
 
 ['functionalTest', 'configCacheFunctionalTest'].each { baseName ->
- ["current", "7.3.3", "7.2", "7.1", "6.8.3", "6.7.1"].each { gradleVersion ->
+ ["current", "7.3.3", "7.2", "7.1"].each { gradleVersion ->
  String taskName = gradleVersion == 'current' ? baseName : "gradle${gradleVersion}${baseName.capitalize()}"
  // Add a task to run the functional tests
  def testTask = tasks.register(taskName, Test) {

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

@@ -0,0 +1,218 @@
+/*
+ * 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
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.graalvm.buildtools.gradle.dsl;
+
+import org.graalvm.buildtools.gradle.dsl.agent.DeprecatedAgentOptions;
+import org.gradle.api.file.ConfigurableFileCollection;
+import org.gradle.api.provider.ListProperty;
+import org.gradle.api.provider.MapProperty;
+import org.gradle.api.provider.Property;
+import org.gradle.api.tasks.Classpath;
+import org.gradle.api.tasks.Input;
+import org.gradle.api.tasks.InputFiles;
+import org.gradle.api.tasks.Nested;
+import org.gradle.api.tasks.Optional;
+import org.gradle.jvm.toolchain.JavaLauncher;
+
+import java.util.List;
+
+/**
+ * Configuration options for compiling a native binary.
+ */
+public interface NativeImageCompileOptions {
+ /**
+ * Returns the fully qualified name of the Main class to be executed.
+ * <p>
+ * This does not need to be set if using an <a href="https://docs.oracle.com/javase/tutorial/deployment/jar/appman.html">Executable Jar</a> with a {@code Main-Class} attribute.
+ * </p>
+ *
+ * @return mainClass The main class.
+ */
+ @Input
+ @Optional
+ Property<String> getMainClass();
+
+ /**
+ * Returns the arguments for the native-image invocation.
+ *
+ * @return Arguments for the native-image invocation.
+ */
+ @Input
+ ListProperty<String> getBuildArgs();
+
+ /**
+ * Returns the system properties which will be used by the native-image builder process.
+ *
+ * @return The system properties. Returns an empty map when there are no system properties.
+ */
+ @Input
+ MapProperty<String, Object> getSystemProperties();
+
+ /**
+ * Returns the environment variables which will be used by the native-image builder process.
+ * @return the environment variables. Returns an empty map when there are no environment variables.
+ *
+ * @since 0.9.14
+ */
+ @Input
+ MapProperty<String, Object> getEnvironmentVariables();
+
+ /**
+ * Returns the classpath for the native-image building.
+ *
+ * @return classpath The classpath for the native-image building.
+ */
+ @InputFiles
+ @Classpath
+ ConfigurableFileCollection getClasspath();
+
+ /**
+ * Returns the extra arguments to use when launching the JVM for the native-image building process.
+ * Does not include system properties and the minimum/maximum heap size.
+ *
+ * @return The arguments. Returns an empty list if there are no arguments.
+ */
+ @Input
+ ListProperty<String> getJvmArgs();
+
+ /**
+ * Gets the value which toggles native-image debug symbol output.
+ *
+ * @return Is debug enabled
+ */
+ @Input
+ Property<Boolean> getDebug();
+
+ /**
+ * @return Whether to enable fallbacks (defaults to false).
+ */
+ @Input
+ Property<Boolean> getFallback();
+
+ /**
+ * Gets the value which toggles native-image verbose output.
+ *
+ * @return Is verbose output
+ */
+ @Input
+ Property<Boolean> getVerbose();
+
+ /**
+ * Gets the value which determines if shared library is being built.
+ *
+ * @return The value which determines if shared library is being built.
+ */
+ @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();
+
+ /**
+ * Gets the value which determines if image is being built with rich output.
+ *
+ * @return The value which determines if image is being built with rich output.
+ */
+ @Input
+ Property<Boolean> getRichOutput();
+
+ /**
+ * 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<Object, List<String>> getExcludeConfig();
+
+ @Nested
+ NativeResourcesOptions getResources();
+
+ /**
+ * Returns the list of configuration file directories (e.g. resource-config.json, ...) which need
+ * to be passed to native-image.
+ *
+ * @return a collection of directories
+ */
+ @InputFiles
+ ConfigurableFileCollection getConfigurationFileDirectories();
+
+ @Input
+ ListProperty<String> getExcludeConfigArgs();
+
+ /**
+ * Gets the name of the native executable to be generated.
+ *
+ * @return The image name property.
+ */
+ @Input
+ Property<String> getImageName();
+
+ /**
+ * Returns the toolchain used to invoke native-image. Currently pointing
+ * to a Java launcher due to Gradle limitations.
+ *
+ * @return the detected java launcher
+ */
+ @Nested
+ @Optional
+ Property<JavaLauncher> getJavaLauncher();
+
+ /**
+ * If set to true, this will build a fat jar of the image classpath
+ * instead of passing each jar individually to the classpath. This
+ * option can be used in case the classpath is too long and that
+ * invoking native image fails, which can happen on Windows.
+ *
+ * @return true if a fatjar should be used. Defaults to true for Windows, and false otherwise.
+ */
+ @Input
+ Property<Boolean> getUseFatJar();
+
+ @Nested
+ DeprecatedAgentOptions getAgent();
+}