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, TestExecutionListener

public class SqlScriptsTestExecutionListener
extends AbstractTestExecutionListener

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

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.

Since:

4.1

Author:

Sam Brannen

See Also:

Sql, SqlConfig, SqlGroup, TestContextTransactionUtils, TransactionalTestExecutionListener, ResourceDatabasePopulator, ScriptUtils

Field Summary

Fields

Modifier and Type	Field and Description
private static Log	logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
SqlScriptsTestExecutionListener()

Method Summary

Modifier and Type	Method and Description
void	afterTestMethod(TestContext testContext) Execute SQL scripts configured via @Sql for the supplied TestContext after the current test method.
void	beforeTestMethod(TestContext testContext) Execute SQL scripts configured via @Sql for the supplied TestContext before the current test method.
private java.lang.String	detectDefaultScript(TestContext testContext, boolean classLevel) Detect a default SQL script by implementing the algorithm defined in Sql.scripts().
private void	executeSqlScripts(Sql sql, Sql.ExecutionPhase executionPhase, TestContext testContext, boolean classLevel) Execute the SQL scripts configured via the supplied @Sql annotation for the given Sql.ExecutionPhase and TestContext.
private void	executeSqlScripts(TestContext testContext, Sql.ExecutionPhase executionPhase) Execute SQL scripts configured via @Sql for the supplied TestContext and Sql.ExecutionPhase.
private javax.sql.DataSource	getDataSourceFromTransactionManager(PlatformTransactionManager transactionManager)
int	getOrder() Returns 5000.
private java.lang.String[]	getScripts(Sql sql, TestContext testContext, boolean classLevel)

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

afterTestClass, afterTestExecution, beforeTestClass, beforeTestExecution, prepareTestInstance

Field Detail

logger

private static final Log logger

Constructor Detail

SqlScriptsTestExecutionListener

public SqlScriptsTestExecutionListener()

Method Detail

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

beforeTestMethod

public void beforeTestMethod(TestContext testContext)
                      throws java.lang.Exception

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

Parameters:

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

Throws:

java.lang.Exception - allows any exception to propagate

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)
                     throws java.lang.Exception

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

Parameters:

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

Throws:

java.lang.Exception - allows any exception to propagate

See Also:

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

executeSqlScripts

private void executeSqlScripts(TestContext testContext,
                               Sql.ExecutionPhase executionPhase)
                        throws java.lang.Exception

Execute SQL scripts configured via @Sql for the supplied TestContext and Sql.ExecutionPhase.

Throws:

java.lang.Exception

executeSqlScripts

private void executeSqlScripts(Sql sql,
                               Sql.ExecutionPhase executionPhase,
                               TestContext testContext,
                               boolean classLevel)
                        throws java.lang.Exception

Execute the SQL scripts configured via the supplied @Sql annotation for the given Sql.ExecutionPhase and TestContext.

Special care must be taken in order to properly support the configured SqlConfig.transactionMode().

Parameters:

sql - the @Sql annotation to parse

executionPhase - the current execution phase

testContext - the current TestContext

classLevel - true if @Sql was declared at the class level

Throws:

java.lang.Exception

getDataSourceFromTransactionManager

private javax.sql.DataSource getDataSourceFromTransactionManager(PlatformTransactionManager transactionManager)

getScripts

private java.lang.String[] getScripts(Sql sql,
                                      TestContext testContext,
                                      boolean classLevel)

detectDefaultScript

private java.lang.String detectDefaultScript(TestContext testContext,
                                             boolean classLevel)

Detect a default SQL script by implementing the algorithm defined in Sql.scripts().