org.dbunit.assertion

Class DbUnitAssertBase

java.lang.Object

org.dbunit.assertion.DbUnitAssertBase

Direct Known Subclasses:

DbUnitAssert, DbUnitValueComparerAssert

public class DbUnitAssertBase
extends java.lang.Object

Base class for DbUnit assert classes containing common methods.

Since:

2.6.0

Author:

Jeff Jensen

Field Summary

Fields

Modifier and Type	Field and Description
protected ValueComparerDefaults	valueComparerDefaults

Constructor Summary

Constructors

Constructor and Description
DbUnitAssertBase()

Method Summary

Modifier and Type	Method and Description
void	assertWithValueComparer(IDataSet expectedDataSet, IDataSet actualDataSet, FailureHandler failureHandler, ValueComparer defaultValueComparer, java.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueComparer>> tableColumnValueComparers) Asserts the two specified IDataSets comparing their columns using the specified columnValueComparers or defaultValueComparer and handles failures using the specified failureHandler.
void	assertWithValueComparer(ITable expectedTable, ITable actualTable, FailureHandler failureHandler, ValueComparer defaultValueComparer, java.util.Map<java.lang.String,ValueComparer> columnValueComparers) Asserts the two specified ITables comparing their columns using the specified columnValueComparers or defaultValueComparer and handles failures using the specified failureHandler.
protected void	compareColumns(Column[] expectedColumns, Column[] actualColumns, ITableMetaData expectedMetaData, ITableMetaData actualMetaData, FailureHandler failureHandler)
protected void	compareData(ITable expectedTable, ITable actualTable, DbUnitAssert.ComparisonColumn[] comparisonCols, FailureHandler failureHandler)
protected void	compareData(ITable expectedTable, ITable actualTable, DbUnitAssert.ComparisonColumn[] comparisonCols, FailureHandler failureHandler, ValueComparer defaultValueComparer, java.util.Map<java.lang.String,ValueComparer> columnValueComparers)
protected void	compareData(ITable expectedTable, ITable actualTable, DbUnitAssert.ComparisonColumn[] comparisonCols, FailureHandler failureHandler, ValueComparer defaultValueComparer, java.util.Map<java.lang.String,ValueComparer> columnValueComparers, int rowNum, int columnNum)
protected boolean	compareRowCounts(ITable expectedTable, ITable actualTable, FailureHandler failureHandler, java.lang.String expectedTableName)
protected void	compareTableCounts(java.lang.String[] expectedNames, java.lang.String[] actualNames, FailureHandler failureHandler)
protected void	compareTableNames(java.lang.String[] expectedNames, java.lang.String[] actualNames, FailureHandler failureHandler)
protected void	compareTables(IDataSet expectedDataSet, IDataSet actualDataSet, java.lang.String[] expectedNames, FailureHandler failureHandler, ValueComparer defaultValueComparer, java.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueComparer>> tableColumnValueComparers)
protected FailureHandler	determineFailureHandler(FailureHandler failureHandler)
protected java.util.Map<java.lang.String,ValueComparer>	determineValidColumnValueComparers(java.util.Map<java.lang.String,ValueComparer> columnValueComparers, java.lang.String tableName)
protected ValueComparer	determineValidDefaultValueComparer(ValueComparer defaultValueComparer)
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueComparer>>	determineValidTableColumnValueComparers(java.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueComparer>> tableColumnValueComparers)
protected ValueComparer	determineValueComparer(java.lang.String columnName, ValueComparer defaultValueComparer, java.util.Map<java.lang.String,ValueComparer> columnValueComparers)
protected void	failIfNecessary(ITable expectedTable, ITable actualTable, FailureHandler failureHandler, int rowNum, java.lang.String columnName, java.lang.Object expectedValue, java.lang.Object actualValue, java.lang.String failMessage)
protected DbUnitAssert.ComparisonColumn[]	getComparisonColumns(java.lang.String expectedTableName, Column[] expectedColumns, Column[] actualColumns, FailureHandler failureHandler)
protected FailureHandler	getDefaultFailureHandler()
protected FailureHandler	getDefaultFailureHandler(Column[] additionalColumnInfo)
protected java.lang.String[]	getSortedTableNames(IDataSet dataSet)
void	setValueComparerDefaults(ValueComparerDefaults valueComparerDefaults)
protected boolean	skipCompare(java.lang.String columnName, java.lang.Object expectedValue, java.lang.Object actualValue) Method to last-minute intercept the comparison of a single expected and actual value.

Methods inherited from class java.lang.Object

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

Field Detail

valueComparerDefaults

protected ValueComparerDefaults valueComparerDefaults

Constructor Detail

DbUnitAssertBase

public DbUnitAssertBase()

Method Detail

getDefaultFailureHandler

protected FailureHandler getDefaultFailureHandler()

Returns:

The default failure handler

Since:

2.4

getDefaultFailureHandler

protected FailureHandler getDefaultFailureHandler(Column[] additionalColumnInfo)

Returns:

The default failure handler

Since:

2.4

getComparisonColumns

protected DbUnitAssert.ComparisonColumn[] getComparisonColumns(java.lang.String expectedTableName,
                                                               Column[] expectedColumns,
                                                               Column[] actualColumns,
                                                               FailureHandler failureHandler)

Parameters:

expectedTableName -

expectedColumns -

actualColumns -

failureHandler - The FailureHandler to be used when no datatype can be determined

Returns:

The columns to be used for the assertion, including the correct datatype

Since:

2.4

skipCompare

protected boolean skipCompare(java.lang.String columnName,
                              java.lang.Object expectedValue,
                              java.lang.Object actualValue)

Method to last-minute intercept the comparison of a single expected and actual value. Designed to be overridden in order to skip cell comparison by specific cell values.

Parameters:

columnName - The column being compared

expectedValue - The expected value to be compared

actualValue - The actual value to be compared

Returns:

false always so that the comparison is never skipped

Since:

2.4

determineFailureHandler

protected FailureHandler determineFailureHandler(FailureHandler failureHandler)

compareRowCounts

protected boolean compareRowCounts(ITable expectedTable,
                                   ITable actualTable,
                                   FailureHandler failureHandler,
                                   java.lang.String expectedTableName)
                            throws java.lang.Error

Throws:

java.lang.Error

compareColumns

protected void compareColumns(Column[] expectedColumns,
                              Column[] actualColumns,
                              ITableMetaData expectedMetaData,
                              ITableMetaData actualMetaData,
                              FailureHandler failureHandler)
                       throws DataSetException,
                              java.lang.Error

Throws:

DataSetException

java.lang.Error

compareTableCounts

protected void compareTableCounts(java.lang.String[] expectedNames,
                                  java.lang.String[] actualNames,
                                  FailureHandler failureHandler)
                           throws java.lang.Error

Throws:

java.lang.Error

compareTableNames

protected void compareTableNames(java.lang.String[] expectedNames,
                                 java.lang.String[] actualNames,
                                 FailureHandler failureHandler)
                          throws java.lang.Error

Throws:

java.lang.Error

getSortedTableNames

protected java.lang.String[] getSortedTableNames(IDataSet dataSet)
                                          throws DataSetException

Throws:

DataSetException

assertWithValueComparer

public void assertWithValueComparer(IDataSet expectedDataSet,
                                    IDataSet actualDataSet,
                                    FailureHandler failureHandler,
                                    ValueComparer defaultValueComparer,
                                    java.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueComparer>> tableColumnValueComparers)
                             throws DatabaseUnitException

Asserts the two specified IDataSets comparing their columns using the specified columnValueComparers or defaultValueComparer and handles failures using the specified failureHandler. This method ignores the table names, the columns order, the columns data type, and which columns are composing the primary keys.

Parameters:

expectedDataSet - IDataSet containing all expected results.

actualDataSet - IDataSet containing all actual results.

failureHandler - The failure handler used if the assert fails because of a data mismatch. Provides some additional information that may be useful to quickly identify the rows for which the mismatch occurred (for example by printing an additional primary key column). Can be null.

defaultValueComparer - ValueComparer to use with column value comparisons when the column name for the table is not in the tableColumnValueComparers Map. Can be null and will default to #getDefaultValueComparer().

tableColumnValueComparers - Map of ValueComparers to use for specific tables and columns. Key is table name, value is Map of column name in the table to ValueComparers. Can be null and will default to using #getDefaultColumnValueComparerMapForTable(String) or, if that is empty, defaultValueComparer for all columns in all tables.

Throws:

DatabaseUnitException

compareTables

protected void compareTables(IDataSet expectedDataSet,
                             IDataSet actualDataSet,
                             java.lang.String[] expectedNames,
                             FailureHandler failureHandler,
                             ValueComparer defaultValueComparer,
                             java.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueComparer>> tableColumnValueComparers)
                      throws DatabaseUnitException

Throws:

DatabaseUnitException

assertWithValueComparer

public void assertWithValueComparer(ITable expectedTable,
                                    ITable actualTable,
                                    FailureHandler failureHandler,
                                    ValueComparer defaultValueComparer,
                                    java.util.Map<java.lang.String,ValueComparer> columnValueComparers)
                             throws DatabaseUnitException

Asserts the two specified ITables comparing their columns using the specified columnValueComparers or defaultValueComparer and handles failures using the specified failureHandler. This method ignores the table names, the columns order, the columns data type, and which columns are composing the primary keys.

Parameters:

expectedTable - ITable containing all expected results.

actualTable - ITable containing all actual results.

failureHandler - The failure handler used if the assert fails because of a data mismatch. Provides some additional information that may be useful to quickly identify the rows for which the mismatch occurred (for example by printing an additional primary key column). Can be null.

defaultValueComparer - ValueComparer to use with column value comparisons when the column name for the table is not in the columnValueComparers Map. Can be null and will default to #getDefaultValueComparer().

columnValueComparers - Map of ValueComparers to use for specific columns. Key is column name in the table, value is ValueComparer to use in comparing expected to actual column values. Can be null and will default to using #getDefaultColumnValueComparerMapForTable(String) or, if that is empty, defaultValueComparer for all columns in the table.

Throws:

DatabaseUnitException

compareData

protected void compareData(ITable expectedTable,
                           ITable actualTable,
                           DbUnitAssert.ComparisonColumn[] comparisonCols,
                           FailureHandler failureHandler)
                    throws DataSetException

Parameters:

expectedTable - Table containing all expected results.

actualTable - Table containing all actual results.

comparisonCols - The columns to be compared, also including the correct DataTypes for comparison

failureHandler - The failure handler used if the assert fails because of a data mismatch. Provides some additional information that may be useful to quickly identify the rows for which the mismatch occurred (for example by printing an additional primary key column). Must not be null at this stage

Throws:

DataSetException

Since:

2.4

compareData

protected void compareData(ITable expectedTable,
                           ITable actualTable,
                           DbUnitAssert.ComparisonColumn[] comparisonCols,
                           FailureHandler failureHandler,
                           ValueComparer defaultValueComparer,
                           java.util.Map<java.lang.String,ValueComparer> columnValueComparers)
                    throws DatabaseUnitException

Parameters:

expectedTable - ITable containing all expected results.

actualTable - ITable containing all actual results.

comparisonCols - The columns to be compared, also including the correct DataTypes for comparison

failureHandler - The failure handler used if the assert fails because of a data mismatch. Provides some additional information that may be useful to quickly identify the rows for which the mismatch occurred (for example by printing an additional primary key column). Must not be null at this stage.

defaultValueComparer - ValueComparer to use with column value comparisons when the column name for the table is not in the columnValueComparers Map. Can be null and will default to #getDefaultValueComparer().

columnValueComparers - Map of ValueComparers to use for specific columns. Key is column name in the table, value is ValueComparer to use in comparing expected to actual column values. Can be null and will default to using #getDefaultColumnValueComparerMapForTable(String) or, if that is empty, defaultValueComparer for all columns in the table.

Throws:

DataSetException

DatabaseUnitException

Since:

2.4, 2.6.0

compareData

protected void compareData(ITable expectedTable,
                           ITable actualTable,
                           DbUnitAssert.ComparisonColumn[] comparisonCols,
                           FailureHandler failureHandler,
                           ValueComparer defaultValueComparer,
                           java.util.Map<java.lang.String,ValueComparer> columnValueComparers,
                           int rowNum,
                           int columnNum)
                    throws DatabaseUnitException

Throws:

DatabaseUnitException

failIfNecessary

protected void failIfNecessary(ITable expectedTable,
                               ITable actualTable,
                               FailureHandler failureHandler,
                               int rowNum,
                               java.lang.String columnName,
                               java.lang.Object expectedValue,
                               java.lang.Object actualValue,
                               java.lang.String failMessage)

determineValueComparer

protected ValueComparer determineValueComparer(java.lang.String columnName,
                                               ValueComparer defaultValueComparer,
                                               java.util.Map<java.lang.String,ValueComparer> columnValueComparers)

determineValidDefaultValueComparer

protected ValueComparer determineValidDefaultValueComparer(ValueComparer defaultValueComparer)

determineValidTableColumnValueComparers

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueComparer>> determineValidTableColumnValueComparers(java.util.Map<java.lang.String,java.util.Map<java.lang.String,ValueComparer>> tableColumnValueComparers)

determineValidColumnValueComparers

protected java.util.Map<java.lang.String,ValueComparer> determineValidColumnValueComparers(java.util.Map<java.lang.String,ValueComparer> columnValueComparers,
                                                                                           java.lang.String tableName)

setValueComparerDefaults

public void setValueComparerDefaults(ValueComparerDefaults valueComparerDefaults)