Skip to content

Commit 61636af

Browse files
committed
issue: #103 update readme for version 9.x
1 parent c597078 commit 61636af

1 file changed

Lines changed: 22 additions & 13 deletions

File tree

README.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ Test extensions for the Flyway project
99

1010
For Flyway's features, see the [Flyway Db Org Page](http://flywaydb.org/)
1111

12-
Version 7.0.0 Released
12+
Version 9.0.0 Released
1313
----------------------
1414

15-
<b>2020-10-22</b> flyway-test-extensions version <b>7.0.0</b> released.
15+
<b>2023-04-xx</b> flyway-test-extensions version <b>9.0.0</b> released.
1616

17-
Version number 7.0.x are used to show the dependency to Flyway version 7.0.x.
17+
Version number 9.0.x are used to show the dependency or compatibility to Flyway version 9.x.
18+
The main feature can also be used with older features, see the corresponding examples.
1819

1920
See also [Release Notes](https://github.com/flyway/flyway-test-extensions/wiki/Release-Notes)
2021

@@ -44,6 +45,7 @@ With this precondition, each test provides a reproducible database start point.
4445
* Spring 5.x sample (see [complete sample for usage together with Spring 5](https://github.com/flyway/flyway-test-extensions/tree/master/flyway-test-extensions/flyway-test-samples/flyway-test-spring-samples/flyway-test-sample-spring5) )
4546
* Spring 4.x sample (see [UsageFlywaySpringTest4](https://github.com/flyway/flyway-test-extensions/wiki/Usage-flyway-spring-test) )
4647
* SpringBoot 2 test example (see [FlywayTestApplicationTest](https://github.com/flyway/flyway-test-extensions/blob/master/flyway-test-extensions/flyway-test-samples/flyway-test-spring-samples/flyway-test-sample-spring-boot/sample-spring-boot-2/src/test/java/org/flywaydb/sample/test/spring/boot2/flywaytest/FlywayTestApplicationTest.java) )
48+
* SpringBoot 3 test example (see [FlywayTestApplicationTest](https://github.com/flyway/flyway-test-extensions/blob/master/flyway-test-extensions/flyway-test-samples/flyway-test-spring-samples/flyway-test-sample-spring-boot/sample-spring-boot-3-0/src/test/java/org/flywaydb/sample/test/spring/boot3/flywaytest/FlywayTestApplicationTest.java) )
4749
* JUnit5 test example (see [Junit5SpringTest](https://github.com/flyway/flyway-test-extensions/blob/master/flyway-test-extensions/flyway-test-samples/flyway-test-spring-samples/flyway-test-junit5/src/test/java/org/flywaydb/sample/test/junit5/Junit5SpringTest.java) )
4850
* TestNG test example (see [BeforeMethodTest](https://github.com/flyway/flyway-test-extensions/blob/master/flyway-test-extensions/flyway-test-samples/flyway-test-spring-samples/flyway-test-testng/src/test/java/org/flywaydb/sample/test/testng/BeforeMethodTest.java) )
4951
* Additional project supports a DBUnit annotation use together with FlywayTest [DBUnitSupport](https://github.com/flyway/flyway-test-extensions/blob/master/flyway-test-extensions/flyway-dbunit-test/src/main/java/org/flywaydb/test/dbunit/DBUnitSupport.java). A usage example you will find at [UsageFlywayDBUnitTest](https://github.com/flyway/flyway-test-extensions/wiki/Usage-flyway-dbunit-test).
@@ -54,9 +56,11 @@ The flyway test extensions are available at [Maven Central](http://repo1.maven.o
5456

5557
For a detail usage description see the [UsageFlywaySpringTest](https://github.com/flyway/flyway-test-extensions/wiki/Usage-flyway-spring-test) usage page. <br>
5658
*Attention:*
57-
* this version has a dependency on Spring 5.
58-
* The project is build with Java 8 compiler settings simular to Flyway project.<br>
59-
If other compiler classes are needed use flyway-test-spring4 or flyway-test-spring3.
59+
* this version has a default dependency on Spring 6. Examples show also how to use it with older versions.
60+
* The project is build with Java 8 compiler settings for backward compatibility. <br>
61+
If other compiler classes are needed use flyway-test-spring5 or flyway-test-spring4.
62+
* <b>Important:</b> for usage with Flyway version 9, and spring properties `spring.flyway.clean-disabled=false` should be
63+
set to `false` otherwise `CleanDB` will not work.
6064

6165
*Integration*
6266
* Add dependency to flyway-spring-test to your Maven pom file
@@ -65,12 +69,12 @@ For a detail usage description see the [UsageFlywaySpringTest](https://github.co
6569
<dependency>
6670
<groupId>org.flywaydb.flyway-test-extensions</groupId>
6771
<artifactId>flyway-spring-test</artifactId>
68-
<version>7.0.0</version>
72+
<version>9.0.0</version>
6973
<scope>test</scope>
7074
</dependency>
7175
```
7276

73-
* Extend your test class with the Spring test runner annotation (Junit 4).
77+
* Extend your test class with the Spring test runner annotation (Junit 4). The context file should be part of your test project.
7478

7579
```java
7680
@RunWith(SpringRunner.class)
@@ -119,7 +123,7 @@ For a detail usage description see the [UsageFlywaySpringTest](https://github.co
119123
public void testMethod() {
120124
```
121125

122-
* Junit 5 support is only available together with Spring5 and need a different Spring setup.<br/>
126+
* Junit 5 support is only available together with Spring5 or newer and need a different Spring setup.<br/>
123127
A step by step setup can be found [here](https://github.com/flyway/flyway-test-extensions/wiki/How-to-use-Flyway-Test-with-Junit5-and-Springframework-5).
124128

125129
```java
@@ -140,7 +144,7 @@ public class Junit5SpringTest ...
140144

141145
```
142146

143-
* TestNG support is only available with Spring5 and need a different Test setup.
147+
* TestNG support is only available with Spring5 or newer and need a different Test setup.
144148

145149
```java
146150
@ContextConfiguration(locations = {"/context/simple_applicationContext.xml"})
@@ -167,13 +171,18 @@ public class MethodTest extends AbstractTestNGSpringContextTests {
167171

168172
Project depend on
169173
-----------------
170-
* [Flyway](https://github.com/flyway/) (7.0.0)
171-
* [Spring Framework](http://www.springsource.org/) test, context, jdbc (5.2.6, 4.3.25, 3.2)
174+
* [Flyway](https://github.com/flyway/) (9.16.1), and show also examples for version 8.5.13
175+
* [Spring Framework](http://www.springsource.org/) test, context, jdbc (6.0.7, 5.2.6, 4.3.30)
172176

173177
Notes
174178
-----
175-
* The project depends on flyway version 7.0.4
179+
* The project depends on flyway version 9.16.1
176180
* The project will be supported until the extension will be integrated into the flyway project.
181+
* The project depends on Spring version 6.x (see flyway-spring6-test)
177182
* The project depends on Spring version 5.x (see flyway-spring5-test)
178183
* The project depends on Spring version 4.x (see flyway-spring4-test and flyway-dbunit-spring4-test)
179184
* At the moment the code is tested with database H2 and Oracle.<br>Only the DBunit part contains database specific code.
185+
* it shows also examples how different version from flyway can be used with Spring Boot 2.x and 3.x.
186+
See the example projects SpringBoot 2 test example ([FlywayTestApplicationTest](https://github.com/flyway/flyway-test-extensions/blob/master/flyway-test-extensions/flyway-test-samples/flyway-test-spring-samples/flyway-test-sample-spring-boot/sample-spring-boot-2/src/test/java/org/flywaydb/sample/test/spring/boot2/flywaytest/FlywayTestApplicationTest.java) )
187+
and SpringBoot 3 test example ([FlywayTestApplicationTest](https://github.com/flyway/flyway-test-extensions/blob/master/flyway-test-extensions/flyway-test-samples/flyway-test-spring-samples/flyway-test-sample-spring-boot/sample-spring-boot-3-0/src/test/java/org/flywaydb/sample/test/spring/boot3/flywaytest/FlywayTestApplicationTest.java) )
188+

0 commit comments

Comments
 (0)