Partial merge of pull request #983 from philwebb/testcontext

* philwebb-testcontext:
  Polishing
  Remove @BootstrapWith from @WebAppConfiguration

spring-test/src/main/java/org/springframework/test/context/BootstrapUtils.java

 /*
- * 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,16 +24,18 @@ 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;
 
-import static org.springframework.beans.BeanUtils.*;
+import static org.springframework.beans.BeanUtils.instantiateClass;
 
 /**
  * {@code BootstrapUtils} is a collection of utility methods to assist with
  * bootstrapping the <em>Spring TestContext Framework</em>.
  *
  * @author Sam Brannen
+ * @author Phillip Webb
  * @since 4.1
  * @see BootstrapWith
  * @see BootstrapContext
@@ -47,6 +49,10 @@ abstract class BootstrapUtils {
 
 	private static final String DEFAULT_TEST_CONTEXT_BOOTSTRAPPER_CLASS_NAME = "org.springframework.test.context.support.DefaultTestContextBootstrapper";
 
+	private static final String DEFAULT_WEB_TEST_CONTEXT_BOOTSTRAPPER_CLASS_NAME = "org.springframework.test.context.web.WebTestContextBootstrapper";
+
+	private static final String WEB_APP_CONFIGURATION_ANNOTATION_CLASS_NAME = "org.springframework.test.context.web.WebAppConfiguration";
+
 	private static final Log logger = LogFactory.getLog(BootstrapUtils.class);
 
 
@@ -111,37 +117,25 @@ abstract class BootstrapUtils {
 	 * <p>If the {@link BootstrapWith @BootstrapWith} annotation is present on
 	 * the test class, either directly or as a meta-annotation, then its
 	 * {@link BootstrapWith#value value} will be used as the bootstrapper type.
-	 * Otherwise, the {@link org.springframework.test.context.support.DefaultTestContextBootstrapper
-	 * DefaultTestContextBootstrapper} will be used.
+	 * Otherwise, either the
+	 * {@link org.springframework.test.context.support.DefaultTestContextBootstrapper
+	 * DefaultTestContextBootstrapper} or the
+	 * {@link org.springframework.test.context.web.WebTestContextBootstrapper
+	 * WebTestContextBootstrapper} will be used, depending on the presence of
+	 * {@link org.springframework.test.context.web.WebAppConfiguration @WebAppConfiguration}.
 	 *
 	 * @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<? extends TestContextBootstrapper> clazz = null;
+		Class<?> clazz = null;
 		try {
-
-			MultiValueMap<String, Object> attributesMultiMap = AnnotatedElementUtils.getAllAnnotationAttributes(
-				testClass, BootstrapWith.class.getName());
-			List<Object> 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<? extends TestContextBootstrapper>) values.get(0);
+			clazz = resolveExplicitTestContextBootstrapper(testClass);
+			if (clazz == null) {
+				clazz = resolveDefaultTestContextBootstrapper(testClass);
 			}
-			else {
-				clazz = (Class<? extends TestContextBootstrapper>) 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 +146,40 @@ 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);
+		}
+	}
+
+	/**
+	 * @since 4.3
+	 */
+	private static Class<?> resolveExplicitTestContextBootstrapper(Class<?> testClass) {
+		MultiValueMap<String, Object> attributesMultiMap = AnnotatedElementUtils.getAllAnnotationAttributes(
+				testClass, BootstrapWith.class.getName());
+		List<Object> 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);
+	}
+
+	/**
+	 * @since 4.3
+	 */
+	private static Class<?> resolveDefaultTestContextBootstrapper(Class<?> testClass) throws Exception {
+		ClassLoader classLoader = BootstrapUtils.class.getClassLoader();
+		if (AnnotatedElementUtils.isAnnotated(testClass, WEB_APP_CONFIGURATION_ANNOTATION_CLASS_NAME)) {
+			return ClassUtils.forName(DEFAULT_WEB_TEST_CONTEXT_BOOTSTRAPPER_CLASS_NAME, classLoader);
 		}
+		return ClassUtils.forName(DEFAULT_TEST_CONTEXT_BOOTSTRAPPER_CLASS_NAME, classLoader);
 	}
 
 }

spring-test/src/main/java/org/springframework/test/context/web/WebAppConfiguration.java

 /*
- * 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,16 +23,14 @@ 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
  * should be a {@link org.springframework.web.context.WebApplicationContext
  * WebApplicationContext}.
  *
- * <p>The mere presence of {@code @WebAppConfiguration} on a test class ensures
- * that a {@code WebApplicationContext} will be loaded for the test using a default
+ * <p>The presence of {@code @WebAppConfiguration} on a test class indicates that
+ * a {@code WebApplicationContext} should be loaded for the test using a default
  * for the path to the root of the web application. To override the default,
  * specify an explicit resource path via the {@link #value} attribute.
  *
@@ -53,7 +51,6 @@ import org.springframework.test.context.BootstrapWith;
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
-@BootstrapWith(WebTestContextBootstrapper.class)
 public @interface WebAppConfiguration {
 
 	/**

spring-test/src/test/java/org/springframework/test/context/BootstrapUtilsTests.java

 /*
- * 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,16 +24,20 @@ 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.*;
-import static org.mockito.Mockito.*;
-import static org.springframework.test.context.BootstrapUtils.*;
+import static org.hamcrest.CoreMatchers.containsString;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.mockito.Mockito.mock;
+import static org.springframework.test.context.BootstrapUtils.resolveTestContextBootstrapper;
 
 /**
  * Unit tests for {@link BootstrapUtils}.
  *
  * @author Sam Brannen
+ * @author Phillip Webb
  * @since 4.2
  */
 public class BootstrapUtilsTests {
@@ -41,13 +45,18 @@ public class BootstrapUtilsTests {
 	private final CacheAwareContextLoaderDelegate delegate = mock(CacheAwareContextLoaderDelegate.class);
 
 	@Rule
-	public ExpectedException exception = ExpectedException.none();
+	public final ExpectedException exception = ExpectedException.none();
 
 	@Test
 	public void resolveTestContextBootstrapperForNonAnnotatedClass() {
 		assertBootstrapper(NonAnnotatedClass.class, DefaultTestContextBootstrapper.class);
 	}
 
+	@Test
+	public void resolveTestContextBootstrapperForWebAppConfigurationAnnotatedClass() {
+		assertBootstrapper(WebAppConfigurationAnnotatedClass.class, WebTestContextBootstrapper.class);
+	}
+
 	@Test
 	public void resolveTestContextBootstrapperWithEmptyBootstrapWithAnnotation() {
 		BootstrapContext bootstrapContext = BootstrapTestUtils.buildBootstrapContext(EmptyBootstrapWithAnnotationClass.class, delegate);
@@ -124,4 +133,7 @@ public class BootstrapUtilsTests {
 	@BootWithFoo
 	static class DoubleMetaAnnotatedBootstrapWithAnnotationClass {}
 
+	@WebAppConfiguration
+	static class WebAppConfigurationAnnotatedClass {}
+
 }

spring-test/src/test/java/org/springframework/test/context/web/WebAppConfigurationBootstrapWithTests.java

+/*
+ * 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.annotation.Configuration;
+import org.springframework.core.io.Resource;
+import org.springframework.test.context.BootstrapWith;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.MergedContextConfiguration;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.context.web.WebAppConfigurationBootstrapWithTests.CustomWebTestContextBootstrapper;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * JUnit-based integration tests that verify support for loading a
+ * {@link WebApplicationContext} with a custom {@link WebTestContextBootstrapper}.
+ *
+ * @author Sam Brannen
+ * @author Phillip Webb
+ * @since 4.3
+ */
+@RunWith(SpringRunner.class)
+@ContextConfiguration
+@WebAppConfiguration
+@BootstrapWith(CustomWebTestContextBootstrapper.class)
+public class WebAppConfigurationBootstrapWithTests {
+
+	@Autowired
+	WebApplicationContext wac;
+
+
+	@Test
+	public void webApplicationContextIsLoaded() {
+		// from: src/test/webapp/resources/Spring.js
+		Resource resource = wac.getResource("/resources/Spring.js");
+		assertNotNull(resource);
+		assertTrue(resource.exists());
+	}
+
+
+	@Configuration
+	static class Config {
+	}
+
+	/**
+	 * Custom {@link WebTestContextBootstrapper} that requires {@code @WebAppConfiguration}
+	 * but hard codes the resource base path.
+	 */
+	static class CustomWebTestContextBootstrapper extends WebTestContextBootstrapper {
+
+		@Override
+		protected MergedContextConfiguration processMergedContextConfiguration(MergedContextConfiguration mergedConfig) {
+			return new WebMergedContextConfiguration(mergedConfig, "src/test/webapp");
+		}
+	}
+
+}