Skip to content

Commit e7effe4

Browse files
wilkinsonawilkinsona
committed
Merge pull request #46605 from nosan
* gh-46605: Add support for the @FilterRegistration annotation with @WebMvcTest Closes gh-46605
2 parents 94a9085 + bd0f58d commit e7effe4

File tree

3 files changed

+162
-4
lines changed

3 files changed

+162
-4
lines changed

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

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,27 @@
2020
import java.io.PrintWriter;
2121
import java.io.StringWriter;
2222
import java.util.ArrayList;
23+
import java.util.Arrays;
2324
import java.util.Collection;
25+
import java.util.EnumSet;
2426
import java.util.List;
2527

2628
import jakarta.servlet.Filter;
29+
import jakarta.servlet.annotation.WebInitParam;
2730
import org.apache.commons.logging.Log;
2831
import org.apache.commons.logging.LogFactory;
2932

3033
import org.springframework.beans.factory.ListableBeanFactory;
3134
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
3235
import org.springframework.boot.web.servlet.AbstractFilterRegistrationBean;
3336
import org.springframework.boot.web.servlet.DelegatingFilterProxyRegistrationBean;
37+
import org.springframework.boot.web.servlet.FilterRegistration;
3438
import org.springframework.boot.web.servlet.FilterRegistrationBean;
3539
import org.springframework.boot.web.servlet.RegistrationBean;
3640
import org.springframework.boot.web.servlet.ServletContextInitializerBeans;
3741
import org.springframework.context.ApplicationContext;
3842
import org.springframework.context.ConfigurableApplicationContext;
43+
import org.springframework.core.annotation.Order;
3944
import org.springframework.test.web.servlet.MvcResult;
4045
import org.springframework.test.web.servlet.ResultHandler;
4146
import org.springframework.test.web.servlet.result.PrintingResultHandler;
@@ -330,18 +335,49 @@ private static class FilterRegistrationBeans extends ServletContextInitializerBe
330335

331336
@Override
332337
protected void addAdaptableBeans(ListableBeanFactory beanFactory) {
333-
addAsRegistrationBean(beanFactory, Filter.class, new FilterRegistrationBeanAdapter());
338+
addAsRegistrationBean(beanFactory, Filter.class, new FilterRegistrationBeanAdapter(beanFactory));
334339
}
335340

336341
private static final class FilterRegistrationBeanAdapter implements RegistrationBeanAdapter<Filter> {
337342

343+
private final ListableBeanFactory beanFactory;
344+
345+
private FilterRegistrationBeanAdapter(ListableBeanFactory beanFactory) {
346+
this.beanFactory = beanFactory;
347+
}
348+
338349
@Override
339-
public RegistrationBean createRegistrationBean(String name, Filter source, int totalNumberOfSourceBeans) {
350+
public RegistrationBean createRegistrationBean(String beanName, Filter source,
351+
int totalNumberOfSourceBeans) {
340352
FilterRegistrationBean<Filter> bean = new FilterRegistrationBean<>(source);
341-
bean.setName(name);
353+
bean.setName(beanName);
354+
FilterRegistration registrationAnnotation = this.beanFactory.findAnnotationOnBean(beanName,
355+
FilterRegistration.class);
356+
if (registrationAnnotation != null) {
357+
// Supports @Order annotation on @Bean methods
358+
Order orderAnnotation = this.beanFactory.findAnnotationOnBean(beanName, Order.class);
359+
Assert.state(orderAnnotation != null, "'orderAnnotation' must not be null");
360+
configureFromAnnotation(bean, registrationAnnotation, orderAnnotation);
361+
}
342362
return bean;
343363
}
344364

365+
private void configureFromAnnotation(FilterRegistrationBean<Filter> bean,
366+
FilterRegistration registrationAnnotation, Order orderAnnotation) {
367+
bean.setEnabled(registrationAnnotation.enabled());
368+
bean.setOrder(orderAnnotation.value());
369+
if (StringUtils.hasText(registrationAnnotation.name())) {
370+
bean.setName(registrationAnnotation.name());
371+
}
372+
if (registrationAnnotation.dispatcherTypes().length > 0) {
373+
bean.setDispatcherTypes(EnumSet.copyOf(Arrays.asList(registrationAnnotation.dispatcherTypes())));
374+
}
375+
for (WebInitParam param : registrationAnnotation.initParameters()) {
376+
bean.addInitParameter(param.name(), param.value());
377+
}
378+
bean.setUrlPatterns(Arrays.asList(registrationAnnotation.urlPatterns()));
379+
}
380+
345381
}
346382

347383
}

‎spring-boot-project/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/web/servlet/mockmvc/WebMvcTestServletFilterRegistrationIntegrationTests.java

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
/*
2+
* Copyright 2012-present the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.test.autoconfigure.web.servlet.mockmvc;
18+
19+
import java.io.IOException;
20+
import java.util.Collections;
21+
import java.util.Map;
22+
23+
import jakarta.servlet.FilterChain;
24+
import jakarta.servlet.FilterConfig;
25+
import jakarta.servlet.ServletException;
26+
import jakarta.servlet.annotation.WebInitParam;
27+
import jakarta.servlet.http.HttpServletRequest;
28+
import jakarta.servlet.http.HttpServletResponse;
29+
import org.junit.jupiter.api.Test;
30+
31+
import org.springframework.beans.factory.annotation.Autowired;
32+
import org.springframework.boot.autoconfigure.security.SecurityProperties;
33+
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
34+
import org.springframework.boot.test.context.TestConfiguration;
35+
import org.springframework.boot.web.servlet.FilterRegistration;
36+
import org.springframework.boot.web.servlet.FilterRegistrationBean;
37+
import org.springframework.context.annotation.Bean;
38+
import org.springframework.core.annotation.Order;
39+
import org.springframework.test.web.servlet.assertj.MockMvcTester;
40+
import org.springframework.web.filter.OncePerRequestFilter;
41+
42+
import static org.assertj.core.api.Assertions.assertThat;
43+
44+
/**
45+
* Tests for {@link FilterRegistration} and {@link FilterRegistrationBean} with
46+
* {@link WebMvcTest @WebMvcTest}.
47+
*
48+
* @author Dmytro Nosan
49+
*/
50+
@WebMvcTest
51+
class WebMvcTestServletFilterRegistrationIntegrationTests {
52+
53+
@Autowired
54+
private MockMvcTester mvc;
55+
56+
@Test
57+
void annotation() {
58+
assertThat(this.mvc.get().uri("/annotation")).headers()
59+
.hasValue("name", "annotation")
60+
.hasValue("param1", "value1")
61+
.hasValue("param2", "value2")
62+
.doesNotContainHeader("param3")
63+
.doesNotContainHeader("param4");
64+
}
65+
66+
@Test
67+
void registration() {
68+
assertThat(this.mvc.get().uri("/registration")).headers()
69+
.hasValue("name", "registration")
70+
.hasValue("param3", "value3")
71+
.hasValue("param4", "value4")
72+
.doesNotContainHeader("param1")
73+
.doesNotContainHeader("param2");
74+
}
75+
76+
@TestConfiguration(proxyBeanMethods = false)
77+
static class FilterRegistrationConfiguration {
78+
79+
@Bean
80+
@FilterRegistration(name = "annotation", urlPatterns = "/annotation",
81+
initParameters = { @WebInitParam(name = "param1", value = "value1"),
82+
@WebInitParam(name = "param2", value = "value2") })
83+
@Order(SecurityProperties.DEFAULT_FILTER_ORDER - 1)
84+
TestFilter testFilterAnnotationBean() {
85+
return new TestFilter();
86+
}
87+
88+
@Bean
89+
FilterRegistrationBean<TestFilter> testFilterRegistrationBean() {
90+
FilterRegistrationBean<TestFilter> registration = new FilterRegistrationBean<>(new TestFilter());
91+
registration.setName("registration");
92+
registration.addUrlPatterns("/registration");
93+
registration.setInitParameters(Map.of("param3", "value3", "param4", "value4"));
94+
registration.setOrder(SecurityProperties.DEFAULT_FILTER_ORDER - 1);
95+
return registration;
96+
}
97+
98+
}
99+
100+
private static final class TestFilter extends OncePerRequestFilter {
101+
102+
@Override
103+
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
104+
FilterChain filterChain) throws ServletException, IOException {
105+
response.addHeader("name", getFilterName());
106+
FilterConfig config = getFilterConfig();
107+
if (config != null) {
108+
Collections.list(config.getInitParameterNames())
109+
.forEach((name) -> response.addHeader(name, config.getInitParameter(name)));
110+
}
111+
filterChain.doFilter(request, response);
112+
}
113+
114+
}
115+
116+
}

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,13 @@ private void configureFromAnnotation(ServletRegistrationBean<Servlet> bean, Serv
330330
}
331331

332332
/**
333-
* {@link RegistrationBeanAdapter} for {@link Filter} beans.
333+
* {@link RegistrationBeanAdapter} implementation for {@link Filter} beans.
334+
* <p>
335+
* <b>NOTE:</b> A similar implementation is used in
336+
* {@code SpringBootMockMvcBuilderCustomizer} for registering
337+
* {@code @FilterRegistration} beans with {@code @MockMvc}. If you modify this class,
338+
* please also update {@code SpringBootMockMvcBuilderCustomizer} if needed.
339+
* </p>
334340
*/
335341
private static class FilterRegistrationBeanAdapter implements RegistrationBeanAdapter<Filter> {
336342

0 commit comments

Comments
 (0)