uklance / tader

A tool to quickly insert relational test data by generating the stuff you don't care about
8 stars 1 forks source link
database insert-records jdbc test testing-tools

Tader

Tader Test Data Build Status Coverage Status

Tader helps with generating test data prior to testing DAO's, stored procedures or any other service that requires relational data.

How It Works

Tader has knowledge of your relational database model including primary keys, foreign keys and nullable columns. It allows you to succintly generate test data by specifying only the fields you are interested in. Any required fields that were not specified will be generated, including foreign key records. This leaves your test case succint and free from the noise of populating uninteresting fields.

Instantiating Tader

The simplest way to get an instance of Tader is via the TaderBuilder

import org.tader.*;
import org.tader.jdbc.*;
import org.tader.builder.*;

ConnectionSource connectionSource = new SimpleConnectionSource(
   "org.h2.Driver", 
   "jdbc:h2:mem:test;DB_CLOSE_DELAY=-1",
   "user",
   "password"
);

Tader tader = new TaderBuilder()
   .withCoreServices()
   .withCoreJdbcServices()
   .withCoreTypeCoercerContributions()
   .withCoreAutoGenerateSourceContributions()
   .withConnectionSource(connectionSource)
   .withServiceInstance(NameTranslator.class, UpperCamelNameTranslator.class)
   .build();

Inserting Records

Let's assume we have the following two tables

CREATE TABLE AUTHOR (
   AUTHOR_ID int not null GENERATED ALWAYS AS IDENTITY (START WITH 1, INCREMENT BY 1),
   AUTHOR_NAME varchar(255) not null,
   DATE_OF_BIRTH date not null,
   AUTHOR_HOBBY varchar(255),
   constraint PK_AUTHOR primary key(AUTHOR_ID)
)

CREATE TABLE BOOK (
   BOOK_ID int not null GENERATED ALWAYS AS IDENTITY (START WITH 1, INCREMENT BY 1),
   BOOK_NAME varchar(255) not null,
   AUTHOR_ID int not null,
   constraint PK_BOOK primary key(BOOK_ID),
   constraint FK_BOOK_AUTHOR foreign key(AUTHOR_ID) references AUTHOR(AUTHOR_ID)
)
Inserting foreign key records implicitly
import static org.junit.Assert.*;
...
PartialEntity bookPartial = new PartialEntity("book");

Entity book = tader.insert(bookPartial);
assertEquals("bookName0", book.getString("bookName"));
assertEquals(1, book.getInteger("bookId").intValue());

Entity author = book.getEntity("authorId");
assertEquals("authorName0", author.getString("authorName"));
assertEquals(1, author.getInteger("authorId").intValue());
Inserting foreign key records by PartialEntity
PartialEntity authorPartial = new PartialEntity("author")
   .withValue("authorName", "Stephen King");

PartialEntity bookPartial = new PartialEntity("book")
   .withValue("authorId", authorPartial);

Entity book = tader.insert(bookPartial);
assertEquals("bookName0", book.getString("bookName"));
assertEquals(1, book.getInteger("bookId").intValue());

Entity author = book.getEntity("authorId");
assertEquals("Stephen King", author.getString("authorName"));
assertEquals(1, author.getInteger("authorId").intValue());

AutoGenerateSource / AutoGenerateStrategy

Invoking TaderBuilder.withCoreAutoGenerateSourceContributions() will configure auto-generate strategies for the following SQL types:

If you want to configure your own custom AutoGenerateStrategy implementations, this can be done by TaderBuilder.withAutoGenerateStrategy (a convenience method which contributes to the AutoGenerateSource service).

import java.sql.Types;
import java.util.Random;
...
final Random random = new Random();
AutoGenerateStrategy randomIntegerStrategy = new AutoGenerateStrategy() {
   public Object generate(PropertyDef propDef, int increment) {
      return random.nextInt();
   }
};
AutoGenerateStrategy fooStringStrategy = new ConstantAutoGenerateStrategy("foo");

Tader tader = new TaderBuilder()
   .with...
   .withAutoGenerateStrategy(Types.INTEGER, randomIntegerStrategy)
   .withAutoGenerateStrategy("author", "authorHobby", fooStringStrategy)
   .build();
Autogenerate for nullable columns

By default, nullable columns will not be auto-generated unless a specific auto-generate strategy is configured for the entity property. To auto-generate for nullable columns by default, set the 'tader.DEFAULT_AUTOGENERATE_NULLABLE' property to true

Tader tader = new TaderBuilder()
   .with...
   .withProperty(TaderConstants.PROP_DEFAULT_AUTOGENERATE_NULLABLE, "true")
   .build();

NameTranslator

The NameTranslator service converts between entity name / property names used by tader to table name / column names in the database. The NoopNameTranslator is configured by TaderBuilder.withCoreJdbcServices() which simply uses the table and column names in the database. If you'd prefer to use author and authorName in your tests instead of AUTHOR and AUTHOR_NAME, configure the UpperCamelNameTranslator.

Tader tader = new TaderBuilder()
   .with...
   .withServiceInstance(NameTranslator.class, UpperCamelNameTranslator.class)
   .build();

TypeCoercer

TODO

Examples

Currently, the best example is TaderIntegrationTest.java.

TODO