Document how to parameterize output directory for REST Docs with WebTestClient

[brneto]

closes #27747

[pivotal-cla]

@brneto Please sign the Contributor License Agreement!

Click here to manually synchronize the status of this Pull Request.

See the FAQ for frequently asked questions.

[pivotal-cla]

@brneto Thank you for signing the Contributor License Agreement!

[brneto]

@wilkinsona It failed with message A build scan was not published as you have not authenticated with server 'ge.spring.io'., is there something more I have to do?

[wilkinsona]

Thanks very much for the PR, @brneto. I've left a couple of comments for your consideration when you have a moment.

[wilkinsona]

It failed with message A build scan was not published as you have not authenticated with server 'ge.spring.io'., is there something more I have to do?

That's not a failure. It's just indicating that it couldn't publish a build scan to ge.spring.io. The build itself should be unaffected.

[brneto]

I'm still intrigued why this doesn't work:

@WebFluxTest
@AutoConfigureRestDocs
abstract class ContractTest {

    @TestConfiguration(proxyBeanMethods = false)
    static class RestDocsParameterizedOutput {

        @Bean
        WebTestClientBuilderCustomizer restDocsParameterizedOutput() {
            return builder -> builder.entityExchangeResultConsumer(document("{class-name}/{method-name}"));
        }
    }

    @Autowired
    private WebTestClient webTestClient;

    void webTestClientSetup() {
        RestAssuredWebTestClient.webTestClient(webTestClient);
    }
}

While this does:

@WebFluxTest
@AutoConfigureRestDocs
abstract class ContractTest {

    @Autowired
    private ApplicationContext context;

    @Autowired
    private WebTestClientRestDocumentationConfigurer configurer;

    void webTestClientSetup() {
        RestAssuredWebTestClient.webTestClient(
                WebTestClient
                        .bindToApplicationContext(context)
                        .configureClient()
                        .filter(configurer)
                        .entityExchangeResultConsumer(document("{class-name}/{method-name}"))
                        .build());
    }
}

Any thought why this is happening?

Thanks!

[brneto]

@wilkinsona I've just figured out why this is happening! That's because the tests generated by the Spring Contract Test does not have the @TestConfiguration creating the WebTestClientBuilderCustomizer bean. Would you have any suggestion how I could overcome this? Thanks!

[brneto]

@wilkinsona It worked externalising the @TestConfiguration class and importing it.
e.g.

@WebFluxTest
@AutoConfigureRestDocs
@Import(ContractTestConfiguration.class)
abstract class ContractTest {

    @BeforeEach
    void webTestClientSetup(@Autowired WebTestClient webTestClient) {
        RestAssuredWebTestClient.webTestClient(webTestClient);
    }
}

[brneto]

@wilkinsona is there anything else I have to do or this is it for this PR?

Do you know why this concourse-ci/status check is still in failure state?

[wilkinsona]

It's failing because the code in MyWebTestClientBuilderCustomizerConfiguration doesn't compile. It appears to be missing a static import for WebTestClientRestDocumentation.document. The package declaration is also incorrect. Don't worry about it, though. We can take care of it when we come to merge this.

[brneto]

Let me fix that. Give me a sec.

[brneto]

@wilkinsona, just did ae79b33. Sorry for that! :(

[brneto]

@wilkinsona it's still failing! Have I made any other mistake? :(

[scottfrederick]

@brneto Just a small checkstyle violation. You can push another commit to fix that, or as Andy said we're happy to fix it when merging.

[wilkinsona]

@brneto Thanks very much for making your first contribution to Spring Boot.