From 964939d3a9b5671a37b394677188ec4c6cf0e335 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Tue, 9 Jan 2018 11:53:12 +0000 Subject: [PATCH] Polish "Add auto-configuration for using REST Docs with WebTestClient" Closes gh-10696 --- ...estDocsWebTestClientBuilderCustomizer.java | 49 ++++++++++--------- ...sWebTestClientConfigurationCustomizer.java | 11 ++--- ...DocsAutoConfigurationIntegrationTests.java | 10 ++-- 3 files changed, 35 insertions(+), 35 deletions(-) diff --git a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsWebTestClientBuilderCustomizer.java b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsWebTestClientBuilderCustomizer.java index 22e72b342b..e7206a3a30 100644 --- a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsWebTestClientBuilderCustomizer.java +++ b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsWebTestClientBuilderCustomizer.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2017 the original author or authors. + * Copyright 2012-2018 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. @@ -16,19 +16,18 @@ package org.springframework.boot.test.autoconfigure.restdocs; -import org.springframework.beans.factory.InitializingBean; import org.springframework.boot.test.autoconfigure.web.reactive.WebTestClientBuilderCustomizer; import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer; import org.springframework.test.web.reactive.server.WebTestClient; import org.springframework.util.StringUtils; /** - * A customizer that configures Spring REST Docs with WebTestClient. + * A {@WebTestClientBuilderCustomizer} that configures Spring REST Docs. * - * @author Eddú Meléndez * @author Roman Zaynetdinov + * @author Andy Wilkinson */ -class RestDocsWebTestClientBuilderCustomizer implements InitializingBean, WebTestClientBuilderCustomizer { +class RestDocsWebTestClientBuilderCustomizer implements WebTestClientBuilderCustomizer { private final WebTestClientRestDocumentationConfigurer delegate; @@ -38,7 +37,8 @@ class RestDocsWebTestClientBuilderCustomizer implements InitializingBean, WebTes private Integer uriPort; - RestDocsWebTestClientBuilderCustomizer(WebTestClientRestDocumentationConfigurer delegate) { + RestDocsWebTestClientBuilderCustomizer( + WebTestClientRestDocumentationConfigurer delegate) { this.delegate = delegate; } @@ -66,25 +66,28 @@ class RestDocsWebTestClientBuilderCustomizer implements InitializingBean, WebTes this.uriPort = uriPort; } - @Override - public void afterPropertiesSet() throws Exception { - } - @Override public void customize(WebTestClient.Builder builder) { - if (StringUtils.hasText(this.uriScheme) && StringUtils.hasText(this.uriHost)) { - String baseUrl = this.uriScheme + "://" + this.uriHost; - - if (this.uriPort == 80 && this.uriScheme.equals("http")) { - // Don't add default port - } else if (this.uriPort == 443 && this.uriScheme.equals("https")) { - // Don't add default port - } else if (this.uriPort != null) { - baseUrl += ":" + this.uriPort; - } - - builder.baseUrl(baseUrl); - } + customizeBaseUrl(builder); builder.filter(this.delegate); } + + private void customizeBaseUrl(WebTestClient.Builder builder) { + String scheme = StringUtils.hasText(this.uriScheme) ? this.uriScheme : "http"; + String host = StringUtils.hasText(this.uriHost) ? this.uriHost : "localhost"; + String baseUrl = scheme + "://" + host; + if (!isStandardPort()) { + baseUrl += ":" + this.uriPort; + } + builder.baseUrl(baseUrl); + } + + private boolean isStandardPort() { + if (this.uriPort == null) { + return true; + } + return this.uriScheme.equals("http") && this.uriPort == 80 + || this.uriScheme.equals("https") && this.uriPort.equals(443); + } + } diff --git a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsWebTestClientConfigurationCustomizer.java b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsWebTestClientConfigurationCustomizer.java index cebff084c7..0a7745a7b5 100644 --- a/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsWebTestClientConfigurationCustomizer.java +++ b/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/restdocs/RestDocsWebTestClientConfigurationCustomizer.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2017 the original author or authors. + * Copyright 2012-2018 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. @@ -20,13 +20,12 @@ import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation /** * A customizer for {@link WebTestClientRestDocumentationConfigurer}. If a - * {@code RestDocsWebTestClientConfigurationCustomizer} bean is found in the application context - * it will be {@link #customize called} to customize the - * {@code WebTestClientRestDocumentationConfigurer} before it is applied. Intended for use only - * when the attributes on {@link AutoConfigureRestDocs} do not provide sufficient + * {@code RestDocsWebTestClientConfigurationCustomizer} bean is found in the application + * context it will be {@link #customize called} to customize the + * {@code WebTestClientRestDocumentationConfigurer} before it is applied. Intended for use + * only when the attributes on {@link AutoConfigureRestDocs} do not provide sufficient * customization. * - * @author Andy Wilkinson * @author Roman Zaynetdinov * @since 2.0.0 */ diff --git a/spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/restdocs/WebTestClientRestDocsAutoConfigurationIntegrationTests.java b/spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/restdocs/WebTestClientRestDocsAutoConfigurationIntegrationTests.java index d0558fe566..31f93934ee 100644 --- a/spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/restdocs/WebTestClientRestDocsAutoConfigurationIntegrationTests.java +++ b/spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/restdocs/WebTestClientRestDocsAutoConfigurationIntegrationTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2017 the original author or authors. + * Copyright 2012-2018 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. @@ -29,14 +29,12 @@ import org.springframework.test.context.junit4.SpringRunner; import org.springframework.test.web.reactive.server.WebTestClient; import org.springframework.util.FileSystemUtils; - import static org.assertj.core.api.Assertions.assertThat; import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document; /** - * Integration tests for {@link RestDocsAutoConfiguration} with WebClientTest. + * Integration tests for {@link RestDocsAutoConfiguration} with {@link WebTestClient}. * - * @author Andy Wilkinson * @author Roman Zaynetdinov */ @RunWith(SpringRunner.class) @@ -54,8 +52,8 @@ public class WebTestClientRestDocsAutoConfigurationIntegrationTests { @Test public void defaultSnippetsAreWritten() throws Exception { - this.webTestClient.get().uri("/").exchange() - .expectBody().consumeWith(document("default-snippets")); + this.webTestClient.get().uri("/").exchange().expectBody() + .consumeWith(document("default-snippets")); File defaultSnippetsDir = new File("target/generated-snippets/default-snippets"); assertThat(defaultSnippetsDir).exists(); assertThat(new File(defaultSnippetsDir, "curl-request.adoc"))