Add web test client restdocs autoconfiguration #10969

zaynetro · 2017-11-09T17:25:54Z

This is my work in progress to autoconfigure WebTestClient.

eddumelendez · 2017-11-09T19:56:13Z

...ain/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsAutoConfiguration.java

@@ -108,4 +110,26 @@ public RestDocsRestAssuredBuilderCustomizer restAssuredBuilderCustomizer(

 	}

+	@Configuration
+	@ConditionalOnClass(WebTestClientRestDocumentation.class)
+	@ConditionalOnWebApplication(type = Type.SERVLET)


it should be REACTIVE

zaynetro · 2017-11-09T20:23:23Z

How do I execute one test only?

Specifically org.springframework.boot.test.autoconfigure.restdocs.WebTestClientRestDocsAutoConfigurationIntegrationTests

wilkinsona · 2017-11-10T11:22:17Z

@zaynetro You can either run that test in your IDE, or use -Dtestcase on the command line

zaynetro · 2017-11-10T18:25:40Z

I figured that with this change test succeeds:

diff --git a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/reactive/WebTestClientAutoConfiguration.java b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/reactive/WebTestClientAutoConfiguration.java
index 8997ebb4bd..68264a8e3d 100644
--- a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/reactive/WebTestClientAutoConfiguration.java
+++ b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/reactive/WebTestClientAutoConfiguration.java
@@ -30,6 +30,7 @@ import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.http.codec.ClientCodecConfigurer;
+import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer;
 import org.springframework.test.web.reactive.server.WebTestClient;
 import org.springframework.test.web.reactive.server.WebTestClient.Builder;
 import org.springframework.util.CollectionUtils;
@@ -49,11 +50,13 @@ public class WebTestClientAutoConfiguration {

        @Bean
        @ConditionalOnMissingBean
-       public WebTestClient webTestClient(ApplicationContext applicationContext) {
+       public WebTestClient webTestClient(ApplicationContext applicationContext, WebTestClientRestDocumentationConfigurer configurer) {
                WebTestClient.Builder builder = WebTestClient
                                .bindToApplicationContext(applicationContext).configureClient();
                customizeWebTestClient(builder, applicationContext);
                customizeWebTestClientCodecs(builder, applicationContext);
+               builder.baseUrl("https://api.example.com/");
+               builder.filter(configurer);
                return builder.build();
        }

I know it isn't not the proper way to set up the WebTestClient. Due to the lack of knowledge I don't know how to add Configurer only if RestDocs are setup.

Could someone point me at how I can overcome this and whether I am doing it at the right place?

zaynetro · 2017-11-12T09:18:07Z

spring-boot-project/spring-boot-parent/src/checkstyle/checkstyle.xml

@@ -70,7 +70,7 @@
 		<module name="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck" />
 		<module name="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck">
 			<property name="excludes"
-				value="io.restassured.RestAssured.*, org.assertj.core.api.Assertions.*, org.junit.Assert.*, org.junit.Assume.*, org.junit.internal.matchers.ThrowableMessageMatcher.*, org.hamcrest.CoreMatchers.*, org.hamcrest.Matchers.*, org.springframework.boot.configurationprocessor.ConfigurationMetadataMatchers.*, org.springframework.boot.configurationprocessor.TestCompiler.*, org.springframework.boot.test.autoconfigure.AutoConfigurationImportedCondition.*, org.mockito.Mockito.*, org.mockito.BDDMockito.*, org.mockito.ArgumentMatchers.*, org.mockito.Matchers.*, org.springframework.restdocs.hypermedia.HypermediaDocumentation.*, org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.*, org.springframework.restdocs.operation.preprocess.Preprocessors.*, org.springframework.restdocs.restassured3.operation.preprocess.RestAssuredPreprocessors.*, org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.*, org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*, org.springframework.test.web.servlet.result.MockMvcResultMatchers.*, org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.*, org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.*, org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo, org.springframework.test.web.client.ExpectedCount.*, org.springframework.test.web.client.match.MockRestRequestMatchers.*, org.springframework.test.web.client.response.MockRestResponseCreators.*" />
+				value="io.restassured.RestAssured.*, org.assertj.core.api.Assertions.*, org.junit.Assert.*, org.junit.Assume.*, org.junit.internal.matchers.ThrowableMessageMatcher.*, org.hamcrest.CoreMatchers.*, org.hamcrest.Matchers.*, org.springframework.boot.configurationprocessor.ConfigurationMetadataMatchers.*, org.springframework.boot.configurationprocessor.TestCompiler.*, org.springframework.boot.test.autoconfigure.AutoConfigurationImportedCondition.*, org.mockito.Mockito.*, org.mockito.BDDMockito.*, org.mockito.ArgumentMatchers.*, org.mockito.Matchers.*, org.springframework.restdocs.hypermedia.HypermediaDocumentation.*, org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.*, org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.*, org.springframework.restdocs.operation.preprocess.Preprocessors.*, org.springframework.restdocs.restassured3.operation.preprocess.RestAssuredPreprocessors.*, org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.*, org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*, org.springframework.test.web.servlet.result.MockMvcResultMatchers.*, org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.*, org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.*, org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo, org.springframework.test.web.client.ExpectedCount.*, org.springframework.test.web.client.match.MockRestRequestMatchers.*, org.springframework.test.web.client.response.MockRestResponseCreators.*" />


Added org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.*

zaynetro · 2017-11-12T09:29:49Z

Figured it out.

zaynetro · 2017-11-12T11:39:42Z

Yay! Let me know if something else needs to be changed.

zaynetro · 2017-11-16T17:39:24Z

Any chance this can get merged some time soon?

wilkinsona · 2017-11-17T11:47:05Z

@zaynetro Thanks for the PR. I'll try to review and merge this in RC1.

See gh-10969

* gh-10969: Polish "Add auto-configuration for using REST Docs with WebTestClient" Add auto-configuration for using REST Docs with WebTestClient

wilkinsona · 2018-01-09T12:09:55Z

Thanks for the PR, @zaynetro. I've merged the changes into master.

zaynetro added 2 commits November 9, 2017 19:24

Add web test client restdocs autoconfiguration

56ad74f

Remove comment

0af9dc7

spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Nov 9, 2017

zaynetro added 3 commits November 9, 2017 20:38

Fix checkstyle violations

dfd63b2

Add restdocs webtestclient dependency

9e449aa

Use correct document import

2786521

eddumelendez reviewed Nov 9, 2017

View reviewed changes

zaynetro added 2 commits November 9, 2017 22:05

Use reactive type

4f1c03d

Add static webclienttest document to checkstyle

5b0c5aa

Customize web test client

9cccae5

zaynetro commented Nov 12, 2017

View reviewed changes

Format files

973b984

zaynetro changed the title ~~WIP Add web test client restdocs autoconfiguration~~ Add web test client restdocs autoconfiguration Nov 12, 2017

zaynetro added 3 commits November 12, 2017 11:33

Remove unused imports

bc7d330

Add default web test client builder customizer

2963eb7

Reorder imports

3b62b92

Use application context from field

24e3da7

philwebb added the for: team-attention An issue we'd like other members of the team to review label Nov 16, 2017

wilkinsona added priority: normal type: enhancement A general enhancement and removed for: team-attention An issue we'd like other members of the team to review status: waiting-for-triage An issue we've not yet triaged labels Nov 17, 2017

wilkinsona added this to the 2.0.0.RC1 milestone Nov 17, 2017

wilkinsona self-assigned this Nov 17, 2017

wilkinsona mentioned this pull request Nov 17, 2017

Support WebTestClient in AutoConfigureRestDocs #10967

Closed

wilkinsona mentioned this pull request Nov 30, 2017

MockMvc doesn't use spring-boot's mvc exception handler #7321

Closed

wilkinsona mentioned this pull request Jan 9, 2018

Introduce a WebTestClientBuilderCustomizer callback #11579

Closed

wilkinsona pushed a commit that referenced this pull request Jan 9, 2018

Add auto-configuration for using REST Docs with WebTestClient

ab7c47d

See gh-10969

wilkinsona added a commit that referenced this pull request Jan 9, 2018

Merge pull request #10969 from Roman Zaynetdinov

adf0d61

* gh-10969: Polish "Add auto-configuration for using REST Docs with WebTestClient" Add auto-configuration for using REST Docs with WebTestClient

wilkinsona closed this Jan 9, 2018

zaynetro deleted the restdocs-webflux branch January 9, 2018 20:04

wilkinsona mentioned this pull request Nov 20, 2018

Update documentation to reflect @AutoConfigureRestDocs support for @WebTestClient #15220

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add web test client restdocs autoconfiguration #10969

Add web test client restdocs autoconfiguration #10969

Uh oh!

zaynetro commented Nov 9, 2017

Uh oh!

eddumelendez Nov 9, 2017 •

edited

Loading

Uh oh!

zaynetro Nov 9, 2017

Uh oh!

zaynetro commented Nov 9, 2017

Uh oh!

wilkinsona commented Nov 10, 2017

Uh oh!

zaynetro commented Nov 10, 2017

Uh oh!

zaynetro Nov 12, 2017

Uh oh!

zaynetro commented Nov 12, 2017

Uh oh!

zaynetro commented Nov 12, 2017

Uh oh!

zaynetro commented Nov 16, 2017

Uh oh!

wilkinsona commented Nov 17, 2017

Uh oh!

wilkinsona commented Jan 9, 2018

Uh oh!

Uh oh!

Add web test client restdocs autoconfiguration #10969

Add web test client restdocs autoconfiguration #10969

Uh oh!

Conversation

zaynetro commented Nov 9, 2017

Uh oh!

eddumelendez Nov 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zaynetro Nov 9, 2017

Choose a reason for hiding this comment

Uh oh!

zaynetro commented Nov 9, 2017

Uh oh!

wilkinsona commented Nov 10, 2017

Uh oh!

zaynetro commented Nov 10, 2017

Uh oh!

zaynetro Nov 12, 2017

Choose a reason for hiding this comment

Uh oh!

zaynetro commented Nov 12, 2017

Uh oh!

zaynetro commented Nov 12, 2017

Uh oh!

zaynetro commented Nov 16, 2017

Uh oh!

wilkinsona commented Nov 17, 2017

Uh oh!

wilkinsona commented Jan 9, 2018

Uh oh!

Uh oh!

eddumelendez Nov 9, 2017 •

edited

Loading