Skip to content

Flyway auto-configuration does not work with Flyway 10 when using GraalVM #40821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

package org.springframework.boot.autoconfigure.flyway;

import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.util.Arrays;

import org.flywaydb.core.api.configuration.FluentConfiguration;
Expand All @@ -24,26 +26,63 @@
import org.flywaydb.core.internal.scanner.ResourceNameCache;
import org.flywaydb.core.internal.scanner.Scanner;

import org.springframework.util.ClassUtils;

/**
* Registers {@link NativeImageResourceProvider} as a Flyway
* {@link org.flywaydb.core.api.ResourceProvider}.
*
* @author Moritz Halbritter
* @author Maziz Esa
*/
class NativeImageResourceProviderCustomizer extends ResourceProviderCustomizer {

@Override
public void customize(FluentConfiguration configuration) {
if (configuration.getResourceProvider() == null) {
Scanner<JavaMigration> scanner = new Scanner<>(JavaMigration.class,
Arrays.asList(configuration.getLocations()), configuration.getClassLoader(),
configuration.getEncoding(), configuration.isDetectEncoding(), false, new ResourceNameCache(),
new LocationScannerCache(), configuration.isFailOnMissingLocations());
final var scanner = getFlyway9OrFallbackTo10ScannerObject(configuration);
NativeImageResourceProvider resourceProvider = new NativeImageResourceProvider(scanner,
configuration.getClassLoader(), Arrays.asList(configuration.getLocations()),
configuration.getEncoding(), configuration.isFailOnMissingLocations());
configuration.resourceProvider(resourceProvider);
}
}

private static Scanner getFlyway9OrFallbackTo10ScannerObject(FluentConfiguration configuration) {
Scanner scanner;
try {
scanner = getFlyway9Scanner(configuration);
}
catch (NoSuchMethodError noSuchMethodError) {
// happens when scanner is flyway version 10, which the constructor accepts
// different number of parameters.
scanner = getFlyway10Scanner(configuration);
}
return scanner;
}

private static Scanner getFlyway10Scanner(FluentConfiguration configuration) {
final Constructor<?> scannerConstructor;
final Scanner scanner;
try {
scannerConstructor = ClassUtils.forName("org.flywaydb.core.internal.scanner.Scanner", null)
.getDeclaredConstructors()[0];
scanner = (Scanner) scannerConstructor.newInstance(JavaMigration.class, false, new ResourceNameCache(),
new LocationScannerCache(), configuration);
}
catch (ClassNotFoundException | InstantiationException | IllegalAccessException
| InvocationTargetException ex) {
throw new RuntimeException(ex);
}
return scanner;
}

private static Scanner getFlyway9Scanner(FluentConfiguration configuration) {
Scanner scanner;
scanner = new Scanner<>(JavaMigration.class, Arrays.asList(configuration.getLocations()),
configuration.getClassLoader(), configuration.getEncoding(), configuration.isDetectEncoding(), false,
new ResourceNameCache(), new LocationScannerCache(), configuration.isFailOnMissingLocations());
return scanner;
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*
* Copyright 2012-2023 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.boot.autoconfigure.flyway;

import java.util.Collection;

import org.flywaydb.core.api.ResourceProvider;
import org.flywaydb.core.api.configuration.FluentConfiguration;
import org.flywaydb.core.api.resource.LoadableResource;
import org.junit.jupiter.api.Test;

import org.springframework.boot.testsupport.classpath.ClassPathOverrides;

import static org.assertj.core.api.Assertions.assertThat;

/**
* Tests for {@link NativeImageResourceProviderCustomizer} with Flyway 10.
*
* @author Moritz Halbritter
* @author Andy Wilkinson
* @author Maziz
*/
@ClassPathOverrides("org.flywaydb:flyway-core:10.12.0")
class Flyway10NativeImageResourceProviderCustomizerTests {

private final NativeImageResourceProviderCustomizer customizer = new NativeImageResourceProviderCustomizer();

@Test
void nativeImageResourceProviderShouldFindMigrations() {
FluentConfiguration configuration = new FluentConfiguration();
this.customizer.customize(configuration);
ResourceProvider resourceProvider = configuration.getResourceProvider();
Collection<LoadableResource> migrations = resourceProvider.getResources("V", new String[] { ".sql" });
LoadableResource migration = resourceProvider.getResource("V1__init.sql");
assertThat(migrations).containsExactly(migration);
}

}