Package net.bugreaper.modules.db

Class MsSQL

java.lang.Object

net.bugreaper.modules.db.jdbc.JdbcExecutor<MsSQL>

net.bugreaper.modules.db.MsSQL

All Implemented Interfaces:

SqlConfig<MsSQL>, SqlGet, SqlPost

public class MsSQL
extends JdbcExecutor<MsSQL>

MsSQL helper that provides a common API for operating with MsSQL.

It is recommended to use a single instance: MsSQL db = MsSQL.getInstance();

Provides:

• Assertions with await support
• Data manipulation operations such as create, update, and clean

For more information, see JdbcExecutor.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	COUNT
protected String	getColumnsQuery
protected JdbcDirectivesHikari	jdbc
protected String	password
protected static final String	SELECT_ALL
protected String	url
protected String	username

Constructor Summary

Constructors

Constructor	Description
MsSQL()	Constructs a MsSQL client using YAML configuration.
MsSQL(String dbUrl, String username, String passwd)	Creates a new MsSQL database helper instance with the specified connection parameters.

Method Summary

Modifier and Type	Method	Description
protected void	assertCountInTableBuilder(String tableName, String conditions, Object[][] conditionsArray, String expectedCount, int awaitMs)
static MsSQL	getInstance()	Returns the instance of MsSQL with config builder MsSQL().
protected String[]	getTableColumns(String tableName)	Returns the list of columns in the table.
protected void	recordExistsBuilder(String tableName, String conditions, Object[][] conditionsArray, int awaitMs)
void	renameTable(String tableName)	Renames the specified table by adding the "_X_" suffix.
void	rollbackTable(String tableName)	Rolls back the table name by removing the "_X_" suffix added by SqlPost.renameTable(java.lang.String).
protected void	seeInDbByCondMethod(String tableName, String conditions)
protected void	showDataFromTableMethod(String tableName)

Methods inherited from class net.bugreaper.modules.db.jdbc.JdbcExecutor

deleteFromTable, deleteFromTable, deleteFromTable, getConfigSummary, insertIntoTable, insertIntoTable, insertIntoTable, runScript, runScriptFromFile, seeRecordExistsInTable, seeRecordExistsInTable, seeRecordExistsInTableCustom, seeRowsCountInTableExactly, seeRowsCountInTableExactly, seeRowsCountInTableExactly, seeRowsCountInTableExactlyCustom, seeTableIsEmpty, seeTableIsNotEmpty, self, setAwaitMs, setTemplatesDirectory, showDataByCondition, showDataFromTable, truncateTable, truncateTables, updateTable, updateTable, updateTable, withAwaitMs

Methods inherited from class java.lang.Object

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

Field Details

jdbc

protected JdbcDirectivesHikari jdbc

getColumnsQuery

protected String getColumnsQuery

url

protected String url

username

protected String username

password

protected String password

SELECT_ALL

protected static final String SELECT_ALL

See Also:

• Constant Field Values

COUNT

protected static final String COUNT

See Also:

• Constant Field Values

Constructor Details

MsSQL

public MsSQL(String dbUrl,
 String username,
 String passwd)

Creates a new MsSQL database helper instance with the specified connection parameters.

Parameters:

dbUrl - the JDBC connection URL for the MsSQL database

username - the username used to authenticate with the database

passwd - the password used to authenticate with the database

Throws:

IllegalArgumentException - if any of the required parameters are null or empty

MsSQL

public MsSQL()

Constructs a MsSQL client using YAML configuration.

Loads configuration values from a YAML file.

Example:

MsSQL db = new MsSQL();

 sqlserver:
   url: 'jdbc:sqlserver://localhost:1435;encrypt=false'
   username: user
   password: pass
   await: 1000 (optional)
 

See Also:

• JdbcExecutor

Method Details

getInstance

public static MsSQL getInstance()

Returns the instance of MsSQL with config builder MsSQL().

This implementation is thread-safe using method-level synchronization.

Returns:

the shared instance of MsSQL

Throws:

IllegalArgumentException - if the configuration contains invalid values

See Also:

• config setup

renameTable

@Step("(DB) Rename table \'{tableName}\'")
public void renameTable(String tableName)

Description copied from interface: SqlPost

Renames the specified table by adding the "_X_" suffix.

Note: Roll back the table name after the test using SqlPost.rollbackTable(java.lang.String).

Specified by:

renameTable in interface SqlPost

Overrides:

renameTable in class JdbcExecutor<MsSQL>

Parameters:

tableName - table name in the format schema_name.table_name

rollbackTable

@Step("(DB) Rollback renamed table \'{tableName}\'")
public void rollbackTable(String tableName)

Description copied from interface: SqlPost

Rolls back the table name by removing the "_X_" suffix added by SqlPost.renameTable(java.lang.String).

Specified by:

rollbackTable in interface SqlPost

Overrides:

rollbackTable in class JdbcExecutor<MsSQL>

Parameters:

tableName - table name in the format schema_name.table_name

assertCountInTableBuilder

@Step("(DB)[ASSERT] Table: \'{tableName}\' contains EXACTLY <{expectedCount}> record/s {conditions}")
protected void assertCountInTableBuilder(String tableName,
 String conditions,
 @Param(mode=HIDDEN)
 Object[][] conditionsArray,
 String expectedCount,
 @Param(mode=HIDDEN)
 int awaitMs)

recordExistsBuilder

@Step("(DB)[ASSERT] Table \'{tableName}\' contains records {conditions}")
protected void recordExistsBuilder(String tableName,
 String conditions,
 @Param(mode=HIDDEN)
 Object[][] conditionsArray,
 @Param(mode=HIDDEN)
 int awaitMs)

showDataFromTableMethod

protected void showDataFromTableMethod(String tableName)

seeInDbByCondMethod

@Step("(DB) Show data from table \'{tableName}\' {conditions}")
protected void seeInDbByCondMethod(String tableName,
 String conditions)

getTableColumns

protected String[] getTableColumns(String tableName)

Returns the list of columns in the table.

Parameters:

tableName - table name in the format schema_name.table_name

Returns:

array containing column names