Package net.bugreaper.modules.db

Class CustomDb

java.lang.Object

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

net.bugreaper.modules.db.CustomDb

All Implemented Interfaces:

SqlConfig<CustomDb>, SqlGet, SqlPost

public class CustomDb
extends JdbcExecutor<CustomDb>

CustomDb helper that provides a common API for operating with SQL-database that is not yet fully supported.

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

Supports only basic features:

• Get all data for allure on failed not supported
• Get data all data by conditions not supported
• Get data all data from table not supported
• Specific conditions(JSON_*, REGEX) not supported (only basic conditions)

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
CustomDb()	Constructs a CustomDb client for a database that is not yet fully supported, using YAML configuration.
CustomDb(String dbUrl, String username, String passwd)	Creates a new Custom 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 CustomDb	getInstance()	Returns the instance of CustomDb with config builder CustomDb().
protected String[]	getTableColumns(String tableName)	Returns the list of columns in the table.
protected void	recordExistsBuilder(String tableName, String conditions, Object[][] conditionsArray, int awaitMs)
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, renameTable, rollbackTable, 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

CustomDb

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

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

Parameters:

dbUrl - the JDBC connection URL for the Custom 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

CustomDb

public CustomDb()

Constructs a CustomDb client for a database that is not yet fully supported, using YAML configuration.

Loads configuration values from a YAML file.

Example:

CustomDb db = new CustomDb();

 custom-db: # reserved type
   url: 'jdbc:mysql://localhost:3308'
   username: user
   password: pass
   await: 1000 (optional)
 

See Also:

• JdbcExecutor

Method Details

getInstance

public static CustomDb getInstance()

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

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

Returns:

the shared instance of CustomDb

Throws:

IllegalArgumentException - if the configuration contains invalid values

See Also:

• config setup

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