Integration testing of the generated endpoint only

[keetron]

When using @SpringBootTestit allows the user to start up the spring context with a limited amount of classes which can be useful for isolated integration testing the inbound and outbound parts of the service.
An example how this would look like:

@SpringBootTest(classes = [ExposedGraphQL::class], webEnvironment = RANDOM_PORT)
@AutoConfigureWebTestClient
@EnableAutoConfiguration
class ExposedGraphQLIT(@Autowired private val testClient: WebTestClient)  {
((tests go here))
}

This however is throwing errors:

nested exception is com.expediagroup.graphql.generator.exceptions.TypeNotSupportedException: Cannot convert java.time.Instant since it is not a valid GraphQL type or outside the supported packages "[your.package]"

Adding the java.time package to the graphql.packages list is not possible as then the following error is thrown:

nested exception is com.expediagroup.graphql.generator.exceptions.InvalidInputFieldTypeException: Argument cannot be an interface or a union, parameter #1 arg0 of fun java.time.temporal.TemporalAccessor.range(java.time.temporal.TemporalField!): java.time.temporal.ValueRange!

Of course, I could start up the entire application, spin up docker containers for database and redis, start up wiremock for downstream services and basically end up with a slow and complicated test and I do not want to do that to test only the configuration of the graphql controller that is generated by the graphql-kotlin plugin.

How to enable this test, what am I doing wrong here?

[smyrick]

It looks like you are trying to return TemporalAccessor somewhere in the schema so it is taking all the functions in this class and running them through the generator. The method TemporalAccessor.range has one argument and that happens to be an interface. In Kotlin this is valid, but in GraphQL you can not use interfaces as input objects. So the resolution here is to either use a type different than TemporalAccessor or modify the behaviour with hooks to ignore this method.

I would suggest not using any of the base java classes in your schema unless you are doing something with custom scalars. Avoiding these types means your API schema is better controlled and more focuses on returning the exact data the client needs rather than having the ability to access every method on TemporalAccessor

[keetron]

As it turns out the application indeed has customised SchemaGenerationHooks, the challenge now is how to wire those into the test.

[keetron]

Update a few hours later:
With the trusted @TestConfiguration a configuration was set up to be able to load the bean for the custom hooks. This allows me to run controller tests without having to spin up the entire context.

[Keerthan22]

Hello @keetron I'm facing a similar issue as this but in a different setup using Quarkus and exception with com.expediagroup.graphql.generator.scalars.ID type, can you elaborate on what exactly you configured to get the integration tests working?

[keetron]

No sorry, this is rather long ago, I left that role and never encountered a similar problem since.

[smyrick]

@Keerthan22 Check to make sure that you are using your custom hooks in the integration tests

[Keerthan22]

@smyrick Currently I'm spinning up the resource using @QuarkusTest & testing the same using RestAssured, although I expect it to work OOTB, I'm not sure whats wrong.
On a side note: The application works as expected when built as a Quarkus application, its only the Integration tests with @QuarkusTest annotation that have this issue

[smyrick]

I am not familiar with Quarkus, you can look at the examples folder for Spring and how that imports the things for @SpringTest

graphql-kotlin/examples/server/spring-server/src/main/kotlin/com/expediagroup/graphql/examples/server/spring/Application.kt

Line 42 in ad93137

fun hooks(wiringFactory: KotlinDirectiveWiringFactory) = CustomSchemaGeneratorHooks(wiringFactory)

If you are getting a com.expediagroup.graphql.generator.exceptions.TypeNotSupportedException in test and not in app then to me that idicates that you hooks are not being properly configured for the test