Package org.springframework.test.context.jdbc

Class SqlScriptsTestExecutionListener

java.lang.Object

org.springframework.test.context.support.AbstractTestExecutionListener

org.springframework.test.context.jdbc.SqlScriptsTestExecutionListener

All Implemented Interfaces:

Ordered, AotTestExecutionListener, TestExecutionListener

public class SqlScriptsTestExecutionListener
extends AbstractTestExecutionListener
implements AotTestExecutionListener

TestExecutionListener that provides support for executing SQL scripts and inlined statements configured via the @Sql annotation.

Class-level annotations that are constrained to a class-level execution phase (BEFORE_TEST_CLASS or AFTER_TEST_CLASS) will be run once before all test methods or once after all test methods, respectively. All other scripts and inlined statements will be executed before or after execution of the corresponding test method, depending on the configured value of the executionPhase flag.

Scripts and inlined statements will be executed without a transaction, within an existing Spring-managed transaction, or within an isolated transaction, depending on the configured value of SqlConfig.transactionMode() and the presence of a transaction manager.

Script Resources

For details on default script detection and how script resource locations are interpreted, see Sql.scripts().

Required Spring Beans

A PlatformTransactionManager and a DataSource, just a PlatformTransactionManager, or just a DataSource must be defined as beans in the Spring ApplicationContext for the corresponding test. Consult the javadocs for SqlConfig.transactionMode(), SqlConfig.transactionManager(), SqlConfig.dataSource(), TestContextTransactionUtils.retrieveDataSource(org.springframework.test.context.TestContext, java.lang.String), and TestContextTransactionUtils.retrieveTransactionManager(org.springframework.test.context.TestContext, java.lang.String) for details on permissible configuration constellations and on the algorithms used to locate these beans.

Required Dependencies

Use of this listener requires the spring-jdbc and spring-tx modules as well as their transitive dependencies to be present on the classpath.

Since:

4.1

Author:

Sam Brannen, Dmitry Semukhin, Andreas Ahlenstorf

See Also:

• Sql
• SqlConfig
• SqlMergeMode
• SqlGroup
• TestContextTransactionUtils
• TransactionalTestExecutionListener
• ResourceDatabasePopulator
• ScriptUtils

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
SqlScriptsTestExecutionListener()

Method Summary

Modifier and Type	Method	Description
void	afterTestClass(TestContext testContext)	Execute SQL scripts configured via @Sql for the supplied TestContext once per test class after all test methods have been run.
void	afterTestMethod(TestContext testContext)	Execute SQL scripts configured via @Sql for the supplied TestContext after the current test method.
void	beforeTestClass(TestContext testContext)	Execute SQL scripts configured via @Sql for the supplied TestContext once per test class before any test method is run.
void	beforeTestMethod(TestContext testContext)	Execute SQL scripts configured via @Sql for the supplied TestContext before the current test method.
final int	getOrder()	Returns 5000.
void	processAheadOfTime(RuntimeHints runtimeHints, Class<?> testClass, ClassLoader classLoader)	Process the supplied test class and its methods and register run-time hints for any SQL scripts configured or detected as classpath resources via @Sql.

Methods inherited from class org.springframework.test.context.support.AbstractTestExecutionListener

afterTestExecution, beforeTestExecution, prepareTestInstance

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.test.context.TestExecutionListener

afterTestExecution, beforeTestExecution, prepareTestInstance

Constructor Details

SqlScriptsTestExecutionListener

public SqlScriptsTestExecutionListener()

Method Details

getOrder

public final int getOrder()

Returns 5000.

Specified by:

getOrder in interface Ordered

Overrides:

getOrder in class AbstractTestExecutionListener

Returns:

the order value

See Also:

• Ordered.HIGHEST_PRECEDENCE
• Ordered.LOWEST_PRECEDENCE

beforeTestClass

public void beforeTestClass(TestContext testContext)
                     throws Exception

Execute SQL scripts configured via @Sql for the supplied TestContext once per test class before any test method is run.

Specified by:

beforeTestClass in interface TestExecutionListener

Overrides:

beforeTestClass in class AbstractTestExecutionListener

Parameters:

testContext - the test context for the test; never null

Throws:

Exception - allows any exception to propagate

Since:

6.1

afterTestClass

public void afterTestClass(TestContext testContext)
                    throws Exception

Execute SQL scripts configured via @Sql for the supplied TestContext once per test class after all test methods have been run.

Specified by:

afterTestClass in interface TestExecutionListener

Overrides:

afterTestClass in class AbstractTestExecutionListener

Parameters:

testContext - the test context for the test; never null

Throws:

Exception - allows any exception to propagate

Since:

6.1

beforeTestMethod

public void beforeTestMethod(TestContext testContext)

Execute SQL scripts configured via @Sql for the supplied TestContext before the current test method.

Specified by:

beforeTestMethod in interface TestExecutionListener

Overrides:

beforeTestMethod in class AbstractTestExecutionListener

Parameters:

testContext - the test context in which the test method will be executed; never null

See Also:

• TestExecutionListener.afterTestMethod(org.springframework.test.context.TestContext)
• TestExecutionListener.beforeTestExecution(org.springframework.test.context.TestContext)
• TestExecutionListener.afterTestExecution(org.springframework.test.context.TestContext)

afterTestMethod

public void afterTestMethod(TestContext testContext)

Execute SQL scripts configured via @Sql for the supplied TestContext after the current test method.

Specified by:

afterTestMethod in interface TestExecutionListener

Overrides:

afterTestMethod in class AbstractTestExecutionListener

Parameters:

testContext - the test context in which the test method was executed; never null

See Also:

• TestExecutionListener.beforeTestMethod(org.springframework.test.context.TestContext)
• TestExecutionListener.beforeTestExecution(org.springframework.test.context.TestContext)
• TestExecutionListener.afterTestExecution(org.springframework.test.context.TestContext)

processAheadOfTime

public void processAheadOfTime(RuntimeHints runtimeHints,
 Class<?> testClass,
 ClassLoader classLoader)

Process the supplied test class and its methods and register run-time hints for any SQL scripts configured or detected as classpath resources via @Sql.

Specified by:

processAheadOfTime in interface AotTestExecutionListener

Parameters:

runtimeHints - the RuntimeHints to use

testClass - the test class to process

classLoader - the classloader to use

Since:

6.0