public abstract class

AbstractTransactionalSpringContextTests

extends AbstractDependencyInjectionSpringContextTests
java.lang.Object
   ↳ junit.framework.Assert
     ↳ junit.framework.TestCase
       ↳ org.springframework.test.ConditionalTestCase
         ↳ org.springframework.test.AbstractSpringContextTests
           ↳ org.springframework.test.AbstractSingleSpringContextTests
             ↳ org.springframework.test.AbstractDependencyInjectionSpringContextTests
               ↳ org.springframework.test.AbstractTransactionalSpringContextTests
Known Direct Subclasses
Known Indirect Subclasses

This class is deprecated.
as of Spring 3.0, in favor of using the listener-based test context framework (AbstractJUnit38SpringContextTests)

Class Overview

Convenient base class for JUnit 3.8 based tests that should occur in a transaction, but normally will roll the transaction back on the completion of each test.

This is useful in a range of circumstances, allowing the following benefits:

  • Ability to delete or insert any data in the database, without affecting other tests
  • Providing a transactional context for any code requiring a transaction
  • Ability to write anything to the database without any need to clean up.

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.

Summary

[Expand]
Inherited Constants
From class org.springframework.test.AbstractDependencyInjectionSpringContextTests
Fields
protected TransactionDefinition transactionDefinition Transaction definition used by this test class: by default, a plain DefaultTransactionDefinition.
protected PlatformTransactionManager transactionManager The transaction manager to use
protected TransactionStatus transactionStatus TransactionStatus for this test.
[Expand]
Inherited Fields
From class org.springframework.test.AbstractSingleSpringContextTests
From class org.springframework.test.ConditionalTestCase
Public Constructors
AbstractTransactionalSpringContextTests()
Default constructor for AbstractTransactionalSpringContextTests.
AbstractTransactionalSpringContextTests(String name)
Constructor for AbstractTransactionalSpringContextTests with a JUnit name.
Public Methods
void setDefaultRollback(boolean defaultRollback)
Subclasses can set this value in their constructor to change the default, which is always to roll the transaction back.
void setTransactionManager(PlatformTransactionManager transactionManager)
Specify the transaction manager to use.
Protected Methods
void endTransaction()
Immediately force a commit or rollback of the transaction, according to the complete and rollback flags.
boolean isDefaultRollback()
Get the default rollback flag for this test.
boolean isRollback()
Determines whether or not to rollback transactions for the current test.
void onSetUp()
This implementation creates a transaction before test execution.
void onSetUpBeforeTransaction()
Subclasses can override this method to perform any setup operations, such as populating a database table, before the transaction created by this class.
void onSetUpInTransaction()
Subclasses can override this method to perform any setup operations, such as populating a database table, within the transaction created by this class.
void onTearDown()
This implementation ends the transaction after test execution.
void onTearDownAfterTransaction()
Subclasses can override this method to perform cleanup after a transaction here.
void onTearDownInTransaction()
Subclasses can override this method to run invariant tests here.
void preventTransaction()
Call this method in an overridden runBare() method to prevent transactional execution.
void setComplete()
Cause the transaction to commit for this test method, even if the test method is configured to rollback.
void setTransactionDefinition(TransactionDefinition customDefinition)
Call this method in an overridden runBare() method to override the transaction attributes that will be used, so that setUp() and tearDown() behavior is modified.
void startNewTransaction()
Start a new transaction.
[Expand]
Inherited Methods
From class org.springframework.test.AbstractDependencyInjectionSpringContextTests
From class org.springframework.test.AbstractSingleSpringContextTests
From class org.springframework.test.AbstractSpringContextTests
From class org.springframework.test.ConditionalTestCase
From class junit.framework.TestCase
From class junit.framework.Assert
From class java.lang.Object
From interface junit.framework.Test

Fields

protected TransactionDefinition transactionDefinition

Transaction definition used by this test class: by default, a plain DefaultTransactionDefinition. Subclasses can change this to cause different behavior.

protected PlatformTransactionManager transactionManager

The transaction manager to use

protected TransactionStatus transactionStatus

TransactionStatus for this test. Typical subclasses won't need to use it.

Public Constructors

public AbstractTransactionalSpringContextTests ()

Default constructor for AbstractTransactionalSpringContextTests.

public AbstractTransactionalSpringContextTests (String name)

Constructor for AbstractTransactionalSpringContextTests with a JUnit name.

Public Methods

public void setDefaultRollback (boolean defaultRollback)

Subclasses can set this value in their constructor to change the default, which is always to roll the transaction back.

public void setTransactionManager (PlatformTransactionManager transactionManager)

Specify the transaction manager to use. No transaction management will be available if this is not set. Populated through dependency injection by the superclass.

This mode works only if dependency checking is turned off in the AbstractDependencyInjectionSpringContextTests superclass.

Protected Methods

protected void endTransaction ()

Immediately force a commit or rollback of the transaction, according to the 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).

See Also

protected boolean isDefaultRollback ()

Get the default rollback flag for this test.

Returns
  • The default rollback flag.

protected boolean isRollback ()

Determines whether or not to rollback transactions for the current test.

The default implementation delegates to isDefaultRollback(). Subclasses can override as necessary.

protected void onSetUp ()

This implementation creates a transaction before test execution.

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.

Throws
Exception simply let any exception propagate
See Also

protected void onSetUpBeforeTransaction ()

Subclasses can override this method to perform any setup operations, such as populating a database table, before the transaction created by this class. Only invoked if there is a transaction: that is, if preventTransaction() has not been invoked in an overridden runTest() method.

Throws
Exception simply let any exception propagate

protected void onSetUpInTransaction ()

Subclasses can override this method to perform any setup operations, such as populating a database table, within the transaction created by this class.

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.

Throws
Exception simply let any exception propagate

protected void onTearDown ()

This implementation ends the transaction after test execution.

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.

Throws
Exception simply let any exception propagate
See Also

protected void onTearDownAfterTransaction ()

Subclasses can override this method to perform cleanup after a transaction here. At this point, the transaction is not active anymore.

Throws
Exception simply let any exception propagate

protected void onTearDownInTransaction ()

Subclasses can override this method to run invariant tests here. The transaction is still active at this point, so any changes made in the transaction will still be visible. However, there is no need to clean up the database, as a rollback will follow automatically.

NB: Not called if there is no actual transaction, for example due to no transaction manager being provided in the application context.

Throws
Exception simply let any exception propagate

protected void preventTransaction ()

Call this method in an overridden runBare() method to prevent transactional execution.

protected void setComplete ()

Cause the transaction to commit for this test method, even if the test method is configured to rollback.

Throws
IllegalStateException if the operation cannot be set to complete as no transaction manager was provided

protected void setTransactionDefinition (TransactionDefinition customDefinition)

Call this method in an overridden runBare() method to override the transaction attributes that will be used, so that setUp() and tearDown() behavior is modified.

Parameters
customDefinition the custom transaction definition

protected void startNewTransaction ()

Start a new transaction. Only call this method if 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.

Throws
TransactionException if starting the transaction failed