org.dbunit.IDatabaseTester Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbunit Show documentation

dbUnit is a JUnit extension (also usable from Ant and Maven) targeted for database-driven projects that, among other things, puts your database into a known state between test runs. This is an excellent way to avoid the myriad of problems that can occur when one test case corrupts the database and causes subsequent tests to fail or exacerbate the damage.

There is a newer version: 2.8.0

Show newest version

/*
 *
 * The DbUnit Database Testing Framework
 * Copyright (C)2002-2004, DbUnit.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
package org.dbunit;

import org.dbunit.database.IDatabaseConnection;
import org.dbunit.dataset.IDataSet;
import org.dbunit.operation.DatabaseOperation;

/**
 * This interface defines the behavior of a DatabaseTester, which is responsible
 * for adding DBUnit features as composition on existing test cases (instead of
 * extending DBTestCase directly).
 *
 * @author Andres Almiray ([email protected])
 * @author Last changed by: $Author$
 * @version $Revision$ $Date$
 * @since 2.2.0
 */
public interface IDatabaseTester
{
    /**
     * Close the specified connection.
     *
     * @deprecated since 2.4.4 define a user defined
     *             {@link #setOperationListener(IOperationListener)} in advance
     */
    @Deprecated
    void closeConnection(IDatabaseConnection connection) throws Exception;

    /**
     * Returns the test database connection.
     */
    IDatabaseConnection getConnection() throws Exception;

    /**
     * Returns the test dataset.
     */
    IDataSet getDataSet();

    /**
     * Gets the DatabaseOperation to call when starting the test.
     */
    DatabaseOperation getSetUpOperation();

    /**
     * Gets the DatabaseOperation to call when ending the test.
     */
    DatabaseOperation getTearDownOperation();

    /**
     * Sets the test dataset to use.
     */
    void setDataSet(IDataSet dataSet);

    /**
     * Sets the schema value.
     *
     * @deprecated since 2.4.3 Should not be used anymore. Every concrete
     *             {@link IDatabaseTester} implementation that needs a schema
     *             has the possibility to set it somehow in the constructor
     */
    @Deprecated
    void setSchema(String schema);

    /**
     * Sets the DatabaseOperation to call when starting the test.
     */
    void setSetUpOperation(DatabaseOperation setUpOperation);

    /**
     * Sets the DatabaseOperation to call when ending the test.
     */
    void setTearDownOperation(DatabaseOperation tearDownOperation);

    /**
     * TestCases must call this method inside setUp()
     */
    void onSetup() throws Exception;

    /**
     * TestCases must call this method inside tearDown()
     */
    void onTearDown() throws Exception;

    /**
     * @param operationListener
     *            The operation listener that is invoked on specific events in
     *            the {@link IDatabaseTester}.
     * @since 2.4.4
     */
    void setOperationListener(IOperationListener operationListener);
}