Compiling your Quarkus applications to native executables

Procedure

1. Open the Getting Started project pom.xml file and verify that it includes the native profile:

   <profiles>
       <profile>
           <id>native</id>
           <properties>
               <quarkus.package.type>native</quarkus.package.type>
           </properties>
       </profile>
   </profiles>

   Copy to Clipboard Toggle word wrap
   Note

   Using Quarkus native profile allows you to run both the native executable and the native image tests.

2. Build a native executable using one of the following methods:

   1. Build a native executable with Docker:

      ./mvnw package -Pnative -Dquarkus.native.container-build=true

      Copy to Clipboard Toggle word wrap

   2. Build a native executable with Podman:

      ./mvnw package -Pnative -Dquarkus.native.container-build=true -Dquarkus.native.container-runtime=podman

      Copy to Clipboard Toggle word wrap

      These commands create the getting-started-*-runner binary in the target directory.

      Important

      Compiling a Quarkus application to a native executable consumes a lot of memory during analysis and optimization. You can limit the amount of memory used during native compilation by setting the quarkus.native.native-image-xmx configuration property. Setting low memory limits might increase the build time. For more details, refer to Native executable configuration properties.

3. Run the native executable:

   ./target/getting-started-*-runner

   Copy to Clipboard Toggle word wrap

   When you build the native executable the prod profile is enabled and the Quarkus native tests run using the prod profile. You can change this using the quarkus.test.native-image-profile property.

Procedure

1. Open the pom.xml file and verify that the native profile contains the following elements:

   <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-failsafe-plugin</artifactId>
       <version>${surefire-plugin.version}</version>
       <executions>
           <execution>
               <goals>
                   <goal>integration-test</goal>
                   <goal>verify</goal>
               </goals>
               <configuration>
                   <systemPropertyVariables>
                       <native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path>
                       <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                       <maven.home>${maven.home}</maven.home>
                   </systemPropertyVariables>
               </configuration>
           </execution>
       </executions>
   </plugin>

   Copy to Clipboard Toggle word wrap

   The failsafe-maven-plugin runs integration test and indicates the location of the produced native executable.

2. Open the src/test/java/org/acme/quickstart/NativeGreetingResourceIT.java file and verify that it includes the following content:

   package org.acme.quickstart;
   
   
   import io.quarkus.test.junit.NativeImageTest;
   
   @NativeImageTest 

   1

   
   public class NativeGreetingResourceIT extends GreetingResourceTest { 

   2

   
   
       // Run the same tests
   
   }

   Copy to Clipboard Toggle word wrap

   1

   Use another test runner that starts the application from the native file before the tests. The executable is retrieved using the native.image.path system property configured in the Failsafe Maven Plugin.

   2

   This example extends the GreetingResourceTest, but you can also create a new test.

3. Run the test:

   ./mvnw verify -Pnative

   Copy to Clipboard Toggle word wrap

   The following example shows the output of this command:

   ./mvnw verify -Pnative
   ...
   [getting-started-1.0-SNAPSHOT-runner:18820]     universe:     587.26 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]      (parse):   2,247.59 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]     (inline):   1,985.70 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]    (compile):  14,922.77 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]      compile:  20,361.28 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]        image:   2,228.30 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]        write:     364.35 ms
   [getting-started-1.0-SNAPSHOT-runner:18820]      [total]:  52,777.76 ms
   [INFO]
   [INFO] --- maven-failsafe-plugin:2.22.1:integration-test (default) @ getting-started ---
   [INFO]
   [INFO] -------------------------------------------------------
   [INFO]  T E S T S
   [INFO] -------------------------------------------------------
   [INFO] Running org.acme.quickstart.NativeGreetingResourceIT
   Executing [/data/home/gsmet/git/quarkus-quickstarts/getting-started/target/getting-started-1.0-SNAPSHOT-runner, -Dquarkus.http.port=8081, -Dtest.url=http://localhost:8081, -Dquarkus.log.file.path=build/quarkus.log]
   2019-04-15 11:33:20,348 INFO  [io.quarkus] (main) Quarkus 999-SNAPSHOT started in 0.002s. Listening on: http://[::]:8081
   2019-04-15 11:33:20,348 INFO  [io.quarkus] (main) Installed features: [cdi, resteasy]
   [INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.387 s - in org.acme.quickstart.NativeGreetingResourceIT
   ...

   Copy to Clipboard Toggle word wrap
   Note

   Quarkus waits for 60 seconds for the native image to start before automatically failing the native tests. You can change this duration using the quarkus.test.native-image-wait-time system property.

   You can extend the wait time using the following command where <duration> is the wait time in seconds:

   ./mvnw verify -Pnative -Dquarkus.test.native-image-wait-time=<duration>

   Copy to Clipboard Toggle word wrap