DBUnit

Lizenz

GNU Lesser General Public License, Version 2.1

Letzter Untersuchungszeitpunkt

28.04.2011

DbUnit setzt auf JUnit auf und Erweitert es um die Fähigkeit, mit relationalen Datenbanken umzugehen. Mit Hilfe von DbUnit können Datenbanken, vor dem Ausführen von Tests, in einen bekannten Zustand versetzt werden, damit die einzelnen Tests sich nicht gegenseitig beeinflussen. Außerdem bietet DbUnit die Funktionalität, Datensätze aus- und einzulesen und miteinander zu vergleichen.

Fazit

Das Werkzeug bietet Einsteigern, mit Grundlagenkenntnissen bezüglich relationalen Datenbanken, schon nach kurzer Einarbeitung ein intuitiv nutzbares Hilfsmittel. Es eignet sich auch für größere Projekte, unter der Voraussetzung, dass die von den Entwicklern vorgeschlagenen "best pracitces" eingehalten werden. Speziell bedeutet es, möglichst kleine Test Datensätze zu verwenden, die speziell an die Tests angepasst sind, da sonst Probleme mit der Anordnung von Einträgen und daraus resultierend mit Triggern, foreign Keys etc. auftreten können. Es existieren Werkzeuge, die Teile der Funktionalität von DbUnit oder das ganze Framework sinnvoll ergänzen. Interessant sind z.B. die Tools Unitils und Jailer, da sie Lösungen für einige Probleme mit DbUnit anbieten.

Einsatzgebiete

DbUnit kommt bei Unit Tests mit relationalen Datenbanken zum Einsatz. Darüber hinaus kann es auch dafür verwendet werden, Datensätze ein und auszulesen, zum Beispiel zwecks Datenbank-Migration.

Einsatzumgebungen

DbUnit ist wird unabhängig von IDE's als Bibliothek angeboten. Zum Benutzen müssen jedoch zwangsweise ein Logger und Logging-Fassade "SLF4J" in das Testprojekt eingebunden werden.

Installation

Die Installation von DbUnit ist wegen Abhängigkeiten zu anderen Bibliotheken etwas komplexer. DbUnit selbst muss lediglich als .jar Datei in das Projekt eingebunden werden. Allerdings müssen darüber hinaus noch "Simple Logging Facade for Java" (SLF4J) mit einem der unterstützten Logger wie z.B. Log4J oder JCL eingebunden und konfiguriert werden. Darüber hinaus wird ein passender JDBC Treiber für die verwendete Datenbank benötigt.

Dokumentation

Die Dokumentation von DbUnit wird nur in englischer Sprache und im HTML Format, ohne direkte Downloadmöglichkeit, angeboten. Es gibt einen hilfreichen Kurzeinstieg, der die grundlegenden Funktionen von DbUnit verständlich vermittelt. Außerdem gibt es eine Dokumentation im JavaDoc Format.

Wartung der Projektseite

Es gibt eine kontinuierliche Versionsgeschichte, allerdings liegen oft größere Zeitabstände zwischen Updates. Die aktuellste Version 2.4.8 wurde, laut den Nachrichten auf der Hauptseite, am 01.09.2010 veröffentlicht und wurde bis zum letzten Untersuchungszeitpunkt (27.04.2011), noch nicht in die Versionsgeschichte aufgenommen. Dies vermittelt den Eindruck, dass die Seite selten bearbeitet und gepflegt wird.

Nutzergruppen und Support

Die Mailingliste für Hilfeanfragen unter der Adresse "dbunit-user@lists.sourceforge.net", wird auf der Webseite des Herstellers als der Beste Weg um Hilfe zu bekommen bezeichnet. Weiterhin gibt es ein Wiki und Tracking-Systeme für Bugs und Änderungswünsche.

Intuitive Nutzbarkeit

Das Arbeiten mit DbUnit ist intuitiv, unter der Voraussetzung, dass der Benutzer über Grundlagenkenntnisse in relationalen Datenbanken, SQL und JDBC verfügt.

Automatisierung

In Verbindung mit JUnit, sind die Testabläufe fast identisch zu reinen JUnit Tests. Es werden auch Ant-Tasks und Maven unterstützt.

Einführendes Beispiel

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:

Standard DbUnit Testklassen erben von DBTestCase und basieren auf Junit 3.8.2 Testklassen. Die Tests selbst müssen somit nach dem Prinzip von Junit 3 Testklassen aufgebaut werden und die selben Regeln bezüglich Namen der Methoden etc. einhalten.
Es ist auch möglich DbUnit mit JUnit 4 zu verwenden: Anleitung

Testklasse: DbUnitTest.java

package test;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import junit.framework.Assert;
import org.dbunit.Assertion;
import org.dbunit.DBTestCase;
import org.dbunit.PropertiesBasedJdbcDatabaseTester;
import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.ITable;
import org.dbunit.dataset.xml.FlatXmlDataSet;
import org.dbunit.dataset.xml.FlatXmlDataSetBuilder;
import org.dbunit.operation.DatabaseOperation;

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

    // JDBC Verbindung einrichten
    public DbUnitTest(String name) {
        super(name);
        System.setProperty(PropertiesBasedJdbcDatabaseTester.DBUNIT_DRIVER_CLASS,
                "org.apache.derby.jdbc.ClientDriver");
        System.setProperty(PropertiesBasedJdbcDatabaseTester.DBUNIT_CONNECTION_URL,
                "jdbc:derby://localhost:1527/javadb");
        System.setProperty(PropertiesBasedJdbcDatabaseTester.DBUNIT_USERNAME, "myUsrName");
        System.setProperty(PropertiesBasedJdbcDatabaseTester.DBUNIT_PASSWORD, "myPwd");
        // System.setProperty(PropertiesBasedJdbcDatabaseTester.DBUNIT_SCHEMA, "");
    }

    //.xml Datei mit Datensatz wird eingelesen. Vor Tests wird die Datenbank mit
    //default Einstellung "clean insert" ab und neu aufgebaut und mit Datensatz befuellt. 
    protected IDataSet getDataSet() throws Exception {
        return new FlatXmlDataSetBuilder().build(new FileInputStream("dataset.xml"));
    }

    @Override
    protected DatabaseOperation getSetUpOperation() throws Exception {
        //wenn getSetUpOperation() nicht ueberladen wird, wird clean insert gemacht
        //hier nur zur Veranschaulichung ueberladen - clean insert kann an
        //Bedarf angepasst werden
		
        return DatabaseOperation.CLEAN_INSERT;
    }

    @Override
    protected DatabaseOperation getTearDownOperation() throws Exception {
        //wenn getTearDownOperation() nicht ueberladen wird, wird kein cleanup gemacht
        //hier nur zur Veranschaulichung ueberladen - kann an
        //Bedarf angepasst werden, z.B. zum aufraumen der DB nach Test
		
        return DatabaseOperation.NONE;
    }

    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);
    }

    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");
        }
    }
}

Testsuite und Runner: Testsuite.java

package test;

import junit.framework.Test;
import junit.framework.TestSuite;

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

    public static void main(String[] args) {

        junit.swingui.TestRunner.run(Testsuite.class);

    }

    public static Test suite() {
        TestSuite suite = new TestSuite("DbUnit Test");
        suite.addTestSuite(DbUnitTest.class);
        return suite;
    }
}

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.

Detaillierte Beschreibung

Beispiel: DBUnit mit JUnit 4

Literatur

-

Zurück zur Werkzeugübersicht
Zurück zur CSI-Hauptseite

Name

Homepage