From da1a17e8b230b4c892b795932c3daebf4ade059d Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Mon, 1 Oct 2018 13:30:33 +0100 Subject: [PATCH] Stop adding filters with disabled registrations to MockMvc Closes gh-14636 --- .../SpringBootMockMvcBuilderCustomizer.java | 10 ++- ...rRegistrationDisabledIntegrationTests.java | 61 +++++++++++++++++++ 2 files changed, 68 insertions(+), 3 deletions(-) create mode 100644 spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/web/servlet/WebMvcTestServletFilterRegistrationDisabledIntegrationTests.java diff --git a/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/servlet/SpringBootMockMvcBuilderCustomizer.java b/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/servlet/SpringBootMockMvcBuilderCustomizer.java index 590510f6417..24d120e3e14 100644 --- a/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/servlet/SpringBootMockMvcBuilderCustomizer.java +++ b/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/web/servlet/SpringBootMockMvcBuilderCustomizer.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2016 the original author or authors. + * Copyright 2012-2018 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. @@ -119,12 +119,16 @@ public class SpringBootMockMvcBuilderCustomizer implements MockMvcBuilderCustomi private void addFilter(ConfigurableMockMvcBuilder builder, FilterRegistrationBean registration) { - addFilter(builder, registration.getFilter(), registration.getUrlPatterns()); + if (registration.isEnabled()) { + addFilter(builder, registration.getFilter(), registration.getUrlPatterns()); + } } private void addFilter(ConfigurableMockMvcBuilder builder, DelegatingFilterProxyRegistrationBean registration) { - addFilter(builder, registration.getFilter(), registration.getUrlPatterns()); + if (registration.isEnabled()) { + addFilter(builder, registration.getFilter(), registration.getUrlPatterns()); + } } private void addFilter(ConfigurableMockMvcBuilder builder, Filter filter, diff --git a/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/web/servlet/WebMvcTestServletFilterRegistrationDisabledIntegrationTests.java b/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/web/servlet/WebMvcTestServletFilterRegistrationDisabledIntegrationTests.java new file mode 100644 index 00000000000..47f1c2ff974 --- /dev/null +++ b/spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/web/servlet/WebMvcTestServletFilterRegistrationDisabledIntegrationTests.java @@ -0,0 +1,61 @@ +/* + * Copyright 2012-2018 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.boot.test.autoconfigure.web.servlet; + +import org.junit.Test; +import org.junit.runner.RunWith; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.TestConfiguration; +import org.springframework.boot.web.servlet.FilterRegistrationBean; +import org.springframework.context.annotation.Bean; +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.test.web.servlet.MockMvc; + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header; + +/** + * Tests for {@link WebMvcTest} with a disabled filter registration. + * + * @author Andy Wilkinson + */ +@RunWith(SpringRunner.class) +@WebMvcTest +public class WebMvcTestServletFilterRegistrationDisabledIntegrationTests { + + @Autowired + private MockMvc mvc; + + @Test + public void shouldApplyFilter() throws Exception { + this.mvc.perform(get("/one")).andExpect(header().string("x-test", (String) null)); + } + + @TestConfiguration + static class DisabledRegistrationConfiguration { + + @Bean + public FilterRegistrationBean exampleFilterRegistration(ExampleFilter filter) { + FilterRegistrationBean registration = new FilterRegistrationBean(filter); + registration.setEnabled(false); + return registration; + } + + } + +}