[mybatis-spring] minor updates to SqlSessionFactoryBeanTest; refactored sample code and test cases to consolidate and clean up for new users

Author: hpresnall

src/test/java/org/mybatis/spring/SqlSessionFactoryBeanTest.java

@@ -143,16 +143,16 @@ public void testSetConfigLocation() throws Exception {
     }
 
     @Test
-    public void testFragmentsAreReadWithMapperLocatios() throws Exception {
-      setupFactoryBean();
-    
-      factoryBean.setMapperLocations(new Resource[] {
-          new ClassPathResource("org/mybatis/spring/TestMapper.xml")});
-    
-      SqlSessionFactory factory = factoryBean.getObject();
-    
-      assertEquals(2, factory.getConfiguration().getSqlFragments().size());
-    }  
+    public void testFragmentsAreReadWithMapperLocations() throws Exception {
+        setupFactoryBean();
+
+        factoryBean.setMapperLocations(new Resource[] { new ClassPathResource("org/mybatis/spring/TestMapper.xml") });
+
+        SqlSessionFactory factory = factoryBean.getObject();
+
+        // one for 'includedSql' and another for 'org.mybatis.spring.TestMapper.includedSql'
+        assertEquals(2, factory.getConfiguration().getSqlFragments().size());
+    }
 
     @Test
     public void testNullMapperLocations() throws Exception {
@@ -178,19 +178,21 @@ public void testMapperLocationsWithNullEntry() throws Exception {
 
         assertDefaultConfig(factoryBean.getObject());
     }
-    
+
     @Test
     public void testAddATypeHandler() throws Exception {
         setupFactoryBean();
-        factoryBean.setTypeHandlers(new TypeHandler[] {new DummyTypeHandler()});
+        factoryBean.setTypeHandlers(new TypeHandler[] { new DummyTypeHandler() });
+
         TypeHandlerRegistry typeHandlerRegistry = factoryBean.getObject().getConfiguration().getTypeHandlerRegistry();
         assertTrue(typeHandlerRegistry.hasTypeHandler(BigInteger.class));
     }
 
     @Test
     public void testAddATypeAlias() throws Exception {
         setupFactoryBean();
-        factoryBean.setTypeAliases(new Class[] {DummyTypeAlias.class});
+
+        factoryBean.setTypeAliases(new Class[] { DummyTypeAlias.class });
         TypeAliasRegistry typeAliasRegistry = factoryBean.getObject().getConfiguration().getTypeAliasRegistry();
         typeAliasRegistry.resolveAlias("testAlias");
     }
@@ -199,8 +201,10 @@ public void testAddATypeAlias() throws Exception {
     public void testSearchATypeAliasPackage() throws Exception {
         setupFactoryBean();
         factoryBean.setTypeAliasesPackage("org/mybatis/spring/type");
+
         TypeAliasRegistry typeAliasRegistry = factoryBean.getObject().getConfiguration().getTypeAliasRegistry();
         typeAliasRegistry.resolveAlias("testAlias");
+        typeAliasRegistry.resolveAlias("testAlias2");
     }
 
     private void assertDefaultConfig(SqlSessionFactory factory) {
@@ -219,9 +223,10 @@ private void assertConfig(SqlSessionFactory factory, String environment,
         assertSame(factory.getConfiguration().getEnvironment().getTransactionFactory().getClass(),
                 transactionFactoryClass);
 
-        // no mappers configured => no mapped statements
+        // no mappers configured => no mapped statements or other parsed elements
         assertEquals(factory.getConfiguration().getMappedStatementNames().size(), 0);
         assertEquals(factory.getConfiguration().getResultMapNames().size(), 0);
         assertEquals(factory.getConfiguration().getParameterMapNames().size(), 0);
+        assertEquals(factory.getConfiguration().getSqlFragments().size(), 0);
     }
 }

src/test/java/org/mybatis/spring/sample/SampleBasicTest.java renamed to src/test/java/org/mybatis/spring/sample/AbstractSampleTest.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2010 The myBatis Team
+ *    Copyright 2010-2011 The myBatis Team
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -13,42 +13,45 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
+
+/**
+ * @version $Id$
+ */
 package org.mybatis.spring.sample;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 
 import org.junit.Test;
 import org.junit.runner.RunWith;
+
 import org.mybatis.spring.sample.domain.User;
 import org.mybatis.spring.sample.service.FooService;
+
 import org.springframework.beans.factory.annotation.Autowired;
+
 import org.springframework.test.annotation.DirtiesContext;
-import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 
 /**
- * Example of MyBatis-Spring basic integration usage.
- * This is the recommended scenario.
- *
- * @version $Id: MyBatisSampleTest.java 2697 2010-10-14 13:04:41Z eduardo.macarron $
- */
-@ContextConfiguration(locations = {"classpath:org/mybatis/spring/sample/applicationContext-basic.xml"})
+* @version $Id$
+*/
 @RunWith(SpringJUnit4ClassRunner.class)
 @DirtiesContext
-public class SampleBasicTest {
+public abstract class AbstractSampleTest {
 
     @Autowired
-    private FooService fooService;
+    protected FooService fooService;
 
-    public void setFooService(FooService fooService) {
+    public final void setFooService(FooService fooService) {
         this.fooService = fooService;
     }
 
     @Test
-    public void testFooService(){
+    public final void testFooService() {
         User user = this.fooService.doSomeBusinessStuff("u1");
         assertNotNull(user);
         assertEquals("Pocoyo", user.getName());
     }
+
 }

src/test/java/org/mybatis/spring/sample/SampleAutoTest.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2010 The myBatis Team
+ *    Copyright 2010-2011 The myBatis Team
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -15,39 +15,17 @@
  */
 package org.mybatis.spring.sample;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.mybatis.spring.sample.domain.User;
-import org.mybatis.spring.sample.service.FooService;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.test.annotation.DirtiesContext;
 import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 
 /**
- * Example of MyBatis-Spring batch integration usage 
+ * Example of MyBatis-Spring batch integration usage.
  *
  * @version $Id: MyBatisSampleTest.java 2697 2010-10-14 13:04:41Z eduardo.macarron $
  */
 @ContextConfiguration(locations = {"classpath:org/mybatis/spring/sample/applicationContext-batch.xml"})
-@RunWith(SpringJUnit4ClassRunner.class)
-@DirtiesContext
-public class SampleBatchTest {
-
-    private FooService fooService;
-
-    @Autowired
-    public void setFooService(FooService fooService) {
-        this.fooService = fooService;
-    }
-
-    @Test
-    public void testFooService() throws Exception {
-        User user = this.fooService.doSomeBusinessStuff("u1");
-        assertNotNull(user);
-        assertEquals("Pocoyo", user.getName());
-    }
+public class SampleBatchTest extends AbstractSampleTest {
+    // Note this does not actually test batch functionality since FooService
+    // only calls one DAO method. This class and associated Spring context
+    // simply show that no implementation changes are needed to enable
+    // different MyBatis configurations.
 }

src/test/java/org/mybatis/spring/sample/SampleBatchTest.java

@@ -0,0 +1,27 @@
+/*
+ *    Copyright 2010-2011 The myBatis Team
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.mybatis.spring.sample;
+
+import org.springframework.test.context.ContextConfiguration;
+
+/**
+ * Example of MyBatis-Spring integration with a DAO created by
+ * MapperFactoryBean.
+ * 
+ * @version $Id: MyBatisSampleTest.java 2697 2010-10-14 13:04:41Z eduardo.macarron $
+ */
+@ContextConfiguration(locations = { "classpath:org/mybatis/spring/sample/applicationContext-mapper.xml" })
+public class SampleMapperTest extends AbstractSampleTest {}

src/test/java/org/mybatis/spring/sample/SampleMapperTest.java

@@ -0,0 +1,27 @@
+/*
+ *    Copyright 2010-2011 The myBatis Team
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.mybatis.spring.sample;
+
+import org.springframework.test.context.ContextConfiguration;
+
+/**
+ * Example of MyBatis-Spring integration with a DAO configured via
+ * MapperScannerConfigurer.
+ * 
+ * @version $Id: MyBatisSampleTest.java 2697 2010-10-14 13:04:41Z eduardo.macarron $
+ */
+@ContextConfiguration(locations = { "classpath:org/mybatis/spring/sample/applicationContext-scanner.xml" })
+public class SampleScannerTest extends AbstractSampleTest {}

src/test/java/org/mybatis/spring/sample/SampleScannerTest.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2010 The myBatis Team
+ *    Copyright 2010-2011 The myBatis Team
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -15,41 +15,13 @@
  */
 package org.mybatis.spring.sample;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.mybatis.spring.sample.domain.User;
-import org.mybatis.spring.sample.service.FooService;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.test.annotation.DirtiesContext;
 import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 
 /**
- * Example of MyBatis-Spring integration usage.
- * This sample gets access to the SqlSession provided by Spring to
- * call MyBatis methods
+ * Example of basic MyBatis-Spring integration usage with a manual DAO
+ * implementation that subclasses SqlSessionDaoSupport.
  *
  * @version $Id: MyBatisSampleTest.java 2697 2010-10-14 13:04:41Z eduardo.macarron $
  */
 @ContextConfiguration(locations = {"classpath:org/mybatis/spring/sample/applicationContext-sqlsession.xml"})
-@RunWith(SpringJUnit4ClassRunner.class)
-@DirtiesContext
-public class SampleSqlSessionTest {
-
-    @Autowired
-    private FooService fooService;
-
-    public void setFooService(FooService fooService) {
-        this.fooService = fooService;
-    }
-
-    @Test
-    public void testFooService(){
-        User user = this.fooService.doSomeBusinessStuff("u1");
-        assertNotNull(user);
-        assertEquals("Pocoyo", user.getName());
-    }
-}
+public class SampleSqlSessionTest extends AbstractSampleTest {}

src/test/java/org/mybatis/spring/sample/SampleSqlSessionTest.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2010 The myBatis Team
+ *    Copyright 2010-2011 The myBatis Team
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -19,16 +19,17 @@
 import org.mybatis.spring.support.SqlSessionDaoSupport;
 
 /**
- * This DAO extends SqlSessionDaoSupport and uses a Spring managed SqlSession instead of MyBatis one
- * SqlSessions are handled by Spring so you don't need to open/close/commit/rollback them.
+ * This DAO extends SqlSessionDaoSupport and uses a Spring managed SqlSession
+ * instead of the MyBatis one. SqlSessions are handled by Spring so you don't
+ * need to open/close/commit/rollback.
  * MyBatis exceptions are translated to Spring Data Exceptions.
  *
  * @version $Id: UserMapperTemplateImpl.java 2444 2010-09-15 07:38:37Z simone.tripodi $
  */
 public class UserDaoImpl extends SqlSessionDaoSupport implements UserDao {
 
     public User getUser(String userId) {
-        return (User) getSqlSession().selectOne("org.mybatis.spring.sample.mapper.UserMapper.getUser", userId);
+        return (User) getSqlSession().selectOne("org.mybatis.spring.sample.dao.UserDao.getUser", userId);
     }
 
 }