Merge pull request #161 from zonkyio/2.0.x

2.0.0

Author: tomix26

.github/workflows/gradle.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        java: [8]
+        java: [8, 11, 15]
     steps:
     - name: Checkout project
       uses: actions/checkout@v1
@@ -23,5 +23,10 @@ jobs:
         key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
         restore-keys: |
           ${{ runner.os }}-gradle-
+    - name: Accept third party licence
+      env:
+        ACCEPT_LICENCE: ${{ secrets.ACCEPT_LICENCE }}
+      if: env.ACCEPT_LICENCE == 'true'
+      run: ./accept-third-party-license.sh
     - name: Build with Gradle
       run: ./gradlew build

.gitignore

@@ -25,4 +25,7 @@ build/
 hs_err_pid*
 
 # Gradle wrapper files
-!gradle/wrapper/gradle-wrapper.jar
+!gradle/wrapper/gradle-wrapper.jar
+
+# Prevent license accepting file to get accidentially commited to git
+container-license-acceptance.txt

README.md

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+{
+  echo "mcr.microsoft.com/mssql/server:2019-latest"
+  echo "mcr.microsoft.com/mssql/server:2017-latest"
+  echo "mcr.microsoft.com/mssql/server:2017-CU20"
+} > embedded-database-spring-test/src/test/resources/container-license-acceptance.txt

accept-third-party-license.sh

@@ -1,7 +1,9 @@
 # ContextCustomizerFactories for the Spring TestContext Framework
 org.springframework.test.context.ContextCustomizerFactory = \
-  io.zonky.test.db.postgres.EmbeddedPostgresContextCustomizerFactory
+  io.zonky.test.db.EmbeddedDatabaseContextCustomizerFactory
 
 # TestExecutionListeners for the Spring TestContext Framework
 org.springframework.test.context.TestExecutionListener = \
-  io.zonky.test.db.flyway.OptimizedFlywayTestExecutionListener
+  io.zonky.test.db.EmbeddedDatabaseTestExecutionListener,\
+  io.zonky.test.db.event.EventPublishingTestExecutionListener,\
+  io.zonky.test.db.flyway.OptimizedFlywayTestExecutionListener

build.gradle

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,8 +31,7 @@
  * <p>
  * This annotation may be used as a <em>meta-annotation</em> to create custom <em>composed annotations</em>.
  *
- * @see io.zonky.test.db.postgres.EmbeddedPostgresContextCustomizerFactory
- * @see io.zonky.test.db.flyway.OptimizedFlywayTestExecutionListener
+ * @see EmbeddedDatabaseContextCustomizerFactory
  */
 @Documented
 @Inherited
@@ -42,98 +41,169 @@
 public @interface AutoConfigureEmbeddedDatabase {
 
     /**
-     * The bean name to be used to identify the data source that will be replaced.
-     * It is only necessary if there is no existing DataSource
-     * or the context contains multiple DataSource beans.
+     * The bean name to identify the data source to be associated with the embedded database.
      *
-     * @return the name to identify the DataSource bean
+     * <p>It is required only if the application context contains multiple DataSource beans.
+     *
+     * @return the bean name to identify the DataSource bean
      */
     String beanName() default "";
 
     /**
-     * Determines what type of existing DataSource beans can be replaced.
+     * Determines the refresh mode of the embedded database.
      *
-     * @return the type of existing DataSource to replace
+     * <p>This feature allows for reset the database to its initial state that existed before the test began.
+     * It is based on the use of template databases and does not rely on the rollback of the current transaction,
+     * so it is possible to save and commit data within the test without any consequences.
+     *
+     * <p>The refresh mode may also be configured via the {@code zonky.test.database.refresh} configuration property.
+     *
+     * @return the type of refresh mode to be used for database reset
      */
-    Replace replace() default Replace.ANY;
+    RefreshMode refresh() default RefreshMode.NEVER;
 
     /**
-     * The type of an embedded database to be initialized
-     * when {@link #replace() replacing} the data source.
+     * The type of embedded database to be created when {@link #replace() replacing} the data source.
+     * By default will attempt to detect the database type based on the classpath.
      *
-     * @return the type of an embedded database
+     * <p>The database type may also be configured via the {@code zonky.test.database.type} configuration property.
+     *
+     * @return the type of embedded database
      */
-    EmbeddedDatabaseType type() default EmbeddedDatabaseType.POSTGRES;
+    DatabaseType type() default DatabaseType.AUTO;
 
     /**
-     * Provider used to create the underlying embedded database,
-     * see the documentation for the comparision matrix.
-     * Note that the provider can also be configured
-     * through {@code zonky.test.database.provider} property.
+     * Provider to be used to create the underlying embedded database, see the documentation for the comparison matrix.
+     *
+     * <p>The provider may also be configured via the {@code zonky.test.database.provider} configuration property.
      *
-     * @return the provider of an embedded database
+     * @return the provider to create the embedded database
      */
     DatabaseProvider provider() default DatabaseProvider.DEFAULT;
 
     /**
-     * What the test database can replace.
+     * Determines what type of existing DataSource beans can be replaced.
+     *
+     * <p>It may also be configured via the {@code zonky.test.database.replace} configuration property.
+     *
+     * @return the type of existing DataSource to replace
      */
-    enum Replace {
+    Replace replace() default Replace.ANY;
+
+    /**
+     * The supported refresh modes.
+     */
+    enum RefreshMode {
 
         /**
-         * Replace any DataSource bean (auto-configured or manually defined).
+         * The database will not be reset at all.
          */
-        ANY,
+        NEVER,
 
         /**
-         * Don't replace the application default DataSource.
+         * The database will be reset to its initial state before the test class.
          */
-        NONE
+        BEFORE_CLASS,
+
+        /**
+         * The database will be reset to its initial state before each test method in the class.
+         */
+        BEFORE_EACH_TEST_METHOD,
+
+        /**
+         * The database will be reset to its initial state after each test method in the class.
+         */
+        AFTER_EACH_TEST_METHOD,
+
+        /**
+         * The database will be reset to its initial state after the test class.
+         */
+        AFTER_CLASS
 
     }
 
     /**
      * The supported types of embedded databases.
      */
-    enum EmbeddedDatabaseType {
+    enum DatabaseType {
+
+        /**
+         * Database is detected automatically based on the classpath.
+         */
+        AUTO,
 
         /**
          * PostgreSQL Database
          */
-        POSTGRES
+        POSTGRES,
+
+        /**
+         * Microsoft SQL Server
+         */
+        MSSQL,
+
+        /**
+         * MySQL Database
+         */
+        MYSQL,
+
+        /**
+         * MariaDB Database
+         */
+        MARIADB
 
     }
 
     /**
-     * The supported providers of embedded databases.
+     * The supported providers for creating embedded databases.
      */
     enum DatabaseProvider {
 
         /**
-         * Default typically equals to {@link #ZONKY} provider,
-         * unless a different default has been configured by externalized configuration.
+         * Default typically equals to {@link #DOCKER} provider,
+         * unless a different default has been configured by configuration properties.
          */
         DEFAULT,
 
         /**
-         * Run the embedded database in a Docker container.
+         * Run the embedded database in Docker as a container.
          */
         DOCKER,
 
         /**
-         * Use Zonky's fork of OpenTable Embedded PostgreSQL Component to create the embedded database (https://github.com/zonkyio/embedded-postgres).
+         * Use Zonky's fork of OpenTable Embedded PostgreSQL Component to create the embedded database
+         * (<a href="https://github.com/zonkyio/embedded-postgres">https://github.com/zonkyio/embedded-postgres</a>).
          */
         ZONKY,
 
         /**
-         * Use OpenTable Embedded PostgreSQL Component to create the embedded database (https://github.com/opentable/otj-pg-embedded).
+         * Use OpenTable Embedded PostgreSQL Component to create the embedded database
+         * (<a href="https://github.com/opentable/otj-pg-embedded">https://github.com/opentable/otj-pg-embedded</a>).
          */
         OPENTABLE,
 
         /**
-         * Use Yandex's Embedded PostgreSQL Server to create the embedded database (https://github.com/yandex-qatools/postgresql-embedded).
+         * Use Yandex's Embedded PostgreSQL Server to create the embedded database
+         * (<a href="https://github.com/yandex-qatools/postgresql-embedded">https://github.com/yandex-qatools/postgresql-embedded</a>).
          */
         YANDEX,
 
     }
+
+    /**
+     * What the test database can replace.
+     */
+    enum Replace {
+
+        /**
+         * Replace any DataSource bean (auto-configured or manually defined).
+         */
+        ANY,
+
+        /**
+         * Don't replace the application default DataSource.
+         */
+        NONE
+
+    }
 }

embedded-database-spring-test-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 the original author or authors.
+ * Copyright 2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.