Unit testing: unitils & dbmaintain

Unit testing unitils - dbmaintain Filip Neven

Presentation goal Demonstrate the added value Unitils can give to your projects

Unitils ‘Mission statement’ Provide a good testing environment

Why Unitils? Tackle complexity of persistence layer testing Many practical problems

A lot of boilerplate code required Offer all kinds of useful functionalities Assertion using reflection

Features by example Persistence layer testing

Introduction Originates from Ordina Testing & QA task force (2005) Brainstorm

Testing guidelines: www.unitils.org/guidelines.html

Supporting code  Unitils open source project

Features Persistence layer testing JPA

Hibernate Automatic database maintenance DbMaintain General testing utilities Reflection assert Spring integration

Persistence layer testing Important to test persistence layer Queries are often complex

Two separated parts -> mismatches more likely Testing persistence is difficult Test database

Provide test data Lot of boilerplate code required Depends on technology: Plain old JDBC, ORM, spring

Persistence layer testing guidelines Need control over database & test data Test database

Small dataset per group of related tests Typically one dataset per test class

Separate developer schema’s Separate schema per developer Develop in isolation

Persistence layer testing – DAO example public class UserDao { @PersistenceContext private EntityManager entityManager; public List<User> findByLastName(String lastName) { return entityManager.createQuery( “ select u from User u where u.lastName = :lastName”) .setParameter(“lastName”, lastName) .getResultList(); } // ... }

Persistence layer testing – test example @DataSet @JpaEntityManagerFactory (persistenceUnit=“eshop”, configFiles={“persistence-test.xml”}) public class UserDaoTest extends UnitilsJUnit4 { @PersistenceContext EntityManager entityManager; UserDao userDao; @Before public void init() { JpaUnitils.injectEntityManagerInto (userDao); } @Test public void testFindByLastName() { List<User> users = userDao.findByLastName("Doe"); assertPropertyLenientEquals ("userName", Arrays.asList("johnDoe", "janeDoe"), users); } }

Loading test data - example @DataSet @JpaEntityManagerFactory(persistenceUnit=“eshop”, configFiles={“persistence-test.xml”}) public class UserDaoTest extends UnitilsJUnit4 { @PersistenceContext EntityManager entityManager; UserDao userDao; @Before public void init() { JpaUnitils.injectEntityManagerInto(userDao); } @Test public void testFindByLastName() { List<User> users = userDao.findByLastName("Doe"); assertPropertyLenientEquals("userName", Arrays.asList("johnDoe", "janeDoe"), users); } }

Loading test data @DataSet Dbunit dataset is loaded before each test Tables are cleared first Default file: same package & name as class UserDaoTest.xml: <?xml version='1.0' encoding='UTF-8'?> <dataset [… XSD declaration …]> <user id="1" userName="johnDoe" /> <user id="2" userName="janeRoe" /> <user id="3" userName="janeDoe" /> </dataset>  Put database in known state before each test

Loading test data - possibilities Custom file name Method - specific data set Load multiple datasets @DataSet("UserData.xml") public class UserDaoTest extends UnitilsJUnit4 { @DataSet("UserData-adminUser.xml") public void testFindAdminUsers() { @DataSet({"ReferenceData.xml", "UserData.xml"}) public class UserDaoTest extends UnitilsJUnit4 {

Loading test data - XSD XSD for validation & auto completion Automatically generated by Unitils <?xml version='1.0' encoding='UTF-8'?> <dataset xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance" xsi:noNamespaceSchemaLocation="<path to dataset.xsd file>" > <user id="1" userName="johnDoe" age="54"/> <user id="2" userName="janeRoe" lastName="Roe"/> <user id="3" userName="janeDoe" firstName="Jane"/> </dataset>

Loading test data – multi-schema support Multi – schema dataset support <?xml version='1.0' encoding='UTF-8'?> <dataset xmlns:schema1="SCHEMA1" xmlns:schema2="SCHEMA2" > < schema1 :user id="1" userName="johnDoe" age="54"/> < schema2 :user id="2" userName="janeRoe" lastName="Roe"/> </dataset>

Loading test data – dbunit issues Solve annoying dbunit issue With Unitils: <?xml version='1.0' encoding='UTF-8'?> <dataset [… namespace declaration …]> <user id="1" userName="johnDoe" lastName="Roe"/> <user id="2" userName="janeRoe"/> </dataset> With plain dbunit: <?xml version='1.0' encoding='UTF-8'?> <dataset [… namespace declaration …]> <user id="1" userName="johnDoe" lastName="Roe" /> <user id="2" userName="janeRoe" lastName=“[null]"/> </dataset> When using dbunit directly, this is not possible: Once you’ve used a column, you must use it in every record

Verify database contents @ExpectedDataSet Verify database contents after test execution UserDaoTest.testCreateNewUser-expected.xml: <?xml version='1.0' encoding='UTF-8'?> <dataset [… namespace declaration …]> <user id="1" userName="johnDoe"/> </dataset> @ExpectedDataSet public void testCreateNewUser() { // ... }

Transaction support Run each test in a transaction Avoid problems with ‘select for update’ or deferred check constraints

Required in some environments Possible to rollback after each test Facilitates test isolation: DB stays in original state

Enables using pre-filled test DB Default behavior: commit after every test Modify using @Transactional Powered by spring

Transaction support - example @DataSet @Transactional(TransactionMode.ROLLBACK) @JpaEntityManagerFactory(persistenceUnit=“eshop”, configFiles={“persistence-test.xml”}) public class UserDaoTest extends UnitilsJUnit4 { @PersistenceContext EntityManager entityManager; UserDao userDao; @Before public void init() { JpaUnitils.injectEntityManagerInto(userDao); } @Test public void testFindByLastName() { List<User> users = userDao.findByLastName("Doe"); assertPropertyLenientEquals("userName", Arrays.asList("johnDoe", "janeDoe"), users); } }

JPA integration - example @DataSet @JpaEntityManagerFactory(persistenceUnit=“eshop”, configFiles={“persistence-test.xml”}) public class UserDaoTest extends UnitilsJUnit4 { @PersistenceContext EntityManager entityManager; UserDao userDao; @Before public void init() { JpaUnitils.injectEntityManagerInto (userDao); } @Test public void testFindByLastName() { List<User> users = userDao.findByLastName("Doe"); assertPropertyLenientEquals("userName", Arrays.asList("johnDoe", "janeDoe"), users); } }

JPA integration @JpaEntityManagerFactory Create EntityManagerFactory

Connects with unit test database

New EntityManager for each test Attached to unitils transaction Powered by spring

JPA integration – persistence providers Supported persistence providers Hibernate

JPA integration – mapping test Entity / database mapping test Verifies if database structure is in sync with entities

Only works when persistence provider = hibernate @Test public void testMappingToDatabase() { JpaUnitils.assertMappingWithDatabaseConsistent(); } Found mismatches between Java objects and database tables. Applying DDL statements should resolve the problem: alter table PERSON add column lastName varchar(255); alter table PRODUCT add column barCode varchar(255);

Reflection assert - example @DataSet @JpaEntityManagerFactory(persistenceUnit=“eshop”, configFiles={“persistence-test.xml”}) public class UserDaoTest extends UnitilsJUnit4 { @PersistenceContext EntityManager entityManager; UserDao userDao; @Before public void init() { JpaUnitils.injectEntityManagerInto(userDao); } @Test public void testFindByLastName() { List<User> users = userDao.findByLastName("Doe"); assertPropertyLenientEquals ("userName", Arrays.asList("johnDoe", "janeDoe"), users); } }

Reflection assert ReflectionAssert assertReflectionEquals(expectedUser, actualUser); Compares all fields using reflection

Recursively compares inner objects

Loops over collections and arrays

Reflection assert - leniency Leniency Keep your tests maintainable

Only verify what’s relevant for the test Lenient by default: Lenient number types

Lenient collection types Leniency options: assertLenientEquals ( ... ) Lenient order of collections

Ignore java default values (0 or null)

Reflection assert – lenient collection order Ignore order of collections and arrays assertReflectionEquals(expectedCollection, actualCollection, ReflectionComparatorMode.LENIENT_ORDER); assertLenientEquals(expectedCollection, actualCollection); Expected users: [ john , jane ] Actual users: [ jane , john ]

Reflection assert – ignore defaults Ignore java default values: 0 or null assertReflectionEquals(expectedCollection, actualCollection, ReflectionComparatorMode.IGNORE_DEFAULTS); assertLenientEquals(expectedUser, actualUser); Expected id: 0 first name: Jane last name: null Actual id: 123 first name: Jane last name: Doe

Reflection assert – check property value Check property value assertPropertyLenientEquals( " address.houseNr " , 5 , user); Check property value for all elements in collection assertPropertyLenientEquals( “ userName " , Arrays.asList( " johnDoe " , " janeDoe " ), users);

Persistence layer testing - example @DataSet @JpaEntityManagerFactory (persistenceUnit=“eshop”, configFiles={“persistence-test.xml”}) public class UserDaoTest extends UnitilsJUnit4 { @PersistenceContext EntityManager entityManager; UserDao userDao; @Before public void init() { JpaUnitils.injectEntityManagerInto (userDao); } @Test public void testFindByLastName() { List<User> users = userDao.findByLastName("Doe"); assertPropertyLenientEquals ("userName", Arrays.asList("johnDoe", "janeDoe"), users); } }

Base test class with all plumbing @DataSet @JpaEntityManagerFactory (persistenceUnit=“eshop”, configFiles={“persistence-test.xml”}) public class BaseDaoTest extends UnitilsJUnit4 { @PersistenceContext protected EntityManager entityManager; protected Dao dao = createDao(); @Before public void init() { JpaUnitils.injectEntityManagerInto (dao); } protected abstract DAO createDAO(); }

Test without plumbing public class UserDaoTest extends BaseDaoTest { UserDao userDao = new UserDao(); @Override protected Object getTestedObject() { return userDao; } @Test public void testFindByLastName() { List<User> users = dao.findByLastName("Doe"); assertPropertyLenientEquals("userName", Arrays.asList("johnDoe", "janeDoe"), users); } }

Hibernate support - example @DataSet public class UserDaoTest extends UnitilsJUnit4 { @HibernateSessionFactory(“hibernate-test.cfg.xml”) EntityManagerFactory entityManagerFactory; UserDao userDao; @Before // Instantiate UserDao and inject EntityManagerFactory @Test public void testFindByLastName() { List<User> users = userDao.findByLastName("Doe"); assertPropertyLenientEquals("userName", Arrays.asList("johnDoe", "janeDoe"), users); } }

Spring integration – DAO example import org.springframework.orm.hibernate3.support.HibernateDaoSupport; public class UserDao extends HibernateDaoSupport { // ... public List<User> findByLastName(String lastName) { return (Long) getHibernateTemplate().findByNamedParam( "from User u where u.lastName = :lastName", "user", user).get(0); } // ... }

Spring integration – test example @SpringApplicationContext({“eshop-config.xml”, “test-config.xml”}) @DataSet public class UserDaoTest extends UnitilsJUnit4 { @SpringBean(“userDao”) UserDao userDao; @Test public void testFindByLastName() { List<User> users = userDao.findByLastName("Doe"); assertPropertyLenientEquals("userName", Arrays.asList("johnDoe", "janeDoe"), users); } }

Spring integration - configuration eshop-config.xml <bean id="userDao" class="eshop.dao.UserDao"> <property name="sessionFactory" ref="sessionFactory"/> </bean> <bean id="sessionFactory" class="..AnnotationSessionFactoryBean"> <property name="dataSource" ref="dataSource"/> <property name="annotatedClasses"> <list> <value>eshop.model.User</value> </list> </property> </bean> <bean id="dataSource"> … </bean> test-config.xml <bean id="dataSource" class="org.unitils..UnitilsDataSourceFactoryBean"/>

Spring integration @SpringApplicationContext Application context is loaded

Typically application & test specific config file @SpringBean Inject bean from ApplicationContext into test

Other possibilities @SpringBeanByName, @SpringBeanByType

Automatic database maintenance Automatic database maintenance Currently still part of unitils (2.2)

Split off into DbMaintain project 1.0 released in february Will be removed from Unitils

Why automatic database maintenance? Drawbacks of manual maintenance Lot of databases – lot to maintain

What was rolled out where?  Time consuming, error prone

Why automatic database maintenance? Fully automatic deployments Enables frequent deployments

Tester / customer can trigger deployment Shorter feedback cycle Enables automatic integration tests

Database maintainer – basic usage Folder with indexed scripts Database table stores executed scripts info Rollout: Only apply new scripts FILE_NAME VERSION LAST_MODIFIED CHECKSUM EXECUTED_AT SUCCEEDED 01_users.sql 1 1206695947921 15a4be468g 2008-09-17 20:23:12 1 02_roles.sql 1 1206695947996 79a5b32g10 2008-09-18 10:15:12 1 DBMAINTAIN_SCRIPTS dbscripts / 01_users.sql / 02_roles.sql

Database maintainer – script organization Work incremental Database change = new script

Unit testing: unitils & dbmaintain

More Related Content

What's hot

Similar to Unit testing: unitils & dbmaintain

Recently uploaded

Unit testing: unitils & dbmaintain