Promote JVM extension to Native
The directory extensions-jvm
contains extensions that have not been tested in
native mode yet. Configuring the
native build and implementing integration tests for
them may open the door to even faster startup and lower memory footprint.
Please find some guiding steps below to start this quest:
-
Make sure that nobody else works on promoting the same extension by searching through the GitHub issues.
-
Let others know that you work on promoting the given extension by either creating a new issue or asking to assign an existing one to you.
-
Select the JVM Only extension to be promoted, for instance the grpc extension like below:
$ cd camel-quarkus $ export EXT='grpc'
-
Split the JVM Only extension into
extensions
andintegration-tests
folders, from a shell execute:$ { sed -i '/integration-test/d' "extensions-jvm/${EXT}/pom.xml" sed -i "/<module>${EXT}<\/module>/d" "extensions-jvm/pom.xml" git mv "extensions-jvm/${EXT}/integration-test/" "integration-tests/${EXT}" git mv "extensions-jvm/${EXT}" "extensions/${EXT}" sed -i -r "s/(.*)activemq(.*)/\1activemq\2\n\1${EXT}\2/g" extensions/pom.xml sed -i -r "s/(.*)activemq(.*)/\1activemq\2\n\1${EXT}\2/g" integration-tests/pom.xml sed -i -r "s/camel-quarkus-build-parent-it/camel-quarkus-integration-tests/g" "integration-tests/${EXT}/pom.xml" sed -i '/relativePath/d' "integration-tests/${EXT}/pom.xml" sed -i -r "s/camel-quarkus-${EXT}-integration-test/camel-quarkus-integration-test-${EXT}/g" "integration-tests/${EXT}/pom.xml" sed -i -r "s/Quarkus :: (.*) :: Integration Test/Quarkus :: Integration Tests :: \1/g" "integration-tests/${EXT}/pom.xml" }
-
Add the native profile at the end of
integration-tests/${EXT}/pom.xml
:<profiles> <profile> <id>native</id> <activation> <property> <name>native</name> </property> </activation> <properties> <quarkus.package.type>native</quarkus.package.type> </properties> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-failsafe-plugin</artifactId> <executions> <execution> <goals> <goal>integration-test</goal> <goal>verify</goal> </goals> </execution> </executions> </plugin> </plugins> </build> </profile> </profiles>
-
Remove the warning build step from
extensions/${EXT}/deployment/src/main/java/org/apache/camel/quarkus/component/${EXT}/deployment/${EXT}Processor.java
:/** * Remove this once this extension starts supporting the native mode. */ @BuildStep(onlyIf = NativeBuild.class) @Record(value = ExecutionTime.RUNTIME_INIT) void warnJvmInNative(JvmOnlyRecorder recorder) { JvmOnlyRecorder.warnJvmInNative(LOG, FEATURE); // warn at build time recorder.warnJvmInNative(FEATURE); // warn at runtime }
-
Create a native test at
integration-tests/${EXT}/src/test/java/org/apache/camel/quarkus/component/${EXT}/it/${EXT}IT.java
-
Check the
extensions/${EXT}/runtime/src/main/resources/META-INF/quarkus-extension.yaml
file.The `description` comes from Camel Catalog. If it looks improper or too long due to concatenation of multiple component descriptions, you may override it by setting an explicit `<description>` in the runtime `pom.xml` of your new extension. If you think the value coming from Camel Catalog should be changed, please https://issues.apache.org/jira/secure/CreateIssue!default.jspa[file a new Camel issue] and ask to fix the metadata for the given Camel component.
If there is some important keyword missing in both the `name` and `description` through which your new extension should definitely be findable on https://code.quarkus.io[code.quarkus.io], consider setting `<quarkus.metadata.keywords>` property in your runtime `pom.xml`.
Make sure you run `mvn -N cq:update-quarkus-metadata` from the source tree's root directory to re-generate the `quarkus-extension.yaml` file. As a result the `unlisted: true` line should disappear.
Check the xref:contributor-guide/extension-metadata.adoc[Extension metadata] page for more details about the `quarkus-extension.yaml` file
-
Add the integration test to an existing or new test category in
.github/test-categories.yaml
, for instance:rpc: - grpc
-
Unify source files format, update docs and rebuild the whole project:
mvn clean install -D skipTests -P format
-
Execute integration tests:
cd "integration-tests/${EXT}" mvn clean verify -P native
-
Now it’s time to solve native build issues if any, extend integration tests coverage and perhaps even shifting some tasks from runtime to build time. The Quarkus extension author’s guide may be a good ally for this.
-
Please also check the Create new extension page as it contains some useful tips for a good contribution.