Polish contribution

Closes gh-143

Author: eddumelendez

mybatis-spring-boot-test-autoconfigure/src/main/java/org/mybatis/spring/boot/test/autoconfigure/AutoConfigureMybatis.java

@@ -26,6 +26,9 @@
 import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
 
 /**
+ * {@link ImportAutoConfiguration Auto-configuration imports} for typical Mybatis tests.
+ * Most tests should consider using {@link MybatisTest @MybatisTest} rather than using
+ * this annotation directly.
  *
  * @author wonwoo
  * @since 1.2.1
@@ -36,4 +39,5 @@
 @Inherited
 @ImportAutoConfiguration
 public @interface AutoConfigureMybatis {
+
 }

mybatis-spring-boot-test-autoconfigure/src/main/java/org/mybatis/spring/boot/test/autoconfigure/MybatisTest.java

@@ -16,10 +16,13 @@
 
 package org.mybatis.spring.boot.test.autoconfigure;
 
+import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.test.autoconfigure.OverrideAutoConfiguration;
 import org.springframework.boot.test.autoconfigure.core.AutoConfigureCache;
 import org.springframework.boot.test.autoconfigure.filter.TypeExcludeFilters;
+import org.springframework.boot.test.autoconfigure.orm.jpa.AutoConfigureTestDatabase;
+import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.context.SpringBootTestContextBootstrapper;
 import org.springframework.context.annotation.ComponentScan.Filter;
 import org.springframework.test.context.BootstrapWith;
@@ -33,6 +36,22 @@
 import java.lang.annotation.Target;
 
 /**
+ * Annotation that can be used in combination with {@code @RunWith(SpringRunner.class)}
+ * for a typical mybatis test. Can be used when a test focuses <strong>only</strong> on
+ * mybatis-based components.
+ * <p>
+ * Using this annotation will disable full auto-configuration and instead apply only
+ * configuration relevant to mybatis tests.
+ * <p>
+ * By default, tests annotated with {@code @JdbcTest} will use an embedded in-memory
+ * database (replacing any explicit or usually auto-configured DataSource). The
+ * {@link AutoConfigureTestDatabase @AutoConfigureTestDatabase} annotation can be used to
+ * override these settings.
+ * <p>
+ * If you are looking to load your full application configuration, but use an embedded
+ * database, you should consider {@link SpringBootTest @SpringBootTest} combined with
+ * {@link AutoConfigureTestDatabase @AutoConfigureTestDatabase} rather than this
+ * annotation.
  *
  * @author wonwoo
  * @see AutoConfigureMybatis
@@ -45,9 +64,11 @@
 @BootstrapWith(SpringBootTestContextBootstrapper.class)
 @OverrideAutoConfiguration(enabled = false)
 @TypeExcludeFilters(MybatisTypeExcludeFilter.class)
-@AutoConfigureCache
 @Transactional
+@AutoConfigureCache
 @AutoConfigureMybatis
+@AutoConfigureTestDatabase
+@ImportAutoConfiguration
 public @interface MybatisTest {
 
   /**
@@ -77,12 +98,4 @@
    */
   Filter[] excludeFilters() default {};
 
-  /**
-   * spring boot 1.5 start
-   * Auto-configuration exclusions that should be applied for this test.
-   *
-   * @return auto-configuration exclusions to apply
-   */
-//  @AliasFor(annotation = ImportAutoConfiguration.class, attribute = "exclude")
-//  Class<?>[] excludeAutoConfiguration() default {};
 }

mybatis-spring-boot-test-autoconfigure/src/main/java/org/mybatis/spring/boot/test/autoconfigure/MybatisTypeExcludeFilter.java

@@ -26,6 +26,7 @@
 
 /**
  * {@link TypeExcludeFilter} for {@link MybatisTest @MybatisTest}.
+ *
  * @author wonwoo
  * @since 1.2.1
  */
@@ -63,10 +64,4 @@ protected Set<Class<?>> getDefaultIncludes() {
     return Collections.emptySet();
   }
 
-
-  //spring boot 1.5 start
-//  @Override
-//  protected Set<Class<?>> getComponentIncludes() {
-//    return Collections.emptySet();
-//  }
 }

mybatis-spring-boot-test-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -1,4 +1,4 @@
-# AutoConfigureDataMybatis auto-configuration imports
+# AutoConfigureMybatis auto-configuration imports
 org.mybatis.spring.boot.test.autoconfigure.AutoConfigureMybatis=\
 org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
 org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,\

mybatis-spring-boot-test-autoconfigure/src/test/java/org/mybatis/spring/boot/test/autoconfigure/ExampleComponent.java

@@ -19,6 +19,7 @@
 import org.springframework.stereotype.Component;
 
 /**
+ * Example component used with {@link MybatisTest} tests.
  *
  * @author wonwoo
  * @since 1.2.1

mybatis-spring-boot-test-autoconfigure/src/test/java/org/mybatis/spring/boot/test/autoconfigure/ExampleMybatisApplication.java

@@ -19,6 +19,7 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
 /**
+ * Example {@link SpringBootApplication} used with {@link MybatisTest} tests.
  *
  * @author wonwoo
  * @since 1.2.1

mybatis-spring-boot-test-autoconfigure/src/test/java/org/mybatis/spring/boot/test/autoconfigure/DataMybatisTestIntegrationTests.java renamed to mybatis-spring-boot-test-autoconfigure/src/test/java/org/mybatis/spring/boot/test/autoconfigure/MybatisTestIntegrationTests.java

@@ -33,6 +33,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
+ * Integration tests for {@link MybatisTest}.
  *
  * @author wonwoo
  * @since 1.2.1
@@ -44,7 +45,7 @@
   "mybatis.mapper-locations=org/mybatis/spring/boot/test/autoconfigure/*.xml",
   "spring.datasource.schema=classpath:org/mybatis/spring/boot/test/autoconfigure/schema.sql"
 })
-public class DataMybatisTestIntegrationTests {
+public class MybatisTestIntegrationTests {
 
   @Rule
   public ExpectedException thrown = ExpectedException.none();

mybatis-spring-boot-test-autoconfigure/src/test/java/org/mybatis/spring/boot/test/autoconfigure/Sample.java

@@ -17,6 +17,7 @@
 package org.mybatis.spring.boot.test.autoconfigure;
 
 /**
+ * Example entity used with {@link MybatisTest} tests.
  *
  * @author wonwoo
  * @since 1.2.1

mybatis-spring-boot-test-autoconfigure/src/test/java/org/mybatis/spring/boot/test/autoconfigure/SampleMapper.java

@@ -19,6 +19,7 @@
 import org.apache.ibatis.annotations.Mapper;
 
 /**
+ * Example mapper used with {@link MybatisTest} tests.
  *
  * @author wonwoo
  * @since 1.2.1