程序包 cn.taketoday.test.context.jdbc

类 SqlScriptsTestExecutionListener

java.lang.Object

cn.taketoday.test.context.support.AbstractTestExecutionListener

cn.taketoday.test.context.jdbc.SqlScriptsTestExecutionListener

所有已实现的接口:

cn.taketoday.core.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 Infra-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 Infra Beans

A PlatformTransactionManager and a DataSource, just a PlatformTransactionManager, or just a DataSource must be defined as beans in the Infra ApplicationContext for the corresponding test. Consult the javadocs for SqlConfig.transactionMode(), SqlConfig.transactionManager(), SqlConfig.dataSource(), TestContextTransactionUtils.retrieveDataSource(cn.taketoday.test.context.TestContext, java.lang.String), and TestContextTransactionUtils.retrieveTransactionManager(cn.taketoday.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 today-jdbc and today-tx modules as well as their transitive dependencies to be present on the classpath.

从以下版本开始:

4.0

作者:

Sam Brannen, Dmitry Semukhin, Andreas Ahlenstorf, Harry Yang

另请参阅:

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

字段概要

字段

修饰符和类型	字段	说明
private static final cn.taketoday.logging.Logger	logger
private static final String	SLASH
private static final cn.taketoday.util.ReflectionUtils.MethodFilter	sqlMethodFilter

从接口继承的字段 cn.taketoday.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

构造器概要

构造器

构造器	说明
SqlScriptsTestExecutionListener()

方法概要

修饰符和类型	方法	说明
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.
private cn.taketoday.jdbc.datasource.init.ResourceDatabasePopulator	createDatabasePopulator(MergedSqlConfig mergedSqlConfig)
private String	detectDefaultScript(Class<?> testClass, Method testMethod, boolean classLevel)	Detect a default SQL script by implementing the algorithm defined in Sql.scripts().
private void	executeClassLevelSqlScripts(TestContext testContext, Sql.ExecutionPhase executionPhase)	Execute class-level SQL scripts configured via @Sql for the supplied TestContext and the supplied BEFORE_TEST_CLASS or AFTER_TEST_CLASS execution phase.
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 void	executeSqlScripts(Set<Sql> sqlAnnotations, TestContext testContext, Sql.ExecutionPhase executionPhase, boolean classLevel)	Execute SQL scripts for the supplied @Sql annotations.
private DataSource	getDataSourceFromTransactionManager(cn.taketoday.transaction.PlatformTransactionManager transactionManager)
final int	getOrder()	Returns 5000.
private String[]	getScripts(Sql sql, Class<?> testClass, Method testMethod, boolean classLevel)
private Set<Sql>	getSqlAnnotationsFor(Class<?> clazz)	Get the @Sql annotations declared on the supplied class.
private Set<Sql>	getSqlAnnotationsFor(Method method)	Get the @Sql annotations declared on the supplied method.
private SqlMergeMode	getSqlMergeModeFor(Class<?> clazz)	Get the @SqlMergeMode annotation declared on the supplied class.
private SqlMergeMode	getSqlMergeModeFor(Method method)	Get the @SqlMergeMode annotation declared on the supplied method.
private Stream<Method>	getSqlMethods(Class<?> testClass)
private static boolean	isValidMethodLevelPhase(Sql.ExecutionPhase executionPhase)
private boolean	mergeSqlAnnotations(TestContext testContext)	Determine if method-level @Sql annotations should be merged with class-level @Sql annotations.
void	processAheadOfTime(cn.taketoday.aot.hint.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.
private void	registerClasspathResources(String[] paths, cn.taketoday.aot.hint.RuntimeHints runtimeHints, ClassLoader classLoader)
private static boolean	sameDataSource(DataSource ds1, DataSource ds2)	Determine if the two data sources are effectively the same, unwrapping proxies as necessary to compare the target instances.

从类继承的方法 cn.taketoday.test.context.support.AbstractTestExecutionListener

afterTestExecution, beforeTestExecution, prepareTestInstance

从类继承的方法 java.lang.Object

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

从接口继承的方法 cn.taketoday.test.context.TestExecutionListener

afterTestExecution, beforeTestExecution, prepareTestInstance

字段详细资料

SLASH

private static final String SLASH

另请参阅:

• 常量字段值

logger

private static final cn.taketoday.logging.Logger logger

sqlMethodFilter

private static final cn.taketoday.util.ReflectionUtils.MethodFilter sqlMethodFilter

构造器详细资料

SqlScriptsTestExecutionListener

public SqlScriptsTestExecutionListener()

方法详细资料

getOrder

public final int getOrder()

Returns 5000.

指定者:

getOrder 在接口中 cn.taketoday.core.Ordered

覆盖:

getOrder 在类中 AbstractTestExecutionListener

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.

指定者:

beforeTestClass 在接口中 TestExecutionListener

覆盖:

beforeTestClass 在类中 AbstractTestExecutionListener

参数:

testContext - the test context for the test; never null

抛出:

Exception - allows any exception to propagate

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.

指定者:

afterTestClass 在接口中 TestExecutionListener

覆盖:

afterTestClass 在类中 AbstractTestExecutionListener

参数:

testContext - the test context for the test; never null

抛出:

Exception - allows any exception to propagate

beforeTestMethod

public void beforeTestMethod(TestContext testContext)

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

指定者:

beforeTestMethod 在接口中 TestExecutionListener

覆盖:

beforeTestMethod 在类中 AbstractTestExecutionListener

参数:

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

另请参阅:

• TestExecutionListener.afterTestMethod(cn.taketoday.test.context.TestContext)
• TestExecutionListener.beforeTestExecution(cn.taketoday.test.context.TestContext)
• TestExecutionListener.afterTestExecution(cn.taketoday.test.context.TestContext)

afterTestMethod

public void afterTestMethod(TestContext testContext)

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

指定者:

afterTestMethod 在接口中 TestExecutionListener

覆盖:

afterTestMethod 在类中 AbstractTestExecutionListener

参数:

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

另请参阅:

• TestExecutionListener.beforeTestMethod(cn.taketoday.test.context.TestContext)
• TestExecutionListener.beforeTestExecution(cn.taketoday.test.context.TestContext)
• TestExecutionListener.afterTestExecution(cn.taketoday.test.context.TestContext)

processAheadOfTime

public void processAheadOfTime(cn.taketoday.aot.hint.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.

指定者:

processAheadOfTime 在接口中 AotTestExecutionListener

参数:

runtimeHints - the RuntimeHints to use

testClass - the test class to process

classLoader - the classloader to use

executeClassLevelSqlScripts

private void executeClassLevelSqlScripts(TestContext testContext,
 Sql.ExecutionPhase executionPhase)

Execute class-level SQL scripts configured via @Sql for the supplied TestContext and the supplied BEFORE_TEST_CLASS or AFTER_TEST_CLASS execution phase.

executeSqlScripts

private void executeSqlScripts(TestContext testContext,
 Sql.ExecutionPhase executionPhase)

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

mergeSqlAnnotations

private boolean mergeSqlAnnotations(TestContext testContext)

Determine if method-level @Sql annotations should be merged with class-level @Sql annotations.

getSqlMergeModeFor

@Nullable
private SqlMergeMode getSqlMergeModeFor(Class<?> clazz)

Get the @SqlMergeMode annotation declared on the supplied class.

getSqlMergeModeFor

@Nullable
private SqlMergeMode getSqlMergeModeFor(Method method)

Get the @SqlMergeMode annotation declared on the supplied method.

getSqlAnnotationsFor

private Set<Sql> getSqlAnnotationsFor(Class<?> clazz)

Get the @Sql annotations declared on the supplied class.

getSqlAnnotationsFor

private Set<Sql> getSqlAnnotationsFor(Method method)

Get the @Sql annotations declared on the supplied method.

executeSqlScripts

private void executeSqlScripts(Set<Sql> sqlAnnotations,
 TestContext testContext,
 Sql.ExecutionPhase executionPhase,
 boolean classLevel)

Execute SQL scripts for the supplied @Sql annotations.

executeSqlScripts

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.

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

参数:

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

createDatabasePopulator

@NonNull
private cn.taketoday.jdbc.datasource.init.ResourceDatabasePopulator createDatabasePopulator(MergedSqlConfig mergedSqlConfig)

sameDataSource

private static boolean sameDataSource(DataSource ds1,
 DataSource ds2)

Determine if the two data sources are effectively the same, unwrapping proxies as necessary to compare the target instances.

另请参阅:

• TransactionSynchronizationUtils.unwrapResourceIfNecessary(Object)

getDataSourceFromTransactionManager

@Nullable
private DataSource getDataSourceFromTransactionManager(cn.taketoday.transaction.PlatformTransactionManager transactionManager)

getScripts

private String[] getScripts(Sql sql,
 Class<?> testClass,
 @Nullable
 Method testMethod,
 boolean classLevel)

detectDefaultScript

private String detectDefaultScript(Class<?> testClass,
 @Nullable
 Method testMethod,
 boolean classLevel)

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

getSqlMethods

private Stream<Method> getSqlMethods(Class<?> testClass)

registerClasspathResources

private void registerClasspathResources(String[] paths,
 cn.taketoday.aot.hint.RuntimeHints runtimeHints,
 ClassLoader classLoader)

isValidMethodLevelPhase

private static boolean isValidMethodLevelPhase(Sql.ExecutionPhase executionPhase)