Merge branch '1.2.x'

2018-08-08 14:48:16 +01:00
parent ceb844183d 244a734232
commit fad2dff977
155 changed files with 465 additions and 1030 deletions
--- a/spring-restdocs-webtestclient/src/main/java/org/springframework/restdocs/webtestclient/WebTestClientRequestConverter.java
+++ b/spring-restdocs-webtestclient/src/main/java/org/springframework/restdocs/webtestclient/WebTestClientRequestConverter.java
@@ -112,7 +112,7 @@ class WebTestClientRequestConverter implements RequestConverter<ExchangeResult>
 	private OperationRequestPart createOperationRequestPart(Part part) {
 		ByteArrayOutputStream content = readPartBodyContent(part);
 		return new OperationRequestPartFactory().create(part.name(),
-				part instanceof FilePart ? ((FilePart) part).filename() : null,
+				(part instanceof FilePart) ? ((FilePart) part).filename() : null,
 				content.toByteArray(), part.headers());
 	}

--- a/spring-restdocs-webtestclient/src/main/java/org/springframework/restdocs/webtestclient/WebTestClientRestDocumentation.java
+++ b/spring-restdocs-webtestclient/src/main/java/org/springframework/restdocs/webtestclient/WebTestClientRestDocumentation.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2017 the original author or authors.
+ * Copyright 2014-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.
@@ -52,7 +52,6 @@ public abstract class WebTestClientRestDocumentation {
 	/**
 	 * Provides access to a {@link ExchangeFilterFunction} that can be used to configure a
 	 * {@link WebTestClient} instance using the given {@code contextProvider}.
-	 *
 	 * @param contextProvider the context provider
 	 * @return the configurer
 	 * @see Builder#filter(ExchangeFilterFunction)
@@ -66,7 +65,6 @@ public abstract class WebTestClientRestDocumentation {
 	 * Returns a {@link Consumer} that, when called, documents the API call with the given
 	 * {@code identifier} using the given {@code snippets} in addition to any default
 	 * snippets.
-	 *
 	 * @param identifier an identifier for the API call that is being documented
 	 * @param snippets the snippets
 	 * @param <T> the type of {@link ExchangeResult} that will be consumed
@@ -86,7 +84,6 @@ public abstract class WebTestClientRestDocumentation {
 	 * Documents the API call with the given {@code identifier} using the given
 	 * {@code snippets} in addition to any default snippets. The given
 	 * {@code requestPreprocessor} is applied to the request before it is documented.
-	 *
 	 * @param identifier an identifier for the API call that is being documented
 	 * @param requestPreprocessor the request preprocessor
 	 * @param snippets the snippets
@@ -105,7 +102,6 @@ public abstract class WebTestClientRestDocumentation {
 	 * Documents the API call with the given {@code identifier} using the given
 	 * {@code snippets} in addition to any default snippets. The given
 	 * {@code responsePreprocessor} is applied to the request before it is documented.
-	 *
 	 * @param identifier an identifier for the API call that is being documented
 	 * @param responsePreprocessor the response preprocessor
 	 * @param snippets the snippets
@@ -125,7 +121,6 @@ public abstract class WebTestClientRestDocumentation {
 	 * {@code snippets} in addition to any default snippets. The given
 	 * {@code requestPreprocessor} and {@code responsePreprocessor} are applied to the
 	 * request and response respectively before they are documented.
-	 *
 	 * @param identifier an identifier for the API call that is being documented
 	 * @param requestPreprocessor the request preprocessor
 	 * @param responsePreprocessor the response preprocessor
--- a/spring-restdocs-webtestclient/src/test/java/org/springframework/restdocs/webtestclient/WebTestClientRestDocumentationIntegrationTests.java
+++ b/spring-restdocs-webtestclient/src/test/java/org/springframework/restdocs/webtestclient/WebTestClientRestDocumentationIntegrationTests.java
@@ -38,7 +38,12 @@ import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseCookie;
 import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.restdocs.templates.TemplateFormat;
 import org.springframework.restdocs.templates.TemplateFormats;
+import org.springframework.restdocs.test.SnippetConditions;
+import org.springframework.restdocs.test.SnippetConditions.CodeBlockCondition;
+import org.springframework.restdocs.test.SnippetConditions.HttpResponseCondition;
+import org.springframework.restdocs.test.SnippetConditions.TableCondition;
 import org.springframework.test.web.reactive.server.EntityExchangeResult;
 import org.springframework.test.web.reactive.server.WebTestClient;
 import org.springframework.util.FileCopyUtils;
@@ -59,11 +64,6 @@ import static org.springframework.restdocs.request.RequestDocumentation.partWith
 import static org.springframework.restdocs.request.RequestDocumentation.pathParameters;
 import static org.springframework.restdocs.request.RequestDocumentation.requestParameters;
 import static org.springframework.restdocs.request.RequestDocumentation.requestParts;
-import static org.springframework.restdocs.templates.TemplateFormats.asciidoctor;
-import static org.springframework.restdocs.test.SnippetConditions.codeBlock;
-import static org.springframework.restdocs.test.SnippetConditions.httpResponse;
-import static org.springframework.restdocs.test.SnippetConditions.tableWithHeader;
-import static org.springframework.restdocs.test.SnippetConditions.tableWithTitleAndHeader;
 import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.document;
 import static org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.documentationConfiguration;
 import static org.springframework.web.reactive.function.BodyInserters.fromObject;
@@ -89,11 +89,11 @@ public class WebTestClientRestDocumentationIntegrationTests {
 				.andRoute(RequestPredicates.GET("/{foo}/{bar}"),
 						(request) -> ServerResponse.status(HttpStatus.OK)
 								.body(fromObject(new Person("Jane", "Doe"))))
-				.andRoute(RequestPredicates.POST("/upload"), (request) -> {
-					return request.body(BodyExtractors.toMultipartData()).map((parts) -> {
-						return ServerResponse.status(HttpStatus.OK).build().block();
-					});
-				}).andRoute(RequestPredicates.GET("/set-cookie"),
+				.andRoute(RequestPredicates.POST("/upload"),
+						(request) -> request.body(BodyExtractors.toMultipartData())
+								.map((parts) -> ServerResponse.status(HttpStatus.OK)
+										.build().block()))
+				.andRoute(RequestPredicates.GET("/set-cookie"),
 						(request) -> ServerResponse.ok()
 								.cookie(ResponseCookie.from("name", "value")
 										.domain("localhost").httpOnly(true).build())
@@ -166,9 +166,9 @@ public class WebTestClientRestDocumentationIntegrationTests {
 		this.webTestClient.get().uri("/set-cookie").exchange().expectStatus().isOk()
 				.expectBody().consumeWith(document("set-cookie"));
 		assertThat(new File("build/generated-snippets/set-cookie/http-response.adoc"))
-				.has(content(httpResponse(asciidoctor(), HttpStatus.OK).header(
-						HttpHeaders.SET_COOKIE,
-						"name=value; Domain=localhost; HttpOnly")));
+				.has(content(httpResponse(TemplateFormats.asciidoctor(), HttpStatus.OK)
+						.header(HttpHeaders.SET_COOKIE,
+								"name=value; Domain=localhost; HttpOnly")));
 	}

 	@Test
@@ -178,10 +178,11 @@ public class WebTestClientRestDocumentationIntegrationTests {
 				.expectBody().consumeWith(document("curl-snippet-with-cookies"));
 		assertThat(new File(
 				"build/generated-snippets/curl-snippet-with-cookies/curl-request.adoc"))
-						.has(content(codeBlock(asciidoctor(), "bash").withContent(String
-								.format("$ curl 'https://api.example.com/' -i -X GET \\%n"
-										+ "    -H 'Accept: application/json' \\%n"
-										+ "    --cookie 'cookieName=cookieVal'"))));
+						.has(content(codeBlock(TemplateFormats.asciidoctor(), "bash")
+								.withContent(String.format(
+										"$ curl 'https://api.example.com/' -i -X GET \\%n"
+												+ "    -H 'Accept: application/json' \\%n"
+												+ "    --cookie 'cookieName=cookieVal'"))));
 	}

 	@Test
@@ -191,10 +192,11 @@ public class WebTestClientRestDocumentationIntegrationTests {
 				.expectBody().consumeWith(document("httpie-snippet-with-cookies"));
 		assertThat(new File(
 				"build/generated-snippets/httpie-snippet-with-cookies/httpie-request.adoc"))
-						.has(content(codeBlock(asciidoctor(), "bash").withContent(
-								String.format("$ http GET 'https://api.example.com/' \\%n"
-										+ "    'Accept:application/json' \\%n"
-										+ "    'Cookie:cookieName=cookieVal'"))));
+						.has(content(codeBlock(TemplateFormats.asciidoctor(), "bash")
+								.withContent(String.format(
+										"$ http GET 'https://api.example.com/' \\%n"
+												+ "    'Accept:application/json' \\%n"
+												+ "    'Cookie:cookieName=cookieVal'"))));
 	}

 	private void assertExpectedSnippetFilesExist(File directory, String... snippets) {
@@ -224,6 +226,23 @@ public class WebTestClientRestDocumentationIntegrationTests {
 		};
 	}

+	private CodeBlockCondition<?> codeBlock(TemplateFormat format, String language) {
+		return SnippetConditions.codeBlock(format, language);
+	}
+
+	private HttpResponseCondition httpResponse(TemplateFormat format, HttpStatus status) {
+		return SnippetConditions.httpResponse(format, status);
+	}
+
+	private TableCondition<?> tableWithHeader(TemplateFormat format, String... headers) {
+		return SnippetConditions.tableWithHeader(format, headers);
+	}
+
+	private TableCondition<?> tableWithTitleAndHeader(TemplateFormat format, String title,
+			String... headers) {
+		return SnippetConditions.tableWithTitleAndHeader(format, title, headers);
+	}
+
 	/**
 	 * A person.
 	 */