Implement 'cleanOnValidationError' for Flyway 11

Author: mschorsch

extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/FlywayContainer.java

@@ -8,6 +8,7 @@ public class FlywayContainer {
 
     private final boolean baselineAtStart;
     private final boolean cleanAtStart;
+    private final boolean cleanOnValidationError;
     private final boolean migrateAtStart;
     private final boolean repairAtStart;
 
@@ -17,12 +18,13 @@ public class FlywayContainer {
     private final boolean createPossible;
     private final String id;
 
-    public FlywayContainer(Flyway flyway, boolean baselineAtStart, boolean cleanAtStart, boolean migrateAtStart,
-            boolean repairAtStart, boolean validateAtStart,
+    public FlywayContainer(Flyway flyway, boolean baselineAtStart, boolean cleanAtStart, boolean cleanOnValidationError,
+            boolean migrateAtStart, boolean repairAtStart, boolean validateAtStart,
             String dataSourceName, boolean hasMigrations, boolean createPossible) {
         this.flyway = flyway;
         this.baselineAtStart = baselineAtStart;
         this.cleanAtStart = cleanAtStart;
+        this.cleanOnValidationError = cleanOnValidationError;
         this.migrateAtStart = migrateAtStart;
         this.repairAtStart = repairAtStart;
         this.validateAtStart = validateAtStart;
@@ -44,6 +46,10 @@ public boolean isCleanAtStart() {
         return cleanAtStart;
     }
 
+    public boolean isCleanOnValidationError() {
+        return cleanOnValidationError;
+    }
+
     public boolean isMigrateAtStart() {
         return migrateAtStart;
     }

extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/FlywayContainerProducer.java

@@ -52,7 +52,7 @@ public FlywayContainer createFlyway(DataSource dataSource, String dataSourceName
                 configCustomizerInstances, dataSourceName)).withCallbacks(callbacks)
                 .createFlyway(dataSource);
         return new FlywayContainer(flyway, matchingRuntimeConfig.baselineAtStart, matchingRuntimeConfig.cleanAtStart,
-                matchingRuntimeConfig.migrateAtStart,
+                matchingRuntimeConfig.cleanOnValidationError, matchingRuntimeConfig.migrateAtStart,
                 matchingRuntimeConfig.repairAtStart, matchingRuntimeConfig.validateAtStart,
                 dataSourceName, hasMigrations,
                 createPossible);

extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/FlywayDataSourceRuntimeConfig.java

@@ -152,6 +152,12 @@ public static FlywayDataSourceRuntimeConfig defaultConfig() {
     @ConfigItem
     public boolean validateAtStart;
 
+    /**
+     * true to automatically execute a Flyway clean command when a validation error occurs at start, false otherwise.
+     */
+    @ConfigItem(name = "validate-at-start.clean-on-validation-error")
+    public boolean cleanOnValidationError;
+
     /**
      * true to execute Flyway baseline before migrations This flag is ignored if the flyway_schema_history table exists in the
      * current schema or if the current schema is empty.

extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/FlywayRecorder.java

@@ -129,7 +129,15 @@ public void doStartActions(String dataSourceName) {
             flywayContainer.getFlyway().clean();
         }
         if (flywayContainer.isValidateAtStart()) {
-            flywayContainer.getFlyway().validate();
+            if (flywayContainer.isCleanOnValidationError()) {
+                var result = flywayContainer.getFlyway().validateWithResult();
+
+                if (!result.validationSuccessful) {
+                    flywayContainer.getFlyway().clean();
+                }
+            } else {
+                flywayContainer.getFlyway().validate();
+            }
         }
         if (flywayContainer.isBaselineAtStart()) {
             new FlywayExecutor(flywayContainer.getFlyway().getConfiguration())

extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/UnconfiguredDataSourceFlywayContainer.java

@@ -12,7 +12,7 @@ public class UnconfiguredDataSourceFlywayContainer extends FlywayContainer {
     private final Throwable cause;
 
     public UnconfiguredDataSourceFlywayContainer(String dataSourceName, String message, Throwable cause) {
-        super(null, false, false, false, false, false, dataSourceName, false, false);
+        super(null, false, false, false, false, false, false, dataSourceName, false, false);
         this.message = message;
         this.cause = cause;
     }

extensions/flyway/runtime/src/test/java/io/quarkus/flyway/runtime/FlywayCreatorTest.java

@@ -170,6 +170,14 @@ void testValidateOnMigrate() {
         assertTrue(runtimeConfig.validateOnMigrate);
     }
 
+    @Test
+    @DisplayName("clean on validation error default matches to false")
+    void testCleanOnValidationError() {
+        creator = new FlywayCreator(runtimeConfig, buildConfig);
+        assertEquals(runtimeConfig.cleanOnValidationError, createdFlywayConfig().isCleanOnValidationError());
+        assertFalse(runtimeConfig.cleanOnValidationError);
+    }
+
     @Test
     @DisplayName("clean disabled default matches to false")
     void testCleanDisabled() {