Merge pull request #241 from zonkyio/flyway-plugin-config

tomix26 · web-flow · commit 228374c494c5 · 2023-05-16T13:58:59.000+02:00
#240 Add support for flyway plugin configuration
diff --git a/embedded-database-spring-test/src/main/java/io/zonky/test/db/flyway/FlywayDescriptor.java b/embedded-database-spring-test/src/main/java/io/zonky/test/db/flyway/FlywayDescriptor.java
@@ -63,6 +63,10 @@ public class FlywayDescriptor {
                     && !EXCLUDED_FIELDS.contains(field.getName())
                     && !EXCLUDED_TYPES.contains(field.getType());
 
+    private static final FieldFilter PLUGIN_FIELDS =
+            field -> !Modifier.isStatic(field.getModifiers())
+                    && !EXCLUDED_TYPES.contains(field.getType());
+
     private final List<String> locations;
     private final List<String> schemas;
     private final String table;
@@ -74,6 +78,7 @@ public class FlywayDescriptor {
     private final boolean ignoreFutureMigrations;
     private final boolean validateOnMigrate;
     private final Map<Field, Object> otherFields;
+    private final Map<Class<?>, Map<Field, Object>> pluginsFields;
 
     private FlywayDescriptor(FlywayWrapper wrapper) {
         this.locations = ImmutableList.copyOf(wrapper.getLocations());
@@ -87,27 +92,15 @@ private FlywayDescriptor(FlywayWrapper wrapper) {
         this.ignoreFutureMigrations = wrapper.isIgnoreFutureMigrations();
         this.validateOnMigrate = wrapper.isValidateOnMigrate();
 
-        Map<Field, Object> otherFields = new HashMap<>();
-        Object config = wrapper.getConfig();
+        this.otherFields = getFields(wrapper.getConfig(), OTHER_FIELDS);
 
-        doWithFields(config.getClass(), field -> {
-            makeAccessible(field);
-            Object value = getField(field, config);
-
-            if (value != null) {
-                if (Collection.class.isAssignableFrom(field.getType())) {
-                    value = Lists.newArrayList((Collection<?>) value);
-                } else if (Map.class.isAssignableFrom(field.getType())) {
-                    value = Maps.newHashMap((Map<?, ?>) value);
-                } else if (field.getType().isArray()) {
-                    value = Lists.newArrayList((Object[]) value);
-                }
-            }
-
-            otherFields.put(field, value);
-        }, OTHER_FIELDS);
-
-        this.otherFields = otherFields;
+        Map<Class<?>, Map<Field, Object>> pluginsFields = new HashMap<>();
+        List<Object> plugins = wrapper.getConfigurationExtensions();
+        for (Object plugin : plugins) {
+            Map<Field, Object> pluginFields = getFields(plugin, PLUGIN_FIELDS);
+            pluginsFields.put(plugin.getClass(), pluginFields);
+        }
+        this.pluginsFields = pluginsFields;
     }
 
     public static FlywayDescriptor from(FlywayWrapper wrapper) {
@@ -128,21 +121,13 @@ public void applyTo(FlywayWrapper wrapper) {
         wrapper.setIgnoreFutureMigrations(ignoreFutureMigrations);
         wrapper.setValidateOnMigrate(validateOnMigrate);
 
-        otherFields.forEach((field, value) -> {
-            makeAccessible(field);
+        setFields(config, otherFields);
 
-            if (value == null) {
-                setField(field, config, value);
-            } else if (Collection.class.isAssignableFrom(field.getType())) {
-                setCollection(field, config, (Collection<?>) value);
-            } else if (Map.class.isAssignableFrom(field.getType())) {
-                setMap(field, config, (Map<?, ?>) value);
-            } else if (field.getType().isArray()) {
-                setArray(field, config, (List<?>) value);
-            } else {
-                setField(field, config, value);
-            }
-        });
+        List<Object> plugins = wrapper.getConfigurationExtensions();
+        for (Object plugin : plugins) {
+            Map<Field, Object> pluginFields = pluginsFields.get(plugin.getClass());
+            setFields(plugin, pluginFields);
+        }
     }
 
     public List<String> getLocations() {
@@ -200,7 +185,8 @@ public boolean equals(Object o) {
                 && Objects.equals(repeatableSqlMigrationPrefix, that.repeatableSqlMigrationPrefix)
                 && Objects.equals(sqlMigrationSeparator, that.sqlMigrationSeparator)
                 && Objects.equals(sqlMigrationSuffixes, that.sqlMigrationSuffixes)
-                && Objects.equals(otherFields, that.otherFields);
+                && Objects.equals(otherFields, that.otherFields)
+                && Objects.equals(pluginsFields, that.pluginsFields);
     }
 
     @Override
@@ -209,7 +195,7 @@ public int hashCode() {
                 sqlMigrationPrefix, repeatableSqlMigrationPrefix,
                 sqlMigrationSeparator, sqlMigrationSuffixes,
                 ignoreMissingMigrations, ignoreFutureMigrations,
-                validateOnMigrate, otherFields);
+                validateOnMigrate, otherFields, pluginsFields);
     }
 
     private static void setCollection(Field field, Object target, Collection<?> value) {
@@ -237,4 +223,46 @@ private static void setArray(Field field, Object config, List<?> value) {
         Object[] array = value.toArray((Object[]) Array.newInstance(componentType, 0));
         setField(field, config, array);
     }
+
+    private static Map<Field, Object> getFields(Object targetObject, FieldFilter fieldFilter) {
+        Map<Field, Object> fieldValues = new HashMap<>();
+
+        Class<?> objectClass = targetObject.getClass();
+        doWithFields(objectClass, field -> {
+            makeAccessible(field);
+            Object value = getField(field, targetObject);
+
+            if (value != null) {
+                if (Collection.class.isAssignableFrom(field.getType())) {
+                    value = Lists.newArrayList((Collection<?>) value);
+                } else if (Map.class.isAssignableFrom(field.getType())) {
+                    value = Maps.newHashMap((Map<?, ?>) value);
+                } else if (field.getType().isArray()) {
+                    value = Lists.newArrayList((Object[]) value);
+                }
+            }
+
+            fieldValues.put(field, value);
+        }, fieldFilter);
+
+        return fieldValues;
+    }
+
+    private static void setFields(Object targetObject, Map<Field, Object> fieldValues) {
+        fieldValues.forEach((field, value) -> {
+            makeAccessible(field);
+
+            if (value == null) {
+                setField(field, targetObject, value);
+            } else if (Collection.class.isAssignableFrom(field.getType())) {
+                setCollection(field, targetObject, (Collection<?>) value);
+            } else if (Map.class.isAssignableFrom(field.getType())) {
+                setMap(field, targetObject, (Map<?, ?>) value);
+            } else if (field.getType().isArray()) {
+                setArray(field, targetObject, (List<?>) value);
+            } else {
+                setField(field, targetObject, value);
+            }
+        });
+    }
 }
diff --git a/embedded-database-spring-test/src/main/java/io/zonky/test/db/flyway/FlywayWrapper.java b/embedded-database-spring-test/src/main/java/io/zonky/test/db/flyway/FlywayWrapper.java
@@ -398,12 +398,30 @@ public void setCleanDisabled(boolean cleanDisabled) {
         setValue(config, "setCleanDisabled", cleanDisabled);
     }
 
-    private static <T> T getValue(Object target, String method) {
-        return invokeMethod(target, method);
+    public List<Object> getConfigurationExtensions() {
+        if (flywayVersion >= 90) {
+            try {
+                Object pluginRegister = getField(getConfig(), "pluginRegister");
+                Class<?> pluginType = ClassUtils.forName("org.flywaydb.core.extensibility.ConfigurationExtension", classLoader);
+                return ImmutableList.copyOf(getList(pluginRegister, "getPlugins", pluginType));
+            } catch (ClassNotFoundException e) {
+                throw new IllegalStateException("Class not found: " + e.getMessage());
+            }
+        } else {
+            return ImmutableList.of();
+        }
+    }
+
+    private static <T> T getValue(Object target, String method, Object... args) {
+        return invokeMethod(target, method, args);
+    }
+
+    private static <E> E[] getArray(Object target, String method, Object... args) {
+        return invokeMethod(target, method, args);
     }
 
-    private static <E> E[] getArray(Object target, String method) {
-        return invokeMethod(target, method);
+    private static <E> List<E> getList(Object target, String method, Object... args) {
+        return invokeMethod(target, method, args);
     }
 
     private static void setValue(Object target, String method, Object value) {
diff --git a/embedded-database-spring-test/src/test/java/io/zonky/test/db/flyway/FlywayDescriptorTest.java b/embedded-database-spring-test/src/test/java/io/zonky/test/db/flyway/FlywayDescriptorTest.java
@@ -93,6 +93,30 @@ public void testDynamicFields() throws ClassNotFoundException {
         assertThat(descriptor1).isEqualTo(descriptor3);
     }
 
+    @Test
+    public void testPluginFields() {
+        FlywayWrapper wrapper1 = FlywayWrapper.newInstance();
+        wrapper1.getConfigurationExtensions().stream()
+                .filter(o -> o.getClass().getSimpleName().equals("PostgreSQLConfigurationExtension"))
+                .forEach(o -> invokeMethod(o, "setTransactionalLock", false));
+
+        FlywayWrapper wrapper2 = FlywayWrapper.newInstance();
+        wrapper2.getConfigurationExtensions().stream()
+                .filter(o -> o.getClass().getSimpleName().equals("PostgreSQLConfigurationExtension"))
+                .forEach(o -> invokeMethod(o, "setTransactionalLock", false));
+
+        FlywayDescriptor descriptor1 = FlywayDescriptor.from(wrapper1);
+        FlywayDescriptor descriptor2 = FlywayDescriptor.from(wrapper2);
+
+        assertThat(descriptor1).isEqualTo(descriptor2);
+
+        FlywayWrapper wrapper3 = FlywayWrapper.newInstance();
+        descriptor1.applyTo(wrapper3);
+        FlywayDescriptor descriptor3 = FlywayDescriptor.from(wrapper3);
+
+        assertThat(descriptor1).isEqualTo(descriptor3);
+    }
+
     @Test
     public void testExcludedFields() {
         FlywayWrapper wrapper1 = FlywayWrapper.newInstance();
