Pass in filter's name when adding to MockMvc

Closes gh-38001

Author: wilkinsona

spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/servlet/SpringBootMockMvcBuilderCustomizer.java

@@ -116,8 +116,8 @@ private void addFilters(ConfigurableMockMvcBuilder<?> builder) {
 	private void addFilter(ConfigurableMockMvcBuilder<?> builder, AbstractFilterRegistrationBean<?> registration) {
 		Filter filter = registration.getFilter();
 		Collection<String> urls = registration.getUrlPatterns();
-		builder.addFilter(filter, registration.getInitParameters(), registration.determineDispatcherTypes(),
-				StringUtils.toStringArray(urls));
+		builder.addFilter(filter, registration.getFilterName(), registration.getInitParameters(),
+				registration.determineDispatcherTypes(), StringUtils.toStringArray(urls));
 	}
 
 	public void setAddFilters(boolean addFilters) {

spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/web/servlet/SpringBootMockMvcBuilderCustomizerTests.java

@@ -20,6 +20,7 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.EnumSet;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.CountDownLatch;
@@ -66,15 +67,18 @@ void customizeShouldAddFilters() {
 		DefaultMockMvcBuilder builder = MockMvcBuilders.webAppContextSetup(context);
 		SpringBootMockMvcBuilderCustomizer customizer = new SpringBootMockMvcBuilderCustomizer(context);
 		customizer.customize(builder);
-		FilterRegistrationBean<?> registrationBean = (FilterRegistrationBean<?>) context
-			.getBean("filterRegistrationBean");
-		Filter testFilter = (Filter) context.getBean("testFilter");
-		Filter otherTestFilter = registrationBean.getFilter();
+		FilterRegistrationBean<?> registrationBean = (FilterRegistrationBean<?>) context.getBean("otherTestFilter");
+		TestFilter testFilter = context.getBean("testFilter", TestFilter.class);
+		OtherTestFilter otherTestFilter = (OtherTestFilter) registrationBean.getFilter();
 		assertThat(builder).extracting("filters", as(InstanceOfAssertFactories.LIST))
-			.extracting("delegate", "initParams", "dispatcherTypes")
-			.containsExactlyInAnyOrder(tuple(testFilter, Collections.emptyMap(), EnumSet.of(DispatcherType.REQUEST)),
-					tuple(otherTestFilter, Map.of("a", "alpha", "b", "bravo"),
-							EnumSet.of(DispatcherType.REQUEST, DispatcherType.ERROR)));
+			.extracting("delegate", "dispatcherTypes")
+			.containsExactlyInAnyOrder(tuple(testFilter, EnumSet.of(DispatcherType.REQUEST)),
+					tuple(otherTestFilter, EnumSet.of(DispatcherType.REQUEST, DispatcherType.ERROR)));
+		builder.build();
+		assertThat(testFilter.filterName).isEqualTo("testFilter");
+		assertThat(testFilter.initParams).isEmpty();
+		assertThat(otherTestFilter.filterName).isEqualTo("otherTestFilter");
+		assertThat(otherTestFilter.initParams).isEqualTo(Map.of("a", "alpha", "b", "bravo"));
 	}
 
 	@Test
@@ -137,7 +141,7 @@ TestServlet testServlet() {
 	static class FilterConfiguration {
 
 		@Bean
-		FilterRegistrationBean<OtherTestFilter> filterRegistrationBean() {
+		FilterRegistrationBean<OtherTestFilter> otherTestFilter() {
 			FilterRegistrationBean<OtherTestFilter> filterRegistrationBean = new FilterRegistrationBean<>(
 					new OtherTestFilter());
 			filterRegistrationBean.setInitParameters(Map.of("a", "alpha", "b", "bravo"));
@@ -158,9 +162,15 @@ static class TestServlet extends HttpServlet {
 
 	static class TestFilter implements Filter {
 
+		private String filterName;
+
+		private Map<String, String> initParams = new HashMap<>();
+
 		@Override
 		public void init(FilterConfig filterConfig) {
-
+			this.filterName = filterConfig.getFilterName();
+			Collections.list(filterConfig.getInitParameterNames())
+				.forEach((name) -> this.initParams.put(name, filterConfig.getInitParameter(name)));
 		}
 
 		@Override
@@ -177,9 +187,15 @@ public void destroy() {
 
 	static class OtherTestFilter implements Filter {
 
+		private String filterName;
+
+		private Map<String, String> initParams = new HashMap<>();
+
 		@Override
 		public void init(FilterConfig filterConfig) {
-
+			this.filterName = filterConfig.getFilterName();
+			Collections.list(filterConfig.getInitParameterNames())
+				.forEach((name) -> this.initParams.put(name, filterConfig.getInitParameter(name)));
 		}
 
 		@Override

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/AbstractFilterRegistrationBean.java

@@ -265,6 +265,15 @@ protected void configure(FilterRegistration.Dynamic registration) {
 	 */
 	public abstract T getFilter();
 
+	/**
+	 * Returns the filter name that will be registered.
+	 * @return the filter name
+	 * @since 3.2.0
+	 */
+	public String getFilterName() {
+		return getOrDeduceName(getFilter());
+	}
+
 	@Override
 	public String toString() {
 		StringBuilder builder = new StringBuilder(getOrDeduceName(this));