DbUnit Beispiel: DbUnit mit JUnit 4

Einleitung:

DbUnit arbeitet mit eigenen Testklassen, die auf JUnit 3 basieren. Das Arbeiten mit den DbUnit Testklassen bringt den Vorteil, dass dem Benutzer einige Methoden zur Verfügung gestellt werden, deren Funktionalität sonst erst implementiert werden muss. Der Nachteil dabei ist die zwingende Bindung an das JUnit 3 Framework. Dieses Beispiel zeigt, wie DbUnit auch mit JUnit 4 eingesetzt werden kann, wobei das Prinzip auch auf andere Frameworks wie TestNG oder das Arbeiten ohne Framework übertragbar ist.

Vorbereitung:

Dieses Beispiel arbeitet mit einer JavaDB Datenbank im client/server Modus. JavaDB muss installiert und der Server gestartet sein. Außerdem wird eine angelegte Datenbank benötigt. In dem Beispiel wird eine Datenbank mit dem Namen "javadb", dem Benutzernamen "myUsrName" und dem Passwort "myPwd" verwendet. Wenn die Datenbank unter einem anderen Namen oder mit anderem Benutzer angelegt wurde, müssen die Parameter im Beispielcode entsprechend angepasst werden.

Projekt anlegen:

Das Projekt wird als normales Java Projekt angelegt. Als Bibliotheken müssen folgende .jar Dateien hinzugefügt werden:

dbunit-2.4.8.jar
junit-3.8.2
slf4j-api-1.6.1.jar und slf4j-log4j12-1.6.1.jar
log4j-1.2.16.jar
derbyclient.jar (Aus JavaDB Installationsverzeichnis)

Ergebnis

Die folgenden .xml Dateien müssen im Projektordner erstellt werden:

Datensatz für Ausgangszustand der Testdatenbank: dataset.xml

<?xml version='1.0' encoding='UTF-8'?>
<dataset>
  <TESTTABLE ID="1" VORNAME="Andre" NACHNAME="Heidt"/>
  <TESTTABLE ID="2" VORNAME="Franz" NACHNAME="Meier"/>
  <TESTTABLE ID="3" VORNAME="Lisa" NACHNAME="Fischer"/>
  <TESTTABLE ID="4" VORNAME="Otto" NACHNAME="Sauer"/>
  <TESTTABLE ID="5" VORNAME="Johanna" NACHNAME="Buchholz"/>
  <TESTTABLE ID="6" VORNAME="Max Otto" NACHNAME="Stirlitz"/>
  <TESTTABLE ID="7" VORNAME="Florence" NACHNAME="Nightingale"/>
</dataset>

Datensatz für erwarteten DB Zustand nach Test: test1.xml

<?xml version='1.2' encoding='UTF-8'?>
<dataset>
  <TESTTABLE ID="1" VORNAME="Andre" NACHNAME="Heidt"/>
  <TESTTABLE ID="2" VORNAME="Franz" NACHNAME="Meier"/>
  <TESTTABLE ID="3" VORNAME="Lisa" NACHNAME="Fischer"/>
  <TESTTABLE ID="4" VORNAME="Otto" NACHNAME="Sauer"/>
  <TESTTABLE ID="5" VORNAME="Johanna" NACHNAME="Buchholz"/>
  <TESTTABLE ID="6" VORNAME="Max Otto" NACHNAME="Stirlitz"/>
  <TESTTABLE ID="7" VORNAME="Florence" NACHNAME="Nightingale"/>
  <TESTTABLE ID="8" VORNAME="TestVorname" NACHNAME="TestNachname"/>
</dataset>

Beispielcode:

Da die DbUnit eigenen Testklassen nicht verwendet werden, muss die JDBC Verbindung manuell aufgebaut werden und der DbUnit DatabaseConnection klasse übergeben werden. In diesem Beispiel werden die Datenbankverbindungen in einer separaten Klasse "DBConnection.java" verwaltet.

Datenbankverbindungen: DBconnection.java

package test;

import java.sql.*;
import org.dbunit.DatabaseUnitException;
import org.dbunit.database.DatabaseConnection;
import org.dbunit.database.IDatabaseConnection;

public class DBConnection {

    private static Connection connJDBC = null;
    private static IDatabaseConnection connection;
    final static String URL = "jdbc:derby://localhost:1527/javadb";
    final static String username = "myUsrName";
    final static String password = "myPwd";
    final static String driverClassName = "org.apache.derby.jdbc.ClientDriver";

    @SuppressWarnings("unchecked")
    private static void connect() {
        try {
            Class driver = Class.forName(driverClassName);
            connJDBC =
                    DriverManager.getConnection(URL, username, password);
        } catch (Exception e) {
            System.err.println("Exception: keine Verbindung zur Datenbank!");
            System.err.println(e.getMessage());
        }
    }

    public static Connection getConnJDBC() {
        if (connJDBC == null) {
            connect();
        }
        return connJDBC;
    }

    public static IDatabaseConnection getConnection() {
        if (connection == null) {
            try {
                connection = new DatabaseConnection(getConnJDBC(), null, true);
            } catch (DatabaseUnitException ex) {
            }
        }
        return connection;
    }

    public void jdbcClose() {
        try {
            connJDBC.close();
        } catch (Exception e) {
        }
        connJDBC = null;
    }

    public void dbUnitConnectionClose() {
        try {
            connection.close();
        } catch (Exception e) {
        }
        connection = null;
    }

    protected void finalize() {
        dbUnitConnectionClose();
        jdbcClose();
    }
}

Testklasse: DbUnitTest.java

package test;

import org.dbunit.dataset.xml.FlatXmlDataSet;
import java.io.FileOutputStream;
import junit.framework.Assert;
import org.dbunit.Assertion;
import java.io.File;
import org.dbunit.dataset.ITable;
import java.io.FileNotFoundException;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import java.io.FileInputStream;
import org.dbunit.DatabaseUnitException;
import java.sql.SQLException;
import org.dbunit.operation.DatabaseOperation;
import org.dbunit.dataset.IDataSet;
import org.dbunit.database.IDatabaseConnection;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

/**
 *
 * @author Andre Heidt
 */
public class DbUnitTest {

    @Before
    public void setUp() throws SQLException, DatabaseUnitException, FileNotFoundException {
        // Dataset initialisieren
        IDataSet dataSet =
                new FlatXmlDataSetBuilder().build(new FileInputStream("dataset.xml"));

        // Clean Insert = alles Loeschen und neu aufbauen
        try {
            DatabaseOperation.CLEAN_INSERT.execute(getConnection(), dataSet);
        } catch (DatabaseUnitException due) {
            throw due;
        } finally {
        }
    }

    @After
    public void tearDown() throws SQLException {
    }
    
    @Test
    public void test1() throws Exception {
        getConnection().getConnection().prepareStatement("INSERT INTO testtable "
                + "(id, vorname, nachname) VALUES (8, 'TestVorname', 'TestNachname')").execute();

        //Datensatz und spezielle Tabelle werden aus Datenbank geladen
        IDataSet databaseDataSet = getConnection().createDataSet();
        ITable actualTable = databaseDataSet.getTable("testtable");
        //Datensatz zum Vergleich wird aus .xml Datei geladen und daraus spezielle Tabelle gelesen.
        IDataSet expectedDataSet = new FlatXmlDataSetBuilder().build(new File("test1.xml"));
        ITable expectedTable = expectedDataSet.getTable("testtable");

        //Vergleich auf Gleichheit der beiden Tabellen
        Assertion.assertEquals(expectedTable, actualTable);
    }

    @Test
    public void test2() throws Exception {
        getConnection().getConnection().prepareStatement("DELETE FROM testtable "
                + "WHERE vorname = 'Andre'").execute();

        IDataSet databaseDataSet = getConnection().createDataSet();
        ITable actualTable = databaseDataSet.getTable("testtable");

        //Vergleichsdatensatz bewusst der Selbe wie in Test 1, damit Vergleich scheitert.
        IDataSet expectedDataSet = new FlatXmlDataSetBuilder().build(new File("test1.xml"));
        ITable expectedTable = expectedDataSet.getTable("testtable");

        //DbUnit bietet mit dem DiffCollectingFailureHandler umfangreichere
        //Moeglichkeiten Unterschiede auszuwerten. Fuer Beispiel siehe DbUnit Dokumentation
        //auf der DbUnit Webseite http://dbunit.sourceforge.net/howto.html
        if (actualTable.equals(expectedTable)) {
            Assert.assertTrue(true);
        } else {
            //Beispielhaftes schreiben eines Datensatzes in .xml Datei
            FlatXmlDataSet.write(databaseDataSet, new FileOutputStream("test2fail.xml"));
            Assert.fail("Erwartetes DataSet ist ungleich tatsaechlichem DataSet\n"
                    + "siehe \"test2fail.xml\" fuer tatsaechliches DataSet");
        }
    }

     public IDatabaseConnection getConnection(){
        return DBConnection.getConnection();
     }
}

Erklärung des Beispiels:

Der erste Test fügt der "testtable" Tabelle einen Eintrag hinzu und vergleicht den so entstandenen neuen Datensatz mit dem erwarteten, der aus "test1.xml" geladen wird.
Der zweite Test löscht einen Eintrag und vergleicht ebenfalls mit "test1.xml", was zum scheitern des Tests führt. Außerdem wird das schreiben eines Datensatzes in eine .xml Datei demonstriert.
Zwischen den Tests wird die Datenbank von der DbUnit Testklasse automatisch auf den gleichen Ausgangszustand gebracht, der in dataset.xml definiert ist.