org.springframework.test
Class AbstractDependencyInjectionSpringContextTests

java.lang.Object
  junit.framework.Assert
      junit.framework.TestCase
          org.springframework.test.AbstractSpringContextTests
              org.springframework.test.AbstractDependencyInjectionSpringContextTests

All Implemented Interfaces:

Test

Direct Known Subclasses:

AbstractTransactionalSpringContextTests

public abstract class AbstractDependencyInjectionSpringContextTests
extends AbstractSpringContextTests

Convenient superclass for tests depending on a Spring context. The test instance itself is populated by Dependency Injection.

Really for integration testing, not unit testing. You should not normally use the Spring container for unit tests: simply populate your POJOs in plain JUnit tests!

This supports two modes of populating the test:

• Via Setter Dependency Injection. Simply express dependencies on objects in the test fixture, and they will be satisfied by autowiring by type.
• Via Field Injection. Declare protected variables of the required type which match named beans in the context. This is autowire by name, rather than type. This approach is based on an approach originated by Ara Abrahmian. Setter Dependency Injection is the default: set the "populateProtectedVariables" property to true in the constructor to switch on Field Injection.

This class will normally cache contexts based on a context key: normally the config locations String array describing the Spring resource descriptors making up the context. Unless the setDirty() method is called by a test, the context will not be reloaded, even across different subclasses of this test. This is particularly beneficial if your context is slow to construct, for example if you are using Hibernate and the time taken to load the mappings is an issue.

If you don't want this behavior, you can override the contextKey() method, most likely to return the test class. In conjunction with this you would probably override the getContext method, which by default loads the locations specified in the getConfigLocations() method.

WARNING: When doing integration tests from within Eclipse, only use classpath resource URLs. Else, you may see misleading failures when changing context locations.

Since:

1.1.1

Author:

Rod Johnson, Rob Harrop

See Also:

setDirty(), contextKey(), AbstractSpringContextTests.getContext(java.lang.Object), getConfigLocations()

Field Summary

protected ConfigurableApplicationContext	applicationContext Application context this test will run against
static int	AUTOWIRE_BY_NAME Constant that indicates autowiring bean properties by name.
static int	AUTOWIRE_BY_TYPE Constant that indicates autowiring bean properties by type.
static int	AUTOWIRE_NO Constant that indicates no autowiring at all.
protected String[]	managedVariableNames

Fields inherited from class org.springframework.test.AbstractSpringContextTests

logger

Constructor Summary

AbstractDependencyInjectionSpringContextTests()
Default constructor for AbstractDependencyInjectionSpringContextTests.

AbstractDependencyInjectionSpringContextTests(String name)
Constructor for AbstractDependencyInjectionSpringContextTests with a JUnit name.

Method Summary

protected Object	contextKey() Return a key for this context.
int	getAutowireMode() Return the autowire mode for test properties set by Dependency Injection.
protected abstract String[]	getConfigLocations() Subclasses must implement this method to return the locations of their config files.
int	getLoadCount() Return the current number of context load attempts.
protected void	initManagedVariableNames()
boolean	isDependencyCheck() Return whether or not dependency checking should be performed for test properties set by Dependency Injection.
boolean	isPopulateProtectedVariables() Return whether to populate protected variables of this test case.
protected ConfigurableApplicationContext	loadContextLocations(String[] locations) Subclasses can invoke this to get a context key for the given location.
protected void	onSetUp() Subclasses can override this method in place of the setUp() method, which is final in this class.
protected void	onTearDown() Subclasses can override this to add custom behavior on teardown.
protected void	populateProtectedVariables()
void	setAutowireMode(int autowireMode) Set the autowire mode for test properties set by Dependency Injection.
void	setDependencyCheck(boolean dependencyCheck) Set whether or not dependency checking should be performed for test properties set by Dependency Injection.
void	setDirty() Called to say that the "applicationContext" instance variable is dirty and should be reloaded.
void	setPopulateProtectedVariables(boolean populateFields) Set whether to populate protected variables of this test case.
protected void	setUp()
protected void	tearDown() Reload the context if it's marked as dirty.

Methods inherited from class org.springframework.test.AbstractSpringContextTests

contextKeyString, getContext, hasCachedContext, loadContext, setDirty

Methods inherited from class junit.framework.TestCase

countTestCases, createResult, getName, run, run, runBare, runTest, setName, toString

Methods inherited from class junit.framework.Assert

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

AUTOWIRE_NO

public static final int AUTOWIRE_NO

Constant that indicates no autowiring at all.

See Also:

setAutowireMode(int), Constant Field Values

AUTOWIRE_BY_NAME

public static final int AUTOWIRE_BY_NAME

Constant that indicates autowiring bean properties by name.

See Also:

setAutowireMode(int), Constant Field Values

AUTOWIRE_BY_TYPE

public static final int AUTOWIRE_BY_TYPE

Constant that indicates autowiring bean properties by type.

See Also:

setAutowireMode(int), Constant Field Values

applicationContext

protected ConfigurableApplicationContext applicationContext

Application context this test will run against

managedVariableNames

protected String[] managedVariableNames

Constructor Detail

AbstractDependencyInjectionSpringContextTests

public AbstractDependencyInjectionSpringContextTests()

Default constructor for AbstractDependencyInjectionSpringContextTests.

AbstractDependencyInjectionSpringContextTests

public AbstractDependencyInjectionSpringContextTests(String name)

Constructor for AbstractDependencyInjectionSpringContextTests with a JUnit name.

Method Detail

setPopulateProtectedVariables

public void setPopulateProtectedVariables(boolean populateFields)

Set whether to populate protected variables of this test case. Default is "false".

isPopulateProtectedVariables

public boolean isPopulateProtectedVariables()

Return whether to populate protected variables of this test case.

setAutowireMode

public void setAutowireMode(int autowireMode)

Set the autowire mode for test properties set by Dependency Injection.

The default is "AUTOWIRE_BY_TYPE". Can be set to "AUTOWIRE_BY_NAME" or "AUTOWIRE_NO" instead.

See Also:

AUTOWIRE_BY_TYPE, AUTOWIRE_BY_NAME, AUTOWIRE_NO

getAutowireMode

public int getAutowireMode()

Return the autowire mode for test properties set by Dependency Injection.

setDependencyCheck

public void setDependencyCheck(boolean dependencyCheck)

Set whether or not dependency checking should be performed for test properties set by Dependency Injection.

The default is "true", meaning that tests cannot be run unless all properties are populated.

isDependencyCheck

public boolean isDependencyCheck()

Return whether or not dependency checking should be performed for test properties set by Dependency Injection.

getLoadCount

public final int getLoadCount()

Return the current number of context load attempts.

setDirty

public void setDirty()

Called to say that the "applicationContext" instance variable is dirty and should be reloaded. We need to do this if a test has modified the context (for example, by replacing a bean definition).

setUp

protected final void setUp()
                    throws Exception

Overrides:

setUp in class TestCase

Throws:

Exception

contextKey

protected Object contextKey()

Return a key for this context. Usually based on config locations, but a subclass overriding buildContext() might want to return its class.

loadContextLocations

protected ConfigurableApplicationContext loadContextLocations(String[] locations)

Description copied from class: AbstractSpringContextTests

Subclasses can invoke this to get a context key for the given location. This doesn't affect the applicationContext instance variable in this class. Dependency Injection cannot be applied from such contexts.

Overrides:

loadContextLocations in class AbstractSpringContextTests

initManagedVariableNames

protected void initManagedVariableNames()
                                 throws IllegalAccessException

Throws:

IllegalAccessException

populateProtectedVariables

protected void populateProtectedVariables()
                                   throws IllegalAccessException

Throws:

IllegalAccessException

onSetUp

protected void onSetUp()
                throws Exception

Subclasses can override this method in place of the setUp() method, which is final in this class. This implementation does nothing.

Throws:

Exception - simply let any exception propagate

tearDown

protected final void tearDown()

Reload the context if it's marked as dirty.

Overrides:

tearDown in class TestCase

See Also:

onTearDown()

onTearDown

protected void onTearDown()
                   throws Exception

Subclasses can override this to add custom behavior on teardown.

Throws:

Exception - simply let any exception propagate

getConfigLocations

protected abstract String[] getConfigLocations()

Subclasses must implement this method to return the locations of their config files. A plain path will be treated as class path location. E.g.: "org/springframework/whatever/foo.xml". Note however that you may prefix path locations with standard Spring resource prefixes. Therefore, a config location path prefixed with "classpath:" with behave the same as a plain path, but a config location such as "file:/some/path/path/location/appContext.xml" will be treated as a filesystem location.

Returns:

an array of config locations