Use Quarkus Maven plugin to build native executables

quarkus-qe · Dec 22, 2023 · 2e932a4 · 2e932a4
1 parent f38097e
commit 2e932a4
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 6 deletions.
diff --git a/examples/amq-amqp/pom.xml b/examples/amq-amqp/pom.xml
@@ -34,4 +34,20 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>${quarkus.platform.group-id}</groupId>
+                <artifactId>quarkus-maven-plugin</artifactId>
+                <version>${quarkus.platform.version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>build</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
 </project>
diff --git a/examples/amq-tcp/pom.xml b/examples/amq-tcp/pom.xml
@@ -9,6 +9,9 @@
     </parent>
     <artifactId>examples-amq-tcp</artifactId>
     <name>Quarkus - Test Framework - Examples - AMQ TCP</name>
+    <properties>
+        <quarkus.build.skip>true</quarkus.build.skip>
+    </properties>
     <dependencies>
         <dependency>
             <groupId>io.quarkiverse.artemis</groupId>
@@ -35,4 +38,20 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>${quarkus.platform.group-id}</groupId>
+                <artifactId>quarkus-maven-plugin</artifactId>
+                <version>${quarkus.platform.version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>build</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
 </project>
diff --git a/...n/java/io/quarkus/test/services/quarkus/ProdQuarkusApplicationManagedResourceBuilder.java b/...n/java/io/quarkus/test/services/quarkus/ProdQuarkusApplicationManagedResourceBuilder.java
@@ -157,8 +157,17 @@ private Path tryToReuseOrBuildArtifact() {
     }
 
     private Path buildArtifact() {
-        if (QuarkusProperties.isNativePackageType(getContext()) && OS.WINDOWS.isCurrentOs()) {
-            return new QuarkusMavenPluginBuildHelper(this).buildNativeExecutable();
+        if (QuarkusProperties.isNativePackageType(getContext())) {
+            return new QuarkusMavenPluginBuildHelper(this)
+                    .buildNativeExecutable()
+                    .orElseGet(() -> {
+                        LOG.warn("""
+                                Quarkus Maven plugin is missing, falling back to Quarkus bootstrap strategy.
+                                Please add 'quarkus-maven-plugin' to your project as the bootstrap strategy will be removed
+                                in the future.
+                                """);
+                        return buildArtifactUsingQuarkusBootstrap();
+                    });
         }
         return buildArtifactUsingQuarkusBootstrap();
     }

diff --git a/...st-core/src/main/java/io/quarkus/test/services/quarkus/QuarkusMavenPluginBuildHelper.java b/...st-core/src/main/java/io/quarkus/test/services/quarkus/QuarkusMavenPluginBuildHelper.java
@@ -18,7 +18,9 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Arrays;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Optional;
 import java.util.Set;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -45,6 +47,11 @@
 
 class QuarkusMavenPluginBuildHelper {
 
+    private static final Set<String> FAILSAFE_BUILD_LIFECYCLE_PHASES = Set.of("verify", "install", "deploy",
+            "integration-test");
+    // following constant helps us to detect args specified before lifecycle phase like `mvn -Dstuff verify`
+    // TODO: this should probably be more robust
+    private static final String LAUNCHER = "org.codehaus.plexus.classworlds.launcher.Launcher";
     private static final String JAVA_SUFFIX = ".java";
     private static final String POM_XML = "pom.xml";
     private final Path appFolder;
@@ -58,10 +65,38 @@ class QuarkusMavenPluginBuildHelper {
         this.appFolder = resourceBuilder.getApplicationFolder();
         this.appClassNames = Arrays.stream(resourceBuilder.getAppClasses()).map(Class::getName).collect(toUnmodifiableSet());
         this.forcedDependencies = List.copyOf(resourceBuilder.getForcedDependencies());
-        this.cmdLineBuildArgs = Set.copyOf(resourceBuilder.getBuildPropertiesSetAsSystemProperties());
+        this.cmdLineBuildArgs = findMavenCommandLineArgs();
     }
 
-    Path buildNativeExecutable() {
+    private static Set<String> findMavenCommandLineArgs() {
+        Set<String> mvnArgs = new HashSet<>();
+        ProcessHandle processHandle = ProcessHandle.current();
+        do {
+            if (processHandle.info().arguments().isPresent()) {
+                String[] args = processHandle.info().arguments().get();
+                boolean keepArgs = false;
+                for (String arg : args) {
+                    if (arg == null) {
+                        // this is probably not necessary, but let's stay on the safe side
+                        continue;
+                    }
+                    if (keepArgs && arg.startsWith("-D")) {
+                        mvnArgs.add(arg);
+                    } else if (LAUNCHER.equals(arg) || FAILSAFE_BUILD_LIFECYCLE_PHASES.contains(arg)) {
+                        // order is important here - we only want to propagate mvn args
+                        keepArgs = true;
+                    }
+                }
+                if (keepArgs) {
+                    return mvnArgs;
+                }
+            }
+            processHandle = processHandle.parent().orElse(null);
+        } while (processHandle != null);
+        throw new IllegalStateException("Failed to detect mvn command line arguments");
+    }
+
+    Optional<Path> buildNativeExecutable() {
         // this snapshot helps to determine next time app is restarted whether build is necessary (what has changes)
         createSnapshotOfBuildProperties.run();
 
@@ -113,8 +148,7 @@ Path buildNativeExecutable() {
             nativeRunnerExpectedLocation += EXE;
         }
         return findTargetFile(mavenBuildProjectRoot.resolve(TARGET), nativeRunnerExpectedLocation)
-                .map(Path::of)
-                .orElseThrow(() -> new IllegalStateException("Native executable is missing"));
+                .map(Path::of);
     }
 
     private String[] getBuildNativeExecutableCmd() {