From cf89ebcf92057f0d263a85af3cd34e6883259218 Mon Sep 17 00:00:00 2001 From: Dmytro Nosan Date: Mon, 18 Feb 2019 14:24:07 +0200 Subject: [PATCH 1/2] Add an example showing how to use Spring REST Docs with WebTestClient See gh-15978 --- .../main/asciidoc/spring-boot-features.adoc | 18 +++++++ ...DocsWebTestClientConfigurationExample.java | 37 +++++++++++++++ .../webclient/UsersDocumentationTests.java | 47 +++++++++++++++++++ 3 files changed, 102 insertions(+) create mode 100644 spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/AdvancedRestDocsWebTestClientConfigurationExample.java create mode 100644 spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 1dd46b23853..d101046682f 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -7716,7 +7716,25 @@ bean can be used, as shown in the following example: include::{code-examples}/test/autoconfigure/restdocs/restassured/AdvancedConfigurationExample.java[tag=configuration] ---- +[[boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs-web-test-client]] +===== Auto-configured Spring REST Docs Tests with WebTestClient +`@AutoConfigureRestDocs` could be used in conjunction with a `@WebFluxTest` to generate REST Docs. +`@AutoConfigureRestDocs` customizes the `WebTestClient` bean to use Spring REST Docs. You can +inject it by using `@Autowired` and use it in your tests. Here is a quick sample: +[source,java,indent=0] +---- +include::{code-examples}/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java[tag=source] +---- + +If you require more control over Spring REST Docs configuration than offered by the +attributes of `@AutoConfigureRestDocs`, you can use a +`RestDocsWebTestClientConfigurationCustomizer` bean, as shown in the following example: + +[source,java,indent=0] +---- +include::{code-examples}/test/autoconfigure/restdocs/webclient/AdvancedRestDocsWebTestClientConfigurationExample.java[tag=configuration] +---- [[boot-features-testing-spring-boot-applications-testing-auto-configured-additional-auto-config]] ==== Additional Auto-configuration and Slicing diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/AdvancedRestDocsWebTestClientConfigurationExample.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/AdvancedRestDocsWebTestClientConfigurationExample.java new file mode 100644 index 00000000000..f3b0b500016 --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/AdvancedRestDocsWebTestClientConfigurationExample.java @@ -0,0 +1,37 @@ +/* + * Copyright 2012-2019 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.springframework.boot.docs.test.autoconfigure.restdocs.webclient; + +import org.springframework.boot.test.autoconfigure.restdocs.RestDocsWebTestClientConfigurationCustomizer; +import org.springframework.boot.test.context.TestConfiguration; +import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer; + +public class AdvancedRestDocsWebTestClientConfigurationExample { + + // tag::configuration[] + @TestConfiguration + static class CustomizationConfiguration + implements RestDocsWebTestClientConfigurationCustomizer { + + @Override + public void customize(WebTestClientRestDocumentationConfigurer configurer) { + configurer.snippets().withEncoding("UTF-8"); + } + + } + // end::configuration[] + +} diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java new file mode 100644 index 00000000000..374f5bed428 --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java @@ -0,0 +1,47 @@ +/* + * Copyright 2012-2019 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.springframework.boot.docs.test.autoconfigure.restdocs.webclient; + +// tag::source[] + +import org.junit.jupiter.api.Test; +import org.junit.runner.RunWith; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs; +import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest; +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.test.web.reactive.server.WebTestClient; + +import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document; + +@RunWith(SpringRunner.class) +@WebFluxTest +@AutoConfigureRestDocs +public class UsersDocumentationTests { + + @Autowired + private WebTestClient webTestClient; + + @Test + void listUsers() { + this.webTestClient.get().uri("/").exchange().expectStatus().isOk().expectBody() + .consumeWith(document("list-users")); + + } + +} +// end::source[] From ce17a923dd28fbec2ecb362fbe3c83d68b3d3832 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Wed, 27 Feb 2019 16:03:28 +0100 Subject: [PATCH 2/2] Polish contribution Closes gh-15978 --- .../main/asciidoc/spring-boot-features.adoc | 40 ++++++++++--------- ...java => AdvancedConfigurationExample.java} | 5 ++- .../webclient/UsersDocumentationTests.java | 3 +- 3 files changed, 26 insertions(+), 22 deletions(-) rename spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/{AdvancedRestDocsWebTestClientConfigurationExample.java => AdvancedConfigurationExample.java} (92%) diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index d101046682f..46abcdcd805 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -7695,6 +7695,28 @@ generate the default snippets. The following example shows a +[[boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs-web-test-client]] +===== Auto-configured Spring REST Docs Tests with WebTestClient +`@AutoConfigureRestDocs` can also be used with `WebTestClient`. You can inject it by using +`@Autowired` and use it in your tests as you normally would when using `@WebFluxTest` and +Spring REST Docs, as shown in the following example: + +[source,java,indent=0] +---- +include::{code-examples}/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java[tag=source] +---- + +If you require more control over Spring REST Docs configuration than offered by the +attributes of `@AutoConfigureRestDocs`, you can use a +`RestDocsWebTestClientConfigurationCustomizer` bean, as shown in the following example: + +[source,java,indent=0] +---- +include::{code-examples}/test/autoconfigure/restdocs/webclient/AdvancedConfigurationExample.java[tag=configuration] +---- + + + [[boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs-rest-assured]] ===== Auto-configured Spring REST Docs Tests with REST Assured `@AutoConfigureRestDocs` makes a `RequestSpecification` bean, preconfigured to use Spring @@ -7716,25 +7738,7 @@ bean can be used, as shown in the following example: include::{code-examples}/test/autoconfigure/restdocs/restassured/AdvancedConfigurationExample.java[tag=configuration] ---- -[[boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs-web-test-client]] -===== Auto-configured Spring REST Docs Tests with WebTestClient -`@AutoConfigureRestDocs` could be used in conjunction with a `@WebFluxTest` to generate REST Docs. -`@AutoConfigureRestDocs` customizes the `WebTestClient` bean to use Spring REST Docs. You can -inject it by using `@Autowired` and use it in your tests. Here is a quick sample: -[source,java,indent=0] ----- -include::{code-examples}/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java[tag=source] ----- - -If you require more control over Spring REST Docs configuration than offered by the -attributes of `@AutoConfigureRestDocs`, you can use a -`RestDocsWebTestClientConfigurationCustomizer` bean, as shown in the following example: - -[source,java,indent=0] ----- -include::{code-examples}/test/autoconfigure/restdocs/webclient/AdvancedRestDocsWebTestClientConfigurationExample.java[tag=configuration] ----- [[boot-features-testing-spring-boot-applications-testing-auto-configured-additional-auto-config]] ==== Additional Auto-configuration and Slicing diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/AdvancedRestDocsWebTestClientConfigurationExample.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/AdvancedConfigurationExample.java similarity index 92% rename from spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/AdvancedRestDocsWebTestClientConfigurationExample.java rename to spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/AdvancedConfigurationExample.java index f3b0b500016..4b10ed43332 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/AdvancedRestDocsWebTestClientConfigurationExample.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/AdvancedConfigurationExample.java @@ -13,17 +13,18 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.springframework.boot.docs.test.autoconfigure.restdocs.webclient; import org.springframework.boot.test.autoconfigure.restdocs.RestDocsWebTestClientConfigurationCustomizer; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer; -public class AdvancedRestDocsWebTestClientConfigurationExample { +public class AdvancedConfigurationExample { // tag::configuration[] @TestConfiguration - static class CustomizationConfiguration + public static class CustomizationConfiguration implements RestDocsWebTestClientConfigurationCustomizer { @Override diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java index 374f5bed428..7b94a6d9a3c 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/test/autoconfigure/restdocs/webclient/UsersDocumentationTests.java @@ -13,10 +13,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.springframework.boot.docs.test.autoconfigure.restdocs.webclient; // tag::source[] - import org.junit.jupiter.api.Test; import org.junit.runner.RunWith; @@ -40,7 +40,6 @@ public class UsersDocumentationTests { void listUsers() { this.webTestClient.get().uri("/").exchange().expectStatus().isOk().expectBody() .consumeWith(document("list-users")); - } }