Allow to customize TestDispatcherServlet

This commit introduces the `DispatcherServletCustomizer` callback
interface that can be used to customize the `DispatcherServlet` that a
`MockMvc` is using.

Previously, only the `dispatchOptions` flag can be customized. This
commit allows to customize any property of `DispatcherServlet` before it
is initialized.

Issue: SPR-14277

Author: snicoll

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

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2002-2016 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.test.web.servlet;
+
+import org.springframework.web.servlet.DispatcherServlet;
+
+/**
+ * Strategy interface for customizing {@link DispatcherServlet} instances that are
+ * managed by {@link MockMvc}.
+ *
+ * @author Stephane Nicoll
+ * @since 4.3.4
+ */
+public interface DispatcherServletCustomizer {
+
+	/**
+	 * Customize the supplied {@link DispatcherServlet} <em>before</em> it is
+	 * initialized.
+	 * @param dispatcherServlet the dispatcher servlet to customize
+	 */
+	void customize(DispatcherServlet dispatcherServlet);
+
+}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2016 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,6 +16,7 @@
 
 package org.springframework.test.web.servlet;
 
+import java.util.Collections;
 import java.util.List;
 import javax.servlet.Filter;
 import javax.servlet.ServletContext;
@@ -24,6 +25,7 @@
 import org.springframework.core.NestedRuntimeException;
 import org.springframework.mock.web.MockServletConfig;
 import org.springframework.web.context.WebApplicationContext;
+import org.springframework.web.servlet.DispatcherServlet;
 
 /**
  * Base class for MockMvc builder implementations, providing the capability to
@@ -35,19 +37,34 @@
  *
  * @author Rossen Stoyanchev
  * @author Rob Winch
+ * @author Stephane Nicoll
  * @since 3.2
  */
 public abstract class MockMvcBuilderSupport {
 
+	@Deprecated
 	protected final MockMvc createMockMvc(Filter[] filters, MockServletConfig servletConfig,
 			WebApplicationContext webAppContext, RequestBuilder defaultRequestBuilder,
 			List<ResultMatcher> globalResultMatchers, List<ResultHandler> globalResultHandlers,
 			Boolean dispatchOptions) {
+		return createMockMvc(filters, servletConfig, webAppContext, defaultRequestBuilder,
+				globalResultMatchers, globalResultHandlers,
+				Collections.<DispatcherServletCustomizer>singletonList(new DispatchOptionsDispatcherServletCustomizer(dispatchOptions)));
+	}
+
+	protected final MockMvc createMockMvc(Filter[] filters, MockServletConfig servletConfig,
+			WebApplicationContext webAppContext, RequestBuilder defaultRequestBuilder,
+			List<ResultMatcher> globalResultMatchers, List<ResultHandler> globalResultHandlers,
+			List<DispatcherServletCustomizer> dispatcherServletCustomizers) {
 
 		ServletContext servletContext = webAppContext.getServletContext();
 
 		TestDispatcherServlet dispatcherServlet = new TestDispatcherServlet(webAppContext);
-		dispatcherServlet.setDispatchOptionsRequest(dispatchOptions);
+		if (dispatcherServletCustomizers != null) {
+			for (DispatcherServletCustomizer customizers : dispatcherServletCustomizers) {
+				customizers.customize(dispatcherServlet);
+			}
+		}
 		try {
 			dispatcherServlet.init(servletConfig);
 		}
@@ -72,4 +89,18 @@ public MockMvcBuildException(String msg, Throwable cause) {
 		}
 	}
 
+	private static class DispatchOptionsDispatcherServletCustomizer
+			implements DispatcherServletCustomizer {
+		private final Boolean dispatchOptions;
+
+		private DispatchOptionsDispatcherServletCustomizer(Boolean dispatchOptions) {
+			this.dispatchOptions = dispatchOptions;
+		}
+
+		@Override
+		public void customize(DispatcherServlet dispatcherServlet) {
+			dispatcherServlet.setDispatchOptionsRequest(this.dispatchOptions);
+		}
+	}
+
 }

spring-test/src/main/java/org/springframework/test/web/servlet/setup/AbstractMockMvcBuilder.java

@@ -22,6 +22,7 @@
 import javax.servlet.ServletContext;
 
 import org.springframework.mock.web.MockServletConfig;
+import org.springframework.test.web.servlet.DispatcherServletCustomizer;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.MockMvcBuilderSupport;
 import org.springframework.test.web.servlet.RequestBuilder;
@@ -32,6 +33,7 @@
 import org.springframework.test.web.servlet.request.RequestPostProcessor;
 import org.springframework.util.Assert;
 import org.springframework.web.context.WebApplicationContext;
+import org.springframework.web.servlet.DispatcherServlet;
 
 /**
  * An abstract implementation of {@link org.springframework.test.web.servlet.MockMvcBuilder}
@@ -42,6 +44,7 @@
  * pass to the DispatcherServlet.
  *
  * @author Rossen Stoyanchev
+ * @author Stephane Nicoll
  * @since 4.0
  */
 public abstract class AbstractMockMvcBuilder<B extends AbstractMockMvcBuilder<B>>
@@ -55,7 +58,7 @@ public abstract class AbstractMockMvcBuilder<B extends AbstractMockMvcBuilder<B>
 
 	private final List<ResultHandler> globalResultHandlers = new ArrayList<ResultHandler>();
 
-	private Boolean dispatchOptions = Boolean.TRUE;
+	private final List<DispatcherServletCustomizer> dispatcherServletCustomizers = new ArrayList<DispatcherServletCustomizer>();
 
 	private final List<MockMvcConfigurer> configurers = new ArrayList<MockMvcConfigurer>(4);
 
@@ -104,11 +107,20 @@ public final <T extends B> T alwaysDo(ResultHandler resultHandler) {
 	}
 
 	@SuppressWarnings("unchecked")
-	public final <T extends B> T dispatchOptions(boolean dispatchOptions) {
-		this.dispatchOptions = dispatchOptions;
+	public final <T extends B> T addDispatcherServletCustomizer(DispatcherServletCustomizer customizer) {
+		this.dispatcherServletCustomizers.add(customizer);
 		return (T) this;
 	}
 
+	public final <T extends B> T dispatchOptions(final boolean dispatchOptions) {
+		return addDispatcherServletCustomizer(new DispatcherServletCustomizer() {
+			@Override
+			public void customize(DispatcherServlet dispatcherServlet) {
+				dispatcherServlet.setDispatchOptionsRequest(dispatchOptions);
+			}
+		});
+	}
+
 	@SuppressWarnings("unchecked")
 	public final <T extends B> T apply(MockMvcConfigurer configurer) {
 		configurer.afterConfigurerAdded(this);
@@ -144,7 +156,7 @@ public final MockMvc build() {
 		Filter[] filterArray = this.filters.toArray(new Filter[this.filters.size()]);
 
 		return super.createMockMvc(filterArray, mockServletConfig, wac, this.defaultRequestBuilder,
-				this.globalResultMatchers, this.globalResultHandlers, this.dispatchOptions);
+				this.globalResultMatchers, this.globalResultHandlers, this.dispatcherServletCustomizers);
 	}
 
 	/**

spring-test/src/test/java/org/springframework/test/web/servlet/setup/DefaultMockMvcBuilderTests.java

@@ -20,11 +20,14 @@
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
 
+import org.springframework.beans.DirectFieldAccessor;
 import org.springframework.context.support.StaticApplicationContext;
 import org.springframework.mock.web.MockServletContext;
+import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.web.context.WebApplicationContext;
 import org.springframework.web.context.support.StaticWebApplicationContext;
 import org.springframework.web.context.support.WebApplicationContextUtils;
+import org.springframework.web.servlet.DispatcherServlet;
 
 import static org.hamcrest.CoreMatchers.*;
 import static org.junit.Assert.*;
@@ -36,6 +39,7 @@
  * @author Rob Winch
  * @author Sebastien Deleuze
  * @author Sam Brannen
+ * @author Stephane Nicoll
  */
 public class DefaultMockMvcBuilderTests {
 
@@ -124,4 +128,32 @@ public void rootWacServletContainerAttributeNotPreviouslySetWithContextHierarchy
 		assertSame(root, WebApplicationContextUtils.getRequiredWebApplicationContext(this.servletContext));
 	}
 
+	/**
+	 * See /SPR-14277
+	 */
+	@Test
+	public void dispatcherServletCustomizer() {
+		StubWebApplicationContext root = new StubWebApplicationContext(this.servletContext);
+		DefaultMockMvcBuilder builder = webAppContextSetup(root);
+		builder.addDispatcherServletCustomizer(ds -> ds.setContextId("test-id"));
+		builder.dispatchOptions(true);
+		MockMvc mvc = builder.build();
+		DispatcherServlet ds = (DispatcherServlet) new DirectFieldAccessor(mvc)
+				.getPropertyValue("servlet");
+		assertEquals("test-id", ds.getContextId());
+	}
+
+	@Test
+	public void dispatcherServletCustomizerProcessedInOrder() {
+		StubWebApplicationContext root = new StubWebApplicationContext(this.servletContext);
+		DefaultMockMvcBuilder builder = webAppContextSetup(root);
+		builder.addDispatcherServletCustomizer(ds -> ds.setContextId("test-id"));
+		builder.addDispatcherServletCustomizer(ds -> ds.setContextId("override-id"));
+		builder.dispatchOptions(true);
+		MockMvc mvc = builder.build();
+		DispatcherServlet ds = (DispatcherServlet) new DirectFieldAccessor(mvc)
+				.getPropertyValue("servlet");
+		assertEquals("override-id", ds.getContextId());
+	}
+
 }