org.dbunit.JdbcDatabaseTester 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 java.sql.Connection;
import java.sql.DriverManager;

import org.dbunit.database.DatabaseConnection;
import org.dbunit.database.IDatabaseConnection;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * DatabaseTester that uses JDBC's Driver Manager to create connections.

 *
 * @author Andres Almiray ([email protected])
 * @author Felipe Leme ([email protected])
 * @version $Revision: 928 $
 * @since 2.2
 */
public class JdbcDatabaseTester extends AbstractDatabaseTester
{

    /**
     * Logger for this class
     */
    private static final Logger logger = LoggerFactory.getLogger(JdbcDatabaseTester.class);

    private String connectionUrl;
    private String driverClass;
    private String password;
    private String username;

    /**
     * Creates a new JdbcDatabaseTester with the specified properties.

     * Username and Password are set to null.
     *
     * @param driverClass the classname of the JDBC driver to use
     * @param connectionUrl the connection url
     * @throws ClassNotFoundException If the given driverClass was not found
     */
    public JdbcDatabaseTester( String driverClass, String connectionUrl ) 
    throws ClassNotFoundException
    {
        this( driverClass, connectionUrl, null, null );
    }

    /**
     * Creates a new JdbcDatabaseTester with the specified properties.
     *
     * @param driverClass the classname of the JDBC driver to use
     * @param connectionUrl the connection url
     * @param username a username that can has access to the database
     * @param password the user's password
     * @throws ClassNotFoundException If the given driverClass was not found
     */
    public JdbcDatabaseTester( String driverClass, String connectionUrl, String username,
            String password ) 
    throws ClassNotFoundException
    {
        this(driverClass, connectionUrl, username, password, null);
    }

    /**
     * Creates a new JdbcDatabaseTester with the specified properties.
     *
     * @param driverClass the classname of the JDBC driver to use
     * @param connectionUrl the connection url
     * @param username a username that can has access to the database - can be null
     * @param password the user's password - can be null
     * @param schema the database schema to be tested - can be null
     * @throws ClassNotFoundException If the given driverClass was not found
     * @since 2.4.3
     */
    public JdbcDatabaseTester( String driverClass, String connectionUrl, String username,
            String password, String schema ) 
    throws ClassNotFoundException
    {
        super(schema);
        this.driverClass = driverClass;
        this.connectionUrl = connectionUrl;
        this.username = username;
        this.password = password;
        
        assertNotNullNorEmpty( "driverClass", driverClass );
        Class.forName( driverClass );
    }

    public IDatabaseConnection getConnection() throws Exception
    {
        logger.debug("getConnection() - start");

        assertNotNullNorEmpty( "connectionUrl", connectionUrl );
        Connection conn = null;
        if( username == null && password == null ){
            conn = DriverManager.getConnection( connectionUrl );
        }else{
            conn = DriverManager.getConnection( connectionUrl, username, password );
        }
        return new DatabaseConnection( conn, getSchema() );
    }

    public String toString()
    {
        StringBuffer sb = new StringBuffer();
        sb.append(getClass().getName()).append("[");
        sb.append("connectionUrl=").append(this.connectionUrl);
        sb.append(", driverClass=").append(this.driverClass);
        sb.append(", username=").append(this.username);
        sb.append(", password=**********");
        sb.append(", schema=").append(super.getSchema());
        sb.append("]");
        return sb.toString();
    }

}