Package io.debezium.connector.sqlserver.util

Class TestHelper

java.lang.Object

io.debezium.connector.sqlserver.util.TestHelper

public class TestHelper
extends Object

Author:

Horia Chiorean (hchiorea@redhat.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TestHelper.CdcRecordFoundBlockingMultiResultSetConsumer	A multiple result-set consumer used internally by waitForCdcRecord(SqlServerConnection, String, CdcRecordHandler) that allows returning whether the provided TestHelper.CdcRecordHandler detected the expected condition or not.
static interface	TestHelper.CdcRecordHandler

Field Summary

Fields

Modifier and Type	Field	Description
private static String	CDC_WRAPPERS_DML
static Path	DB_HISTORY_PATH
private static String	DISABLE_DB_CDC
private static String	DISABLE_TABLE_CDC
private static String	ENABLE_DB_CDC
private static String	ENABLE_TABLE_CDC
private static String	ENABLE_TABLE_CDC_WITH_CUSTOM_CAPTURE
private static String	IS_CDC_ENABLED
private static String	IS_CDC_TABLE_ENABLED
private static org.slf4j.Logger	LOGGER
private static String	STATEMENTS_PLACEHOLDER
static String	TEST_DATABASE
static String	TEST_DATABASE_1
static String	TEST_DATABASE_2
private static String	TEST_PROPERTY_PREFIX
static String	TEST_SERVER_NAME
private static String	TEST_TASK_ID
static String	TYPE_LENGTH_PARAMETER_KEY	Key for schema parameter used to store a source column's type length.
static String	TYPE_NAME_PARAMETER_KEY	Key for schema parameter used to store a source column's type name.
static String	TYPE_SCALE_PARAMETER_KEY	Key for schema parameter used to store a source column's type scale.

Constructor Summary

Constructors

Constructor	Description
TestHelper()

Method Summary

Modifier and Type	Method	Description
static io.debezium.connector.sqlserver.SqlServerConnection	adminConnection()
static void	createTestDatabase()
static void	createTestDatabase(String databaseName)
static void	createTestDatabases(String... databaseNames)
static Configuration.Builder	defaultConfig()	Returns a default connector configuration suitable for most test cases.
static Configuration.Builder	defaultConnectorConfig()
static JdbcConfiguration	defaultJdbcConfig()
static Configuration.Builder	defaultMultiPartitionConfig()
static Configuration.Builder	defaultMultiPartitionConfig(String... databaseNames)	Returns a default configuration for connectors in multi-partition mode.
protected static void	disableDbCdc(io.debezium.connector.sqlserver.SqlServerConnection connection, String name)	Disables CDC for a given database, if not already disabled.
static void	disableTableCdc(JdbcConnection connection, String name)	Disables CDC for a table for which it was enabled before.
static void	dropTestDatabase()
private static void	dropTestDatabase(io.debezium.connector.sqlserver.SqlServerConnection connection, String databaseName)
static void	enableDbCdc(io.debezium.connector.sqlserver.SqlServerConnection connection, String name)	Enables CDC for a given database, if not already enabled.
static void	enableTableCdc(io.debezium.connector.sqlserver.SqlServerConnection connection, String name)	Enables CDC for a table if not already enabled and generates the wrapper functions for that table.
static void	enableTableCdc(io.debezium.connector.sqlserver.SqlServerConnection connection, String tableName, String captureName)	Enables CDC for a table with a custom capture name functions for that table.
static void	enableTableCdc(JdbcConnection connection, String tableName, String captureName, List<String> captureColumnList)	Enables CDC for a table with a custom capture name functions for that table.
private static ObjectName	getObjectName(String context, String serverName)
private static ObjectName	getObjectName(String context, String serverName, String databaseName)
private static ObjectName	getObjectName(Map<String,String> tags)
static boolean	isCdcEnabled(io.debezium.connector.sqlserver.SqlServerConnection connection, String name)
static io.debezium.connector.sqlserver.SqlServerConnection	multiPartitionTestConnection()	Returns a database connection that isn't explicitly connected to any database.
static io.debezium.connector.sqlserver.SqlServerConnection	testConnection()
private static io.debezium.connector.sqlserver.SqlServerConnection	testConnection(JdbcConfiguration config)
static io.debezium.connector.sqlserver.SqlServerConnection	testConnection(String databaseName)
static io.debezium.connector.sqlserver.SqlServerConnection	testConnectionWithOptionRecompile()
static String	topicName(String databaseName, String tableName)
static void	waitForCdcRecord(io.debezium.connector.sqlserver.SqlServerConnection connection, String tableName, TestHelper.CdcRecordHandler handler)	Utility method that will poll the CDC change tables and provide the record handler with the changes detected.
static void	waitForCdcRecord(io.debezium.connector.sqlserver.SqlServerConnection connection, String tableName, String captureInstanceName, TestHelper.CdcRecordHandler handler)
static void	waitForDatabaseSnapshotsToBeCompleted(String... databaseNames)
static void	waitForDatabaseSnapshotToBeCompleted(String databaseName)
static void	waitForDisabledCdc(io.debezium.connector.sqlserver.SqlServerConnection connection, String table)
static void	waitForEnabledCdc(io.debezium.connector.sqlserver.SqlServerConnection connection, String table)
static void	waitForMaxLsnAvailable(io.debezium.connector.sqlserver.SqlServerConnection connection)
static void	waitForMaxLsnAvailable(io.debezium.connector.sqlserver.SqlServerConnection connection, String databaseName)
static void	waitForSnapshotToBeCompleted()
private static void	waitForSnapshotToBeCompleted(ObjectName objectName)
static void	waitForStreamingStarted()
static void	waitForStreamingStarted(ObjectName objectName)
static void	waitForTaskStreamingStarted()
static void	waitForTaskStreamingStarted(String taskId)
static int	waitTimeForRecords()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

DB_HISTORY_PATH

public static final Path DB_HISTORY_PATH

TEST_DATABASE

public static final String TEST_DATABASE

See Also:

Constant Field Values

TEST_DATABASE_1

public static final String TEST_DATABASE_1

See Also:

Constant Field Values

TEST_DATABASE_2

public static final String TEST_DATABASE_2

See Also:

Constant Field Values

TEST_SERVER_NAME

public static final String TEST_SERVER_NAME

See Also:

Constant Field Values

TEST_PROPERTY_PREFIX

private static final String TEST_PROPERTY_PREFIX

See Also:

Constant Field Values

TEST_TASK_ID

private static final String TEST_TASK_ID

See Also:

Constant Field Values

STATEMENTS_PLACEHOLDER

private static final String STATEMENTS_PLACEHOLDER

See Also:

Constant Field Values

ENABLE_DB_CDC

private static final String ENABLE_DB_CDC

See Also:

Constant Field Values

DISABLE_DB_CDC

private static final String DISABLE_DB_CDC

See Also:

Constant Field Values

ENABLE_TABLE_CDC

private static final String ENABLE_TABLE_CDC

See Also:

Constant Field Values

IS_CDC_ENABLED

private static final String IS_CDC_ENABLED

See Also:

Constant Field Values

IS_CDC_TABLE_ENABLED

private static final String IS_CDC_TABLE_ENABLED

See Also:

Constant Field Values

ENABLE_TABLE_CDC_WITH_CUSTOM_CAPTURE

private static final String ENABLE_TABLE_CDC_WITH_CUSTOM_CAPTURE

See Also:

Constant Field Values

DISABLE_TABLE_CDC

private static final String DISABLE_TABLE_CDC

See Also:

Constant Field Values

CDC_WRAPPERS_DML

private static final String CDC_WRAPPERS_DML

TYPE_NAME_PARAMETER_KEY

public static final String TYPE_NAME_PARAMETER_KEY

Key for schema parameter used to store a source column's type name.

See Also:

Constant Field Values

TYPE_LENGTH_PARAMETER_KEY

public static final String TYPE_LENGTH_PARAMETER_KEY

Key for schema parameter used to store a source column's type length.

See Also:

Constant Field Values

TYPE_SCALE_PARAMETER_KEY

public static final String TYPE_SCALE_PARAMETER_KEY

Key for schema parameter used to store a source column's type scale.

See Also:

Constant Field Values

Constructor Detail

TestHelper

public TestHelper()

Method Detail

defaultJdbcConfig

public static JdbcConfiguration defaultJdbcConfig()

defaultConnectorConfig

public static Configuration.Builder defaultConnectorConfig()

defaultConfig

public static Configuration.Builder defaultConfig()

Returns a default connector configuration suitable for most test cases. Can be amended/overridden in individual tests as needed.

defaultMultiPartitionConfig

public static Configuration.Builder defaultMultiPartitionConfig(String... databaseNames)

Returns a default configuration for connectors in multi-partition mode.

defaultMultiPartitionConfig

public static Configuration.Builder defaultMultiPartitionConfig()

createTestDatabase

public static void createTestDatabase()

createTestDatabases

public static void createTestDatabases(String... databaseNames)

createTestDatabase

public static void createTestDatabase(String databaseName)

dropTestDatabase

public static void dropTestDatabase()

dropTestDatabase

private static void dropTestDatabase(io.debezium.connector.sqlserver.SqlServerConnection connection,
                                     String databaseName)
                              throws SQLException

Throws:

SQLException

adminConnection

public static io.debezium.connector.sqlserver.SqlServerConnection adminConnection()

testConnection

public static io.debezium.connector.sqlserver.SqlServerConnection testConnection()

multiPartitionTestConnection

public static io.debezium.connector.sqlserver.SqlServerConnection multiPartitionTestConnection()

Returns a database connection that isn't explicitly connected to any database.

testConnection

public static io.debezium.connector.sqlserver.SqlServerConnection testConnection(String databaseName)

testConnection

private static io.debezium.connector.sqlserver.SqlServerConnection testConnection(JdbcConfiguration config)

testConnectionWithOptionRecompile

public static io.debezium.connector.sqlserver.SqlServerConnection testConnectionWithOptionRecompile()

enableDbCdc

public static void enableDbCdc(io.debezium.connector.sqlserver.SqlServerConnection connection,
                               String name)
                        throws SQLException

Enables CDC for a given database, if not already enabled.

Parameters:

name - the name of the DB, may not be null

Throws:

SQLException - if anything unexpected fails

disableDbCdc

protected static void disableDbCdc(io.debezium.connector.sqlserver.SqlServerConnection connection,
                                   String name)
                            throws SQLException

Disables CDC for a given database, if not already disabled.

Parameters:

name - the name of the DB, may not be null

Throws:

SQLException - if anything unexpected fails

enableTableCdc

public static void enableTableCdc(io.debezium.connector.sqlserver.SqlServerConnection connection,
                                  String name)
                           throws SQLException

Enables CDC for a table if not already enabled and generates the wrapper functions for that table.

Parameters:

connection - sql connection

name - the name of the table, may not be null

Throws:

SQLException - if anything unexpected fails

isCdcEnabled

public static boolean isCdcEnabled(io.debezium.connector.sqlserver.SqlServerConnection connection,
                                   String name)
                            throws SQLException

Parameters:

name - the name of the table, may not be null

Returns:

true if CDC is enabled for the table

Throws:

SQLException - if anything unexpected fails

enableTableCdc

public static void enableTableCdc(io.debezium.connector.sqlserver.SqlServerConnection connection,
                                  String tableName,
                                  String captureName)
                           throws SQLException

Enables CDC for a table with a custom capture name functions for that table.

Parameters:

connection - sql connection

tableName - the name of the table, may not be null

captureName - the name of the capture instance, may not be null

Throws:

SQLException - if anything unexpected fails

enableTableCdc

public static void enableTableCdc(JdbcConnection connection,
                                  String tableName,
                                  String captureName,
                                  List<String> captureColumnList)
                           throws SQLException

Enables CDC for a table with a custom capture name functions for that table.

Parameters:

connection - sql connection

tableName - the name of the table, may not be null

captureName - the name of the capture instance, may not be null

captureColumnList - the source table columns that are to be included in the change table, may not be null

Throws:

SQLException - if anything unexpected fails

disableTableCdc

public static void disableTableCdc(JdbcConnection connection,
                                   String name)
                            throws SQLException

Disables CDC for a table for which it was enabled before.

Parameters:

name - the name of the table, may not be null

Throws:

SQLException - if anything unexpected fails

waitForSnapshotToBeCompleted

public static void waitForSnapshotToBeCompleted()

waitForDatabaseSnapshotToBeCompleted

public static void waitForDatabaseSnapshotToBeCompleted(String databaseName)

waitForDatabaseSnapshotsToBeCompleted

public static void waitForDatabaseSnapshotsToBeCompleted(String... databaseNames)

waitForSnapshotToBeCompleted

private static void waitForSnapshotToBeCompleted(ObjectName objectName)

waitForTaskStreamingStarted

public static void waitForTaskStreamingStarted(String taskId)

waitForTaskStreamingStarted

public static void waitForTaskStreamingStarted()

waitForStreamingStarted

public static void waitForStreamingStarted()

waitForStreamingStarted

public static void waitForStreamingStarted(ObjectName objectName)

waitForMaxLsnAvailable

public static void waitForMaxLsnAvailable(io.debezium.connector.sqlserver.SqlServerConnection connection)
                                   throws Exception

Throws:

Exception

waitForMaxLsnAvailable

public static void waitForMaxLsnAvailable(io.debezium.connector.sqlserver.SqlServerConnection connection,
                                          String databaseName)
                                   throws Exception

Throws:

Exception

getObjectName

private static ObjectName getObjectName(String context,
                                        String serverName)

getObjectName

private static ObjectName getObjectName(String context,
                                        String serverName,
                                        String databaseName)

getObjectName

private static ObjectName getObjectName(Map<String,String> tags)

waitTimeForRecords

public static int waitTimeForRecords()

waitForCdcRecord

public static void waitForCdcRecord(io.debezium.connector.sqlserver.SqlServerConnection connection,
                                    String tableName,
                                    TestHelper.CdcRecordHandler handler)

Utility method that will poll the CDC change tables and provide the record handler with the changes detected. The record handler can then make a determination as to whether to return true if the expected outcome exists or false to indicate it did not find what it expected. This method will block until either the handler returns true or if the polling fails to complete within the allocated poll window.

Parameters:

connection - the SQL Server connection to be used

tableName - the main table name to be checked

handler - the handler method to be called if changes are found in the capture table instance

waitForEnabledCdc

public static void waitForEnabledCdc(io.debezium.connector.sqlserver.SqlServerConnection connection,
                                     String table)
                              throws SQLException,
                                     InterruptedException

Throws:

SQLException

InterruptedException

waitForDisabledCdc

public static void waitForDisabledCdc(io.debezium.connector.sqlserver.SqlServerConnection connection,
                                      String table)
                               throws SQLException,
                                      InterruptedException

Throws:

SQLException

InterruptedException

waitForCdcRecord

public static void waitForCdcRecord(io.debezium.connector.sqlserver.SqlServerConnection connection,
                                    String tableName,
                                    String captureInstanceName,
                                    TestHelper.CdcRecordHandler handler)

topicName

public static String topicName(String databaseName,
                               String tableName)