Improve documentation around samples for reactive based slice testing GraphQL controller

[deepakemani-maersk]

hi,

We are trying to do the slice test for a GraphQL controller in a reactive style using @graphqltest.

We neither found full documentation for the same in (https://docs.spring.io/spring-graphql/docs/current/reference/html/#testing-httpgraphqltester) nor examples in the repo (https://github.com/spring-projects/spring-graphql/)

The samples link is broken mentioned in the docs: https://github.com/spring-projects/spring-graphql/tree/main/samples

@rstoyanchev : Can you please help to add the missing relevant documentation for HTTP based reactive tests and in samples repo?

[bclozel]

Thanks for reaching out @deepakemani-maersk , we moved this documentation back to Spring Boot with the auto-configuration, where it belongs.

You can find this documentation in Spring Boot 2.7.x reference documentation - it turns out I did a poor job of reinstating it in Spring Boot 3.0 (see spring-projects/spring-boot#33407) but it should be back in a few minutes here for the next version.

As for the sample projects present on our 1.0.x branch, they're far from ideal and server mostly as integration tests. We're working on improving the situation in #208. I hope this answers your questions!

[rstoyanchev]

Thanks for raising this!

I should start by mentioning the samples are in the process of being replaced, see #208, and were recently dropped from the main branch, so they are now only in the 1.0.x branch. The docs were updated recently with 0baceda so the latest snapshot points correctly to the 1.0.x branch.

You're right we have a documentation gap. Our own reference here is focused mainly on the testing API, but in fact what most applications will use is the Boot testing support. There is no mention of slice tests and nothing that shows the different options from a Boot perspective.

That said, a slice test is meant to be quite isolated and focused, so I'm wondering is there anything in those tests that actually depends on doing this over HTTP in particular? It would make sense that such tests don't really care about the transport.

Beyond that, I'm wondering how we could improve the docs? One option would be to link from our reference to the appropriate section in the Boot documentation, but I don't see anything suitable to link to. Nothing about @GraphQlTest, nor @AutoConfigureGraphQlTester, nor any transport specific options. @bclozel maybe is an improvement to be made in the Boot reference and would that give us a natural place to link to? Alternatively we could consider summarizing all that in our reference docs here, but still it seems like this should be somehow present in the Boot reference as well.

[bclozel]

Yes, there's a gap in our docs - reopening this issue to address that.

[rstoyanchev]

Oh, I see now the section on GraphQL testing in Boot 2.7 looks much more complete. @deepakemani-maersk, please have a look at the link the Brian provided above and let us know if you have further feedback.

Beyond that, I agree we can improve the docs in the test chapter here as well to link to Boot.

[deepakemani-maersk]

Thanks @bclozel, @rstoyanchev for pointing the right location and correcting them.