spring/spring-boot
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-boot.git synced 2026-09-17 12:09:16 +00:00
Code Issues Projects Releases Wiki Activity

Polish "Preserve nested Flyway migration paths in native images"

Browse Source 
See gh-50433
This commit is contained in:
Stéphane Nicoll
2026-07-16 15:38:24 +02:00
parent d9ffeee4b7
commit 9f8f4da563
3 changed files with 79 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files
module/spring-boot-flyway/src/main/java/org/springframework/boot/flyway/autoconfigure/NativeImageResourceProvider.java
+10 -41
View File
@@ -18,7 +18,6 @@ package org.springframework.boot.flyway.autoconfigure;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.net.URI;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Collection;
@@ -39,6 +38,7 @@ import org.jspecify.annotations.Nullable;
import org.springframework.core.NativeDetector;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.util.PathMatcher;
/**
* A Flyway {@link ResourceProvider} which supports GraalVM native-image.
@@ -48,6 +48,7 @@ import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
*
* @author Moritz Halbritter
* @author Dongliang Xie
* @author Stephane Nicoll
*/
class NativeImageResourceProvider implements ResourceProvider {
@@ -141,60 +142,28 @@ class NativeImageResourceProvider implements ResourceProvider {
}
Resource[] resources = getResources(resolver, location, root);
for (Resource resource : resources) {
this.locatedResources
.add(new LocatedResource(resource, location, getClassPathResourcePath(location, root, resource)));
this.locatedResources.add(new LocatedResource(resource, location,
getClassPathResourcePath(resolver.getPathMatcher(), location, root, resource)));
}
}
}
private String getClassPathResourcePath(Location location, Resource root, Resource resource) {
private String getClassPathResourcePath(PathMatcher pathMatcher, Location location, Resource root,
Resource resource) {
if (resource instanceof org.springframework.core.io.ClassPathResource classPathResource) {
return classPathResource.getPath();
}
String rootPath = location.getRootPath();
String resourcePath = getResourcePathRelativeToRoot(root, resource, rootPath);
return (rootPath.isEmpty()) ? resourcePath : rootPath + "/" + resourcePath;
}
private String getResourcePathRelativeToRoot(Resource root, Resource resource, String rootPath) {
try {
URI rootUri = root.getURI();
URI resourceUri = resource.getURI();
String relativePath = getRelativePath(rootUri, resourceUri);
if (relativePath != null) {
return relativePath;
}
String path = getUriPath(resourceUri);
if (!rootPath.isEmpty()) {
int rootPathIndex = path.indexOf(rootPath + "/");
if (rootPathIndex != -1) {
return path.substring(rootPathIndex + rootPath.length() + 1);
}
}
String filename = resource.getFilename();
return (filename != null) ? filename : path;
String rootPath = location.getRootPath();
String relativePath = pathMatcher.extractPathWithinPattern(root.getURI() + "/**/*",
resource.getURI().toString());
return (rootPath.isEmpty()) ? relativePath : rootPath + "/" + relativePath;
}
catch (IOException ex) {
throw new UncheckedIOException("Failed to determine path for " + resource, ex);
}
}
private @Nullable String getRelativePath(URI rootUri, URI resourceUri) {
String rootPath = asDirectoryPath(rootUri);
String resourcePath = getUriPath(resourceUri);
return (resourcePath.startsWith(rootPath)) ? resourcePath.substring(rootPath.length()) : null;
}
private String asDirectoryPath(URI uri) {
String path = getUriPath(uri);
return (path.endsWith("/")) ? path : path + "/";
}
private String getUriPath(URI uri) {
String path = uri.getPath();
return (path != null) ? path : uri.toString();
}
private Resource[] getResources(PathMatchingResourcePatternResolver resolver, Location location, Resource root) {
try {
return resolver.getResources(root.getURI() + "/**/*");
module/spring-boot-flyway/src/test/java/org/springframework/boot/flyway/autoconfigure/NativeImageResourceProviderCustomizerTests.java
-34
View File
@@ -16,34 +16,23 @@
package org.springframework.boot.flyway.autoconfigure;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.flywaydb.core.api.Location;
import org.flywaydb.core.api.ResourceProvider;
import org.flywaydb.core.api.configuration.FluentConfiguration;
import org.flywaydb.core.api.resource.LoadableResource;
import org.flywaydb.core.internal.resource.NoopResourceProvider;
import org.flywaydb.core.internal.scanner.Scanner;
import org.junit.jupiter.api.Test;
import org.springframework.boot.testsupport.classpath.ForkedClassPath;
import org.springframework.boot.testsupport.classpath.resources.WithResource;
import org.springframework.boot.testsupport.classpath.resources.WithResources;
import org.springframework.util.FileCopyUtils;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link NativeImageResourceProviderCustomizer}.
*
* @author Moritz Halbritter
* @author Dongliang Xie
*/
class NativeImageResourceProviderCustomizerTests {
@@ -81,29 +70,6 @@ class NativeImageResourceProviderCustomizerTests {
assertThat(migrations).containsExactlyInAnyOrder(v1, v2);
}
@Test
@ForkedClassPath
@WithResource(name = "db/migration/nested/V2__users.sql", content = "select 1;")
void nativeImageResourceProviderShouldReadNestedMigrations() throws IOException {
System.setProperty("org.graalvm.nativeimage.imagecode", "true");
try {
@SuppressWarnings("unchecked")
Scanner<Object> scanner = mock(Scanner.class);
given(scanner.getResources("V", ".sql")).willReturn(Collections.emptyList());
Location location = Location.fromPath("classpath:", "db/migration");
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
ResourceProvider resourceProvider = new NativeImageResourceProvider(scanner, classLoader, List.of(location),
StandardCharsets.UTF_8, true);
Collection<LoadableResource> migrations = resourceProvider.getResources("V", new String[] { ".sql" });
assertThat(migrations).hasSize(1);
LoadableResource migration = migrations.iterator().next();
assertThat(FileCopyUtils.copyToString(migration.read())).isEqualTo("select 1;");
}
finally {
System.clearProperty("org.graalvm.nativeimage.imagecode");
}
}
@Test
void shouldBackOffOnCustomResourceProvider() {
FluentConfiguration configuration = new FluentConfiguration();
module/spring-boot-flyway/src/test/java/org/springframework/boot/flyway/autoconfigure/NativeImageResourceProviderTests.java
+69
View File
@@ -0,0 +1,69 @@
/*
* Copyright 2012-present 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.flyway.autoconfigure;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.flywaydb.core.api.Location;
import org.flywaydb.core.api.ResourceProvider;
import org.flywaydb.core.api.resource.LoadableResource;
import org.flywaydb.core.internal.scanner.Scanner;
import org.junit.jupiter.api.Test;
import org.springframework.boot.testsupport.classpath.ForkedClassPath;
import org.springframework.boot.testsupport.classpath.resources.WithResource;
import org.springframework.util.FileCopyUtils;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link NativeImageResourceProvider}.
*
* @author Dongliang Xie
* @author Stephane Nicoll
*/
class NativeImageResourceProviderTests {
@Test
@ForkedClassPath
@WithResource(name = "db/migration/nested/V2__users.sql", content = "select 1;")
void nativeImageResourceProviderShouldReadNestedMigrations() throws IOException {
System.setProperty("org.graalvm.nativeimage.imagecode", "true");
try {
Scanner<?> scanner = mock();
given(scanner.getResources("V", ".sql")).willReturn(Collections.emptyList());
Location location = Location.fromPath("classpath:", "db/migration");
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
ResourceProvider resourceProvider = new NativeImageResourceProvider(scanner, classLoader, List.of(location),
StandardCharsets.UTF_8, true);
Collection<LoadableResource> migrations = resourceProvider.getResources("V", new String[] { ".sql" });
assertThat(migrations).hasSize(1);
LoadableResource migration = migrations.iterator().next();
assertThat(FileCopyUtils.copyToString(migration.read())).isEqualTo("select 1;");
}
finally {
System.clearProperty("org.graalvm.nativeimage.imagecode");
}
}
}