com.github.springtestdbunit.annotation

Annotation Type ExpectedDatabase

@Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD})
 @Repeatable(value=ExpectedDatabases.class)
public @interface ExpectedDatabase

Test annotation that can be used to assert that a database is in given state after tests have run.

Author:

Phillip Webb, Mario Zagar

See Also:

DbUnitTestExecutionListener

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
DatabaseAssertionMode	assertionMode Database assertion mode to use.
Class<? extends org.dbunit.dataset.filter.IColumnFilter>[]	columnFilters A set of IColumnFilter that will be applied to column comparison when using non-strict DatabaseAssertionMode.
String	connection The name of the connection that should be used when verifying data.
Class<? extends DataSetModifier>[]	modifiers A set of DataSetModifier that will be applied to the IDataSet before it is used.
boolean	override If this expectation overrides any others that have been defined at a higher level.
String	query Optional SQL to retrieve the actual subset of the table rows from the database.
String	table Optional table name that can be used to limit the comparison to a specific table.
String	value Provides the location of the dataset that will be used to test the database.

Element Detail

connection

public abstract String connection

The name of the connection that should be used when verifying data. Can refer to a connection specified in @DbUnitConfiguration or left blank to use the default connection.

Returns:

the connection

Default:

""

value

public abstract String value

Provides the location of the dataset that will be used to test the database.

Returns:

The dataset locations

See Also:

DbUnitConfiguration.dataSetLoader()

Default:

""

assertionMode

public abstract DatabaseAssertionMode assertionMode

Database assertion mode to use. Default is DatabaseAssertionMode.DEFAULT.

Returns:

Database assertion mode to use

Default:

com.github.springtestdbunit.assertion.DatabaseAssertionMode.DEFAULT

table

public abstract String table

Optional table name that can be used to limit the comparison to a specific table.

Returns:

the table name

Default:

""

query

public abstract String query

Optional SQL to retrieve the actual subset of the table rows from the database. NOTE: a table name must also be specified when using a query.

Returns:

the SQL Query

Default:

""

override

public abstract boolean override

If this expectation overrides any others that have been defined at a higher level. Defaults to true

Returns:

if this annotation overrides any others

Default:

true

modifiers

public abstract Class<? extends DataSetModifier>[] modifiers

A set of DataSetModifier that will be applied to the IDataSet before it is used. Can refer to a static or inner class of the test.

Returns:

the modifiers to apply

Default:

{}

columnFilters

public abstract Class<? extends org.dbunit.dataset.filter.IColumnFilter>[] columnFilters

A set of IColumnFilter that will be applied to column comparison when using non-strict DatabaseAssertionMode.

Specify this when you want to use DTD with your expected dataset XML file but want to exclude some columns from comparison.

Returns:

column filters to apply

Default:

{}