From 90668584c3e11006844732743cf1335513eaca1c Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Thu, 27 Aug 2015 08:34:51 +0100 Subject: [PATCH] Polish contribution Closes gh-3703 --- ...a => SecurityFilterAutoConfiguration.java} | 13 +++-- .../main/resources/META-INF/spring.factories | 2 +- .../SecurityAutoConfigurationTests.java | 47 +++++-------------- 3 files changed, 24 insertions(+), 38 deletions(-) rename spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/{SecurityFilterRegistrationAutoConfiguration.java => SecurityFilterAutoConfiguration.java} (78%) diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityFilterRegistrationAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityFilterAutoConfiguration.java similarity index 78% rename from spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityFilterRegistrationAutoConfiguration.java rename to spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityFilterAutoConfiguration.java index 9f41830f6c..bdb5b39bb5 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityFilterRegistrationAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityFilterAutoConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2015 the original author or authors. + * Copyright 2012-2015 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. @@ -19,16 +19,21 @@ import javax.servlet.Filter; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication; import org.springframework.boot.context.embedded.FilterRegistrationBean; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; +import org.springframework.security.config.annotation.web.configuration.WebSecurityConfiguration; import org.springframework.security.web.context.AbstractSecurityWebApplicationInitializer; /** - * Configures the ordering for Spring Security's Filter. + * {@link EnableAutoConfiguration Auto-configuration} for Spring Security's Filter. + * Configured separately from {@link SpringBootWebSecurityConfiguration} to ensure that + * the filter's order is still configured when a user-provided + * {@link WebSecurityConfiguration} exists. * * @author Rob Winch * @since 1.3 @@ -37,7 +42,8 @@ import org.springframework.security.web.context.AbstractSecurityWebApplicationIn @ConditionalOnWebApplication @EnableConfigurationProperties @AutoConfigureAfter(SpringBootWebSecurityConfiguration.class) -public class SecurityFilterRegistrationAutoConfiguration { +public class SecurityFilterAutoConfiguration { + @Bean @ConditionalOnBean(name = AbstractSecurityWebApplicationInitializer.DEFAULT_FILTER_NAME) public FilterRegistrationBean securityFilterChainRegistration( @@ -49,4 +55,5 @@ public class SecurityFilterRegistrationAutoConfiguration { .setName(AbstractSecurityWebApplicationInitializer.DEFAULT_FILTER_NAME); return registration; } + } \ No newline at end of file diff --git a/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories b/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories index e04ad19f53..9980c1a0cd 100644 --- a/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories +++ b/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories @@ -56,7 +56,7 @@ org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\ org.springframework.boot.autoconfigure.reactor.ReactorAutoConfiguration,\ org.springframework.boot.autoconfigure.redis.RedisAutoConfiguration,\ org.springframework.boot.autoconfigure.security.SecurityAutoConfiguration,\ -org.springframework.boot.autoconfigure.security.SecurityFilterRegistrationAutoConfiguration,\ +org.springframework.boot.autoconfigure.security.SecurityFilterAutoConfiguration,\ org.springframework.boot.autoconfigure.security.FallbackWebSecurityAutoConfiguration,\ org.springframework.boot.autoconfigure.security.oauth2.OAuth2AutoConfiguration,\ org.springframework.boot.autoconfigure.sendgrid.SendGridAutoConfiguration,\ diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/security/SecurityAutoConfigurationTests.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/security/SecurityAutoConfigurationTests.java index 7da08bb272..7acbc85211 100644 --- a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/security/SecurityAutoConfigurationTests.java +++ b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/security/SecurityAutoConfigurationTests.java @@ -21,9 +21,6 @@ import java.util.List; import org.junit.After; import org.junit.Test; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.support.DefaultListableBeanFactory; -import org.springframework.boot.autoconfigure.EnableAutoConfiguration; -import org.springframework.boot.autoconfigure.EnableAutoConfigurationImportSelector; import org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration; import org.springframework.boot.autoconfigure.TestAutoConfigurationPackage; import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration; @@ -38,9 +35,6 @@ import org.springframework.context.annotation.AnnotationConfigApplicationContext import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.annotation.Order; -import org.springframework.core.io.DefaultResourceLoader; -import org.springframework.core.type.StandardAnnotationMetadata; -import org.springframework.mock.env.MockEnvironment; import org.springframework.mock.web.MockServletContext; import org.springframework.orm.jpa.JpaTransactionManager; import org.springframework.security.authentication.AuthenticationManager; @@ -60,7 +54,6 @@ import org.springframework.security.core.authority.AuthorityUtils; import org.springframework.security.core.userdetails.UserDetailsService; import org.springframework.security.web.FilterChainProxy; import org.springframework.security.web.SecurityFilterChain; -import org.springframework.util.ObjectUtils; import org.springframework.web.context.support.AnnotationConfigWebApplicationContext; import static org.junit.Assert.assertEquals; @@ -73,6 +66,7 @@ import static org.junit.Assert.fail; * Tests for {@link SecurityAutoConfiguration}. * * @author Dave Syer + * @author Rob Winch */ public class SecurityAutoConfigurationTests { @@ -100,14 +94,12 @@ public class SecurityAutoConfigurationTests { assertEquals(5, filterChains.size()); } - // gh-3703 @Test public void testDefaultFilterOrderWithSecurityAdapter() throws Exception { this.context = new AnnotationConfigWebApplicationContext(); this.context.setServletContext(new MockServletContext()); - this.context.register(WebSecurity.class, - SecurityAutoConfiguration.class, - SecurityFilterRegistrationAutoConfiguration.class, + this.context.register(WebSecurity.class, SecurityAutoConfiguration.class, + SecurityFilterAutoConfiguration.class, ServerPropertiesAutoConfiguration.class, PropertyPlaceholderAutoConfiguration.class); this.context.refresh(); @@ -118,29 +110,17 @@ public class SecurityAutoConfigurationTests { } @Test - public void testSecurityFilterRegistrationAutoConfigurationRegisteredAutoConfiguration() throws Exception { - EnableAutoConfigurationImportSelector selector = new EnableAutoConfigurationImportSelector(); - selector.setBeanFactory(new DefaultListableBeanFactory()); - selector.setEnvironment(new MockEnvironment()); - selector.setResourceLoader(new DefaultResourceLoader()); - String[] imports = selector.selectImports(new StandardAnnotationMetadata(AutoConfiguration.class)); - - assertTrue(ObjectUtils.containsElement(imports, "org.springframework.boot.autoconfigure.security.SecurityFilterRegistrationAutoConfiguration")); - } - - @Test - public void testDefaultFilterOrderNotWeb() throws Exception { + public void testFilterIsNotRegisteredInNonWeb() throws Exception { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); context.register(SecurityAutoConfiguration.class, - SecurityFilterRegistrationAutoConfiguration.class, + SecurityFilterAutoConfiguration.class, ServerPropertiesAutoConfiguration.class, PropertyPlaceholderAutoConfiguration.class); - try { context.refresh(); - assertFalse( - context.containsBean("securityFilterChainRegistration")); - } finally { + assertFalse(context.containsBean("securityFilterChainRegistration")); + } + finally { context.close(); } } @@ -150,7 +130,7 @@ public class SecurityAutoConfigurationTests { this.context = new AnnotationConfigWebApplicationContext(); this.context.setServletContext(new MockServletContext()); this.context.register(SecurityAutoConfiguration.class, - SecurityFilterRegistrationAutoConfiguration.class, + SecurityFilterAutoConfiguration.class, ServerPropertiesAutoConfiguration.class, PropertyPlaceholderAutoConfiguration.class); this.context.refresh(); @@ -166,7 +146,7 @@ public class SecurityAutoConfigurationTests { EnvironmentTestUtils.addEnvironment(this.context, "security.filter-order:12345"); this.context.setServletContext(new MockServletContext()); this.context.register(SecurityAutoConfiguration.class, - SecurityFilterRegistrationAutoConfiguration.class, + SecurityFilterAutoConfiguration.class, ServerPropertiesAutoConfiguration.class, PropertyPlaceholderAutoConfiguration.class); this.context.refresh(); @@ -470,9 +450,8 @@ public class SecurityAutoConfigurationTests { @Configuration @EnableWebSecurity - static class WebSecurity extends WebSecurityConfigurerAdapter {} + static class WebSecurity extends WebSecurityConfigurerAdapter { + + } - @Configuration - @EnableAutoConfiguration - static class AutoConfiguration {} }