com.consol.citrus.dsl.builder

Class ExecuteSQLQueryBuilder

java.lang.Object

com.consol.citrus.dsl.builder.AbstractTestActionBuilder<ExecuteSQLQueryAction>

com.consol.citrus.dsl.builder.ExecuteSQLQueryBuilder

All Implemented Interfaces:

TestActionBuilder<ExecuteSQLQueryAction>, TestAction

public class ExecuteSQLQueryBuilder
extends AbstractTestActionBuilder<ExecuteSQLQueryAction>

Action executes SQL queries and offers result set validation. The class enables you to query data result sets from a database. Validation will happen on column basis inside the result set.

Since:

2.3

Author:

Christoph Deppisch

Field Summary

Fields inherited from class com.consol.citrus.dsl.builder.AbstractTestActionBuilder

action

Constructor Summary

Constructors

Constructor and Description
ExecuteSQLQueryBuilder() Default constructor.
ExecuteSQLQueryBuilder(ExecuteSQLQueryAction action) Constructor using action field.

Method Summary

Modifier and Type	Method and Description
ExecuteSQLQueryBuilder	dataSource(DataSource dataSource) Sets the SQL data source.
ExecuteSQLQueryBuilder	extract(String columnName, String variableName) User can extract column values to test variables.
ExecuteSQLQueryBuilder	groovy(org.springframework.core.io.Resource scriptResource) Validate SQL result set via validation script, for instance Groovy.
ExecuteSQLQueryBuilder	groovy(String script) Validate SQL result set via validation script, for instance Groovy.
ExecuteSQLQueryBuilder	jdbcTemplate(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate) Sets the Spring JDBC template to use.
ExecuteSQLQueryBuilder	sqlResource(org.springframework.core.io.Resource sqlResource) Setter for external file resource containing the SQL statements to execute.
ExecuteSQLQueryBuilder	sqlResource(String filePath) Setter for external file resource containing the SQL statements to execute.
ExecuteSQLQueryBuilder	statement(String statements) Adds a new statement to the list of SQL executions.
ExecuteSQLQueryBuilder	statements(List<String> statements) List of statements to execute.
ExecuteSQLQueryBuilder	transactionIsolationLevel(String isolationLevel) Sets the transaction isolation level to use.
ExecuteSQLQueryBuilder	transactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager) Sets the transaction manager to use.
ExecuteSQLQueryBuilder	transactionTimeout(int transactionTimeout) Sets the transaction timeout to use.
ExecuteSQLQueryBuilder	transactionTimeout(String transactionTimeout) Sets the transaction timeout to use.
ExecuteSQLQueryBuilder	validate(String column, String... values) Set expected control result set.
ExecuteSQLQueryBuilder	validateScript(org.springframework.core.io.Resource scriptResource, String type) Validate SQL result set via validation script, for instance Groovy.
ExecuteSQLQueryBuilder	validateScript(org.springframework.core.io.Resource scriptResource, String type, Charset charset) Validate SQL result set via validation script, for instance Groovy.
ExecuteSQLQueryBuilder	validateScript(String script, String type) Validate SQL result set via validation script, for instance Groovy.
ExecuteSQLQueryBuilder	validator(SqlResultSetScriptValidator validator) Sets an explicit validator implementation for this action.

Methods inherited from class com.consol.citrus.dsl.builder.AbstractTestActionBuilder

actor, build, description, execute, getActor, getDescription, getName, isDisabled, setActor, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecuteSQLQueryBuilder

public ExecuteSQLQueryBuilder(ExecuteSQLQueryAction action)

Constructor using action field.

Parameters:

action -

ExecuteSQLQueryBuilder

public ExecuteSQLQueryBuilder()

Default constructor.

Method Detail

jdbcTemplate

public ExecuteSQLQueryBuilder jdbcTemplate(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate)

Sets the Spring JDBC template to use.

Parameters:

jdbcTemplate -

Returns:

transactionManager

public ExecuteSQLQueryBuilder transactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

Sets the transaction manager to use.

Parameters:

transactionManager -

Returns:

transactionTimeout

public ExecuteSQLQueryBuilder transactionTimeout(int transactionTimeout)

Sets the transaction timeout to use.

Parameters:

transactionTimeout -

Returns:

transactionTimeout

public ExecuteSQLQueryBuilder transactionTimeout(String transactionTimeout)

Sets the transaction timeout to use.

Parameters:

transactionTimeout -

Returns:

transactionIsolationLevel

public ExecuteSQLQueryBuilder transactionIsolationLevel(String isolationLevel)

Sets the transaction isolation level to use.

Parameters:

isolationLevel -

Returns:

dataSource

public ExecuteSQLQueryBuilder dataSource(DataSource dataSource)

Sets the SQL data source.

Parameters:

dataSource -

Returns:

statements

public ExecuteSQLQueryBuilder statements(List<String> statements)

List of statements to execute. Declared inline in the test case.

Parameters:

statements -

statement

public ExecuteSQLQueryBuilder statement(String statements)

Adds a new statement to the list of SQL executions.

Parameters:

statements -

Returns:

sqlResource

public ExecuteSQLQueryBuilder sqlResource(org.springframework.core.io.Resource sqlResource)

Setter for external file resource containing the SQL statements to execute.

Parameters:

sqlResource -

sqlResource

public ExecuteSQLQueryBuilder sqlResource(String filePath)

Setter for external file resource containing the SQL statements to execute.

Parameters:

filePath -

validate

public ExecuteSQLQueryBuilder validate(String column,
                                       String... values)

Set expected control result set. Keys represent the column names, values the expected values.

Parameters:

column -

values -

validateScript

public ExecuteSQLQueryBuilder validateScript(String script,
                                             String type)

Validate SQL result set via validation script, for instance Groovy.

Parameters:

script -

type -

validateScript

public ExecuteSQLQueryBuilder validateScript(org.springframework.core.io.Resource scriptResource,
                                             String type)

Validate SQL result set via validation script, for instance Groovy.

Parameters:

scriptResource -

type -

validateScript

public ExecuteSQLQueryBuilder validateScript(org.springframework.core.io.Resource scriptResource,
                                             String type,
                                             Charset charset)

Validate SQL result set via validation script, for instance Groovy.

Parameters:

scriptResource -

type -

charset -

groovy

public ExecuteSQLQueryBuilder groovy(String script)

Validate SQL result set via validation script, for instance Groovy.

Parameters:

script -

groovy

public ExecuteSQLQueryBuilder groovy(org.springframework.core.io.Resource scriptResource)

Validate SQL result set via validation script, for instance Groovy.

Parameters:

scriptResource -

extract

public ExecuteSQLQueryBuilder extract(String columnName,
                                      String variableName)

User can extract column values to test variables. Map holds column names (keys) and respective target variable names (values).

Parameters:

columnName -

variableName -

validator

public ExecuteSQLQueryBuilder validator(SqlResultSetScriptValidator validator)

Sets an explicit validator implementation for this action.

Parameters:

validator - the validator to set