org.dbunit

Class DefaultPrepAndExpectedTestCase

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.dbunit.DatabaseTestCase

org.dbunit.DBTestCase

org.dbunit.DefaultPrepAndExpectedTestCase

All Implemented Interfaces:

junit.framework.Test, PrepAndExpectedTestCase

public class DefaultPrepAndExpectedTestCase
extends DBTestCase
implements PrepAndExpectedTestCase

Test case base class supporting prep data and expected data. Prep data is the data needed for the test to run. Expected data is the data needed to compare if the test ran successfully.

Since:

2.4.8

Version:

$Revision$ $Date$

Author:

Jeff Jensen jeffjensen AT users.sourceforge.net, Last changed by: $Author$

See Also:

org.dbunit.DefaultPrepAndExpectedTestCaseDiIT, org.dbunit.DefaultPrepAndExpectedTestCaseExtIT

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TEST_ERROR_MSG

Constructor Summary

Constructors

Constructor and Description
DefaultPrepAndExpectedTestCase() Create new instance.
DefaultPrepAndExpectedTestCase(DataFileLoader dataFileLoader, IDatabaseTester databaseTester) Create new instance with specified dataFileLoader and databaseTester.
DefaultPrepAndExpectedTestCase(java.lang.String name) Create new instance with specified test case name.

Method Summary

Modifier and Type	Method and Description
ITable	applyColumnFilters(ITable table, java.lang.String[] excludeColumns, java.lang.String[] includeColumns) Apply the specified exclude and include column filters to the specified table.
void	cleanupData() Cleanup tables specified in prep and expected datasets, using the provided databaseTester.
protected void	compareData(SortedTable expectedSortedTable, SortedTable actualSortedTable, Column[] additionalColumnInfo, ValueComparer defaultValueComparer, java.util.Map<java.lang.String,ValueComparer> columnValueComparers) Compare the tables, enables easy overriding.
void	configureTest(VerifyTableDefinition[] verifyTableDefinitions, java.lang.String[] prepDataFiles, java.lang.String[] expectedDataFiles) Configure the test.
IDatabaseTester	getDatabaseTester() Get the databaseTester.
DataFileLoader	getDataFileLoader() Get the dataFileLoader.
IDataSet	getDataSet() Returns the test dataset.
IDataSet	getExpectedDataset() Get the expected dataset, created from the expectedDataFiles.
ExpectedDataSetAndVerifyTableDefinitionVerifier	getExpectedDataSetAndVerifyTableDefinitionVerifier()
IDataSet	getPrepDataset() Get the prep dataset, created from the prepDataFiles.
protected DatabaseOperation	getSetUpOperation() Returns the database operation executed in test setup.
protected DatabaseOperation	getTearDownOperation() Returns the database operation executed in test cleanup.
VerifyTableDefinition[]	getVerifyTableDefs() Get the tableDefs.
ITable	loadTableDataFromDatabase(java.lang.String tableName, IDatabaseConnection connection)
ITable	loadTableDataFromDataSet(java.lang.String tableName)
protected Column[]	makeAdditionalColumnInfo(ITable expectedTable, java.lang.String[] excludeColumns) Don't add excluded columns to additionalColumnInfo as they are not found and generate a not found message in the fail message.
IDataSet	makeCompositeDataSet(java.lang.String[] dataFiles, java.lang.String dataFilesName) Make a IDataSet from the specified files.
IDatabaseTester	newDatabaseTester() Creates a new IDatabaseTester.
void	postTest() Execute all post-test steps.
void	postTest(boolean verifyData) Execute post-test steps.
void	preTest() Execute pre-test steps.
void	preTest(VerifyTableDefinition[] tables, java.lang.String[] prepDataFiles, java.lang.String[] expectedDataFiles) Convenience method to call configureTest() and preTest().
java.lang.Object	runTest(VerifyTableDefinition[] verifyTables, java.lang.String[] prepDataFiles, java.lang.String[] expectedDataFiles, PrepAndExpectedTestCaseSteps testSteps) Run the DbUnit test.
void	setDatabaseTester(IDatabaseTester databaseTester) Set the databaseTester.
void	setDataFileLoader(DataFileLoader dataFileLoader) Set the dataFileLoader.
void	setExpectedDataSetAndVerifyTableDefinitionVerifier(ExpectedDataSetAndVerifyTableDefinitionVerifier expectedDataSetAndVerifyTableDefinitionVerifier)
void	setExpectedDs(IDataSet expectedDataSet) Set the expectedDs.
void	setPrepDs(IDataSet prepDataSet) Set the prepDs.
void	setupData() Use the provided databaseTester to prep the database with the provided prep dataset.
void	setVerifyTableDefs(VerifyTableDefinition[] verifyTableDefs) Set the tableDefs.
protected void	tearDown()
void	verifyData() For the provided VerifyTableDefinitions, verify each table's actual results are as expected.
protected void	verifyData(IDatabaseConnection connection, VerifyTableDefinition verifyTableDefinition)
protected void	verifyData(ITable expectedTable, ITable actualTable, java.lang.String[] excludeColumns, java.lang.String[] includeColumns, ValueComparer defaultValueComparer, java.util.Map<java.lang.String,ValueComparer> columnValueComparers) For the specified expected and actual tables (and excluding and including the specified columns), verify the actual data is as expected.

Methods inherited from class org.dbunit.DBTestCase

getConnection

Methods inherited from class org.dbunit.DatabaseTestCase

closeConnection, getOperationListener, setUp, setUpDatabaseConfig

Methods inherited from class junit.framework.TestCase

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runBare, runTest, setName, toString

Methods inherited from class java.lang.Object

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

Field Detail

TEST_ERROR_MSG

public static final java.lang.String TEST_ERROR_MSG

See Also:

Constant Field Values

Constructor Detail

DefaultPrepAndExpectedTestCase

public DefaultPrepAndExpectedTestCase()

Create new instance.

DefaultPrepAndExpectedTestCase

public DefaultPrepAndExpectedTestCase(DataFileLoader dataFileLoader,
                                      IDatabaseTester databaseTester)

Create new instance with specified dataFileLoader and databaseTester.

Parameters:

dataFileLoader - Load to use for loading the data files.

databaseTester - Tester to use for database manipulation.

DefaultPrepAndExpectedTestCase

public DefaultPrepAndExpectedTestCase(java.lang.String name)

Create new instance with specified test case name.

Parameters:

name - The test case name.

Method Detail

newDatabaseTester

public IDatabaseTester newDatabaseTester()
                                  throws java.lang.Exception

Creates a new IDatabaseTester. Default implementation returns a PropertiesBasedJdbcDatabaseTester. This implementation returns the databaseTester set by the test.

Overrides:

newDatabaseTester in class DBTestCase

Throws:

java.lang.Exception

getDataSet

public IDataSet getDataSet()
                    throws java.lang.Exception

Returns the test dataset. Returns the prep dataset.

Specified by:

getDataSet in class DatabaseTestCase

Throws:

java.lang.Exception

configureTest

public void configureTest(VerifyTableDefinition[] verifyTableDefinitions,
                          java.lang.String[] prepDataFiles,
                          java.lang.String[] expectedDataFiles)
                   throws java.lang.Exception

Configure the test. Call this method before performing the test steps.

Specified by:

configureTest in interface PrepAndExpectedTestCase

Parameters:

verifyTableDefinitions - Table definitions to verify after test execution.

prepDataFiles - The prep data files (as classpath resources) to load and insert contents into the database as seed data.

expectedDataFiles - The expected data files (as classpath resources) to load as expected data and verify actual data matches at test end.

Throws:

java.lang.Exception

preTest

public void preTest()
             throws java.lang.Exception

Execute pre-test steps. Call this method before performing the test steps.

Specified by:

preTest in interface PrepAndExpectedTestCase

Throws:

java.lang.Exception

preTest

public void preTest(VerifyTableDefinition[] tables,
                    java.lang.String[] prepDataFiles,
                    java.lang.String[] expectedDataFiles)
             throws java.lang.Exception

Convenience method to call configureTest() and preTest().

Specified by:

preTest in interface PrepAndExpectedTestCase

Parameters:

tables - Table definitions to verify after test execution.

prepDataFiles - The prep data files (as classpath resources) to load and insert contents into the database as seed data.

expectedDataFiles - The expected data files (as classpath resources) to load as expected data and verify actual data matches at test end.

Throws:

java.lang.Exception

runTest

public java.lang.Object runTest(VerifyTableDefinition[] verifyTables,
                                java.lang.String[] prepDataFiles,
                                java.lang.String[] expectedDataFiles,
                                PrepAndExpectedTestCaseSteps testSteps)
                         throws java.lang.Exception

Run the DbUnit test.

Specified by:

runTest in interface PrepAndExpectedTestCase

Parameters:

verifyTables - Table definitions to verify after test execution.

prepDataFiles - The prep data files (as classpath resources) to load and insert contents into the database as seed data.

expectedDataFiles - The expected data files (as classpath resources) to load as expected data and verify actual data matches at test end.

testSteps - The test steps to run.

Returns:

User defined object from running the test steps.

Throws:

java.lang.Exception

postTest

public void postTest()
              throws java.lang.Exception

Execute all post-test steps. Call this method after performing the test steps.

Specified by:

postTest in interface PrepAndExpectedTestCase

Throws:

java.lang.Exception

postTest

public void postTest(boolean verifyData)
              throws java.lang.Exception

Execute post-test steps. Call this method after performing the test steps.

Specified by:

postTest in interface PrepAndExpectedTestCase

Parameters:

verifyData - Specify true to perform verify data steps, false to not. Useful to specify false when test has failure in progress (e.g. an exception) and verifying data would fail, masking original test failure.

Throws:

java.lang.Exception

cleanupData

public void cleanupData()
                 throws java.lang.Exception

Cleanup tables specified in prep and expected datasets, using the provided databaseTester. See IDatabaseTester.onTearDown().

Specified by:

cleanupData in interface PrepAndExpectedTestCase

Throws:

java.lang.Exception

tearDown

protected void tearDown()
                 throws java.lang.Exception

Overrides:

tearDown in class DatabaseTestCase

Throws:

java.lang.Exception

setupData

public void setupData()
               throws java.lang.Exception

Use the provided databaseTester to prep the database with the provided prep dataset. See IDatabaseTester.onSetup().

Throws:

java.lang.Exception

getSetUpOperation

protected DatabaseOperation getSetUpOperation()
                                       throws java.lang.Exception

Description copied from class: DatabaseTestCase

Returns the database operation executed in test setup.

Overrides:

getSetUpOperation in class DatabaseTestCase

Throws:

java.lang.Exception

getTearDownOperation

protected DatabaseOperation getTearDownOperation()
                                          throws java.lang.Exception

Description copied from class: DatabaseTestCase

Returns the database operation executed in test cleanup.

Overrides:

getTearDownOperation in class DatabaseTestCase

Throws:

java.lang.Exception

verifyData

public void verifyData()
                throws java.lang.Exception

For the provided VerifyTableDefinitions, verify each table's actual results are as expected. Uses the connection from the provided databaseTester.

Specified by:

verifyData in interface PrepAndExpectedTestCase

Throws:

java.lang.Exception

verifyData

protected void verifyData(IDatabaseConnection connection,
                          VerifyTableDefinition verifyTableDefinition)
                   throws java.lang.Exception

Throws:

java.lang.Exception

loadTableDataFromDataSet

public ITable loadTableDataFromDataSet(java.lang.String tableName)
                                throws DataSetException

Throws:

DataSetException

loadTableDataFromDatabase

public ITable loadTableDataFromDatabase(java.lang.String tableName,
                                        IDatabaseConnection connection)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

verifyData

protected void verifyData(ITable expectedTable,
                          ITable actualTable,
                          java.lang.String[] excludeColumns,
                          java.lang.String[] includeColumns,
                          ValueComparer defaultValueComparer,
                          java.util.Map<java.lang.String,ValueComparer> columnValueComparers)
                   throws DatabaseUnitException

For the specified expected and actual tables (and excluding and including the specified columns), verify the actual data is as expected.

Parameters:

expectedTable - The expected table to compare the actual table to.

actualTable - The actual table to compare to the expected table.

excludeColumns - The column names to exclude from comparison. See DefaultColumnFilter.excludeColumn(String) .

includeColumns - The column names to only include in comparison. See DefaultColumnFilter.includeColumn(String) .

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.

columnValueComparers - Map of ValueComparers to use for specific columns. Key is column name, value is the ValueComparer. Can be null and will default to defaultValueComparer for all columns in all tables.

Throws:

DatabaseUnitException

compareData

protected void compareData(SortedTable expectedSortedTable,
                           SortedTable actualSortedTable,
                           Column[] additionalColumnInfo,
                           ValueComparer defaultValueComparer,
                           java.util.Map<java.lang.String,ValueComparer> columnValueComparers)
                    throws DatabaseUnitException

Compare the tables, enables easy overriding.

Throws:

DatabaseUnitException

makeAdditionalColumnInfo

protected Column[] makeAdditionalColumnInfo(ITable expectedTable,
                                            java.lang.String[] excludeColumns)
                                     throws DataSetException

Don't add excluded columns to additionalColumnInfo as they are not found and generate a not found message in the fail message.

Throws:

DataSetException

makeCompositeDataSet

public IDataSet makeCompositeDataSet(java.lang.String[] dataFiles,
                                     java.lang.String dataFilesName)
                              throws DataSetException

Make a IDataSet from the specified files.

Parameters:

dataFiles - Represents the array of dbUnit data files.

Returns:

The composite dataset.

Throws:

DataSetException - On dbUnit errors.

applyColumnFilters

public ITable applyColumnFilters(ITable table,
                                 java.lang.String[] excludeColumns,
                                 java.lang.String[] includeColumns)
                          throws DataSetException

Apply the specified exclude and include column filters to the specified table.

Parameters:

table - The table to apply the filters to.

excludeColumns - The exclude filters; use null or empty array to mean exclude none.

includeColumns - The include filters; use null to mean include all.

Returns:

The filtered table.

Throws:

DataSetException

getPrepDataset

public IDataSet getPrepDataset()

Get the prep dataset, created from the prepDataFiles.

Specified by:

getPrepDataset in interface PrepAndExpectedTestCase

Returns:

The prep dataset.

getExpectedDataset

public IDataSet getExpectedDataset()

Get the expected dataset, created from the expectedDataFiles.

Specified by:

getExpectedDataset in interface PrepAndExpectedTestCase

Returns:

The expected dataset.

getDatabaseTester

public IDatabaseTester getDatabaseTester()

Get the databaseTester.

Overrides:

getDatabaseTester in class DatabaseTestCase

Returns:

The databaseTester.

See Also:

#databaseTester}.

setDatabaseTester

public void setDatabaseTester(IDatabaseTester databaseTester)

Set the databaseTester.

Parameters:

databaseTester - The databaseTester to set.

See Also:

#databaseTester}.

getDataFileLoader

public DataFileLoader getDataFileLoader()

Get the dataFileLoader.

Returns:

The dataFileLoader.

See Also:

#dataFileLoader}.

setDataFileLoader

public void setDataFileLoader(DataFileLoader dataFileLoader)

Set the dataFileLoader.

Parameters:

dataFileLoader - The dataFileLoader to set.

See Also:

#dataFileLoader}.

setPrepDs

public void setPrepDs(IDataSet prepDataSet)

Set the prepDs.

Parameters:

prepDataSet - The prepDs to set.

See Also:

#prepDataSet}.

setExpectedDs

public void setExpectedDs(IDataSet expectedDataSet)

Set the expectedDs.

Parameters:

expectedDataSet - The expectedDs to set.

See Also:

#expectedDataSet}.

getVerifyTableDefs

public VerifyTableDefinition[] getVerifyTableDefs()

Get the tableDefs.

Returns:

The tableDefs.

See Also:

#verifyTableDefs}.

setVerifyTableDefs

public void setVerifyTableDefs(VerifyTableDefinition[] verifyTableDefs)

Set the tableDefs.

Parameters:

verifyTableDefs - The tableDefs to set.

See Also:

#verifyTableDefs}.

getExpectedDataSetAndVerifyTableDefinitionVerifier

public ExpectedDataSetAndVerifyTableDefinitionVerifier getExpectedDataSetAndVerifyTableDefinitionVerifier()

setExpectedDataSetAndVerifyTableDefinitionVerifier

public void setExpectedDataSetAndVerifyTableDefinitionVerifier(ExpectedDataSetAndVerifyTableDefinitionVerifier expectedDataSetAndVerifyTableDefinitionVerifier)