From 504779e2104fe961091d3fc274c156e8116dea4f Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Fri, 26 Feb 2016 13:41:56 -0800 Subject: [PATCH] Remove @BootstrapWith from @WebAppConfiguration Update @WebAppConfiguration so that it no longer directly specifies a TestContextBootstrapper. This allows third parties to use the annotation in combination with their own bootstrapper. BootstrapUtils now provides the detection logic for when WebTestContextBootstrapper should be used. Issue: SPR-13991 --- .../test/context/BootstrapUtils.java | 61 +++++++++-------- .../test/context/web/WebAppConfiguration.java | 5 +- .../test/context/BootstrapUtilsTests.java | 12 +++- ...ebbAppConfigurationBootstrapWithTests.java | 65 +++++++++++++++++++ 4 files changed, 112 insertions(+), 31 deletions(-) create mode 100644 spring-test/src/test/java/org/springframework/test/context/web/WebbAppConfigurationBootstrapWithTests.java diff --git a/spring-test/src/main/java/org/springframework/test/context/BootstrapUtils.java b/spring-test/src/main/java/org/springframework/test/context/BootstrapUtils.java index 411b3254dd..806aee54a3 100644 --- a/spring-test/src/main/java/org/springframework/test/context/BootstrapUtils.java +++ b/spring-test/src/main/java/org/springframework/test/context/BootstrapUtils.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2015 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. @@ -24,6 +24,7 @@ import org.apache.commons.logging.LogFactory; import org.springframework.core.annotation.AnnotatedElementUtils; import org.springframework.core.annotation.AnnotationUtils; +import org.springframework.util.Assert; import org.springframework.util.ClassUtils; import org.springframework.util.MultiValueMap; @@ -43,6 +44,10 @@ abstract class BootstrapUtils { private static final String DEFAULT_BOOTSTRAP_CONTEXT_CLASS_NAME = "org.springframework.test.context.support.DefaultBootstrapContext"; + private static final String DEFAULT_WEB_BOOTSTRAP_CONTEXT_CLASS_NAME = "org.springframework.test.context.web.WebTestContextBootstrapper"; + + private static final String WEB_APP_CONFIGURATION_ANNOTATION = "org.springframework.test.context.web.WebAppConfiguration"; + private static final String DEFAULT_CACHE_AWARE_CONTEXT_LOADER_DELEGATE_CLASS_NAME = "org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate"; private static final String DEFAULT_TEST_CONTEXT_BOOTSTRAPPER_CLASS_NAME = "org.springframework.test.context.support.DefaultTestContextBootstrapper"; @@ -117,31 +122,15 @@ abstract class BootstrapUtils { * @param bootstrapContext the bootstrap context to use * @return a fully configured {@code TestContextBootstrapper} */ - @SuppressWarnings("unchecked") static TestContextBootstrapper resolveTestContextBootstrapper(BootstrapContext bootstrapContext) { Class testClass = bootstrapContext.getTestClass(); - Class clazz = null; + Class clazz = null; try { - - MultiValueMap attributesMultiMap = AnnotatedElementUtils.getAllAnnotationAttributes( - testClass, BootstrapWith.class.getName()); - List values = (attributesMultiMap == null ? null : attributesMultiMap.get(AnnotationUtils.VALUE)); - - if (values != null) { - if (values.size() != 1) { - String msg = String.format( - "Configuration error: found multiple declarations of @BootstrapWith on test class [%s] with values %s", - testClass.getName(), values); - throw new IllegalStateException(msg); - } - clazz = (Class) values.get(0); + clazz = resolveExplicitTestContextBootstrapper(testClass); + if (clazz == null) { + clazz = resolveDefaultTestContextBootstrapper(testClass); } - else { - clazz = (Class) ClassUtils.forName( - DEFAULT_TEST_CONTEXT_BOOTSTRAPPER_CLASS_NAME, BootstrapUtils.class.getClassLoader()); - } - if (logger.isDebugEnabled()) { logger.debug(String.format("Instantiating TestContextBootstrapper for test class [%s] from class [%s]", testClass.getName(), clazz.getName())); @@ -152,15 +141,35 @@ abstract class BootstrapUtils { return testContextBootstrapper; } - catch (Throwable t) { - if (t instanceof IllegalStateException) { - throw (IllegalStateException) t; + catch (Throwable ex) { + if (ex instanceof IllegalStateException) { + throw (IllegalStateException) ex; } - throw new IllegalStateException("Could not load TestContextBootstrapper [" + clazz + "]. Specify @BootstrapWith's 'value' attribute " - + "or make the default bootstrapper class available.", t); + + "or make the default bootstrapper class available.", ex); } } + private static Class resolveExplicitTestContextBootstrapper(Class testClass) { + MultiValueMap attributesMultiMap = AnnotatedElementUtils.getAllAnnotationAttributes( + testClass, BootstrapWith.class.getName()); + List values = (attributesMultiMap == null ? null : attributesMultiMap.get(AnnotationUtils.VALUE)); + if (values == null) { + return null; + } + Assert.state(values.size() == 1, String.format("Configuration error: found multiple declarations of " + + "@BootstrapWith on test class [%s] with values %s", testClass.getName(), values)); + return (Class) values.get(0); + } + + private static Class resolveDefaultTestContextBootstrapper(Class testClass) + throws Exception { + ClassLoader classLoader = BootstrapUtils.class.getClassLoader(); + if (AnnotatedElementUtils.isAnnotated(testClass, WEB_APP_CONFIGURATION_ANNOTATION)) { + return ClassUtils.forName(DEFAULT_WEB_BOOTSTRAP_CONTEXT_CLASS_NAME, classLoader); + } + return ClassUtils.forName(DEFAULT_TEST_CONTEXT_BOOTSTRAPPER_CLASS_NAME, classLoader); + } + } diff --git a/spring-test/src/main/java/org/springframework/test/context/web/WebAppConfiguration.java b/spring-test/src/main/java/org/springframework/test/context/web/WebAppConfiguration.java index b2434c5879..cadc6bd234 100644 --- a/spring-test/src/main/java/org/springframework/test/context/web/WebAppConfiguration.java +++ b/spring-test/src/main/java/org/springframework/test/context/web/WebAppConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2014 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. @@ -23,8 +23,6 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -import org.springframework.test.context.BootstrapWith; - /** * {@code @WebAppConfiguration} is a class-level annotation that is used to * declare that the {@code ApplicationContext} loaded for an integration test @@ -53,7 +51,6 @@ import org.springframework.test.context.BootstrapWith; @Inherited @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) -@BootstrapWith(WebTestContextBootstrapper.class) public @interface WebAppConfiguration { /** diff --git a/spring-test/src/test/java/org/springframework/test/context/BootstrapUtilsTests.java b/spring-test/src/test/java/org/springframework/test/context/BootstrapUtilsTests.java index 8efb56d3ca..75cdbc0ace 100644 --- a/spring-test/src/test/java/org/springframework/test/context/BootstrapUtilsTests.java +++ b/spring-test/src/test/java/org/springframework/test/context/BootstrapUtilsTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2015 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. @@ -24,6 +24,8 @@ import org.junit.Test; import org.junit.rules.ExpectedException; import org.springframework.test.context.support.DefaultTestContextBootstrapper; +import org.springframework.test.context.web.WebAppConfiguration; +import org.springframework.test.context.web.WebTestContextBootstrapper; import static org.hamcrest.CoreMatchers.*; import static org.junit.Assert.*; @@ -48,6 +50,11 @@ public class BootstrapUtilsTests { assertBootstrapper(NonAnnotatedClass.class, DefaultTestContextBootstrapper.class); } + @Test + public void resolveTestContextBootstrapperForWithWebAppConfigurationAnnotatedClass() throws Exception { + assertBootstrapper(WithWebAppConfiguration.class, WebTestContextBootstrapper.class); + } + @Test public void resolveTestContextBootstrapperWithEmptyBootstrapWithAnnotation() { BootstrapContext bootstrapContext = BootstrapTestUtils.buildBootstrapContext(EmptyBootstrapWithAnnotationClass.class, delegate); @@ -124,4 +131,7 @@ public class BootstrapUtilsTests { @BootWithFoo static class DoubleMetaAnnotatedBootstrapWithAnnotationClass {} + @WebAppConfiguration + static class WithWebAppConfiguration {} + } diff --git a/spring-test/src/test/java/org/springframework/test/context/web/WebbAppConfigurationBootstrapWithTests.java b/spring-test/src/test/java/org/springframework/test/context/web/WebbAppConfigurationBootstrapWithTests.java new file mode 100644 index 0000000000..4848df99a8 --- /dev/null +++ b/spring-test/src/test/java/org/springframework/test/context/web/WebbAppConfigurationBootstrapWithTests.java @@ -0,0 +1,65 @@ +/* + * 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.context.web; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Configuration; +import org.springframework.test.context.BootstrapWith; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +import org.springframework.test.context.web.WebbAppConfigurationBootstrapWithTests.TestWebTestContextBootstrapper; +import org.springframework.web.context.WebApplicationContext; + +import static org.junit.Assert.*; + +/** + * JUnit-based integration tests that verify support for loading a + * {@link WebApplicationContext} with a custom {@code @BootstrapWith}. + * + * @author Phillip Webb + * @since 4.3 + */ +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration +@WebAppConfiguration +@BootstrapWith(TestWebTestContextBootstrapper.class) +public class WebbAppConfigurationBootstrapWithTests { + + @Autowired + private ApplicationContext context; + + + @Test + public void testApplicationContextIsWebApplicationContext() throws Exception { + assertTrue(this.context instanceof WebApplicationContext); + } + + + @Configuration + static class Config { + + } + + + static class TestWebTestContextBootstrapper extends WebTestContextBootstrapper { + + } + +}