io.r2dbc.spi.test

Interface TestKit<T>

Type Parameters:

T - type of parameter placeholder identifiers, see getIdentifier(int).

public interface TestKit<T>

R2DBC TCK implementation to verify a driver. The TCK creates and removes tables after each test using JUnit lifecycle hooks (see createTable() and dropTable()).

Functionality that is not supported by a driver should exclude the individual tests by using @Disabled. Implementors need to provide the following methods:

• getConnectionFactory(): Provide the ConnectionFactory under test.
• getCreateTableWithAutogeneratedKey(): Return the CREATE TABLE statement to create a table.
• getPlaceholder(int): Return an parameter placeholder for the nth argument. Arguments start at zero.
• getIdentifier(int): Return an identifier for the nth argument. The placeholder was obtained prior to this call via getPlaceholder(int). Arguments start at zero
• getJdbcOperations(): Return a handle to JdbcOperations configured to the same data source as getConnectionFactory(). Used for test fixture setup/teardown.

The following customization hooks can be overridden to adapt the TCK to a specific database:

• expand(TestStatement, Object...): Return the SQL statement for a specific TestKit.TestStatement.
• blobType(): Returns the SQL type for a Blob column.
• clobType(): Returns the SQL type for a Clob column.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TestKit.TestStatement Enumeration of TCK statements.

Method Summary

Modifier and Type	Method and Description
default void	autoCommitByDefault()
default void	batch()
static Statement	bind(Statement statement, Object identifier, Object value)
default void	bindFails()
default void	bindNull()
static Statement	bindNull(Statement statement, Object identifier, Class<?> type)
default void	bindNullAsParameter()
default void	bindNullFails()
default void	bindValueAsParameter()
default void	blobInsert()
default void	blobSelect()
default String	blobType() Customization hook: Returns the SQL type for a Blob column.
static Exception	captureException(Callable<?> throwingCallable) Returns an Exception from a Callable.
default void	changeAutoCommitCommitsTransaction()
default void	clobInsert()
default void	clobSelect()
default String	clobType() Customization hook: Returns the SQL type for a Clob column.
static <T> Collection<T>	collectionOf(T... values) Returns an unordered Collection containing 0 or more values.
default void	columnMetadata()
default void	compoundStatement()
default void	createStatementFails()
default void	createTable()
default String	doGetSql(TestKit.TestStatement statement) Customization hook to obtain a SQL text for a TestKit.TestStatement.
default void	dropTable()
default void	duplicateColumnNames()
default String	expand(TestKit.TestStatement statement, Object... args) Obtain and expand SQL text for a TestKit.TestStatement.
default Object	extractColumn(Row row) Customization hook to extract the value column from Row.
default <V> V	extractColumn(Row row, Class<V> type) Customization hook to extract the value column from Row.
default reactor.core.publisher.Mono<Collection<Integer>>	extractColumns(Result result) Customization hook to extract the value column from Result.
default reactor.core.publisher.Mono<Long>	extractRowsUpdated(Result result) Customization hook to extract Result.getRowsUpdated().
ConnectionFactory	getConnectionFactory() Returns a ConnectionFactory for the connected database.
default String	getCreateTableWithAutogeneratedKey() Deprecated. since 0.8.3, use doGetSql(TestStatement) as customization hook instead using TestKit.TestStatement.CREATE_TABLE_AUTOGENERATED_KEY.
T	getIdentifier(int index) Returns the bind identifier for a given substitution.
default String	getInsertIntoWithAutogeneratedKey() Deprecated. since 0.8.3, use doGetSql(TestStatement) as customization hook instead using TestKit.TestStatement.INSERT_VALUE_AUTOGENERATED_KEY.
org.springframework.jdbc.core.JdbcOperations	getJdbcOperations() Returns a JdbcOperations for the connected database.
String	getPlaceholder(int index) Returns the database-specific placeholder for a given substitution.
default void	prepareStatement()
default void	prepareStatementWithIncompleteBatchFails()
default void	prepareStatementWithIncompleteBindingFails()
default void	prepareStatementWithTrailingAddShouldFail()
default void	returnGeneratedValues()
default void	returnGeneratedValuesFails()
default void	row()
default void	rowMetadata()
default void	sameAutoCommitLeavesTransactionUnchanged()
default void	savePoint()
default void	savePointStartsTransaction()
default void	segmentInsertEmitsUpdateCount()
default void	segmentInsertWithFilterCompletesWithoutOnNext()
default void	segmentSelectWithEmitsRow()
default void	segmentSelectWithFilterCompletesWithoutOnNext()
default void	transactionCommit()
default void	transactionRollback()
default void	validate()

Method Detail

extractRowsUpdated

default reactor.core.publisher.Mono<Long> extractRowsUpdated(Result result)

Customization hook to extract Result.getRowsUpdated().

Parameters:

result - the result object

Returns:

mono emitting the update row count.

extractColumns

default reactor.core.publisher.Mono<Collection<Integer>> extractColumns(Result result)

Customization hook to extract the value column from Result.

Parameters:

result - the result object

Returns:

mono containing a collection of result values

extractColumn

@Nullable
default Object extractColumn(Row row)

Customization hook to extract the value column from Row.

Parameters:

row - the row

Returns:

the result value.

extractColumn

@Nullable
default <V> V extractColumn(Row row,
                                      Class<V> type)

Customization hook to extract the value column from Row.

Type Parameters:

V - column value type

Parameters:

row - the row

type - column value type

Returns:

the result value.

expand

default String expand(TestKit.TestStatement statement,
                      Object... args)

Obtain and expand SQL text for a TestKit.TestStatement. SQL retrieval can be customized by using doGetSql(TestStatement).

Parameters:

statement - the test statement

args - parameters for String.format(java.lang.String, java.lang.Object...) replacement.

Returns:

the expanded SQL query.

doGetSql

default String doGetSql(TestKit.TestStatement statement)

Customization hook to obtain a SQL text for a TestKit.TestStatement.

Parameters:

statement - the test statement

Returns:

the SQL query.

getInsertIntoWithAutogeneratedKey

@Deprecated
default String getInsertIntoWithAutogeneratedKey()

Deprecated. since 0.8.3, use doGetSql(TestStatement) as customization hook instead using TestKit.TestStatement.INSERT_VALUE_AUTOGENERATED_KEY.

Customization hook: Returns the INSERT INTO statement for a table which created by getCreateTableWithAutogeneratedKey(), only contains the data for second column value which should be 100.

Example:

     INSERT INTO test VALUES(100);
 // or
     INSERT INTO test VALUES(DEFAULT,100);
 

Returns:

the INSERT INTO statement

getCreateTableWithAutogeneratedKey

@Deprecated
default String getCreateTableWithAutogeneratedKey()

Deprecated. since 0.8.3, use doGetSql(TestStatement) as customization hook instead using TestKit.TestStatement.CREATE_TABLE_AUTOGENERATED_KEY.

Returns the CREATE TABLE statement for a table named test with two columns: First one uses auto-generated keys, second one is named value of type INT.

Example:

     CREATE TABLE test ( id SERIAL,  value INTEGER );
  // or
     CREATE TABLE test ( id INTEGER IDENTITY,  value INTEGER );
     

Returns:

the CREATE TABLE statement

blobType

default String blobType()

Customization hook: Returns the SQL type for a Blob column.

Returns:

the SQL type for a Blob column.

clobType

default String clobType()

Customization hook: Returns the SQL type for a Clob column.

Returns:

the SQL type for a Clob column.

createTable

@BeforeEach
default void createTable()

dropTable

@AfterEach
default void dropTable()

getConnectionFactory

ConnectionFactory getConnectionFactory()

Returns a ConnectionFactory for the connected database.

Returns:

a ConnectionFactory for the connected database

getPlaceholder

String getPlaceholder(int index)

Returns the database-specific placeholder for a given substitution.

Parameters:

index - the zero-index number of the substitution

Returns:

the database-specific placeholder for a given substitution

getIdentifier

T getIdentifier(int index)

Returns the bind identifier for a given substitution.

Parameters:

index - the zero-index number of the substitution

Returns:

the bind identifier for a given substitution

getJdbcOperations

org.springframework.jdbc.core.JdbcOperations getJdbcOperations()

Returns a JdbcOperations for the connected database.

Returns:

a JdbcOperations for the connected database

autoCommitByDefault

@Test
default void autoCommitByDefault()

changeAutoCommitCommitsTransaction

@Test
default void changeAutoCommitCommitsTransaction()

sameAutoCommitLeavesTransactionUnchanged

@Test
default void sameAutoCommitLeavesTransactionUnchanged()

batch

@Test
default void batch()

bindFails

@Test
default void bindFails()

bindValueAsParameter

@Test
default void bindValueAsParameter()

bindNullAsParameter

@Test
default void bindNullAsParameter()

bindNull

@Test
default void bindNull()

bindNullFails

@Test
default void bindNullFails()

blobInsert

@Test
default void blobInsert()

blobSelect

@Test
default void blobSelect()

clobInsert

@Test
default void clobInsert()

clobSelect

@Test
default void clobSelect()

columnMetadata

@Test
default void columnMetadata()

rowMetadata

@Test
default void rowMetadata()

row

@Test
default void row()

compoundStatement

@Test
default void compoundStatement()

createStatementFails

@Test
default void createStatementFails()

duplicateColumnNames

@Test
default void duplicateColumnNames()

prepareStatement

@Test
default void prepareStatement()

prepareStatementWithTrailingAddShouldFail

@Test
default void prepareStatementWithTrailingAddShouldFail()

prepareStatementWithIncompleteBatchFails

@Test
default void prepareStatementWithIncompleteBatchFails()

prepareStatementWithIncompleteBindingFails

@Test
default void prepareStatementWithIncompleteBindingFails()

returnGeneratedValues

@Test
default void returnGeneratedValues()

returnGeneratedValuesFails

@Test
default void returnGeneratedValuesFails()

savePoint

@Test
default void savePoint()

savePointStartsTransaction

@Test
default void savePointStartsTransaction()

segmentInsertEmitsUpdateCount

@Test
default void segmentInsertEmitsUpdateCount()

segmentInsertWithFilterCompletesWithoutOnNext

@Test
default void segmentInsertWithFilterCompletesWithoutOnNext()

segmentSelectWithFilterCompletesWithoutOnNext

@Test
default void segmentSelectWithFilterCompletesWithoutOnNext()

segmentSelectWithEmitsRow

@Test
default void segmentSelectWithEmitsRow()

transactionCommit

@Test
default void transactionCommit()

transactionRollback

@Test
default void transactionRollback()

validate

@Test
default void validate()

bind

static Statement bind(Statement statement,
                      Object identifier,
                      Object value)

bindNull

static Statement bindNull(Statement statement,
                          Object identifier,
                          Class<?> type)

collectionOf

@SafeVarargs
static <T> Collection<T> collectionOf(T... values)

Returns an unordered Collection containing 0 or more values.

Type Parameters:

T - Class of objects in values

Parameters:

values - 0 or more values

Returns:

Collection containing values

captureException

static Exception captureException(Callable<?> throwingCallable)

Returns an Exception from a Callable.

Parameters:

throwingCallable - the callable code block

Returns:

the thrown exception

Throws:

IllegalStateException - if throwingCallable did not throw an exception.