Polish @WebIntegrationTest support

See gh-2299

spring-boot-samples/spring-boot-sample-tomcat/src/test/java/sample/tomcat/SampleTomcatApplicationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 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,14 +19,13 @@ package sample.tomcat;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Value;
-import org.springframework.boot.test.IntegrationTest;
 import org.springframework.boot.test.SpringApplicationConfiguration;
 import org.springframework.boot.test.TestRestTemplate;
+import org.springframework.boot.test.WebIntegrationTest;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.test.annotation.DirtiesContext;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
-import org.springframework.test.context.web.WebAppConfiguration;
 
 import static org.junit.Assert.assertEquals;
 
@@ -37,8 +36,7 @@ import static org.junit.Assert.assertEquals;
  */
 @RunWith(SpringJUnit4ClassRunner.class)
 @SpringApplicationConfiguration(classes = SampleTomcatApplication.class)
-@WebAppConfiguration
+@WebIntegrationTest(randomPort = true)
-@IntegrationTest("server.port:0")
 @DirtiesContext
 public class SampleTomcatApplicationTests {
 

spring-boot/src/main/java/org/springframework/boot/test/IntegrationTest.java

@@ -32,8 +32,8 @@ import org.springframework.test.context.transaction.TransactionalTestExecutionLi
 
 /**
  * Test class annotation signifying that the tests are "integration tests" and therefore
- * require full startup in the same way as a production application (listening on normal
+ * require full startup in the same way as a production application. Normally used in
- * ports). Normally used in conjunction with {@code @SpringApplicationConfiguration}.
+ * conjunction with {@code @SpringApplicationConfiguration}.
  * <p>
  * If your test also uses {@code @WebAppConfiguration} consider using the
  * {@link WebIntegrationTest} instead.

spring-boot/src/main/java/org/springframework/boot/test/MergedContextConfigurationProperties.java

@@ -37,10 +37,11 @@ class MergedContextConfigurationProperties {
 		this.configuration = configuration;
 	}
 
-	public void add(String[] properties) {
+	public void add(String[] properties, String... additional) {
 		Set<String> merged = new LinkedHashSet<String>((Arrays.asList(this.configuration
 				.getPropertySourceProperties())));
 		merged.addAll(Arrays.asList(properties));
+		merged.addAll(Arrays.asList(additional));
 		addIntegrationTestProperty(merged);
 		ReflectionTestUtils.setField(this.configuration, "propertySourceProperties",
 				merged.toArray(new String[merged.size()]));

spring-boot/src/main/java/org/springframework/boot/test/SpringApplicationContextLoader.java

@@ -46,30 +46,28 @@ import org.springframework.test.context.support.AbstractContextLoader;
 import org.springframework.test.context.support.AnnotationConfigContextLoaderUtils;
 import org.springframework.test.context.web.WebAppConfiguration;
 import org.springframework.test.context.web.WebMergedContextConfiguration;
+import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 import org.springframework.util.StringUtils;
 import org.springframework.web.context.support.GenericWebApplicationContext;
 
 /**
  * A {@link ContextLoader} that can be used to test Spring Boot applications (those that
- * normally startup using {@link SpringApplication}). Normally never starts an embedded
+ * normally startup using {@link SpringApplication}). Can be used to test non-web features
- * web server, but detects the {@link WebAppConfiguration @WebAppConfiguration} annotation
+ * (like a repository layer) or start an fully-configured embedded servlet container.
- * on the test class and only creates a web application context if it is present. Non-web
- * features, like a repository layer, can be tested cleanly by simply <em>not</em> marking
- * the test class <code>@WebAppConfiguration</code>.
  * <p>
- * If you <em>want</em> to start a web server, mark the test class as
+ * Use {@code @WebIntegrationTest} (or {@code @IntegrationTest} with
- * <code>@WebAppConfiguration @IntegrationTest</code>. This is useful for testing HTTP
+ * {@code @WebAppConfiguration}) to indicate that you want to use a real servlet container
- * endpoints using {@link TestRestTemplate} (for instance), especially since you can
+ * or {@code @WebAppConfiguration} alone to use a {@link MockServletContext}.
- * <code>@Autowired</code> application context components into your test case to see the
- * internal effects of HTTP requests directly.
  * <p>
  * If <code>@ActiveProfiles</code> are provided in the test class they will be used to
  * create the application context.
  *
  * @author Dave Syer
+ * @author Phillip Webb
  * @see IntegrationTest
  * @see WebIntegrationTest
+ * @see TestRestTemplate
  */
 public class SpringApplicationContextLoader extends AbstractContextLoader {
 
@@ -78,21 +76,15 @@ public class SpringApplicationContextLoader extends AbstractContextLoader {
 	@Override
 	public ApplicationContext loadContext(MergedContextConfiguration config)
 			throws Exception {
+		assertValidAnnotations(config.getTestClass());
 		SpringApplication application = getSpringApplication();
 		application.setSources(getSources(config));
 		ConfigurableEnvironment environment = new StandardEnvironment();
 		if (!ObjectUtils.isEmpty(config.getActiveProfiles())) {
-			String profiles = StringUtils.arrayToCommaDelimitedString(config
+			setActiveProfiles(environment, config.getActiveProfiles());
-					.getActiveProfiles());
-			EnvironmentTestUtils.addEnvironment(environment, "spring.profiles.active="
-					+ profiles);
 		}
-		// Ensure @IntegrationTest properties go before external config and after system
+		Map<String, Object> properties = getEnvironmentProperties(config);
-		environment.getPropertySources()
+		addProperties(environment, properties);
-				.addAfter(
-						StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME,
-						new MapPropertySource("integrationTest",
-								getEnvironmentProperties(config)));
 		application.setEnvironment(environment);
 		List<ApplicationContextInitializer<?>> initializers = getInitializers(config,
 				application);
@@ -106,13 +98,14 @@ public class SpringApplicationContextLoader extends AbstractContextLoader {
 		return application.run();
 	}
 
-	@Override
+	private void assertValidAnnotations(Class<?> testClass) {
-	public void processContextConfiguration(
+		boolean hasWebAppConfiguration = AnnotationUtils.findAnnotation(testClass,
-			ContextConfigurationAttributes configAttributes) {
+				WebAppConfiguration.class) != null;
-		if (!configAttributes.hasLocations() && !configAttributes.hasClasses()) {
+		boolean hasWebIntegrationTest = AnnotationUtils.findAnnotation(testClass,
-			Class<?>[] defaultConfigClasses = detectDefaultConfigurationClasses(configAttributes
+				WebIntegrationTest.class) != null;
-					.getDeclaringClass());
+		if (hasWebAppConfiguration && hasWebIntegrationTest) {
-			configAttributes.setClasses(defaultConfigClasses);
+			throw new IllegalStateException("@WebIntegrationTest and "
+					+ "@WebAppConfiguration cannot be used together");
 		}
 	}
 
@@ -129,27 +122,16 @@ public class SpringApplicationContextLoader extends AbstractContextLoader {
 		Set<Object> sources = new LinkedHashSet<Object>();
 		sources.addAll(Arrays.asList(mergedConfig.getClasses()));
 		sources.addAll(Arrays.asList(mergedConfig.getLocations()));
-		if (sources.isEmpty()) {
+		Assert.state(sources.size() > 0, "No configuration classes "
-			throw new IllegalStateException(
+				+ "or locations found in @SpringApplicationConfiguration. "
-					"No configuration classes or locations found in @SpringApplicationConfiguration. "
+				+ "For default configuration detection to work you need "
-							+ "For default configuration detection to work you need Spring 4.0.3 or better (found "
+				+ "Spring 4.0.3 or better (found " + SpringVersion.getVersion() + ").");
-							+ SpringVersion.getVersion() + ").");
-		}
 		return sources;
 	}
 
-	/**
+	private void setActiveProfiles(ConfigurableEnvironment environment, String[] profiles) {
-	 * Detect the default configuration classes for the supplied test class. By default
+		EnvironmentTestUtils.addEnvironment(environment, "spring.profiles.active="
-	 * simply delegates to
+				+ StringUtils.arrayToCommaDelimitedString(profiles));
-	 * {@link AnnotationConfigContextLoaderUtils#detectDefaultConfigurationClasses} .
-	 * @param declaringClass the test class that declared {@code @ContextConfiguration}
-	 * @return an array of default configuration classes, potentially empty but never
-	 * {@code null}
-	 * @see AnnotationConfigContextLoaderUtils
-	 */
-	protected Class<?>[] detectDefaultConfigurationClasses(Class<?> declaringClass) {
-		return AnnotationConfigContextLoaderUtils
-				.detectDefaultConfigurationClasses(declaringClass);
 	}
 
 	protected Map<String, Object> getEnvironmentProperties(
@@ -159,8 +141,7 @@ public class SpringApplicationContextLoader extends AbstractContextLoader {
 		disableJmx(properties);
 		properties.putAll(extractEnvironmentProperties(config
 				.getPropertySourceProperties()));
-		if (!isAnnotated(config.getTestClass(), IntegrationTest.class,
+		if (!isIntegrationTest(config.getTestClass())) {
-				WebIntegrationTest.class)) {
 			properties.putAll(getDefaultEnvironmentProperties());
 		}
 		return properties;
@@ -170,11 +151,7 @@ public class SpringApplicationContextLoader extends AbstractContextLoader {
 		properties.put("spring.jmx.enabled", "false");
 	}
 
-	private Map<String, String> getDefaultEnvironmentProperties() {
+	final Map<String, Object> extractEnvironmentProperties(String[] values) {
-		return Collections.singletonMap("server.port", "-1");
-	}
-
-	Map<String, Object> extractEnvironmentProperties(String[] values) {
 		// Instead of parsing the keys ourselves, we rely on standard handling
 		if (values == null) {
 			return Collections.emptyMap();
@@ -199,6 +176,18 @@ public class SpringApplicationContextLoader extends AbstractContextLoader {
 		return map;
 	}
 
+	private Map<String, String> getDefaultEnvironmentProperties() {
+		return Collections.singletonMap("server.port", "-1");
+	}
+
+	private void addProperties(ConfigurableEnvironment environment,
+			Map<String, Object> properties) {
+		// @IntegrationTest properties go before external configuration and after system
+		environment.getPropertySources().addAfter(
+				StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME,
+				new MapPropertySource("integrationTest", properties));
+	}
+
 	private List<ApplicationContextInitializer<?>> getInitializers(
 			MergedContextConfiguration mergedConfig, SpringApplication application) {
 		List<ApplicationContextInitializer<?>> initializers = new ArrayList<ApplicationContextInitializer<?>>();
@@ -211,10 +200,34 @@ public class SpringApplicationContextLoader extends AbstractContextLoader {
 		return initializers;
 	}
 
+	@Override
+	public void processContextConfiguration(
+			ContextConfigurationAttributes configAttributes) {
+		if (!configAttributes.hasLocations() && !configAttributes.hasClasses()) {
+			Class<?>[] defaultConfigClasses = detectDefaultConfigurationClasses(configAttributes
+					.getDeclaringClass());
+			configAttributes.setClasses(defaultConfigClasses);
+		}
+	}
+
+	/**
+	 * Detect the default configuration classes for the supplied test class. By default
+	 * simply delegates to
+	 * {@link AnnotationConfigContextLoaderUtils#detectDefaultConfigurationClasses} .
+	 * @param declaringClass the test class that declared {@code @ContextConfiguration}
+	 * @return an array of default configuration classes, potentially empty but never
+	 * {@code null}
+	 * @see AnnotationConfigContextLoaderUtils
+	 */
+	protected Class<?>[] detectDefaultConfigurationClasses(Class<?> declaringClass) {
+		return AnnotationConfigContextLoaderUtils
+				.detectDefaultConfigurationClasses(declaringClass);
+	}
+
 	@Override
 	public ApplicationContext loadContext(String... locations) throws Exception {
-		throw new UnsupportedOperationException(
+		throw new UnsupportedOperationException("SpringApplicationContextLoader "
-				"SpringApplicationContextLoader does not support the loadContext(String...) method");
+				+ "does not support the loadContext(String...) method");
 	}
 
 	@Override
@@ -222,33 +235,37 @@ public class SpringApplicationContextLoader extends AbstractContextLoader {
 		return "-context.xml";
 	}
 
+	/**
+	 * Inner class to configure {@link WebMergedContextConfiguration}.
+	 */
 	private static class WebConfigurer {
 
+		private static final Class<GenericWebApplicationContext> WEB_CONTEXT_CLASS = GenericWebApplicationContext.class;
+
 		void configure(MergedContextConfiguration configuration,
 				SpringApplication application,
 				List<ApplicationContextInitializer<?>> initializers) {
 			WebMergedContextConfiguration webConfiguration = (WebMergedContextConfiguration) configuration;
-			if (!isAnnotated(webConfiguration.getTestClass(), IntegrationTest.class,
+			if (!isIntegrationTest(webConfiguration.getTestClass())) {
-					WebIntegrationTest.class)) {
+				addMockServletContext(initializers, webConfiguration);
-				MockServletContext servletContext = new MockServletContext(
+				application.setApplicationContextClass(WEB_CONTEXT_CLASS);
-						webConfiguration.getResourceBasePath());
-				initializers.add(0, new ServletContextApplicationContextInitializer(
-						servletContext));
-				application
-						.setApplicationContextClass(GenericWebApplicationContext.class);
 			}
 		}
 
+		private void addMockServletContext(
+				List<ApplicationContextInitializer<?>> initializers,
+				WebMergedContextConfiguration webConfiguration) {
+			MockServletContext servletContext = new MockServletContext(
+					webConfiguration.getResourceBasePath());
+			initializers.add(0, new ServletContextApplicationContextInitializer(
+					servletContext));
+		}
+
 	}
 
-	@SuppressWarnings({ "unchecked", "rawtypes" })
+	private static boolean isIntegrationTest(Class<?> testClass) {
-	private static boolean isAnnotated(Class<?> testClass, Class<?>... annotations) {
+		return ((AnnotationUtils.findAnnotation(testClass, IntegrationTest.class) != null) || (AnnotationUtils
-		for (Class<?> annotation : annotations) {
+				.findAnnotation(testClass, WebIntegrationTest.class) != null));
-			if (AnnotationUtils.findAnnotation(testClass, (Class) annotation) != null) {
-				return true;
-			}
-		}
-		return false;
 	}
 
 }

spring-boot/src/main/java/org/springframework/boot/test/WebAppIntegrationTestContextBootstrapper.java

@@ -16,16 +16,11 @@
 
 package org.springframework.boot.test;
 
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.test.context.ContextLoader;
 import org.springframework.test.context.MergedContextConfiguration;
 import org.springframework.test.context.TestContextBootstrapper;
 import org.springframework.test.context.support.DefaultTestContextBootstrapper;
-import org.springframework.test.context.web.ServletTestExecutionListener;
 import org.springframework.test.context.web.WebDelegatingSmartContextLoader;
 import org.springframework.test.context.web.WebMergedContextConfiguration;
 
@@ -55,24 +50,14 @@ class WebAppIntegrationTestContextBootstrapper extends DefaultTestContextBootstr
 			mergedConfig = new WebMergedContextConfiguration(mergedConfig, null);
 			MergedContextConfigurationProperties properties = new MergedContextConfigurationProperties(
 					mergedConfig);
-			properties.add(annotation.value());
+			if (annotation.randomPort()) {
+				properties.add(annotation.value(), "server.port:0");
+			}
+			else {
+				properties.add(annotation.value());
+			}
 		}
 		return mergedConfig;
 	}
 
-	@Override
-	protected List<String> getDefaultTestExecutionListenerClassNames() {
-		WebIntegrationTest annotation = AnnotationUtils.findAnnotation(
-				getBootstrapContext().getTestClass(), WebIntegrationTest.class);
-		List<String> listeners = super.getDefaultTestExecutionListenerClassNames();
-		if (annotation != null) {
-			// Leave out the ServletTestExecutionListener because it only deals with
-			// Mock* servlet stuff. A real embedded application will not need the mocks.
-			listeners = new ArrayList<String>(listeners);
-			listeners.remove(ServletTestExecutionListener.class.getName());
-			listeners.add(IntegrationTestPropertiesListener.class.getName());
-		}
-		return Collections.unmodifiableList(listeners);
-	}
-
 }

spring-boot/src/main/java/org/springframework/boot/test/WebIntegrationTest.java

@@ -37,6 +37,7 @@ import org.springframework.test.context.BootstrapWith;
  *
  * @author Phillip Webb
  * @since 1.2.1
+ * @see IntegrationTest
  */
 @Documented
 @Inherited
@@ -51,4 +52,12 @@ public @interface WebIntegrationTest {
 	 */
 	String[] value() default {};
 
+	/**
+	 * Convenience attribute that can be used to set a {@code server.port=0}
+	 * {@link Environment} property which usually triggers listening on a random port.
+	 * Often used in conjunction with a {@code @Value("server.local.port")} injected field
+	 * on the test.
+	 */
+	boolean randomPort() default false;
+
 }