Merge pull request #720 from hgschmie/maven-switches

Adds two new switches to the maven test goal

Author: alvarosanchez

docs/src/docs/asciidoc/changelog.adoc

@@ -4,6 +4,8 @@
 == Release 0.11.1
 
 - Fix `NoClassDefFoundError` when JUnit feature is missing some dependency
+- Add `skipTestExecution` support to `native-maven-plugin`
+- Add `failNoTests` support to `native-maven-plugin`
 
 == Release 0.11.0
 

docs/src/docs/asciidoc/end-to-end-maven-guide.adoc

@@ -232,6 +232,16 @@ This works similarly to `JAVA_TOOL_OPTIONS`, where the value of the environment
 
 Learn more about Native Image build configuration https://www.graalvm.org/reference-manual/native-image/overview/BuildConfiguration/[on the website].
 
+=== Build, but not execute native tests
+
+During a transition phase, it is often useful to build tests but not execute them. This allows inspection of the generated test image without failing the build when the tests do not execute successfully.
+
+If you wish to build, but not execute, the native tests, invoke Maven with the `-DskipTestExecution` switch or set the value in the plugin configuration.
+
+=== Skip modules without native tests in multi-module builds
+
+Multi-module projects where only some sub-modules contain native tests need to skip test execution for any module that do not contain native tests. Skip test execution for modules by setting the `<failNoTests>` configuration to `false` or providing `-DfailNoTests=false` on the command line.
+
 [[gather-execution-profiles]]
 === Gather Execution Profiles and Build Optimized Images
 

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

@@ -61,6 +61,18 @@ The following configuration options are available:
 ----
 <skipNativeTests>true</skipNativeTests>
 ----
+`<skipTestExecution>`::
+   Skips execution of native tests. If set to true, the plugin will create the native image for the tests but will not execute the tests. This allows the creation of the native image for testing even when tests don't fully execute or tests fail. Otherwise, the build stops at the first test failure. To skip only the execution of the native image compiled tests, add:
+[source,xml, role="multi-language-sample"]
+----
+<skipNativeTests>true</skipNativeTests>
+----
+`<failNoTests>`::
+   Fails the build if no tests were found. In multi-module builds, there are often modules that have no tests (for example, a documentation module ) or where tests are enabled or disabled by profiles (such as slow tests, e2e tests, etc.). This switch allows for a global configuration of the native plugin and then allows you to skip any modules where no tests are present by changing this setting to false in the sub-module. This allows such multi-module projects to build successfully. To avoid failing the build in a module where no tests are present, add:
+[source,xml, role="multi-language-sample"]
+----
+<failNoTests>false</failNoTests>
+----
 `<debug>`::
    If you want to enable generation of debugging information, add:
 [source,xml, role="multi-language-sample"]
@@ -686,6 +698,76 @@ For example, you might wish to disable only native testing support for use cases
 - Your library or application uses a testing framework that is not supported on the JUnit Platform.
 - You need to use the <<agent-support, agent>> when running tests on the JVM but do not wish to run those same tests as native code.
 
+[[control-test-execution]]
+=== Controlling test execution
+
+==== Build, but not execute native tests
+
+During a transition phase, it is often useful to build tests but not execute them. This allows inspection of the generated test image without failing the build when the tests do not execute successfully.
+
+If you wish to build, but not execute, the native tests, invoke Maven with the `-DskipTestExecution` flag. This flag is specific to Native Build Tools.
+
+[source,bash, role="multi-language-sample"]
+----
+./mvnw -Pnative -DskipTestExecution package
+----
+
+Alternatively, set `<skipTestExecution>` to `true` in the plugin configuration:
+
+[source,xml, role="multi-language-sample"]
+----
+<configuration>
+  <skipTestExecution>true</skipTestExecution>
+</configuration>
+----
+
+This will still build the native test image but skips execution of tests as native code.
+
+==== Skip modules without native tests in multi-module builds
+
+In multi-module projects where only some sub-modules contain native tests, you need to skip test execution for any module that does not contain native tests. Any module which should contain tests, but does not, should fail the build.
+
+Skip test execution for modules by configuring the `<failNoTests>` configuration option for the full build and then overriding it in modules where the default behavior is not desired.
+
+If the majority of the sub-modules should contain native tests, nothing needs to be configured globally since this is the default behavior for the native plugin.
+
+For sub-modules that do not contain native tests but should not fail the build, add this to the module's _pom.xml_ in the module in the `<plugins>` section:
+
+[source,xml, role="multi-language-sample"]
+----
+<plugin>
+  <groupId>org.graalvm.buildtools</groupId>
+  <artifactId>native-maven-plugin</artifactId>
+  <configuration>
+    <failNoTests>false</failNoTests>
+  </configuration>
+</plugin>
+----
+
+If only a few sub-modules contain native tests, add this configuration setting to the main plugin configuration:
+
+[source,xml, role="multi-language-sample"]
+----
+<configuration>
+  <failNoTests>false</failNoTests>
+</configuration>
+----
+
+and then override this in any sub-module that should have native tests by adding this to the module in the `<plugins>` section:
+
+[source,xml, role="multi-language-sample"]
+----
+<plugin>
+  <groupId>org.graalvm.buildtools</groupId>
+  <artifactId>native-maven-plugin</artifactId>
+  <configuration>
+    <failNoTests>true</failNoTests>
+  </configuration>
+</plugin>
+----
+
+For testing from the command line, the `-DfailNoTests=false` flag is also supported directly:
+
 [[metadata-support]]
 == GraalVM Reachability Metadata Support
 

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

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2025, 2025, 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
+
+class MavenTestExecutionFunctionalTests extends AbstractGraalVMMavenFunctionalTest {
+    def "test if the skipTestExecution flag skips execution of tests"() {
+        withSample("java-application-with-tests")
+
+        when:
+        mvn '-DquickBuild', '-DskipTestExecution=true', '-Pnative', 'test'
+
+        then:
+        buildSucceeded
+        outputContainsPattern ".*GraalVM Native Image: Generating 'native-tests.*?' \\(executable\\).*"
+        outputDoesNotContain "containers found"
+        outputDoesNotContain "containers skipped"
+        outputDoesNotContain "containers started"
+        outputDoesNotContain "tests found"
+        outputDoesNotContain "tests skipped"
+        outputDoesNotContain "tests started"
+    }
+
+    def "test if clearing the failNoTests flag allows build to continue if no tests are present"() {
+        withSample("non-native") // needs a sample that contains code in src/test but no actual test class
+
+        when:
+        mvn '-DquickBuild', '-DfailNoTests=false', '-Pnative', 'test'
+
+        then:
+        buildSucceeded
+        outputContains "No tests found, skipping."
+    }
+
+    def "test if setting the failNoTests flag fails the build if no tests are present"() {
+        withSample("non-native") // needs a sample that contains code in src/test but no actual test class
+
+        when:
+        mvn '-DquickBuild', '-DfailNoTests=true', '-Pnative', 'test'
+
+        then:
+        buildFailed
+        outputContains "Test configuration file wasn't found. Make sure that test execution wasn't skipped."
+    }
+}

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

@@ -99,6 +99,27 @@ public class NativeTestMojo extends AbstractNativeImageMojo {
     @Parameter(property = "skipNativeTests", defaultValue = "false")
     private boolean skipNativeTests;
 
+    /**
+     * Skips execution of native tests. If set to true, the plugin will create the native image for the tests but do not execute the tests.
+     * This allows the creation of the native image for testing even if they don't fully execute / tests fail.
+     * Otherwise, the build stops at the first test failure.
+     *
+     * @since 0.11.1
+     */
+    @Parameter(property = "skipTestExecution", defaultValue = "false")
+    private boolean skipTestExecution;
+
+    /**
+     * Fail the build if no tests were found. In multi-module builds, there are often modules that have no tests (e.g. documentation)
+     * or tests are enabled/disabled by profiles (slow tests, e2e tests etc.). This switch allows for a global configuration of the
+     * native plugin and then skip any modules where no tests are present by changing this setting to false in the sub-module.
+     * This allows such multi-module projects to build successfully.
+     *
+     * @since 0.11.1
+     */
+    @Parameter(property = "failNoTests", defaultValue = "true")
+    private boolean failNoTests;
+
     @Override
     protected void populateApplicationClasspath() throws MojoExecutionException {
         super.populateApplicationClasspath();
@@ -151,8 +172,13 @@ public void execute() throws MojoExecutionException {
             return;
         }
         if (!hasTestIds()) {
-            logger.error("Test configuration file wasn't found. Make sure that test execution wasn't skipped.");
-            throw new IllegalStateException("Test configuration file wasn't found.");
+            if (failNoTests) {
+                logger.error("Test configuration file wasn't found. Make sure that test execution wasn't skipped.");
+                throw new IllegalStateException("Test configuration file wasn't found.");
+            } else {
+                logger.info("No tests found, skipping.");
+                return;
+            }
         }
 
         logger.info("====================");
@@ -178,7 +204,10 @@ public void execute() throws MojoExecutionException {
         mainClass = "org.graalvm.junit.platform.NativeImageJUnitLauncher";
 
         buildImage();
-        runNativeTests(outputDirectory.toPath().resolve(NATIVE_TESTS_EXE));
+
+        if (!skipTestExecution) {
+            runNativeTests(outputDirectory.toPath().resolve(NATIVE_TESTS_EXE));
+        }
     }
 
     private void configureEnvironment() {