Add local schema file support to Gradle plugin extension

plugins/graphql-kotlin-gradle-plugin/README.md

@@ -32,7 +32,7 @@ graphql {
       allowDeprecatedFields = false
       // List of custom GraphQL scalar to converter mapping containing information about corresponding Java type and converter that should be used to serialize/deserialize values.
       customScalars = listOf(GraphQLScalar("UUID", "java.util.UUID", "com.example.UUIDScalarConverter"))
-      // GraphQL server endpoint that will be used to for running introspection queries. Alternatively you can download schema directly from `sdlEndpoint`.
+      // GraphQL server endpoint that will be used to for running introspection queries. Alternatively you can download schema directly from `sdlEndpoint` or specify local `schemaFileName`.
       endpoint = "http://localhost:8080/graphql"
       // Optional HTTP headers to be specified on an introspection query or SDL request.
       headers = mapOf("X-Custom-Header" to "Custom-Header-Value")
@@ -44,7 +44,9 @@ graphql {
       queryFiles = listOf(file("${project.projectDir}/src/main/resources/queries/MyQuery.graphql"))
       // JSON serializer that will be used to generate the data classes.
       serializer = GraphQLSerializer.JACKSON
-      // GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against `endpoint`.
+      // GraphQL schema file location. Can be used instead of `endpoint` or `sdlEndpoint`.
+      schemaFileName = "${project.projectDir}/src/main/resources/myLocalSchema.graphql"
+      // GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against `endpoint` or specify local `schemaFileName`.
       sdlEndpoint = "http://localhost:8080/sdl"
       // Timeout configuration for introspection query/downloading SDL
       timeout {

plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/GraphQLGradlePlugin.kt

@@ -115,8 +115,11 @@ class GraphQLGradlePlugin : Plugin<Project> {
                         generateClientTask.dependsOn(downloadSDLTask.path)
                         generateClientTask.schemaFile.convention(downloadSDLTask.outputFile)
                     }
+                    extension.clientExtension.schemaFileName != null -> {
+                        generateClientTask.schemaFileName.convention(extension.clientExtension.schemaFileName)
+                    }
                     else -> {
-                        throw RuntimeException("Invalid GraphQL client extension configuration - missing required endpoint/sdlEndpoint property")
+                        throw RuntimeException("Invalid GraphQL client extension configuration - missing required endpoint/sdlEndpoint/schemaFileName property")
                     }
                 }
             }

plugins/graphql-kotlin-gradle-plugin/src/main/kotlin/com/expediagroup/graphql/plugin/gradle/GraphQLPluginExtension.kt

@@ -55,10 +55,12 @@ open class GraphQLPluginExtension {
 }
 
 open class GraphQLPluginClientExtension {
-    /** GraphQL server endpoint that will be used to for running introspection queries. Alternatively you can download schema directly from [sdlEndpoint]. */
+    /** GraphQL server endpoint that will be used to for running introspection queries. Alternatively you can download schema directly from [sdlEndpoint] or specify local [schemaFileName]. */
     var endpoint: String? = null
-    /** GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against [endpoint]. */
+    /** GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against [endpoint] or specify local [schemaFileName]. */
     var sdlEndpoint: String? = null
+    /** GraphQL schema file location. Can be used instead of [endpoint] or [sdlEndpoint]. */
+    var schemaFileName: String? = null
     /** Target package name to be used for generated classes. */
     var packageName: String? = null
     /** Optional HTTP headers to be specified on an introspection query or SDL request. */

plugins/graphql-kotlin-gradle-plugin/src/test/kotlin/com/expediagroup/graphql/plugin/gradle/GraphQLGradlePluginIT.kt

@@ -74,6 +74,43 @@ class GraphQLGradlePluginIT : GraphQLGradlePluginAbstractIT() {
         assertEquals(TaskOutcome.SUCCESS, buildResult.task(":run")?.outcome)
     }
 
+    @Test
+    @Tag("kts")
+    fun `apply the plugin extension to generate client with local schema file (kts)`(@TempDir tempDir: Path) {
+        val testProjectDirectory = tempDir.toFile()
+        val buildFileContents =
+            """
+            |application {
+            |  applicationDefaultJvmArgs = listOf("-DgraphQLEndpoint=${wireMockServer.baseUrl()}/graphql")
+            |  mainClassName = "com.example.ApplicationKt"
+            |}
+            |
+            |graphql {
+            |  client {
+            |    schemaFileName = "${'$'}{project.projectDir}/src/main/resources/schema.graphql"
+            |    packageName = "com.example.generated"
+            |  }
+            |}
+            """.trimMargin()
+        testProjectDirectory.generateBuildFileForClient(buildFileContents)
+        testProjectDirectory.createTestFile("JUnitQuery.graphql", "src/main/resources")
+            .writeText(testQuery)
+        testProjectDirectory.createTestFile("Application.kt", "src/main/kotlin/com/example")
+            .writeText(loadTemplate("Application", mapOf("customScalarsEnabled" to false)))
+        testProjectDirectory.createTestFile("schema.graphql", "src/main/resources")
+            .writeText(testSchema)
+
+        val buildResult = GradleRunner.create()
+            .withProjectDir(testProjectDirectory)
+            .withPluginClasspath()
+            .withArguments("build", "run", "--stacktrace")
+            .build()
+
+        assertEquals(TaskOutcome.SUCCESS, buildResult.task(":$GENERATE_CLIENT_TASK_NAME")?.outcome)
+        assertTrue(File(testProjectDirectory, "build/generated/source/graphql/main/com/example/generated/JUnitQuery.kt").exists())
+        assertEquals(TaskOutcome.SUCCESS, buildResult.task(":run")?.outcome)
+    }
+
     @Test
     @Tag("kts")
     fun `apply the plugin extension to generate client (kts)`(@TempDir tempDir: Path) {

website/docs/plugins/gradle-plugin-tasks.mdx

@@ -118,7 +118,7 @@ graphql {
     allowDeprecatedFields = false
     // List of custom GraphQL scalar to converter mapping containing information about corresponding Java type and converter that should be used to serialize/deserialize values.
     customScalars = listOf(GraphQLScalar("UUID", "java.util.UUID", "com.example.UUIDScalarConverter"))
-    // GraphQL server endpoint that will be used to for running introspection queries. Alternatively you can download schema directly from `sdlEndpoint`.
+    // GraphQL server endpoint that will be used to for running introspection queries. Alternatively you can download schema directly from `sdlEndpoint` or specify local `schemaFileName`.
     endpoint = "http://localhost:8080/graphql"
     // Optional HTTP headers to be specified on an introspection query or SDL request.
     headers = mapOf("X-Custom-Header" to "Custom-Header-Value")
@@ -130,7 +130,9 @@ graphql {
     queryFiles = listOf(file("${project.projectDir}/src/main/resources/queries/MyQuery.graphql"))
     // JSON serializer that will be used to generate the data classes.
     serializer = GraphQLSerializer.JACKSON
-    // GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against `endpoint`.
+    // GraphQL schema file location. Can be used instead of `endpoint` or `sdlEndpoint`.
+    schemaFileName = "${project.projectDir}/src/main/resources/myLocalSchema.graphql"
+    // GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against `endpoint` or specify local `schemaFileName`.
     sdlEndpoint = "http://localhost:8080/sdl"
     // Timeout configuration for introspection query/downloading SDL
     timeout {
@@ -164,7 +166,7 @@ graphql {
         allowDeprecatedFields = false
         // List of custom GraphQL scalar to converter mapping containing information about corresponding Java type and converter that should be used to serialize/deserialize values.
         customScalars = [new GraphQLScalar("UUID", "java.util.UUID", "com.example.UUIDScalarConverter")]
-        // GraphQL server endpoint that will be used to for running introspection queries. Alternatively you can download schema directly from `sdlEndpoint`.
+        // GraphQL server endpoint that will be used to for running introspection queries. Alternatively you can download schema directly from `sdlEndpoint` or specify local `schemaFileName`.
         endpoint = "http://localhost:8080/graphql"
         // Optional HTTP headers to be specified on an introspection query or SDL request.
         headers = ["X-Custom-Header" : "My-Custom-Header-Value"]
@@ -176,7 +178,9 @@ graphql {
         queryFiles = [file("${project.projectDir}/src/main/resources/queries/MyQuery.graphql")]
         // JSON serializer that will be used to generate the data classes.
         serializer = GraphQLSerializer.JACKSON
-        // GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against `endpoint`.
+        // GraphQL schema file location. Can be used instead of `endpoint` or `sdlEndpoint`.
+        schemaFileName = "${project.projectDir}/src/main/resources/myLocalSchema.graphql"
+        // GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against `endpoint` or specify local `schemaFileName`.
         sdlEndpoint = "http://localhost:8080/sdl"
         // Timeout configuration for introspection query/downloading SDL
         timeout { t ->