AbstractTransactionalJUnit4SpringContextTests
)@Deprecated public abstract class AbstractTransactionalSpringContextTests extends AbstractDependencyInjectionSpringContextTests
This is useful in a range of circumstances, allowing the following benefits:
This class is typically very fast, compared to traditional setup/teardown scripts.
If data should be left in the database, call the setComplete()
method in each test. The "defaultRollback"
property, which defaults to "true", determines whether transactions will
complete by default.
It is even possible to end the transaction early; for example, to verify lazy
loading behavior of an O/R mapping tool. (This is a valuable away to avoid
unexpected errors when testing a web UI, for example.) Simply call the
endTransaction()
method. Execution will then occur without a
transactional context.
The startNewTransaction()
method may be called after a call to
endTransaction()
if you wish to create a new transaction, quite
independent of the old transaction. The new transaction's default fate will
be to roll back, unless setComplete()
is called again during the
scope of the new transaction. Any number of transactions may be created and
ended in this way. The final transaction will automatically be rolled back
when the test case is torn down.
Transactional behavior requires a single bean in the context implementing the
PlatformTransactionManager
interface. This will be set by the
superclass's Dependency Injection mechanism. If using the superclass's Field
Injection mechanism, the implementation should be named "transactionManager".
This mechanism allows the use of the
AbstractDependencyInjectionSpringContextTests
superclass even when
there is more than one transaction manager in the context.
This base class can also be used without transaction management, if no
PlatformTransactionManager bean is found in the context provided. Be
careful about using this mode, as it allows the potential to permanently
modify data. This mode is available only if dependency checking is turned off
in the AbstractDependencyInjectionSpringContextTests
superclass. The
non-transactional capability is provided to enable use of the same subclass
in different environments.
Modifier and Type | Field and Description |
---|---|
protected TransactionDefinition |
transactionDefinition
Deprecated.
Transaction definition used by this test class: by default, a plain
DefaultTransactionDefinition.
|
protected PlatformTransactionManager |
transactionManager
Deprecated.
The transaction manager to use
|
protected TransactionStatus |
transactionStatus
Deprecated.
TransactionStatus for this test.
|
AUTOWIRE_BY_NAME, AUTOWIRE_BY_TYPE, AUTOWIRE_NO
applicationContext
logger
Constructor and Description |
---|
AbstractTransactionalSpringContextTests()
Deprecated.
Default constructor for AbstractTransactionalSpringContextTests.
|
AbstractTransactionalSpringContextTests(String name)
Deprecated.
Constructor for AbstractTransactionalSpringContextTests with a JUnit name.
|
Modifier and Type | Method and Description |
---|---|
protected void |
endTransaction()
Deprecated.
Immediately force a commit or rollback of the transaction, according to
the
complete and rollback flags. |
protected boolean |
isDefaultRollback()
Deprecated.
Get the default rollback flag for this test.
|
protected boolean |
isRollback()
Deprecated.
Determines whether or not to rollback transactions for the current test.
|
protected void |
onSetUp()
Deprecated.
This implementation creates a transaction before test execution.
|
protected void |
onSetUpBeforeTransaction()
Deprecated.
Subclasses can override this method to perform any setup operations, such
as populating a database table, before the transaction created by
this class.
|
protected void |
onSetUpInTransaction()
Deprecated.
Subclasses can override this method to perform any setup operations, such
as populating a database table, within the transaction created by
this class.
|
protected void |
onTearDown()
Deprecated.
This implementation ends the transaction after test execution.
|
protected void |
onTearDownAfterTransaction()
Deprecated.
Subclasses can override this method to perform cleanup after a
transaction here.
|
protected void |
onTearDownInTransaction()
Deprecated.
Subclasses can override this method to run invariant tests here.
|
protected void |
preventTransaction()
Deprecated.
Call this method in an overridden
ConditionalTestCase.runBare() method to prevent
transactional execution. |
protected void |
setComplete()
Deprecated.
Cause the transaction to commit for this test method, even if the test
method is configured to
rollback . |
void |
setDefaultRollback(boolean defaultRollback)
Deprecated.
Subclasses can set this value in their constructor to change the default,
which is always to roll the transaction back.
|
protected void |
setTransactionDefinition(TransactionDefinition customDefinition)
Deprecated.
Call this method in an overridden
ConditionalTestCase.runBare() method to override
the transaction attributes that will be used, so that AbstractSingleSpringContextTests.setUp()
and AbstractSingleSpringContextTests.tearDown() behavior is modified. |
void |
setTransactionManager(PlatformTransactionManager transactionManager)
Deprecated.
Specify the transaction manager to use.
|
protected void |
startNewTransaction()
Deprecated.
Start a new transaction.
|
getAutowireMode, injectDependencies, isDependencyCheck, isPopulateProtectedVariables, prepareTestInstance, setAutowireMode, setDependencyCheck, setPopulateProtectedVariables
contextKey, createApplicationContext, createBeanDefinitionReader, customizeBeanFactory, getApplicationContext, getConfigLocations, getConfigPath, getConfigPaths, getLoadCount, loadContext, loadContextLocations, prepareApplicationContext, setDirty, setUp, tearDown
addContext, contextKeyString, getContext, hasCachedContext, isContextKeyEmpty, setDirty
getDisabledTestCount, isDisabledInThisEnvironment, recordDisabled, runBare
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, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runTest, setName, toString
protected PlatformTransactionManager transactionManager
protected TransactionDefinition transactionDefinition
protected TransactionStatus transactionStatus
public AbstractTransactionalSpringContextTests()
public AbstractTransactionalSpringContextTests(String name)
public void setTransactionManager(PlatformTransactionManager transactionManager)
This mode works only if dependency checking is turned off in the
AbstractDependencyInjectionSpringContextTests
superclass.
public void setDefaultRollback(boolean defaultRollback)
protected boolean isDefaultRollback()
setDefaultRollback(boolean)
protected boolean isRollback()
The default implementation delegates to isDefaultRollback()
.
Subclasses can override as necessary.
protected void preventTransaction()
ConditionalTestCase.runBare()
method to prevent
transactional execution.protected void setTransactionDefinition(TransactionDefinition customDefinition)
ConditionalTestCase.runBare()
method to override
the transaction attributes that will be used, so that AbstractSingleSpringContextTests.setUp()
and AbstractSingleSpringContextTests.tearDown()
behavior is modified.customDefinition
- the custom transaction definitionprotected void onSetUp() throws Exception
Override onSetUpBeforeTransaction()
and/or
onSetUpInTransaction()
to add custom set-up behavior for
transactional execution. Alternatively, override this method for general
set-up behavior, calling super.onSetUp()
as part of your
method implementation.
onSetUp
in class AbstractSingleSpringContextTests
Exception
- simply let any exception propagateonTearDown()
protected void onSetUpBeforeTransaction() throws Exception
preventTransaction()
has not been invoked in an overridden
TestCase.runTest()
method.Exception
- simply let any exception propagateprotected void onSetUpInTransaction() throws Exception
NB: Not called if there is no transaction management, due to no transaction manager being provided in the context.
If any Throwable
is thrown, the transaction that has been started
prior to the execution of this method will be
ended
(or rather an attempt will be made to
end it gracefully
); The offending
Throwable
will then be rethrown.
Exception
- simply let any exception propagateprotected void onTearDown() throws Exception
Override onTearDownInTransaction()
and/or
onTearDownAfterTransaction()
to add custom tear-down behavior
for transactional execution. Alternatively, override this method for
general tear-down behavior, calling super.onTearDown()
as
part of your method implementation.
Note that onTearDownInTransaction()
will only be called if a
transaction is still active at the time of the test shutdown. In
particular, it will not be called if the transaction has been
completed with an explicit endTransaction()
call before.
onTearDown
in class AbstractSingleSpringContextTests
Exception
- simply let any exception propagateonSetUp()
protected void onTearDownInTransaction() throws Exception
NB: Not called if there is no actual transaction, for example due to no transaction manager being provided in the application context.
Exception
- simply let any exception propagateprotected void onTearDownAfterTransaction() throws Exception
Exception
- simply let any exception propagateprotected void setComplete()
rollback
.IllegalStateException
- if the operation cannot be set to complete
as no transaction manager was providedprotected void endTransaction()
complete
and rollback
flags.
Can be used to explicitly let the transaction end early, for example to check whether lazy associations of persistent objects work outside of a transaction (that is, have been initialized properly).
setComplete()
protected void startNewTransaction() throws TransactionException
endTransaction()
has been called. setComplete()
can be
used again in the new transaction. The fate of the new transaction, by
default, will be the usual rollback.TransactionException
- if starting the transaction failed