build: gradle plugin generated SDL integration tests (ExpediaGroup#1657)

### 📝 Description

Migrate generate SDL task integration tests from using GradleRunner to a composite test build.

### 🔗 Related Issues

Author: dariuszkuc

integration/gradle-plugin-integration-tests/buildSrc/build.gradle.kts

@@ -0,0 +1,13 @@
+import org.gradle.kotlin.dsl.`kotlin-dsl`
+
+plugins {
+    `kotlin-dsl`
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation(libs.kotlin.gradle.api)
+}

integration/gradle-plugin-integration-tests/buildSrc/settings.gradle.kts

@@ -0,0 +1,7 @@
+dependencyResolutionManagement {
+    versionCatalogs {
+        create("libs") {
+            from(files("../../../gradle/libs.versions.toml"))
+        }
+    }
+}

integration/gradle-plugin-integration-tests/buildSrc/src/main/kotlin/com/expediagroup/it/VerifyFileExistsTask.kt

@@ -0,0 +1,28 @@
+package com.expediagroup.it
+
+import org.gradle.api.DefaultTask
+import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.tasks.InputFile
+import org.gradle.api.tasks.TaskAction
+
+abstract class VerifyFileExistsTask : DefaultTask() {
+
+    @get:InputFile
+    abstract val actualSchema: RegularFileProperty
+
+    @get:InputFile
+    abstract val expectedSchema: RegularFileProperty
+
+    @TaskAction
+    fun test() {
+        if (!actualSchema.get().asFile.exists()) {
+            throw RuntimeException("schema file was not generated")
+        }
+
+        val expected = expectedSchema.get().asFile.readText()
+        val actual = actualSchema.get().asFile.readText()
+        if (expected != actual) {
+            throw RuntimeException("generated schema file was different.\n---expected---\n$expected\n\n---actual---\n$actual")
+        }
+    }
+}

integration/gradle-plugin-integration-tests/buildSrc/src/main/kotlin/com/expediagroup/it/VerifyGenerateSDLTask.kt

@@ -0,0 +1,28 @@
+package com.expediagroup.it
+
+import org.gradle.api.DefaultTask
+import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.tasks.InputFile
+import org.gradle.api.tasks.TaskAction
+
+abstract class VerifyGenerateSDLTask : DefaultTask() {
+
+    @get:InputFile
+    abstract val actualSchema: RegularFileProperty
+
+    @get:InputFile
+    abstract val expectedSchema: RegularFileProperty
+
+    @TaskAction
+    fun test() {
+        if (!actualSchema.get().asFile.exists()) {
+            throw RuntimeException("schema file was not generated")
+        }
+
+        val expected = expectedSchema.get().asFile.readText()
+        val actual = actualSchema.get().asFile.readText()
+        if (expected != actual) {
+            throw RuntimeException("generated schema file was different.\n---expected---\n$expected\n\n---actual---\n$actual")
+        }
+    }
+}

integration/gradle-plugin-integration-tests/client-generator/custom-scalars-jackson/src/test/kotlin/com/expediagroup/scalars/CustomScalarApplicationTests.kt

@@ -23,7 +23,7 @@ import kotlin.test.assertNull
 import kotlinx.coroutines.runBlocking
 import org.junit.jupiter.api.Test
 import org.springframework.boot.test.context.SpringBootTest
-import org.springframework.boot.web.server.LocalServerPort
+import org.springframework.boot.test.web.server.LocalServerPort
 
 @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
 class CustomScalarApplicationTests(@LocalServerPort private val port: Int) {

integration/gradle-plugin-integration-tests/client-generator/polymorphic-types-jackson/src/test/kotlin/com/expediagroup/polymorphic/PolymorphicApplicationTests.kt

@@ -10,7 +10,7 @@ import com.expediagroup.polymorphic.generated.partialpolymorphicquery.DefaultBas
 import kotlinx.coroutines.runBlocking
 import org.junit.jupiter.api.Test
 import org.springframework.boot.test.context.SpringBootTest
-import org.springframework.boot.web.server.LocalServerPort
+import org.springframework.boot.test.web.server.LocalServerPort
 import kotlin.test.assertNull
 import kotlin.test.assertTrue
 

integration/gradle-plugin-integration-tests/client-generator/polymorphic-types-kotlinx/src/test/kotlin/com/expediagroup/polymorphic/PolymorphicKotlinxTests.kt

@@ -15,6 +15,7 @@ import io.ktor.server.cio.CIO
 import io.ktor.server.engine.embeddedServer
 import java.net.URL
 import kotlinx.coroutines.runBlocking
+import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.modules.SerializersModule
 import kotlinx.serialization.modules.polymorphic
 import org.junit.jupiter.api.Test
@@ -25,11 +26,12 @@ class PolymorphicKotlinxTests {
 
     @Test
     fun `verify polymorphic queries are correctly serialized and deserialized`() {
-        val engine = embeddedServer(CIO, port = 8080, module = Application::graphQLModule)
+        val engine = embeddedServer(CIO, port = 0, module = Application::graphQLModule)
         try {
             engine.start()
             runBlocking {
-                val client = GraphQLKtorClient(url = URL("http://localhost:8080/graphql"))
+                val port = engine.resolvedConnectors().first().port
+                val client = GraphQLKtorClient(url = URL("http://localhost:$port/graphql"))
 
                 val query = CompletePolymorphicQuery(variables = CompletePolymorphicQuery.Variables(input = "foo"))
                 val response = client.execute(query)
@@ -48,9 +50,10 @@ class PolymorphicKotlinxTests {
         }
     }
 
+    @OptIn(ExperimentalSerializationApi::class)
     @Test
     fun `verify polymorphic queries fallbacks are correctly serialized and deserialized`() {
-        val engine = embeddedServer(CIO, port = 8080, module = Application::graphQLModule)
+        val engine = embeddedServer(CIO, port = 0, module = Application::graphQLModule)
         try {
             engine.start()
             runBlocking {
@@ -65,7 +68,8 @@ class PolymorphicKotlinxTests {
                         }
                     }
                 })
-                val client = GraphQLKtorClient(url = URL("http://localhost:8080/graphql"), serializer = serializerWithFallback)
+                val port = engine.resolvedConnectors().first().port
+                val client = GraphQLKtorClient(url = URL("http://localhost:$port/graphql"), serializer = serializerWithFallback)
 
                 val fallbackQuery = PartialPolymorphicQuery(variables = PartialPolymorphicQuery.Variables(input = "bar"))
                 val fallbackResponse = client.execute(fallbackQuery)

integration/gradle-plugin-integration-tests/client-generator/skip-include/src/test/kotlin/com/expediagroup/directives/ApplicationTest.kt

@@ -5,7 +5,7 @@ import com.expediagroup.graphql.client.spring.GraphQLWebClient
 import kotlinx.coroutines.runBlocking
 import org.junit.jupiter.api.Test
 import org.springframework.boot.test.context.SpringBootTest
-import org.springframework.boot.web.server.LocalServerPort
+import org.springframework.boot.test.web.server.LocalServerPort
 import java.util.UUID
 import kotlin.test.assertNotNull
 import kotlin.test.assertNull

integration/gradle-plugin-integration-tests/sdl/classpath-hooks/build.gradle.kts

@@ -0,0 +1,33 @@
+import com.expediagroup.graphql.plugin.gradle.graphql
+import com.expediagroup.it.VerifyGenerateSDLTask
+
+@Suppress("DSL_SCOPE_VIOLATION") // TODO: remove once KTIJ-19369 / Gradle#22797 is fixed
+plugins {
+    id("com.expediagroup.graphql")
+    alias(libs.plugins.kotlin.jvm)
+    alias(libs.plugins.kotlin.spring)
+    alias(libs.plugins.spring.boot)
+}
+
+dependencies {
+    implementation("com.expediagroup:graphql-kotlin-spring-server")
+    implementation("com.expediagroup:graphql-kotlin-hooks-provider")
+    implementation(libs.kotlin.stdlib)
+}
+
+graphql {
+  schema {
+    packages = listOf("com.example")
+  }
+}
+
+// integration test
+tasks.register<VerifyGenerateSDLTask>("integrationTest") {
+    dependsOn("graphqlGenerateSDL")
+
+    actualSchema.set(File(project.buildDir, "schema.graphql"))
+    expectedSchema.set(File(rootProject.projectDir, "src/integration/resources/sdl/custom.graphql"))
+}
+tasks.named("build") {
+    dependsOn("integrationTest")
+}

integration/gradle-plugin-integration-tests/sdl/classpath-hooks/src/main/kotlin/com/example/Application.kt

@@ -0,0 +1,18 @@
+package com.example
+
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.boot.runApplication
+import com.example.CustomFederatedHooks
+import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorHooks
+import org.springframework.context.annotation.Bean
+
+@SpringBootApplication
+class Application
+{
+    @Bean
+    fun federatedSchemaGeneratorHooks(): FederatedSchemaGeneratorHooks = CustomFederatedHooks()
+}
+
+fun main(args: Array<String>) {
+    runApplication<Application>(*args)
+}

integration/gradle-plugin-integration-tests/sdl/classpath-hooks/src/main/kotlin/com/example/CustomFederatedHooks.kt

@@ -0,0 +1,39 @@
+package com.example
+
+import com.expediagroup.graphql.generator.federation.FederatedSchemaGeneratorHooks
+import graphql.language.StringValue
+import graphql.schema.Coercing
+import graphql.schema.CoercingParseLiteralException
+import graphql.schema.GraphQLScalarType
+import graphql.schema.GraphQLType
+import java.util.UUID
+import kotlin.reflect.KType
+
+private val graphqlUUIDType = GraphQLScalarType.newScalar()
+    .name("UUID")
+    .description("Custom scalar representing UUID")
+    .coercing(object : Coercing<UUID, String> {
+        override fun parseValue(input: Any): UUID = UUID.fromString(
+            serialize(input)
+        )
+
+        override fun parseLiteral(input: Any): UUID {
+            val uuidString = (input as? StringValue)?.value
+            return if (uuidString != null) {
+                UUID.fromString(uuidString)
+            } else {
+                throw CoercingParseLiteralException("Unable to convert $input to Any scalar")
+            }
+        }
+
+        override fun serialize(dataFetcherResult: Any): String = dataFetcherResult.toString()
+    })
+    .build()
+
+class CustomFederatedHooks : FederatedSchemaGeneratorHooks(emptyList()) {
+
+    override fun willGenerateGraphQLType(type: KType): GraphQLType? = when (type.classifier) {
+        UUID::class -> graphqlUUIDType
+        else -> super.willGenerateGraphQLType(type)
+    }
+}

integration/gradle-plugin-integration-tests/sdl/classpath-hooks/src/main/kotlin/com/example/CustomHooksProvider.kt

@@ -0,0 +1,9 @@
+package com.example
+
+import com.expediagroup.graphql.generator.hooks.SchemaGeneratorHooks
+import com.expediagroup.graphql.plugin.schema.hooks.SchemaGeneratorHooksProvider
+
+class CustomHooksProvider : SchemaGeneratorHooksProvider {
+
+    override fun hooks(): SchemaGeneratorHooks = CustomFederatedHooks()
+}

integration/gradle-plugin-integration-tests/sdl/classpath-hooks/src/main/kotlin/com/example/HelloWorldQuery.kt

@@ -0,0 +1,17 @@
+package com.example
+
+import com.expediagroup.graphql.server.operations.Query
+import org.springframework.stereotype.Component
+import java.util.UUID
+
+@Component
+class HelloWorldQuery : Query {
+
+    fun helloWorld(name: String? = null) = if (name != null) {
+        "Hello, $name!!!"
+    } else {
+        "Hello, World!!!"
+    }
+
+    fun randomUUID(): UUID = UUID.randomUUID()
+}

integration/gradle-plugin-integration-tests/sdl/classpath-hooks/src/main/resources/META-INF/services/com.expediagroup.graphql.plugin.schema.hooks.SchemaGeneratorHooksProvider

@@ -0,0 +1 @@
+com.example.CustomHooksProvider

integration/gradle-plugin-integration-tests/sdl/extension-groovy/build.gradle

@@ -0,0 +1,30 @@
+import com.expediagroup.it.VerifyGenerateSDLTask
+
+plugins {
+  id 'com.expediagroup.graphql'
+  alias(libs.plugins.kotlin.jvm)
+  alias(libs.plugins.kotlin.spring)
+  alias(libs.plugins.spring.boot)
+}
+
+dependencies {
+    implementation "com.expediagroup:graphql-kotlin-spring-server"
+    implementation(libs.kotlin.stdlib)
+}
+
+graphql {
+  schema {
+    packages = ["com.example"]
+  }
+}
+
+// integration test
+tasks.register("integrationTest", VerifyGenerateSDLTask) {
+    dependsOn("graphqlGenerateSDL")
+
+    actualSchema = new File(project.buildDir, "schema.graphql")
+    expectedSchema = new File(rootProject.projectDir, "src/integration/resources/sdl/schema.graphql")
+}
+tasks.named("build") {
+    dependsOn("integrationTest")
+}

integration/gradle-plugin-integration-tests/sdl/extension-groovy/src/main/kotlin/com/example/Application.kt

@@ -0,0 +1,11 @@
+package com.example
+
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.boot.runApplication
+
+@SpringBootApplication
+class Application
+
+fun main(args: Array<String>) {
+    runApplication<Application>(*args)
+}

integration/gradle-plugin-integration-tests/sdl/extension-groovy/src/main/kotlin/com/example/HelloWorldQuery.kt

@@ -0,0 +1,15 @@
+package com.example
+
+import com.expediagroup.graphql.server.operations.Query
+import org.springframework.stereotype.Component
+
+@Component
+class HelloWorldQuery : Query {
+
+    fun helloWorld(name: String? = null) = if (name != null) {
+        "Hello, $name!!!"
+    } else {
+        "Hello, World!!!"
+    }
+
+}

integration/gradle-plugin-integration-tests/sdl/extension-kotlin/build.gradle.kts

@@ -0,0 +1,32 @@
+import com.expediagroup.graphql.plugin.gradle.graphql
+import com.expediagroup.it.VerifyGenerateSDLTask
+
+@Suppress("DSL_SCOPE_VIOLATION") // TODO: remove once KTIJ-19369 / Gradle#22797 is fixed
+plugins {
+    id("com.expediagroup.graphql")
+    alias(libs.plugins.kotlin.jvm)
+    alias(libs.plugins.kotlin.spring)
+    alias(libs.plugins.spring.boot)
+}
+
+dependencies {
+    implementation("com.expediagroup", "graphql-kotlin-spring-server")
+    implementation(libs.kotlin.stdlib)
+}
+
+graphql {
+  schema {
+    packages = listOf("com.example")
+  }
+}
+
+// integration test
+tasks.register<VerifyGenerateSDLTask>("integrationTest") {
+    dependsOn("graphqlGenerateSDL")
+
+    actualSchema.set(File(project.buildDir, "schema.graphql"))
+    expectedSchema.set(File(rootProject.projectDir, "src/integration/resources/sdl/schema.graphql"))
+}
+tasks.named("build") {
+    dependsOn("integrationTest")
+}

integration/gradle-plugin-integration-tests/sdl/extension-kotlin/src/main/kotlin/com/example/Application.kt

@@ -0,0 +1,11 @@
+package com.example
+
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.boot.runApplication
+
+@SpringBootApplication
+class Application
+
+fun main(args: Array<String>) {
+    runApplication<Application>(*args)
+}

integration/gradle-plugin-integration-tests/sdl/extension-kotlin/src/main/kotlin/com/example/HelloWorldQuery.kt

@@ -0,0 +1,15 @@
+package com.example
+
+import com.expediagroup.graphql.server.operations.Query
+import org.springframework.stereotype.Component
+
+@Component
+class HelloWorldQuery : Query {
+
+    fun helloWorld(name: String? = null) = if (name != null) {
+        "Hello, $name!!!"
+    } else {
+        "Hello, World!!!"
+    }
+
+}