Further alignment of RestTestClient and WebTestClient

See gh-34428

Author: rstoyanchev

spring-test/src/main/java/org/springframework/test/web/reactive/server/CookieAssertions.java

@@ -29,10 +29,12 @@
  */
 public class CookieAssertions extends AbstractCookieAssertions<ExchangeResult, WebTestClient.ResponseSpec> {
 
-	public CookieAssertions(ExchangeResult exchangeResult, WebTestClient.ResponseSpec responseSpec) {
+
+	CookieAssertions(ExchangeResult exchangeResult, WebTestClient.ResponseSpec responseSpec) {
 		super(exchangeResult, responseSpec);
 	}
 
+
 	@Override
 	protected void assertWithDiagnostics(Runnable assertion) {
 		exchangeResult.assertWithDiagnostics(assertion);

spring-test/src/main/java/org/springframework/test/web/reactive/server/DefaultWebTestClient.java

@@ -438,12 +438,12 @@ private static class DefaultResponseSpec implements ResponseSpec {
 
 
 		DefaultResponseSpec(
-				ExchangeResult exchangeResult, ClientResponse response,
+				ExchangeResult result, ClientResponse response,
 				@Nullable JsonEncoderDecoder jsonEncoderDecoder,
 				Consumer<EntityExchangeResult<?>> entityResultConsumer,
 				Duration timeout) {
 
-			this.exchangeResult = exchangeResult;
+			this.exchangeResult = result;
 			this.response = response;
 			this.jsonEncoderDecoder = jsonEncoderDecoder;
 			this.entityResultConsumer = entityResultConsumer;
@@ -468,15 +468,15 @@ public CookieAssertions expectCookie() {
 		@Override
 		public <B> BodySpec<B, ?> expectBody(Class<B> bodyType) {
 			B body = this.response.bodyToMono(bodyType).block(this.timeout);
-			EntityExchangeResult<B> entityResult = initEntityExchangeResult(body);
-			return new DefaultBodySpec<>(entityResult);
+			EntityExchangeResult<B> result = initEntityExchangeResult(body);
+			return new DefaultBodySpec<>(result);
 		}
 
 		@Override
 		public <B> BodySpec<B, ?> expectBody(ParameterizedTypeReference<B> bodyType) {
 			B body = this.response.bodyToMono(bodyType).block(this.timeout);
-			EntityExchangeResult<B> entityResult = initEntityExchangeResult(body);
-			return new DefaultBodySpec<>(entityResult);
+			EntityExchangeResult<B> result = initEntityExchangeResult(body);
+			return new DefaultBodySpec<>(result);
 		}
 
 		@Override
@@ -500,8 +500,8 @@ private <E> ListBodySpec<E> getListBodySpec(Flux<E> flux) {
 		public BodyContentSpec expectBody() {
 			ByteArrayResource resource = this.response.bodyToMono(ByteArrayResource.class).block(this.timeout);
 			byte[] body = (resource != null ? resource.getByteArray() : null);
-			EntityExchangeResult<byte[]> entityResult = initEntityExchangeResult(body);
-			return new DefaultBodyContentSpec(entityResult, this.jsonEncoderDecoder);
+			EntityExchangeResult<byte[]> result = initEntityExchangeResult(body);
+			return new DefaultBodyContentSpec(result, this.jsonEncoderDecoder);
 		}
 
 		private <B> EntityExchangeResult<B> initEntityExchangeResult(@Nullable B body) {

spring-test/src/main/java/org/springframework/test/web/reactive/server/HeaderAssertions.java

@@ -31,10 +31,12 @@
  */
 public class HeaderAssertions extends AbstractHeaderAssertions<ExchangeResult, WebTestClient.ResponseSpec> {
 
+
 	HeaderAssertions(ExchangeResult result, WebTestClient.ResponseSpec spec) {
 		super(result, spec);
 	}
 
+
 	@Override
 	protected void assertWithDiagnostics(Runnable assertion) {
 		exchangeResult.assertWithDiagnostics(assertion);

spring-test/src/main/java/org/springframework/test/web/reactive/server/JsonPathAssertions.java

@@ -34,8 +34,11 @@
  */
 public class JsonPathAssertions extends AbstractJsonPathAssertions<WebTestClient.BodyContentSpec> {
 
-	JsonPathAssertions(WebTestClient.BodyContentSpec spec, String content, String expression,
+
+	JsonPathAssertions(
+			WebTestClient.BodyContentSpec spec, String content, String expression,
 			@Nullable Configuration configuration) {
+
 		super(spec, content, expression, configuration);
 	}
 }

spring-test/src/main/java/org/springframework/test/web/reactive/server/StatusAssertions.java

@@ -29,10 +29,12 @@
  */
 public class StatusAssertions extends AbstractStatusAssertions<ExchangeResult, WebTestClient.ResponseSpec> {
 
+
 	StatusAssertions(ExchangeResult result, WebTestClient.ResponseSpec spec) {
 		super(result, spec);
 	}
 
+
 	@Override
 	protected void assertWithDiagnostics(Runnable assertion) {
 		exchangeResult.assertWithDiagnostics(assertion);

spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java

@@ -73,7 +73,7 @@
  * Client for testing web servers that uses {@link WebClient} internally to
  * perform requests while also providing a fluent API to verify responses.
  * This client can connect to any server over HTTP, or to a WebFlux application
- * via mock request and response objects.
+ * with a mock request and response.
  *
  * <p>Use one of the bindToXxx methods to create an instance. For example:
  * <ul>
@@ -89,9 +89,6 @@
  * @author Sam Brannen
  * @author Michał Rowicki
  * @since 5.0
- * @see StatusAssertions
- * @see HeaderAssertions
- * @see JsonPathAssertions
  */
 public interface WebTestClient {
 
@@ -172,12 +169,10 @@ public interface WebTestClient {
 
 
 	/**
-	 * Use this server setup to test one {@code @Controller} at a time.
-	 * This option loads the default configuration of
-	 * {@link org.springframework.web.reactive.config.EnableWebFlux @EnableWebFlux}.
-	 * There are builder methods to customize the Java config. The resulting
-	 * WebFlux application will be tested without an HTTP server using a mock
-	 * request and response.
+	 * Begin creating a {@link WebTestClient} with a mock server setup that
+	 * tests one {@code @Controller} at a time with
+	 * {@link org.springframework.web.reactive.config.EnableWebFlux @EnableWebFlux}
+	 * equivalent configuration.
 	 * @param controllers one or more controller instances to test
 	 * (specified {@code Class} will be turned into instance)
 	 * @return chained API to customize server and client config; use
@@ -188,10 +183,10 @@ static ControllerSpec bindToController(Object... controllers) {
 	}
 
 	/**
-	 * Use this option to set up a server from a {@link RouterFunction}.
-	 * Internally the provided configuration is passed to
-	 * {@code RouterFunctions#toWebHandler}. The resulting WebFlux application
-	 * will be tested without an HTTP server using a mock request and response.
+	 * Begin creating a {@link WebTestClient} with a mock server setup that
+	 * tests one {@code RouterFunction} at a time with
+	 * {@link org.springframework.web.reactive.config.EnableWebFlux @EnableWebFlux}
+	 * equivalent configuration.
 	 * @param routerFunction the RouterFunction to test
 	 * @return chained API to customize server and client config; use
 	 * {@link MockServerSpec#configureClient()} to transition to client config
@@ -229,8 +224,7 @@ static MockServerSpec<?> bindToWebHandler(WebHandler webHandler) {
 	}
 
 	/**
-	 * This server setup option allows you to connect to a live server through
-	 * a Reactor Netty client connector.
+	 * This server setup option allows you to connect to a live server.
 	 * <p><pre class="code">
 	 * WebTestClient client = WebTestClient.bindToServer()
 	 *         .baseUrl("http://localhost:8080")
@@ -389,17 +383,12 @@ interface RouterFunctionSpec extends MockServerSpec<RouterFunctionSpec> {
 
 
 	/**
-	 * Steps for customizing the {@link WebClient} used to test with,
-	 * internally delegating to a
-	 * {@link org.springframework.web.reactive.function.client.WebClient.Builder
-	 * WebClient.Builder}.
+	 * Steps to customize the underlying {@link WebClient} via {@link WebClient.Builder}.
 	 */
 	interface Builder {
 
 		/**
-		 * Configure a base URI as described in
-		 * {@link org.springframework.web.reactive.function.client.WebClient#create(String)
-		 * WebClient.create(String)}.
+		 * Configure a base URI as described in {@link WebClient#create(String)}.
 		 */
 		Builder baseUrl(String baseUrl);
 
@@ -428,7 +417,7 @@ interface Builder {
 		Builder defaultHeaders(Consumer<HttpHeaders> headersConsumer);
 
 		/**
-		 * Add the given header to all requests that haven't added it.
+		 * Add the given cookie to all requests that haven't already added it.
 		 * @param cookieName the cookie name
 		 * @param cookieValues the cookie values
 		 */
@@ -718,6 +707,7 @@ interface RequestHeadersSpec<S extends RequestHeadersSpec<S>> {
 	 * Specification for providing body of a request.
 	 */
 	interface RequestBodySpec extends RequestHeadersSpec<RequestBodySpec> {
+
 		/**
 		 * Set the length of the body in bytes, as specified by the
 		 * {@code Content-Length} header.
@@ -738,7 +728,7 @@ interface RequestBodySpec extends RequestHeadersSpec<RequestBodySpec> {
 
 		/**
 		 * Set the body to the given {@code Object} value. This method invokes the
-		 * {@link org.springframework.web.reactive.function.client.WebClient.RequestBodySpec#bodyValue(Object)
+		 * {@link WebClient.RequestBodySpec#bodyValue(Object)
 		 * bodyValue} method on the underlying {@code WebClient}.
 		 * @param body the value to write to the request body
 		 * @return spec for further declaration of the request
@@ -773,7 +763,7 @@ <T, S extends Publisher<T>> RequestHeadersSpec<?> body(
 
 		/**
 		 * Set the body from the given producer. This method invokes the
-		 * {@link org.springframework.web.reactive.function.client.WebClient.RequestBodySpec#body(Object, Class)
+		 * {@link WebClient.RequestBodySpec#body(Object, Class)
 		 * body(Object, Class)} method on the underlying {@code WebClient}.
 		 * @param producer the producer to write to the request. This must be a
 		 * {@link Publisher} or another producer adaptable to a
@@ -786,7 +776,7 @@ <T, S extends Publisher<T>> RequestHeadersSpec<?> body(
 
 		/**
 		 * Set the body from the given producer. This method invokes the
-		 * {@link org.springframework.web.reactive.function.client.WebClient.RequestBodySpec#body(Object, ParameterizedTypeReference)
+		 * {@link WebClient.RequestBodySpec#body(Object, ParameterizedTypeReference)
 		 * body(Object, ParameterizedTypeReference)} method on the underlying {@code WebClient}.
 		 * @param producer the producer to write to the request. This must be a
 		 * {@link Publisher} or another producer adaptable to a
@@ -800,7 +790,7 @@ <T, S extends Publisher<T>> RequestHeadersSpec<?> body(
 		/**
 		 * Set the body of the request to the given {@code BodyInserter}.
 		 * This method invokes the
-		 * {@link org.springframework.web.reactive.function.client.WebClient.RequestBodySpec#body(BodyInserter)
+		 * {@link WebClient.RequestBodySpec#body(BodyInserter)
 		 * body(BodyInserter)} method on the underlying {@code WebClient}.
 		 * @param inserter the body inserter to use
 		 * @return spec for further declaration of the request
@@ -908,8 +898,8 @@ interface ResponseSpec {
 		BodyContentSpec expectBody();
 
 		/**
-		 * Exit the chained flow in order to consume the response body
-		 * externally, for example, via {@link reactor.test.StepVerifier}.
+		 * Exit the chained flow in order to consume the response body externally,
+		 * for example, via {@link reactor.test.StepVerifier}.
 		 * <p>Note that when {@code Void.class} is passed in, the response body
 		 * is consumed and released. If no content is expected, then consider
 		 * using {@code .expectBody().isEmpty()} instead which asserts that

spring-test/src/main/java/org/springframework/test/web/servlet/client/CookieAssertions.java

@@ -28,10 +28,12 @@
  */
 public class CookieAssertions extends AbstractCookieAssertions<ExchangeResult, RestTestClient.ResponseSpec> {
 
-	public CookieAssertions(ExchangeResult exchangeResult, RestTestClient.ResponseSpec responseSpec) {
+
+	CookieAssertions(ExchangeResult exchangeResult, RestTestClient.ResponseSpec responseSpec) {
 		super(exchangeResult, responseSpec);
 	}
 
+
 	@Override
 	protected void assertWithDiagnostics(Runnable assertion) {
 		exchangeResult.assertWithDiagnostics(assertion);