Add a new write-args-file goal

docs/src/docs/asciidoc/index.adoc

@@ -19,6 +19,16 @@ If you are using alternative build systems, see <<alternative-build-systems.adoc
 [[changelog]]
 == Changelog
 
+=== Release 0.9.21
+
+==== Gradle plugin
+
+- TBD
+
+==== Maven plugin
+
+- Add a new `native:write-args-file` goal that can be used to write the arguments passed to `native-image` to a file
+
 === Release 0.9.20
 
 ==== Gradle plugin

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

@@ -399,6 +399,9 @@ Under Windows, https://github.com/graalvm/native-build-tools/issues/85[it is pos
 
 To avoid this, since release 0.9.10, the plugin will use an argument file to pass the arguments to the `native-image` tool, instead of passing them directly.
 
+There is also a `native:write-args-file` goal that can be used to generate this argument file. This can be useful in situations where the Native Build Tools plugin is not available, for example, when running native-image in a Docker container. The path to the args file is stored in the project properties
+under the key `graalvm.native-image.args-file`, so that other Maven plugins further in the lifecycle can use it.
+
 In case you are using a GraalVM version older than 21.3, you will however have to use a workaround, since the argument file wasn't supported.
 
 One option is to use a https://maven.apache.org/plugins/maven-shade-plugin[shaded jar] and use it instead of individual jars on classpath.

native-maven-plugin/src/functionalTest/groovy/org/graalvm/buildtools/maven/JavaApplicationFunctionalTest.groovy

@@ -108,4 +108,15 @@ class JavaApplicationFunctionalTest extends AbstractGraalVMMavenFunctionalTest {
         outputContains "Hello, native!"
     }
 
+    def "can write the args file"() {
+        withSample("java-application")
+
+        when:
+        mvn '-Pnative', 'native:write-args-file'
+
+        then:
+        buildSucceeded
+        outputContains "Args file written to: target/native-image"
+    }
+
 }

native-maven-plugin/src/main/java/org/graalvm/buildtools/maven/WriteArgsFileMojo.java

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2020, 2023, 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.maven;
+
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.graalvm.buildtools.utils.NativeImageUtils;
+
+import java.io.File;
+import java.util.List;
+
+/**
+ * Persists the arguments file to be used by the native-image command. This can be useful in situations where
+ * Native Build Tools plugin is not available, for example, when running native-image in a Docker container.
+ *
+ * The path to the args file is stored in the project properties under the key {@code graalvm.native-image.args-file}.
+ *
+ * @author Alvaro Sanchez-Mariscal
+ * @since 0.9.21
+ */
+@Mojo(name = WriteArgsFileMojo.NAME, requiresDependencyResolution = ResolutionScope.RUNTIME, requiresDependencyCollection = ResolutionScope.RUNTIME)
+public class WriteArgsFileMojo extends NativeCompileNoForkMojo {
+
+    public static final String NAME = "write-args-file";
+    public static final String PROPERTY_NAME = "graalvm.native-image.args-file";
+
+    @Override
+    public void execute() throws MojoExecutionException {
+        List<String> args = getBuildArgs();
+        List<String> conversionResult = NativeImageUtils.convertToArgsFile(args, outputDirectory.toPath());
+        if (conversionResult.size() == 1) {
+            String argsFileName = conversionResult.get(0).replace("@", "");
+            getLog().info("Args file written to: " + argsFileName);
+            File argsFile = new File(argsFileName);
+            project.getProperties().setProperty(PROPERTY_NAME, argsFile.getAbsolutePath());
+        } else {
+            throw new MojoExecutionException("Error writing args file");
+        }
+    }
+}