feat(plugin): new generate-graalvm-metadata Maven goal (#1759)

### 📝 Description

Create new `GenerateGraalVmMetadataMojo` that introduces new `generate-graalvm-metadata` goal. New goal generates GraalVM reachability metadata for `graphql-kotlin` servers.

Usage (this only generates metadata, in order to generate native image you will also need to configure `org.graalvm.buildtools:native-maven-plugin`, see example integration)

```xml
<plugin>
    <groupId>com.expediagroup</groupId>
    <artifactId>graphql-kotlin-maven-plugin</artifactId>
    <version>${graphql-kotlin.version}</version>
    <executions>
        <execution>
            <goals>
                <goal>generate-graalvm-metadata</goal>
            </goals>
            <configuration>
                <!-- list of packages that can contain our GraphQL schema -->
                <packages>com.expediagroup.graalvm</packages>
                <!-- application main class name -->
                <mainClassName>com.example.ApplicationKt</mainClassName>
            </configuration>
        </execution>
    </executions>
</plugin>
```

### 🔗 Related Issues

Corresponding Gradle plugin PR -> #1743

Author: dariuszkuc

.github/workflows/graalvm-integration.yml

@@ -1,4 +1,4 @@
-name: GraaLVM Integration Tests
+name: GraalVM Integration Tests
 
 on:
   workflow_call:
@@ -20,7 +20,7 @@ jobs:
         working-directory: integration/graalvm
     strategy:
       matrix:
-        server: ['ktor-graalvm-server']
+        server: ['ktor-graalvm-server', 'maven-graalvm-server']
 
     steps:
       - name: Checkout Repository
@@ -40,20 +40,23 @@ jobs:
       - name: Set up Gradle cache
         uses: gradle/gradle-build-action@v2
 
-      - name: Build server
-        run: ./gradlew :${server}:build :${server}:nativeCompile
+      - name: Build native image
+        id: build_server
+        run: |
+          ./gradlew :${server}:buildGraalVmNativeImage
+          echo "NATIVE_IMAGE=$(echo "${server}/build/native/nativeCompile/${server}")" >> $GITHUB_OUTPUT
         env:
           server: ${{ matrix.server }}
 
-      - name: Build and start the native image
+      - name: Start the native image
         id: start_server
         run: |
           set -x
           echo "starting server"
-          ./${server}/build/native/nativeCompile/${server} &
+          ./${nativeImage} &
           echo "SERVER_PID=$(echo $!)" >> $GITHUB_OUTPUT
         env:
-          server: ${{ matrix.server }}
+          nativeImage: ${{ steps.build_server.outputs.NATIVE_IMAGE }}
 
       - name: Integration Test
         run: |

buildSrc/src/main/kotlin/com.expediagroup.graphql.conventions.gradle.kts

@@ -1,7 +1,6 @@
 import org.gradle.accessors.dm.LibrariesForLibs
 import org.jetbrains.dokka.gradle.DokkaTask
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-import java.time.Duration
 import java.time.Instant
 
 plugins {

integration/graalvm/build.gradle.kts

@@ -17,4 +17,5 @@ allprojects {
             project.ext[key.toString()] = value
         }
     }
+    project.version = project.ext["version"]!!
 }

integration/graalvm/common-graalvm-server/build.gradle.kts

@@ -0,0 +1,25 @@
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+@Suppress("DSL_SCOPE_VIOLATION") // TODO: remove once KTIJ-19369 / Gradle#22797 is fixed
+plugins {
+    alias(libs.plugins.kotlin.jvm)
+    `maven-publish`
+}
+
+dependencies {
+    implementation("com.expediagroup", "graphql-kotlin-server")
+    implementation("com.expediagroup", "graphql-kotlin-hooks-provider")
+}
+
+tasks.withType<KotlinCompile> {
+    kotlinOptions.jvmTarget = "17"
+}
+
+// required for maven test
+publishing {
+    publications {
+        create<MavenPublication>("maven") {
+            from(components["java"])
+        }
+    }
+}

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/hooks/CustomHooks.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/hooks/CustomHooks.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.hooks
+package com.expediagroup.graalvm.hooks
 
 import com.expediagroup.graphql.generator.hooks.SchemaGeneratorHooks
 import com.expediagroup.graphql.plugin.schema.hooks.SchemaGeneratorHooksProvider

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/ArgumentQuery.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/ArgumentQuery.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
 import com.expediagroup.graphql.generator.scalars.ID
 import com.expediagroup.graphql.server.operations.Query

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/AsyncQuery.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/AsyncQuery.kt

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
-import com.expediagroup.graalvm.ktor.schema.dataloader.EXAMPLE_LOADER
+import com.expediagroup.graalvm.schema.dataloader.EXAMPLE_LOADER
 import com.expediagroup.graphql.generator.scalars.ID
 import com.expediagroup.graphql.server.operations.Query
 import graphql.schema.DataFetchingEnvironment

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/BasicMutation.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/BasicMutation.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
 import com.expediagroup.graphql.server.operations.Mutation
 

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/CustomScalarQuery.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/CustomScalarQuery.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
 import com.expediagroup.graphql.server.operations.Query
 import java.util.UUID

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/EnumQuery.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/EnumQuery.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
 import com.expediagroup.graphql.server.operations.Query
 

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/ErrorQuery.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/ErrorQuery.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
 import com.expediagroup.graphql.server.operations.Query
 import graphql.GraphqlErrorBuilder

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/IdQuery.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/IdQuery.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
 import com.expediagroup.graphql.generator.scalars.ID
 import com.expediagroup.graphql.server.operations.Query

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/InnerClassQuery.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/InnerClassQuery.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
 import com.expediagroup.graphql.server.operations.Query
 

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/ListQuery.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/ListQuery.kt

@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
-import com.expediagroup.graalvm.ktor.schema.model.InputOnly
-import com.expediagroup.graalvm.ktor.schema.model.OutputOnly
+import com.expediagroup.graalvm.schema.model.InputOnly
+import com.expediagroup.graalvm.schema.model.OutputOnly
 import com.expediagroup.graphql.server.operations.Query
 
 /**

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/PolymorphicQuery.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/PolymorphicQuery.kt

@@ -14,14 +14,14 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
-import com.expediagroup.graalvm.ktor.schema.model.ExampleInterface
-import com.expediagroup.graalvm.ktor.schema.model.ExampleUnion
-import com.expediagroup.graalvm.ktor.schema.model.FirstImpl
-import com.expediagroup.graalvm.ktor.schema.model.FirstUnionMember
-import com.expediagroup.graalvm.ktor.schema.model.SecondImpl
-import com.expediagroup.graalvm.ktor.schema.model.SecondUnionMember
+import com.expediagroup.graalvm.schema.model.ExampleInterface
+import com.expediagroup.graalvm.schema.model.ExampleUnion
+import com.expediagroup.graalvm.schema.model.FirstImpl
+import com.expediagroup.graalvm.schema.model.FirstUnionMember
+import com.expediagroup.graalvm.schema.model.SecondImpl
+import com.expediagroup.graalvm.schema.model.SecondUnionMember
 import com.expediagroup.graphql.server.operations.Query
 import kotlin.random.Random
 

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/ScalarQuery.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/ScalarQuery.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
 import com.expediagroup.graphql.server.operations.Query
 import java.util.UUID

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/TypesQuery.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/TypesQuery.kt

@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema
+package com.expediagroup.graalvm.schema
 
-import com.expediagroup.graalvm.ktor.schema.model.InputAndOutput
-import com.expediagroup.graalvm.ktor.schema.model.InputOnly
-import com.expediagroup.graalvm.ktor.schema.model.OutputOnly
+import com.expediagroup.graalvm.schema.model.InputAndOutput
+import com.expediagroup.graalvm.schema.model.InputOnly
+import com.expediagroup.graalvm.schema.model.OutputOnly
 import com.expediagroup.graphql.server.operations.Query
 
 /**

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/dataloader/ExampleDataLoader.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/dataloader/ExampleDataLoader.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema.dataloader
+package com.expediagroup.graalvm.schema.dataloader
 
 import com.expediagroup.graphql.dataloader.KotlinDataLoader
 import com.expediagroup.graphql.generator.scalars.ID

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/model/ExampleInterface.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/model/ExampleInterface.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema.model
+package com.expediagroup.graalvm.schema.model
 
 import com.expediagroup.graphql.generator.scalars.ID
 import java.util.UUID

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/model/ExampleUnion.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/model/ExampleUnion.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema.model
+package com.expediagroup.graalvm.schema.model
 
 import java.util.UUID
 import kotlin.random.Random

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/model/InputAndOutput.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/model/InputAndOutput.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema.model
+package com.expediagroup.graalvm.schema.model
 
 import kotlin.random.Random
 

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/model/InputOnly.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/model/InputOnly.kt

@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema.model
+package com.expediagroup.graalvm.schema.model
 
 data class InputOnly(val id: Int)

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/schema/model/OutputOnly.kt renamed to integration/graalvm/common-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/schema/model/OutputOnly.kt

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.expediagroup.graalvm.ktor.schema.model
+package com.expediagroup.graalvm.schema.model
 
 import kotlin.random.Random
 

integration/graalvm/common-graalvm-server/src/main/resources/META-INF/services/com.expediagroup.graphql.plugin.schema.hooks.SchemaGeneratorHooksProvider

@@ -0,0 +1 @@
+com.expediagroup.graalvm.hooks.CustomHooksProvider

integration/graalvm/ktor-graalvm-server/build.gradle.kts

@@ -11,7 +11,7 @@ plugins {
 
 dependencies {
     implementation("com.expediagroup", "graphql-kotlin-ktor-server")
-    implementation("com.expediagroup", "graphql-kotlin-hooks-provider")
+    implementation(projects.commonGraalvmServer)
     implementation(libs.logback)
     implementation(libs.ktor.server.cio)
     testImplementation(libs.junit.api)
@@ -48,6 +48,11 @@ graalvmNative {
 
 graphql {
     graalVm {
-        packages = listOf("com.expediagroup.graalvm.ktor")
+        packages = listOf("com.expediagroup.graalvm")
     }
 }
+
+tasks.register("buildGraalVmNativeImage") {
+    dependsOn("build")
+    dependsOn("nativeCompile")
+}

integration/graalvm/ktor-graalvm-server/src/main/kotlin/com/expediagroup/graalvm/ktor/Application.kt

@@ -16,28 +16,28 @@
 
 package com.expediagroup.graalvm.ktor
 
+import com.expediagroup.graalvm.hooks.CustomHooks
 import com.expediagroup.graalvm.ktor.context.CustomContextFactory
-import com.expediagroup.graalvm.ktor.hooks.CustomHooks
-import com.expediagroup.graalvm.ktor.schema.ArgumentQuery
-import com.expediagroup.graalvm.ktor.schema.AsyncQuery
-import com.expediagroup.graalvm.ktor.schema.BasicMutation
 import com.expediagroup.graalvm.ktor.schema.ContextualQuery
-import com.expediagroup.graalvm.ktor.schema.CustomScalarQuery
-import com.expediagroup.graalvm.ktor.schema.EnumQuery
-import com.expediagroup.graalvm.ktor.schema.ErrorQuery
-import com.expediagroup.graalvm.ktor.schema.IdQuery
-import com.expediagroup.graalvm.ktor.schema.model.ExampleInterface
-import com.expediagroup.graalvm.ktor.schema.model.ExampleUnion
-import com.expediagroup.graalvm.ktor.schema.InnerClassQuery
-import com.expediagroup.graalvm.ktor.schema.ListQuery
-import com.expediagroup.graalvm.ktor.schema.PolymorphicQuery
-import com.expediagroup.graalvm.ktor.schema.ScalarQuery
-import com.expediagroup.graalvm.ktor.schema.TypesQuery
-import com.expediagroup.graalvm.ktor.schema.dataloader.ExampleDataLoader
-import com.expediagroup.graalvm.ktor.schema.model.FirstImpl
-import com.expediagroup.graalvm.ktor.schema.model.FirstUnionMember
-import com.expediagroup.graalvm.ktor.schema.model.SecondImpl
-import com.expediagroup.graalvm.ktor.schema.model.SecondUnionMember
+import com.expediagroup.graalvm.schema.ArgumentQuery
+import com.expediagroup.graalvm.schema.AsyncQuery
+import com.expediagroup.graalvm.schema.BasicMutation
+import com.expediagroup.graalvm.schema.CustomScalarQuery
+import com.expediagroup.graalvm.schema.EnumQuery
+import com.expediagroup.graalvm.schema.ErrorQuery
+import com.expediagroup.graalvm.schema.IdQuery
+import com.expediagroup.graalvm.schema.InnerClassQuery
+import com.expediagroup.graalvm.schema.ListQuery
+import com.expediagroup.graalvm.schema.PolymorphicQuery
+import com.expediagroup.graalvm.schema.ScalarQuery
+import com.expediagroup.graalvm.schema.TypesQuery
+import com.expediagroup.graalvm.schema.dataloader.ExampleDataLoader
+import com.expediagroup.graalvm.schema.model.ExampleInterface
+import com.expediagroup.graalvm.schema.model.ExampleUnion
+import com.expediagroup.graalvm.schema.model.FirstImpl
+import com.expediagroup.graalvm.schema.model.FirstUnionMember
+import com.expediagroup.graalvm.schema.model.SecondImpl
+import com.expediagroup.graalvm.schema.model.SecondUnionMember
 import com.expediagroup.graphql.dataloader.KotlinDataLoaderRegistryFactory
 import com.expediagroup.graphql.server.ktor.GraphQL
 import com.expediagroup.graphql.server.ktor.graphQLGetRoute
@@ -53,7 +53,7 @@ fun main() {
     embeddedServer(CIO, port = 8080, host = "0.0.0.0") {
         install(GraphQL) {
             schema {
-                packages = listOf("com.expediagroup.graalvm.ktor")
+                packages = listOf("com.expediagroup.graalvm")
                 queries = listOf(
                     ArgumentQuery(),
                     AsyncQuery(),

integration/graalvm/ktor-graalvm-server/src/main/resources/META-INF/services/com.expediagroup.graphql.plugin.schema.hooks.SchemaGeneratorHooksProvider

@@ -1,6 +1,22 @@
+/*
+ * Copyright 2023 Expedia, Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package com.expediagroup.graalvm.ktor.schema
 
-import com.expediagroup.graalvm.ktor.schema.model.InputOnly
+import com.expediagroup.graalvm.schema.TypesQuery
+import com.expediagroup.graalvm.schema.model.InputOnly
 import com.expediagroup.graphql.server.ktor.GraphQL
 import com.expediagroup.graphql.server.ktor.graphQLPostRoute
 import com.expediagroup.graphql.server.types.GraphQLRequest
@@ -25,7 +41,7 @@ class TypesQueryTest {
         application {
             install(GraphQL) {
                 schema {
-                    packages = listOf("com.expediagroup.graalvm.ktor.schema")
+                    packages = listOf("com.expediagroup.graalvm")
                     queries = listOf(TypesQuery())
                     typeHierarchy = emptyMap()
                 }