Merge pull request #424 from Filip Hrisafov

* gh-424:
  Polish "Add support for configuring default request and response preprocessors"
  Add support for configuring default request and response preprocessors

Author: wilkinsona

docs/src/docs/asciidoc/configuration.adoc

@@ -114,3 +114,27 @@ include::{examples-dir}/com/example/mockmvc/CustomDefaultSnippets.java[tags=cust
 ----
 include::{examples-dir}/com/example/restassured/CustomDefaultSnippets.java[tags=custom-default-snippets]
 ----
+
+[[configuration-default-preprocessors]]
+=== Default operation preprocessors
+
+You can configure default request and response preprocessors during setup using the
+`RestDocumentationConfigurer` API. For example, to remove the `Foo` headers from all requests
+and pretty print all responses:
+
+[source,java,indent=0,role="primary"]
+.MockMvc
+----
+include::{examples-dir}/com/example/mockmvc/CustomDefaultOperationPreprocessors.java[tags=custom-default-operation-preprocessors]
+----
+<1> Apply a request preprocessor that will remove the header named `Foo`.
+<2> Apply a response preprocessor that will pretty print its content.
+
+[source,java,indent=0,role="secondary"]
+.REST Assured
+----
+include::{examples-dir}/com/example/restassured/CustomDefaultOperationPreprocessors.java[tags=custom-default-operation-preprocessors]
+----
+<1> Apply a request preprocessor that will remove the header named `Foo`.
+<2> Apply a response preprocessor that will pretty print its content.
+

docs/src/docs/asciidoc/customizing-requests-and-responses.adoc

@@ -27,29 +27,25 @@ include::{examples-dir}/com/example/restassured/PerTestPreprocessing.java[tags=p
 <2> Apply a response preprocessor that will pretty print its content.
 
 Alternatively, you may want to apply the same preprocessors to every test. You can do
-so by configuring the preprocessors in your `@Before` method and using the
-<<documentating-your-api-parameterized-output-directories, support for parameterized
-output directories>>:
+so by configuring the preprocessors using the `RestDocumentationConfigurer` API in your
+`@Before` method. For example to remove the `Foo` header from all requests and pretty print
+all responses:
 
 [source,java,indent=0,role="primary"]
 .MockMvc
 ----
 include::{examples-dir}/com/example/mockmvc/EveryTestPreprocessing.java[tags=setup]
 ----
-<1> Create a `RestDocumentationResultHandler`, configured to preprocess the request
-	and response.
-<2> Create a `MockMvc` instance, configured to always call the documentation result
-	handler.
+<1> Apply a request preprocessor that will remove the header named `Foo`.
+<2> Apply a response preprocessor that will pretty print its content.
 
 [source,java,indent=0,role="secondary"]
 .REST Assured
 ----
 include::{examples-dir}/com/example/restassured/EveryTestPreprocessing.java[tags=setup]
 ----
-<1> Create a `RestDocumentationFilter`, configured to preprocess the request
-	and response.
-<2> Create a `RequestSpecification` instance, configured to always call the documentation
-	filter.
+<1> Apply a request preprocessor that will remove the header named `Foo`.
+<2> Apply a response preprocessor that will pretty print its content.
 
 Then, in each test, any configuration specific to that test can be performed. For example:
 
@@ -58,17 +54,12 @@ Then, in each test, any configuration specific to that test can be performed. Fo
 ----
 include::{examples-dir}/com/example/mockmvc/EveryTestPreprocessing.java[tags=use]
 ----
-<1> The request and response will be preprocessed due to the use of `alwaysDo` above.
-<2> Document the links specific to the resource that is being tested
 
 [source,java,indent=0,role="secondary"]
 .REST Assured
 ----
 include::{examples-dir}/com/example/restassured/EveryTestPreprocessing.java[tags=use]
 ----
-<1> The request and response will be preprocessed due to the configuration of the
-`RequestSpecification` in the `setUp` method.
-<2> Document the links specific to the resource that is being tested
 
 Various built in preprocessors, including those illustrated above, are available via the
 static methods on `Preprocessors`. See <<Preprocessors, below>> for further details.

docs/src/test/java/com/example/mockmvc/CustomDefaultOperationPreprocessors.java

@@ -0,0 +1,53 @@
+/*
+ * 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 com.example.mockmvc;
+
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
+
+public class CustomDefaultOperationPreprocessors {
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	private WebApplicationContext context;
+
+	@SuppressWarnings("unused")
+	private MockMvc mockMvc;
+
+	@Before
+	public void setup() {
+		// tag::custom-default-operation-preprocessors[]
+		this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
+				.apply(documentationConfiguration(this.restDocumentation)
+						.operationPreprocessors()
+						.withRequestDefaults(removeHeaders("Foo")) // <1>
+						.withResponseDefaults(prettyPrint())) // <2>
+				.build();
+		// end::custom-default-operation-preprocessors[]
+	}
+
+}

docs/src/test/java/com/example/mockmvc/EveryTestPreprocessing.java

@@ -19,7 +19,6 @@
 import org.junit.Before;
 import org.junit.Rule;
 import org.springframework.restdocs.JUnitRestDocumentation;
-import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.setup.MockMvcBuilders;
 import org.springframework.web.context.WebApplicationContext;
@@ -29,8 +28,6 @@
 import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
 import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
 import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.get;
-import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest;
-import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse;
 import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
 import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@@ -45,26 +42,21 @@ public class EveryTestPreprocessing {
 	// tag::setup[]
 	private MockMvc mockMvc;
 
-	private RestDocumentationResultHandler documentationHandler;
-
 	@Before
 	public void setup() {
-		this.documentationHandler = document("{method-name}", // <1>
-				preprocessRequest(removeHeaders("Foo")),
-				preprocessResponse(prettyPrint()));
 		this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
-				.apply(documentationConfiguration(this.restDocumentation))
-				.alwaysDo(this.documentationHandler) // <2>
-				.build();
+			.apply(documentationConfiguration(this.restDocumentation).operationPreprocessors()
+				.withRequestDefaults(removeHeaders("Foo")) // <1>
+				.withResponseDefaults(prettyPrint())) // <2>
+			.build();
 	}
-
 	// end::setup[]
 
 	public void use() throws Exception {
 		// tag::use[]
-		this.mockMvc.perform(get("/")) // <1>
+		this.mockMvc.perform(get("/"))
 				.andExpect(status().isOk())
-				.andDo(this.documentationHandler.document( // <2>
+				.andDo(document("index",
 						links(linkWithRel("self").description("Canonical self link"))
 				));
 		// end::use[]

docs/src/test/java/com/example/restassured/CustomDefaultOperationPreprocessors.java

@@ -0,0 +1,49 @@
+/*
+ * 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 com.example.restassured;
+
+import io.restassured.builder.RequestSpecBuilder;
+import io.restassured.specification.RequestSpecification;
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.restdocs.JUnitRestDocumentation;
+
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
+import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration;
+
+public class CustomDefaultOperationPreprocessors {
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@SuppressWarnings("unused")
+	private RequestSpecification spec;
+
+	@Before
+	public void setup() {
+		// tag::custom-default-operation-preprocessors[]
+		this.spec = new RequestSpecBuilder()
+			.addFilter(documentationConfiguration(this.restDocumentation).operationPreprocessors()
+				.withRequestDefaults(removeHeaders("Foo")) // <1>
+				.withResponseDefaults(prettyPrint())) // <2>
+			.build();
+		// end::custom-default-operation-preprocessors[]
+	}
+
+}

docs/src/test/java/com/example/restassured/EveryTestPreprocessing.java

@@ -23,13 +23,10 @@
 import org.junit.Rule;
 
 import org.springframework.restdocs.JUnitRestDocumentation;
-import org.springframework.restdocs.restassured3.RestDocumentationFilter;
 
 import static org.hamcrest.CoreMatchers.is;
 import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel;
 import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.links;
-import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest;
-import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse;
 import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
 import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
 import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
@@ -43,26 +40,21 @@ public class EveryTestPreprocessing {
 	// tag::setup[]
 	private RequestSpecification spec;
 
-	private RestDocumentationFilter documentationFilter;
-
 	@Before
 	public void setup() {
-		this.documentationFilter = document("{method-name}",
-				preprocessRequest(removeHeaders("Foo")),
-				preprocessResponse(prettyPrint())); // <1>
 		this.spec = new RequestSpecBuilder()
-				.addFilter(documentationConfiguration(this.restDocumentation))
-				.addFilter(this.documentationFilter)// <2>
-				.build();
+			.addFilter(documentationConfiguration(this.restDocumentation).operationPreprocessors()
+				.withRequestDefaults(removeHeaders("Foo")) // <1>
+				.withResponseDefaults(prettyPrint())) // <2>
+			.build();
 	}
-
 	// end::setup[]
 
 	public void use() throws Exception {
 		// tag::use[]
-		RestAssured.given(this.spec) // <1>
-			.filter(this.documentationFilter.document( // <2>
-					links(linkWithRel("self").description("Canonical self link"))))
+		RestAssured.given(this.spec)
+			.filter(document("index",
+				links(linkWithRel("self").description("Canonical self link"))))
 			.when().get("/")
 			.then().assertThat().statusCode(is(200));
 		// end::use[]

spring-restdocs-core/src/main/java/org/springframework/restdocs/config/OperationPreprocessorsConfigurer.java

@@ -0,0 +1,91 @@
+/*
+ * 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.config;
+
+import java.util.Map;
+
+import org.springframework.restdocs.RestDocumentationContext;
+import org.springframework.restdocs.generate.RestDocumentationGenerator;
+import org.springframework.restdocs.operation.preprocess.OperationPreprocessor;
+import org.springframework.restdocs.operation.preprocess.OperationRequestPreprocessor;
+import org.springframework.restdocs.operation.preprocess.OperationResponsePreprocessor;
+import org.springframework.restdocs.operation.preprocess.Preprocessors;
+
+/**
+ * A configurer that can be used to configure the default operation preprocessors.
+ *
+ * @param <PARENT> The type of the configurer's parent
+ * @param <TYPE> The concrete type of the configurer to be returned from chained methods
+ * @author Filip Hrisafov
+ * @author Andy Wilkinson
+ * @since 2.0.0
+ */
+public abstract class OperationPreprocessorsConfigurer<PARENT, TYPE>
+		extends AbstractNestedConfigurer<PARENT> {
+
+	private OperationRequestPreprocessor defaultOperationRequestPreprocessor;
+
+	private OperationResponsePreprocessor defaultOperationResponsePreprocessor;
+
+	/**
+	 * Creates a new {@code OperationPreprocessorConfigurer} with the given
+	 * {@code parent}.
+	 *
+	 * @param parent the parent
+	 */
+	protected OperationPreprocessorsConfigurer(PARENT parent) {
+		super(parent);
+	}
+
+	@Override
+	public void apply(Map<String, Object> configuration,
+			RestDocumentationContext context) {
+		configuration.put(
+				RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_OPERATION_REQUEST_PREPROCESSOR,
+				this.defaultOperationRequestPreprocessor);
+		configuration.put(
+				RestDocumentationGenerator.ATTRIBUTE_NAME_DEFAULT_OPERATION_RESPONSE_PREPROCESSOR,
+				this.defaultOperationResponsePreprocessor);
+	}
+
+	/**
+	 * Configures the default operation request preprocessors.
+	 *
+	 * @param preprocessors the preprocessors
+	 * @return {@code this}
+	 */
+	@SuppressWarnings("unchecked")
+	public TYPE withRequestDefaults(OperationPreprocessor... preprocessors) {
+		this.defaultOperationRequestPreprocessor = Preprocessors
+				.preprocessRequest(preprocessors);
+		return (TYPE) this;
+	}
+
+	/**
+	 * Configures the default operation response preprocessors.
+	 *
+	 * @param preprocessors the preprocessors
+	 * @return {@code this}
+	 */
+	@SuppressWarnings("unchecked")
+	public TYPE withResponseDefaults(OperationPreprocessor... preprocessors) {
+		this.defaultOperationResponsePreprocessor = Preprocessors
+				.preprocessResponse(preprocessors);
+		return (TYPE) this;
+	}
+
+}