Package net.bugreaper.modules.db

Class MySQL

java.lang.Object

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

net.bugreaper.modules.db.MySQL

All Implemented Interfaces:

SqlConfig<MySQL>, SqlGet, SqlPost

public class MySQL
extends JdbcExecutor<MySQL>

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

It is recommended to use a single instance: MySQL db = MySQL.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 int	awaitPollInterval	Default await polling interval in milliseconds for tests.
protected static final String	COUNT
protected boolean	enableEnchantedReport	Enables enhanced reporting with full table data attached to Allure and actual column values included in assertion exceptions.
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
MySQL()	Constructs MySQL client configuration.
MySQL(String dbUrl, String username, String passwd)	Creates a new MySQL 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 providedAwaitMs)
static MySQL	getInstance()	Returns the singleton instance of MySQL with config builder MySQL().
protected String[]	getTableColumns(String tableName)	Returns the list of columns in the table.
protected void	recordExistsBuilder(String tableName, String conditions, Object[][] conditionsArray, int providedAwaitMs)
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, setEnchantedReport, 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

awaitPollInterval

protected volatile int awaitPollInterval

Default await polling interval in milliseconds for tests.

enableEnchantedReport

protected volatile boolean enableEnchantedReport

Enables enhanced reporting with full table data attached to Allure and actual column values included in assertion exceptions.

Constructor Details

MySQL

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

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

Parameters:

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

MySQL

public MySQL()

Constructs MySQL client configuration.

Loads configuration values from a YAML file.

Example:

MySQL db = new MySQL();

 modules:
   db:
     mysql:
       url: 'jdbc:mysql://localhost:3308'
       username: user
       password: pass
       await: 1000 (optional)
       enchanted-report: true # (optional)
 

See Also:

• JdbcExecutor

Method Details

getInstance

public static MySQL getInstance()

Returns the singleton instance of MySQL with config builder MySQL().

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

Returns:

the singleton instance of MySQL

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 providedAwaitMs)

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 providedAwaitMs)

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