Polishing

Author: jhoeller

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

@@ -43,51 +43,47 @@
  */
 abstract class BootstrapUtils {
 
-	private static final String DEFAULT_BOOTSTRAP_CONTEXT_CLASS_NAME = "org.springframework.test.context.support.DefaultBootstrapContext";
+	private static final String DEFAULT_BOOTSTRAP_CONTEXT_CLASS_NAME =
+			"org.springframework.test.context.support.DefaultBootstrapContext";
 
-	private static final String DEFAULT_CACHE_AWARE_CONTEXT_LOADER_DELEGATE_CLASS_NAME = "org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate";
+	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";
+	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 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 String WEB_APP_CONFIGURATION_ANNOTATION_CLASS_NAME =
+			"org.springframework.test.context.web.WebAppConfiguration";
 
 	private static final Log logger = LogFactory.getLog(BootstrapUtils.class);
 
 
-	private BootstrapUtils() {
-		/* no-op */
-	}
-
 	/**
 	 * Create the {@code BootstrapContext} for the specified {@linkplain Class test class}.
-	 *
 	 * <p>Uses reflection to create a {@link org.springframework.test.context.support.DefaultBootstrapContext}
 	 * that uses a {@link org.springframework.test.context.cache.DefaultCacheAwareContextLoaderDelegate}.
-	 *
 	 * @param testClass the test class for which the bootstrap context should be created
 	 * @return a new {@code BootstrapContext}; never {@code null}
 	 */
 	@SuppressWarnings("unchecked")
 	static BootstrapContext createBootstrapContext(Class<?> testClass) {
 		CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate = createCacheAwareContextLoaderDelegate();
-
 		Class<? extends BootstrapContext> clazz = null;
 		try {
-			clazz = (Class<? extends BootstrapContext>) ClassUtils.forName(DEFAULT_BOOTSTRAP_CONTEXT_CLASS_NAME,
-				BootstrapUtils.class.getClassLoader());
-
-			Constructor<? extends BootstrapContext> constructor = clazz.getConstructor(Class.class,
-				CacheAwareContextLoaderDelegate.class);
-
+			clazz = (Class<? extends BootstrapContext>) ClassUtils.forName(
+					DEFAULT_BOOTSTRAP_CONTEXT_CLASS_NAME, BootstrapUtils.class.getClassLoader());
+			Constructor<? extends BootstrapContext> constructor = clazz.getConstructor(
+					Class.class, CacheAwareContextLoaderDelegate.class);
 			if (logger.isDebugEnabled()) {
 				logger.debug(String.format("Instantiating BootstrapContext using constructor [%s]", constructor));
 			}
 			return instantiateClass(constructor, testClass, cacheAwareContextLoaderDelegate);
 		}
-		catch (Throwable t) {
-			throw new IllegalStateException("Could not load BootstrapContext [" + clazz + "]", t);
+		catch (Throwable ex) {
+			throw new IllegalStateException("Could not load BootstrapContext [" + clazz + "]", ex);
 		}
 	}
 
@@ -104,16 +100,15 @@ private static CacheAwareContextLoaderDelegate createCacheAwareContextLoaderDele
 			}
 			return instantiateClass(clazz, CacheAwareContextLoaderDelegate.class);
 		}
-		catch (Throwable t) {
-			throw new IllegalStateException("Could not load CacheAwareContextLoaderDelegate [" + clazz + "]", t);
+		catch (Throwable ex) {
+			throw new IllegalStateException("Could not load CacheAwareContextLoaderDelegate [" + clazz + "]", ex);
 		}
 	}
 
 	/**
 	 * Resolve the {@link TestContextBootstrapper} type for the test class in the
 	 * supplied {@link BootstrapContext}, instantiate it, and provide it a reference
 	 * to the {@link BootstrapContext}.
-	 *
 	 * <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.
@@ -123,7 +118,6 @@ private static CacheAwareContextLoaderDelegate createCacheAwareContextLoaderDele
 	 * {@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}
 	 */
@@ -138,36 +132,36 @@ static TestContextBootstrapper resolveTestContextBootstrapper(BootstrapContext b
 			}
 			if (logger.isDebugEnabled()) {
 				logger.debug(String.format("Instantiating TestContextBootstrapper for test class [%s] from class [%s]",
-					testClass.getName(), clazz.getName()));
+						testClass.getName(), clazz.getName()));
 			}
-
 			TestContextBootstrapper testContextBootstrapper = instantiateClass(clazz, TestContextBootstrapper.class);
 			testContextBootstrapper.setBootstrapContext(bootstrapContext);
-
 			return testContextBootstrapper;
 		}
 		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.", ex);
+			throw new IllegalStateException("Could not load TestContextBootstrapper [" + clazz +
+					"]. Specify @BootstrapWith's 'value' attribute 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));
+		MultiValueMap<String, Object> attributesMultiMap =
+				AnnotatedElementUtils.getAllAnnotationAttributes(testClass, BootstrapWith.class.getName());
+		List<Object> values = (attributesMultiMap != null ? attributesMultiMap.get(AnnotationUtils.VALUE) : null);
 		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));
+		if (values.size() != 1) {
+			throw new IllegalStateException(String.format("Configuration error: found multiple declarations of " +
+					"@BootstrapWith on test class [%s] with values %s", testClass.getName(), values));
+		}
 		return (Class<?>) values.get(0);
 	}
 

spring-test/src/main/java/org/springframework/test/context/TestExecutionListener.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.
@@ -20,14 +20,17 @@
  * {@code TestExecutionListener} defines a <em>listener</em> API for reacting to
  * test execution events published by the {@link TestContextManager} with which
  * the listener is registered.
+ *
  * <p>Concrete implementations must provide a {@code public} no-args constructor,
  * so that listeners can be instantiated transparently by tools and configuration
  * mechanisms.
+ *
  * <p>Implementations may optionally declare the position in which they should
  * be ordered among the chain of default listeners via the
  * {@link org.springframework.core.Ordered Ordered} interface or
  * {@link org.springframework.core.annotation.Order @Order} annotation. See
  * {@link TestContextBootstrapper#getTestExecutionListeners()} for details.
+ *
  * <p>Spring provides the following out-of-the-box implementations (all of
  * which implement {@code Ordered}):
  * <ul>
@@ -58,7 +61,6 @@ public interface TestExecutionListener {
 	 * <em>before class</em> lifecycle callbacks.
 	 * <p>If a given testing framework does not support <em>before class</em>
 	 * lifecycle callbacks, this method will not be called for that framework.
-	 *
 	 * @param testContext the test context for the test; never {@code null}
 	 * @throws Exception allows any exception to propagate
 	 */
@@ -69,7 +71,6 @@ public interface TestExecutionListener {
 	 * {@link TestContext test context}, for example by injecting dependencies.
 	 * <p>This method should be called immediately after instantiation of the test
 	 * instance but prior to any framework-specific lifecycle callbacks.
-	 *
 	 * @param testContext the test context for the test; never {@code null}
 	 * @throws Exception allows any exception to propagate
 	 */
@@ -82,7 +83,6 @@ public interface TestExecutionListener {
 	 * fixtures.
 	 * <p>This method should be called immediately prior to framework-specific
 	 * <em>before</em> lifecycle callbacks.
-	 *
 	 * @param testContext the test context in which the test method will be
 	 * executed; never {@code null}
 	 * @throws Exception allows any exception to propagate
@@ -96,7 +96,6 @@ public interface TestExecutionListener {
 	 * fixtures.
 	 * <p>This method should be called immediately after framework-specific
 	 * <em>after</em> lifecycle callbacks.
-	 *
 	 * @param testContext the test context in which the test method was
 	 * executed; never {@code null}
 	 * @throws Exception allows any exception to propagate
@@ -110,7 +109,6 @@ public interface TestExecutionListener {
 	 * <em>after class</em> lifecycle callbacks.
 	 * <p>If a given testing framework does not support <em>after class</em>
 	 * lifecycle callbacks, this method will not be called for that framework.
-	 *
 	 * @param testContext the test context for the test; never {@code null}
 	 * @throws Exception allows any exception to propagate
 	 */

spring-test/src/main/java/org/springframework/test/context/TestExecutionListeners.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.
@@ -30,8 +30,8 @@
  * which {@link TestExecutionListener TestExecutionListeners} should be
  * registered with a {@link TestContextManager}.
  *
- * <p>Typically, {@code @TestExecutionListeners} will be used in conjunction with
- * {@link ContextConfiguration @ContextConfiguration}.
+ * <p>Typically, {@code @TestExecutionListeners} will be used in conjunction
+ * with {@link ContextConfiguration @ContextConfiguration}.
  *
  * <p>As of Spring Framework 4.0, this annotation may be used as a
  * <em>meta-annotation</em> to create custom <em>composed annotations</em>.
@@ -48,42 +48,8 @@
 @Target(ElementType.TYPE)
 public @interface TestExecutionListeners {
 
-	/**
-	 * Enumeration of <em>modes</em> that dictate whether or not explicitly
-	 * declared listeners are merged with the default listeners when
-	 * {@code @TestExecutionListeners} is declared on a class that does
-	 * <strong>not</strong> inherit listeners from a superclass.
-	 * @since 4.1
-	 */
-	static enum MergeMode {
-
-		/**
-		 * Indicates that locally declared listeners should replace the default
-		 * listeners.
-		 */
-		REPLACE_DEFAULTS,
-
-		/**
-		 * Indicates that locally declared listeners should be merged with the
-		 * default listeners.
-		 * <p>The merging algorithm ensures that duplicates are removed from
-		 * the list and that the resulting set of merged listeners is sorted
-		 * according to the semantics of
-		 * {@link org.springframework.core.annotation.AnnotationAwareOrderComparator
-		 * AnnotationAwareOrderComparator}. If a listener implements
-		 * {@link org.springframework.core.Ordered Ordered} or is annotated
-		 * with {@link org.springframework.core.annotation.Order @Order} it can
-		 * influence the position in which it is merged with the defaults; otherwise,
-		 * locally declared listeners will simply be appended to the list of default
-		 * listeners when merged.
-		 */
-		MERGE_WITH_DEFAULTS
-	}
-
-
 	/**
 	 * Alias for {@link #listeners}.
-	 *
 	 * <p>This attribute may <strong>not</strong> be used in conjunction with
 	 * {@link #listeners}, but it may be used instead of {@link #listeners}.
 	 */
@@ -93,10 +59,8 @@ static enum MergeMode {
 	/**
 	 * The {@link TestExecutionListener TestExecutionListeners} to register with
 	 * the {@link TestContextManager}.
-	 *
 	 * <p>This attribute may <strong>not</strong> be used in conjunction with
 	 * {@link #value}, but it may be used instead of {@link #value}.
-	 *
 	 * @see org.springframework.test.context.web.ServletTestExecutionListener
 	 * @see org.springframework.test.context.support.DependencyInjectionTestExecutionListener
 	 * @see org.springframework.test.context.support.DirtiesContextTestExecutionListener
@@ -109,7 +73,6 @@ static enum MergeMode {
 	/**
 	 * Whether or not {@link #listeners TestExecutionListeners} from superclasses
 	 * should be <em>inherited</em>.
-	 *
 	 * <p>The default value is {@code true}, which means that an annotated
 	 * class will <em>inherit</em> the listeners defined by an annotated
 	 * superclass. Specifically, the listeners for an annotated class will be
@@ -122,21 +85,19 @@ static enum MergeMode {
 	 * {@code DependencyInjectionTestExecutionListener},
 	 * {@code DirtiesContextTestExecutionListener}, <strong>and</strong>
 	 * {@code TransactionalTestExecutionListener}, in that order.
-	 *
 	 * <pre class="code">
 	 * &#064;TestExecutionListeners({
-	 *    DependencyInjectionTestExecutionListener.class,
-	 *    DirtiesContextTestExecutionListener.class
+	 *     DependencyInjectionTestExecutionListener.class,
+	 *     DirtiesContextTestExecutionListener.class
 	 * })
 	 * public abstract class AbstractBaseTest {
-	 * 	// ...
+	 * 	 // ...
 	 * }
 	 *
 	 * &#064;TestExecutionListeners(TransactionalTestExecutionListener.class)
 	 * public class TransactionalTest extends AbstractBaseTest {
-	 * 	// ...
+	 * 	 // ...
 	 * }</pre>
-	 *
 	 * <p>If {@code inheritListeners} is set to {@code false}, the listeners for
 	 * the annotated class will <em>shadow</em> and effectively replace any
 	 * listeners defined by a superclass.
@@ -158,4 +119,37 @@ static enum MergeMode {
 	 */
 	MergeMode mergeMode() default MergeMode.REPLACE_DEFAULTS;
 
+
+	/**
+	 * Enumeration of <em>modes</em> that dictate whether or not explicitly
+	 * declared listeners are merged with the default listeners when
+	 * {@code @TestExecutionListeners} is declared on a class that does
+	 * <strong>not</strong> inherit listeners from a superclass.
+	 * @since 4.1
+	 */
+	enum MergeMode {
+
+		/**
+		 * Indicates that locally declared listeners should replace the default
+		 * listeners.
+		 */
+		REPLACE_DEFAULTS,
+
+		/**
+		 * Indicates that locally declared listeners should be merged with the
+		 * default listeners.
+		 * <p>The merging algorithm ensures that duplicates are removed from
+		 * the list and that the resulting set of merged listeners is sorted
+		 * according to the semantics of
+		 * {@link org.springframework.core.annotation.AnnotationAwareOrderComparator
+		 * AnnotationAwareOrderComparator}. If a listener implements
+		 * {@link org.springframework.core.Ordered Ordered} or is annotated
+		 * with {@link org.springframework.core.annotation.Order @Order} it can
+		 * influence the position in which it is merged with the defaults; otherwise,
+		 * locally declared listeners will simply be appended to the list of default
+		 * listeners when merged.
+		 */
+		MERGE_WITH_DEFAULTS
+	}
+
 }