AbstractTransactionalTestNGSpringContextTests (Spring Framework 5.1.0.RELEASE API)

java.lang.Object
- org.springframework.test.context.testng.AbstractTestNGSpringContextTests
- - org.springframework.test.context.testng.AbstractTransactionalTestNGSpringContextTests

All Implemented Interfaces:

Aware, ApplicationContextAware, org.testng.IHookable, org.testng.ITestNGListener
```
@TestExecutionListeners(value={TransactionalTestExecutionListener.class,SqlScriptsTestExecutionListener.class})
 @Transactional
public abstract class AbstractTransactionalTestNGSpringContextTests
extends AbstractTestNGSpringContextTests
```
Abstract transactional extension of AbstractTestNGSpringContextTests which adds convenience functionality for JDBC access. Expects a DataSource bean and a PlatformTransactionManager bean to be defined in the Spring application context.
This class exposes a JdbcTemplate and provides an easy way to count the number of rows in a table (potentially with a WHERE clause), delete from tables, drop tables, and execute SQL scripts within a transaction.
Concrete subclasses must fulfill the same requirements outlined in AbstractTestNGSpringContextTests.
The following TestExecutionListeners are configured by default:
Since:

2.5

Author:

Sam Brannen, Juergen Hoeller

See Also:

AbstractTestNGSpringContextTests, ContextConfiguration, TestExecutionListeners, TransactionalTestExecutionListener, SqlScriptsTestExecutionListener, Transactional, Commit, Rollback, BeforeTransaction, AfterTransaction, JdbcTestUtils, AbstractTransactionalJUnit4SpringContextTests

Field Summary

Fields
Modifier and Type Field and Description

protected JdbcTemplate jdbcTemplate
The JdbcTemplate that this base class manages, available to subclasses.
- Fields inherited from class org.springframework.test.context.testng.AbstractTestNGSpringContextTests
  applicationContext, logger

Constructor Summary

Constructors
Constructor and Description

AbstractTransactionalTestNGSpringContextTests()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`countRowsInTable(java.lang.String tableName)` Convenience method for counting the rows in the given table.
`protected int`	`countRowsInTableWhere(java.lang.String tableName, java.lang.String whereClause)` Convenience method for counting the rows in the given table, using the provided `WHERE` clause.
`protected int`	`deleteFromTables(java.lang.String... names)` Convenience method for deleting all rows from the specified tables.
`protected int`	`deleteFromTableWhere(java.lang.String tableName, java.lang.String whereClause, java.lang.Object... args)` Convenience method for deleting all rows from the given table, using the provided `WHERE` clause.
`protected void`	`dropTables(java.lang.String... names)` Convenience method for dropping all of the specified tables.
`protected void`	`executeSqlScript(java.lang.String sqlResourcePath, boolean continueOnError)` Execute the given SQL script.
`void`	`setDataSource(javax.sql.DataSource dataSource)` Set the `DataSource`, typically provided via Dependency Injection.
`void`	`setSqlScriptEncoding(java.lang.String sqlScriptEncoding)` Specify the encoding for SQL scripts, if different from the platform encoding.

Methods inherited from class org.springframework.test.context.testng.AbstractTestNGSpringContextTests
run, setApplicationContext, springTestContextAfterTestClass, springTestContextAfterTestMethod, springTestContextBeforeTestClass, springTestContextBeforeTestMethod, springTestContextPrepareTestInstance

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - jdbcTemplate
```
protected final JdbcTemplate jdbcTemplate
```
    The JdbcTemplate that this base class manages, available to subclasses.
    
    Since:
    
    3.2
- Constructor Detail
  - AbstractTransactionalTestNGSpringContextTests
```
public AbstractTransactionalTestNGSpringContextTests()
```
- Method Detail
  - setDataSource
```
@Autowired
public void setDataSource(javax.sql.DataSource dataSource)
```
    Set the DataSource, typically provided via Dependency Injection.
    This method also instantiates the jdbcTemplate instance variable.
  - setSqlScriptEncoding
```
public void setSqlScriptEncoding(java.lang.String sqlScriptEncoding)
```
    Specify the encoding for SQL scripts, if different from the platform encoding.
    
    See Also:
    
    executeSqlScript(java.lang.String, boolean)
  - countRowsInTable
```
protected int countRowsInTable(java.lang.String tableName)
```
    Convenience method for counting the rows in the given table.
    
    Parameters:
    
    tableName - table name to count rows in
    
    Returns:
    
    the number of rows in the table
    
    See Also:
    
    JdbcTestUtils.countRowsInTable(org.springframework.jdbc.core.JdbcTemplate, java.lang.String)
  - countRowsInTableWhere
```
protected int countRowsInTableWhere(java.lang.String tableName,
                                    java.lang.String whereClause)
```
    Convenience method for counting the rows in the given table, using the provided WHERE clause.
    See the Javadoc for JdbcTestUtils.countRowsInTableWhere(org.springframework.jdbc.core.JdbcTemplate, java.lang.String, java.lang.String) for details.
    
    Parameters:
    
    tableName - the name of the table to count rows in
    
    whereClause - the WHERE clause to append to the query
    
    Returns:
    
    the number of rows in the table that match the provided WHERE clause
    
    Since:
    
    3.2
    
    See Also:
    
    JdbcTestUtils.countRowsInTableWhere(org.springframework.jdbc.core.JdbcTemplate, java.lang.String, java.lang.String)
  - deleteFromTables
```
protected int deleteFromTables(java.lang.String... names)
```
    Convenience method for deleting all rows from the specified tables.
    Use with caution outside of a transaction!
    
    Parameters:
    
    names - the names of the tables from which to delete
    
    Returns:
    
    the total number of rows deleted from all specified tables
    
    See Also:
    
    JdbcTestUtils.deleteFromTables(org.springframework.jdbc.core.JdbcTemplate, java.lang.String...)
  - deleteFromTableWhere
```
protected int deleteFromTableWhere(java.lang.String tableName,
                                   java.lang.String whereClause,
                                   java.lang.Object... args)
```
    Convenience method for deleting all rows from the given table, using the provided WHERE clause.
    Use with caution outside of a transaction!
    See the Javadoc for JdbcTestUtils.deleteFromTableWhere(org.springframework.jdbc.core.JdbcTemplate, java.lang.String, java.lang.String, java.lang.Object...) for details.
    
    Parameters:
    
    tableName - the name of the table to delete rows from
    
    whereClause - the WHERE clause to append to the query
    
    args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding SQL type); may also contain SqlParameterValue objects which indicate not only the argument value but also the SQL type and optionally the scale.
    
    Returns:
    
    the number of rows deleted from the table
    
    Since:
    
    4.0
    
    See Also:
    
    JdbcTestUtils.deleteFromTableWhere(org.springframework.jdbc.core.JdbcTemplate, java.lang.String, java.lang.String, java.lang.Object...)
  - dropTables
```
protected void dropTables(java.lang.String... names)
```
    Convenience method for dropping all of the specified tables.
    Use with caution outside of a transaction!
    
    Parameters:
    
    names - the names of the tables to drop
    
    Since:
    
    3.2
    
    See Also:
    
    JdbcTestUtils.dropTables(org.springframework.jdbc.core.JdbcTemplate, java.lang.String...)
  - executeSqlScript
```
protected void executeSqlScript(java.lang.String sqlResourcePath,
                                boolean continueOnError)
                         throws DataAccessException
```
    Execute the given SQL script.
    Use with caution outside of a transaction!
    The script will normally be loaded by classpath.
    Do not use this method to execute DDL if you expect rollback.
    
    Parameters:
    
    sqlResourcePath - the Spring resource path for the SQL script
    
    continueOnError - whether or not to continue without throwing an exception in the event of an error
    
    Throws:
    
    DataAccessException - if there is an error executing a statement
    
    See Also:
    
    ResourceDatabasePopulator, setSqlScriptEncoding(java.lang.String)

Class AbstractTransactionalTestNGSpringContextTests

Field Summary

Fields inherited from class org.springframework.test.context.testng.AbstractTestNGSpringContextTests

Constructor Summary

Method Summary

Methods inherited from class org.springframework.test.context.testng.AbstractTestNGSpringContextTests

Methods inherited from class java.lang.Object

Field Detail

jdbcTemplate

Constructor Detail

AbstractTransactionalTestNGSpringContextTests

Method Detail

setDataSource

setSqlScriptEncoding

countRowsInTable

countRowsInTableWhere

deleteFromTables

deleteFromTableWhere

dropTables

executeSqlScript