Add support for configuring default request and response preprocessors

See gh-424

spring-restdocs-restassured/src/main/java/org/springframework/restdocs/restassured3/RestAssuredOperationPreprocessorsConfigurer.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2014-2017 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.restdocs.restassured3;
+
+import io.restassured.filter.Filter;
+import io.restassured.filter.FilterContext;
+import io.restassured.response.Response;
+import io.restassured.specification.FilterableRequestSpecification;
+import io.restassured.specification.FilterableResponseSpecification;
+
+import org.springframework.restdocs.config.OperationPreprocessorsConfigurer;
+
+/**
+ * A configurer that can be used to configure the operation preprocessors when
+ * using REST Assured 3.
+ *
+ * @author Filip Hrisafov
+ * @since 2.0.0
+ */
+public final class RestAssuredOperationPreprocessorsConfigurer extends
+		OperationPreprocessorsConfigurer<RestAssuredRestDocumentationConfigurer,
+				RestAssuredOperationPreprocessorsConfigurer>
+		implements Filter {
+
+	RestAssuredOperationPreprocessorsConfigurer(RestAssuredRestDocumentationConfigurer parent) {
+		super(parent);
+	}
+
+	@Override
+	public Response filter(FilterableRequestSpecification requestSpec,
+			FilterableResponseSpecification responseSpec, FilterContext context) {
+		return and().filter(requestSpec, responseSpec, context);
+	}
+}

spring-restdocs-restassured/src/main/java/org/springframework/restdocs/restassured3/RestAssuredRestDocumentationConfigurer.java

@@ -33,15 +33,20 @@ import org.springframework.restdocs.config.RestDocumentationConfigurer;
  * A REST Assured 3-specific {@link RestDocumentationConfigurer}.
  *
  * @author Andy Wilkinson
+ * @author Filip Hrisafov
  * @since 1.2.0
  */
 public final class RestAssuredRestDocumentationConfigurer extends
-		RestDocumentationConfigurer<RestAssuredSnippetConfigurer, RestAssuredRestDocumentationConfigurer>
+		RestDocumentationConfigurer<RestAssuredSnippetConfigurer, RestAssuredOperationPreprocessorsConfigurer,
+				RestAssuredRestDocumentationConfigurer>
 		implements Filter {
 
 	private final RestAssuredSnippetConfigurer snippetConfigurer = new RestAssuredSnippetConfigurer(
 			this);
 
+	private final RestAssuredOperationPreprocessorsConfigurer operationPreprocessorsConfigurer =
+			new RestAssuredOperationPreprocessorsConfigurer(this);
+
 	private final RestDocumentationContextProvider contextProvider;
 
 	RestAssuredRestDocumentationConfigurer(
@@ -54,6 +59,11 @@ public final class RestAssuredRestDocumentationConfigurer extends
 		return this.snippetConfigurer;
 	}
 
+	@Override
+	public RestAssuredOperationPreprocessorsConfigurer operationPreprocessors() {
+		return this.operationPreprocessorsConfigurer;
+	}
+
 	@Override
 	public Response filter(FilterableRequestSpecification requestSpec,
 			FilterableResponseSpecification responseSpec, FilterContext filterContext) {

spring-restdocs-restassured/src/main/java/org/springframework/restdocs/restassured3/RestDocumentationFilter.java

@@ -97,6 +97,10 @@ public class RestDocumentationFilter implements Filter {
 						context);
 				configuration.remove(
 						RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_SNIPPETS);
+				configuration.remove(
+						RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_OPERATION_REQUEST_PREPROCESSOR);
+				configuration.remove(
+						RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_OPERATION_RESPONSE_PREPROCESSOR);
 				return configuration;
 			}
 

spring-restdocs-restassured/src/test/java/org/springframework/restdocs/restassured3/RestAssuredRestDocumentationConfigurerTests.java

@@ -28,6 +28,9 @@ import org.mockito.ArgumentCaptor;
 
 import org.springframework.restdocs.JUnitRestDocumentation;
 import org.springframework.restdocs.generate.RestDocumentationGenerator;
+import org.springframework.restdocs.operation.preprocess.OperationRequestPreprocessor;
+import org.springframework.restdocs.operation.preprocess.OperationResponsePreprocessor;
+import org.springframework.restdocs.operation.preprocess.Preprocessors;
 import org.springframework.restdocs.snippet.WriterResolver;
 import org.springframework.restdocs.templates.TemplateEngine;
 
@@ -43,6 +46,7 @@ import static org.mockito.Mockito.verify;
  * Tests for {@link RestAssuredRestDocumentationConfigurer}.
  *
  * @author Andy Wilkinson
+ * @author Filip Hrisafov
  */
 public class RestAssuredRestDocumentationConfigurerTests {
 
@@ -68,7 +72,11 @@ public class RestAssuredRestDocumentationConfigurerTests {
 
 	@Test
 	public void configurationIsAddedToTheContext() {
-		this.configurer.filter(this.requestSpec, this.responseSpec, this.filterContext);
+		this.configurer
+				.operationPreprocessors()
+				.withDefaultRequestPreprocessors(Preprocessors.prettyPrint())
+				.withDefaultResponsePreprocessors(Preprocessors.removeHeaders("Foo"))
+				.filter(this.requestSpec, this.responseSpec, this.filterContext);
 		@SuppressWarnings("rawtypes")
 		ArgumentCaptor<Map> configurationCaptor = ArgumentCaptor.forClass(Map.class);
 		verify(this.filterContext).setValue(
@@ -84,6 +92,14 @@ public class RestAssuredRestDocumentationConfigurerTests {
 				hasEntry(
 						equalTo(RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_SNIPPETS),
 						instanceOf(List.class)));
+		assertThat(configuration,
+				hasEntry(
+						equalTo(RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_OPERATION_REQUEST_PREPROCESSOR),
+						instanceOf(OperationRequestPreprocessor.class)));
+		assertThat(configuration,
+				hasEntry(
+						equalTo(RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_OPERATION_RESPONSE_PREPROCESSOR),
+						instanceOf(OperationResponsePreprocessor.class)));
 	}
 
 }

spring-restdocs-restassured/src/test/java/org/springframework/restdocs/restassured3/RestAssuredRestDocumentationIntegrationTests.java

@@ -71,6 +71,7 @@ import static org.springframework.restdocs.test.SnippetMatchers.snippet;
  *
  * @author Andy Wilkinson
  * @author Tomasz Kopczynski
+ * @author Filip Hrisafov
  */
 public class RestAssuredRestDocumentationIntegrationTests {
 
@@ -327,6 +328,31 @@ public class RestAssuredRestDocumentationIntegrationTests {
 								.header("Host", "localhost").content(prettyPrinted))));
 	}
 
+	@Test
+	public void defaultPreprocessedRequest() throws Exception {
+		Pattern pattern = Pattern.compile("(\"alpha\")");
+		given().port(tomcat.getPort())
+				.filter(documentationConfiguration(this.restDocumentation)
+						.operationPreprocessors().withDefaultRequestPreprocessors(prettyPrint(),
+								replacePattern(pattern, "\"<<beta>>\""),
+								modifyUris().removePort(),
+								removeHeaders("a", HttpHeaders.CONTENT_LENGTH)))
+				.header("a", "alpha").header("b", "bravo").contentType("application/json")
+				.accept("application/json").body("{\"a\":\"alpha\"}")
+				.filter(document("default-preprocessed-request"))
+				.get("/").then().statusCode(200);
+		String prettyPrinted = String.format("{%n  \"a\" : \"<<beta>>\"%n}");
+		assertThat(
+				new File(
+						"build/generated-snippets/default-preprocessed-request/http-request.adoc"),
+				is(snippet(asciidoctor())
+						.withContents(httpRequest(asciidoctor(), RequestMethod.GET, "/")
+								.header("b", "bravo")
+								.header("Accept", MediaType.APPLICATION_JSON_VALUE)
+								.header("Content-Type", "application/json; charset=UTF-8")
+								.header("Host", "localhost").content(prettyPrinted))));
+	}
+
 	@Test
 	public void preprocessedResponse() throws Exception {
 		Pattern pattern = Pattern.compile("(\"alpha\")");
@@ -353,6 +379,31 @@ public class RestAssuredRestDocumentationIntegrationTests {
 								.content(prettyPrinted))));
 	}
 
+	@Test
+	public void defaultPreprocessedResponse() throws Exception {
+		Pattern pattern = Pattern.compile("(\"alpha\")");
+		given().port(tomcat.getPort())
+				.filter(documentationConfiguration(this.restDocumentation)
+						.operationPreprocessors().withDefaultResponsePreprocessors(prettyPrint(), maskLinks(),
+								removeHeaders("a", "Transfer-Encoding", "Date", "Server"),
+								replacePattern(pattern, "\"<<beta>>\""), modifyUris()
+										.scheme("https").host("api.example.com").removePort()))
+				.filter(document("default-preprocessed-response"))
+				.get("/").then().statusCode(200);
+		String prettyPrinted = String.format("{%n  \"a\" : \"<<beta>>\",%n  \"links\" : "
+				+ "[ {%n    \"rel\" : \"rel\",%n    \"href\" : \"...\"%n  } ]%n}");
+		assertThat(
+				new File(
+						"build/generated-snippets/default-preprocessed-response/http-response.adoc"),
+				is(snippet(asciidoctor())
+						.withContents(httpResponse(asciidoctor(), HttpStatus.OK)
+								.header("Foo", "https://api.example.com/foo/bar")
+								.header("Content-Type", "application/json;charset=UTF-8")
+								.header(HttpHeaders.CONTENT_LENGTH,
+										prettyPrinted.getBytes().length)
+								.content(prettyPrinted))));
+	}
+
 	@Test
 	public void customSnippetTemplate() throws Exception {
 		ClassLoader classLoader = new URLClassLoader(new URL[] {