[plugin] support query file directory in Gradle extension (#914)

Adds ability to specify custom query file directory (previously we had to explicitly provide a list of query files).

```kotlin
graphql {
  client {
    endpoint = "http://localhost:8080/graphql"
    package = "com.example"
    queryFileDirectory = "${project.projectDir}/src/main/resources/queries"
  }
}
```

Author: dariuszkuc

docs/plugins/gradle-plugin.md

@@ -102,7 +102,9 @@ graphql {
     headers = mapOf("X-Custom-Header" to "Custom-Header-Value")
     // Target package name to be used for generated classes.
     packageName = "com.example.generated"
-    // Optional list of query files to be processed, if not specified will default to all query files under src/main/resources.
+    // Custom directory containing query files, defaults to src/main/resources
+    queryFileDirectory = "${project.projectDir}/src/main/resources/queries"
+    // Optional list of query files to be processed, takes precedence over queryFileDirectory
     queryFiles = listOf(file("${project.projectDir}/src/main/resources/queries/MyQuery.graphql"))
     // GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against `endpoint`.
     sdlEndpoint = "http://localhost:8080/sdl"
@@ -134,7 +136,9 @@ graphql {
         headers = ["X-Custom-Header" : "My-Custom-Header-Value"]
         // Target package name to be used for generated classes.
         packageName = "com.example.generated"
-        // Optional list of query files to be processed, if not specified will default to all query files under src/main/resources.
+        // Custom directory containing query files, defaults to src/main/resources
+        queryFileDirectory = "${project.projectDir}/src/main/resources/queries"
+        // Optional list of query files to be processed, takes precedence over queryFileDirectory
         queryFiles = [file("${project.projectDir}/src/main/resources/queries/MyQuery.graphql")]
         // GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against `endpoint`.
         sdlEndpoint = "http://localhost:8080/sdl"

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

@@ -39,7 +39,9 @@ graphql {
     headers = mapOf("X-Custom-Header" to "Custom-Header-Value")
     // Target package name to be used for generated classes.
     packageName = "com.example.generated"
-    // Optional list of query files to be processed, if not specified will default to all query files under src/main/resources.
+    // Custom directory containing query files, defaults to src/main/resources
+    queryFileDirectory = "${project.projectDir}/src/main/resources/queries"
+    // Optional list of query files to be processed, takes precedence over queryFileDirectory
     queryFiles = listOf(file("${project.projectDir}/src/main/resources/queries/MyQuery.graphql"))
     // GraphQL server SDL endpoint that will be used to download schema. Alternatively you can run introspection query against `endpoint`.
     sdlEndpoint = "http://localhost:8080/sdl"

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

@@ -61,6 +61,10 @@ class GraphQLGradlePlugin : Plugin<Project> {
                     generateClientTask.packageName.convention(project.provider { extension.clientExtension.packageName })
                     generateClientTask.allowDeprecatedFields.convention(project.provider { extension.clientExtension.allowDeprecatedFields })
                     generateClientTask.converters.convention(extension.clientExtension.converters)
+                    val queryFileDirectory = extension.clientExtension.queryFileDirectory
+                    if (queryFileDirectory != null) {
+                        generateClientTask.queryFileDirectory.convention(queryFileDirectory)
+                    }
                     generateClientTask.queryFiles.setFrom(extension.clientExtension.queryFiles)
                     generateClientTask.clientType.convention(extension.clientExtension.clientType)
 

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

@@ -57,6 +57,8 @@ open class GraphQLPluginClientExtension {
     var converters: Map<String, ScalarConverterMapping> = emptyMap()
     /** List of query files to be processed. */
     var queryFiles: List<File> = emptyList()
+    /** Directory containing GraphQL query files. */
+    var queryFileDirectory: String? = null
     /** Type of GraphQL client implementation to generate. */
     var clientType: GraphQLClientType = GraphQLClientType.DEFAULT
 

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

@@ -261,4 +261,48 @@ class GraphQLGradlePluginIT : GraphQLGradlePluginAbstractIT() {
         assertTrue(File(testProjectDirectory, "build/generated/source/graphql/main/com/example/generated/DeprecatedQuery.kt").exists())
         assertEquals(TaskOutcome.SUCCESS, buildResult.task(":run")?.outcome)
     }
+
+    @Test
+    @Tag("kts")
+    fun `apply the plugin extension to generate client using custom directory (kts)`(@TempDir tempDir: Path) {
+        val testProjectDirectory = tempDir.toFile()
+        val buildFileContents =
+            """
+            application {
+              applicationDefaultJvmArgs = listOf("-DgraphQLEndpoint=${wireMockServer.baseUrl()}/graphql")
+              mainClassName = "com.example.ApplicationKt"
+            }
+
+            graphql {
+              client {
+                sdlEndpoint = "${wireMockServer.baseUrl()}/sdl"
+                packageName = "com.example.generated"
+
+                // optional
+                allowDeprecatedFields = true
+                queryFileDirectory = "${'$'}{project.projectDir}/src/main/resources/queries"
+              }
+            }
+            """.trimIndent()
+        testProjectDirectory.generateBuildFile(buildFileContents)
+        testProjectDirectory.createTestFile("JUnitQuery.graphql", "src/main/resources/queries")
+            .writeText(testQuery)
+        testProjectDirectory.createTestFile("DeprecatedQuery.graphql", "src/main/resources/queries")
+            .writeText(loadResource("mocks/DeprecatedQuery.graphql"))
+        testProjectDirectory.createTestFile("Application.kt", "src/main/kotlin/com/example")
+            .writeText(loadTemplate("Application", mapOf("customScalarsEnabled" to false)))
+
+        val buildResult = GradleRunner.create()
+            .withProjectDir(testProjectDirectory)
+            .withPluginClasspath()
+            .withArguments("build", "run")
+            .build()
+
+        assertEquals(TaskOutcome.SUCCESS, buildResult.task(":$DOWNLOAD_SDL_TASK_NAME")?.outcome)
+        assertEquals(TaskOutcome.SUCCESS, buildResult.task(":$GENERATE_CLIENT_TASK_NAME")?.outcome)
+        assertTrue(File(testProjectDirectory, "build/schema.graphql").exists())
+        assertTrue(File(testProjectDirectory, "build/generated/source/graphql/main/com/example/generated/JUnitQuery.kt").exists())
+        assertTrue(File(testProjectDirectory, "build/generated/source/graphql/main/com/example/generated/DeprecatedQuery.kt").exists())
+        assertEquals(TaskOutcome.SUCCESS, buildResult.task(":run")?.outcome)
+    }
 }