Browse Source

Apply fallback resolution for non-hierarchical URIs such as "file:."

Includes meaningful exception message for file system resolution.

Closes gh-33124

(cherry picked from commit daea3f0eae)
pull/33211/head
Juergen Hoeller 1 year ago
parent
commit
2302b30c2b
  1. 17
      spring-beans/src/main/java/org/springframework/beans/propertyeditors/PathEditor.java
  2. 61
      spring-beans/src/test/java/org/springframework/beans/propertyeditors/FileEditorTests.java
  3. 67
      spring-beans/src/test/java/org/springframework/beans/propertyeditors/PathEditorTests.java

17
spring-beans/src/main/java/org/springframework/beans/propertyeditors/PathEditor.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2023 the original author or authors. * Copyright 2002-2024 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -92,9 +92,9 @@ public class PathEditor extends PropertyEditorSupport {
// a file prefix (let's try as Spring resource location) // a file prefix (let's try as Spring resource location)
nioPathCandidate = !text.startsWith(ResourceUtils.FILE_URL_PREFIX); nioPathCandidate = !text.startsWith(ResourceUtils.FILE_URL_PREFIX);
} }
catch (FileSystemNotFoundException ex) { catch (FileSystemNotFoundException | IllegalArgumentException ex) {
// URI scheme not registered for NIO (let's try URL // URI scheme not registered for NIO or not meeting Paths requirements:
// protocol handlers via Spring's resource mechanism). // let's try URL protocol handlers via Spring's resource mechanism.
} }
} }
@ -111,8 +111,13 @@ public class PathEditor extends PropertyEditorSupport {
setValue(resource.getFile().toPath()); setValue(resource.getFile().toPath());
} }
catch (IOException ex) { catch (IOException ex) {
throw new IllegalArgumentException( String msg = "Could not resolve \"" + text + "\" to 'java.nio.file.Path' for " + resource + ": " +
"Could not retrieve file for " + resource + ": " + ex.getMessage()); ex.getMessage();
if (nioPathCandidate) {
msg += " - In case of ambiguity, consider adding the 'file:' prefix for an explicit reference " +
"to a file system resource of the same name: \"file:" + text + "\"";
}
throw new IllegalArgumentException(msg);
} }
} }
} }

61
spring-beans/src/test/java/org/springframework/beans/propertyeditors/FileEditorTests.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2019 the original author or authors. * Copyright 2002-2024 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -31,79 +31,82 @@ import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException
* @author Chris Beams * @author Chris Beams
* @author Juergen Hoeller * @author Juergen Hoeller
*/ */
public class FileEditorTests { class FileEditorTests {
@Test @Test
public void testClasspathFileName() throws Exception { void testClasspathFileName() {
PropertyEditor fileEditor = new FileEditor(); PropertyEditor fileEditor = new FileEditor();
fileEditor.setAsText("classpath:" + ClassUtils.classPackageAsResourcePath(getClass()) + "/" + fileEditor.setAsText("classpath:" + ClassUtils.classPackageAsResourcePath(getClass()) + "/" +
ClassUtils.getShortName(getClass()) + ".class"); ClassUtils.getShortName(getClass()) + ".class");
Object value = fileEditor.getValue(); Object value = fileEditor.getValue();
boolean condition = value instanceof File; assertThat(value).isInstanceOf(File.class);
assertThat(condition).isTrue();
File file = (File) value; File file = (File) value;
assertThat(file.exists()).isTrue(); assertThat(file).exists();
} }
@Test @Test
public void testWithNonExistentResource() throws Exception { void testWithNonExistentResource() {
PropertyEditor propertyEditor = new FileEditor(); PropertyEditor fileEditor = new FileEditor();
assertThatIllegalArgumentException().isThrownBy(() -> assertThatIllegalArgumentException().isThrownBy(() ->
propertyEditor.setAsText("classpath:no_way_this_file_is_found.doc")); fileEditor.setAsText("classpath:no_way_this_file_is_found.doc"));
} }
@Test @Test
public void testWithNonExistentFile() throws Exception { void testWithNonExistentFile() {
PropertyEditor fileEditor = new FileEditor(); PropertyEditor fileEditor = new FileEditor();
fileEditor.setAsText("file:no_way_this_file_is_found.doc"); fileEditor.setAsText("file:no_way_this_file_is_found.doc");
Object value = fileEditor.getValue(); Object value = fileEditor.getValue();
boolean condition1 = value instanceof File; assertThat(value).isInstanceOf(File.class);
assertThat(condition1).isTrue();
File file = (File) value; File file = (File) value;
boolean condition = !file.exists(); assertThat(file).doesNotExist();
assertThat(condition).isTrue();
} }
@Test @Test
public void testAbsoluteFileName() throws Exception { void testAbsoluteFileName() {
PropertyEditor fileEditor = new FileEditor(); PropertyEditor fileEditor = new FileEditor();
fileEditor.setAsText("/no_way_this_file_is_found.doc"); fileEditor.setAsText("/no_way_this_file_is_found.doc");
Object value = fileEditor.getValue(); Object value = fileEditor.getValue();
boolean condition1 = value instanceof File; assertThat(value).isInstanceOf(File.class);
assertThat(condition1).isTrue(); File file = (File) value;
assertThat(file).doesNotExist();
}
@Test
void testCurrentDirectory() {
PropertyEditor fileEditor = new FileEditor();
fileEditor.setAsText("file:.");
Object value = fileEditor.getValue();
assertThat(value).isInstanceOf(File.class);
File file = (File) value; File file = (File) value;
boolean condition = !file.exists(); assertThat(file).isEqualTo(new File("."));
assertThat(condition).isTrue();
} }
@Test @Test
public void testUnqualifiedFileNameFound() throws Exception { void testUnqualifiedFileNameFound() {
PropertyEditor fileEditor = new FileEditor(); PropertyEditor fileEditor = new FileEditor();
String fileName = ClassUtils.classPackageAsResourcePath(getClass()) + "/" + String fileName = ClassUtils.classPackageAsResourcePath(getClass()) + "/" +
ClassUtils.getShortName(getClass()) + ".class"; ClassUtils.getShortName(getClass()) + ".class";
fileEditor.setAsText(fileName); fileEditor.setAsText(fileName);
Object value = fileEditor.getValue(); Object value = fileEditor.getValue();
boolean condition = value instanceof File; assertThat(value).isInstanceOf(File.class);
assertThat(condition).isTrue();
File file = (File) value; File file = (File) value;
assertThat(file.exists()).isTrue(); assertThat(file).exists();
String absolutePath = file.getAbsolutePath().replace('\\', '/'); String absolutePath = file.getAbsolutePath().replace('\\', '/');
assertThat(absolutePath.endsWith(fileName)).isTrue(); assertThat(absolutePath).endsWith(fileName);
} }
@Test @Test
public void testUnqualifiedFileNameNotFound() throws Exception { void testUnqualifiedFileNameNotFound() {
PropertyEditor fileEditor = new FileEditor(); PropertyEditor fileEditor = new FileEditor();
String fileName = ClassUtils.classPackageAsResourcePath(getClass()) + "/" + String fileName = ClassUtils.classPackageAsResourcePath(getClass()) + "/" +
ClassUtils.getShortName(getClass()) + ".clazz"; ClassUtils.getShortName(getClass()) + ".clazz";
fileEditor.setAsText(fileName); fileEditor.setAsText(fileName);
Object value = fileEditor.getValue(); Object value = fileEditor.getValue();
boolean condition = value instanceof File; assertThat(value).isInstanceOf(File.class);
assertThat(condition).isTrue();
File file = (File) value; File file = (File) value;
assertThat(file.exists()).isFalse(); assertThat(file).doesNotExist();
String absolutePath = file.getAbsolutePath().replace('\\', '/'); String absolutePath = file.getAbsolutePath().replace('\\', '/');
assertThat(absolutePath.endsWith(fileName)).isTrue(); assertThat(absolutePath).endsWith(fileName);
} }
} }

67
spring-beans/src/test/java/org/springframework/beans/propertyeditors/PathEditorTests.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2021 the original author or authors. * Copyright 2002-2024 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -19,6 +19,7 @@ package org.springframework.beans.propertyeditors;
import java.beans.PropertyEditor; import java.beans.PropertyEditor;
import java.io.File; import java.io.File;
import java.nio.file.Path; import java.nio.file.Path;
import java.nio.file.Paths;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
@ -31,65 +32,65 @@ import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException
* @author Juergen Hoeller * @author Juergen Hoeller
* @since 4.3.2 * @since 4.3.2
*/ */
public class PathEditorTests { class PathEditorTests {
@Test @Test
public void testClasspathPathName() { void testClasspathPathName() {
PropertyEditor pathEditor = new PathEditor(); PropertyEditor pathEditor = new PathEditor();
pathEditor.setAsText("classpath:" + ClassUtils.classPackageAsResourcePath(getClass()) + "/" + pathEditor.setAsText("classpath:" + ClassUtils.classPackageAsResourcePath(getClass()) + "/" +
ClassUtils.getShortName(getClass()) + ".class"); ClassUtils.getShortName(getClass()) + ".class");
Object value = pathEditor.getValue(); Object value = pathEditor.getValue();
assertThat(value instanceof Path).isTrue(); assertThat(value).isInstanceOf(Path.class);
Path path = (Path) value; Path path = (Path) value;
assertThat(path.toFile().exists()).isTrue(); assertThat(path.toFile()).exists();
} }
@Test @Test
public void testWithNonExistentResource() { void testWithNonExistentResource() {
PropertyEditor propertyEditor = new PathEditor(); PropertyEditor pathEditor = new PathEditor();
assertThatIllegalArgumentException().isThrownBy(() -> assertThatIllegalArgumentException().isThrownBy(() ->
propertyEditor.setAsText("classpath:/no_way_this_file_is_found.doc")); pathEditor.setAsText("classpath:/no_way_this_file_is_found.doc"));
} }
@Test @Test
public void testWithNonExistentPath() { void testWithNonExistentPath() {
PropertyEditor pathEditor = new PathEditor(); PropertyEditor pathEditor = new PathEditor();
pathEditor.setAsText("file:/no_way_this_file_is_found.doc"); pathEditor.setAsText("file:/no_way_this_file_is_found.doc");
Object value = pathEditor.getValue(); Object value = pathEditor.getValue();
assertThat(value instanceof Path).isTrue(); assertThat(value).isInstanceOf(Path.class);
Path path = (Path) value; Path path = (Path) value;
assertThat(!path.toFile().exists()).isTrue(); assertThat(path.toFile()).doesNotExist();
} }
@Test @Test
public void testAbsolutePath() { void testAbsolutePath() {
PropertyEditor pathEditor = new PathEditor(); PropertyEditor pathEditor = new PathEditor();
pathEditor.setAsText("/no_way_this_file_is_found.doc"); pathEditor.setAsText("/no_way_this_file_is_found.doc");
Object value = pathEditor.getValue(); Object value = pathEditor.getValue();
assertThat(value instanceof Path).isTrue(); assertThat(value).isInstanceOf(Path.class);
Path path = (Path) value; Path path = (Path) value;
assertThat(!path.toFile().exists()).isTrue(); assertThat(path.toFile()).doesNotExist();
} }
@Test @Test
public void testWindowsAbsolutePath() { void testWindowsAbsolutePath() {
PropertyEditor pathEditor = new PathEditor(); PropertyEditor pathEditor = new PathEditor();
pathEditor.setAsText("C:\\no_way_this_file_is_found.doc"); pathEditor.setAsText("C:\\no_way_this_file_is_found.doc");
Object value = pathEditor.getValue(); Object value = pathEditor.getValue();
assertThat(value instanceof Path).isTrue(); assertThat(value).isInstanceOf(Path.class);
Path path = (Path) value; Path path = (Path) value;
assertThat(!path.toFile().exists()).isTrue(); assertThat(path.toFile()).doesNotExist();
} }
@Test @Test
public void testWindowsAbsoluteFilePath() { void testWindowsAbsoluteFilePath() {
PropertyEditor pathEditor = new PathEditor(); PropertyEditor pathEditor = new PathEditor();
try { try {
pathEditor.setAsText("file://C:\\no_way_this_file_is_found.doc"); pathEditor.setAsText("file://C:\\no_way_this_file_is_found.doc");
Object value = pathEditor.getValue(); Object value = pathEditor.getValue();
assertThat(value instanceof Path).isTrue(); assertThat(value).isInstanceOf(Path.class);
Path path = (Path) value; Path path = (Path) value;
assertThat(!path.toFile().exists()).isTrue(); assertThat(path.toFile()).doesNotExist();
} }
catch (IllegalArgumentException ex) { catch (IllegalArgumentException ex) {
if (File.separatorChar == '\\') { // on Windows, otherwise silently ignore if (File.separatorChar == '\\') { // on Windows, otherwise silently ignore
@ -99,39 +100,49 @@ public class PathEditorTests {
} }
@Test @Test
public void testUnqualifiedPathNameFound() { void testCurrentDirectory() {
PropertyEditor pathEditor = new PathEditor();
pathEditor.setAsText("file:.");
Object value = pathEditor.getValue();
assertThat(value).isInstanceOf(Path.class);
Path path = (Path) value;
assertThat(path).isEqualTo(Paths.get("."));
}
@Test
void testUnqualifiedPathNameFound() {
PropertyEditor pathEditor = new PathEditor(); PropertyEditor pathEditor = new PathEditor();
String fileName = ClassUtils.classPackageAsResourcePath(getClass()) + "/" + String fileName = ClassUtils.classPackageAsResourcePath(getClass()) + "/" +
ClassUtils.getShortName(getClass()) + ".class"; ClassUtils.getShortName(getClass()) + ".class";
pathEditor.setAsText(fileName); pathEditor.setAsText(fileName);
Object value = pathEditor.getValue(); Object value = pathEditor.getValue();
assertThat(value instanceof Path).isTrue(); assertThat(value).isInstanceOf(Path.class);
Path path = (Path) value; Path path = (Path) value;
File file = path.toFile(); File file = path.toFile();
assertThat(file.exists()).isTrue(); assertThat(file).exists();
String absolutePath = file.getAbsolutePath(); String absolutePath = file.getAbsolutePath();
if (File.separatorChar == '\\') { if (File.separatorChar == '\\') {
absolutePath = absolutePath.replace('\\', '/'); absolutePath = absolutePath.replace('\\', '/');
} }
assertThat(absolutePath.endsWith(fileName)).isTrue(); assertThat(absolutePath).endsWith(fileName);
} }
@Test @Test
public void testUnqualifiedPathNameNotFound() { void testUnqualifiedPathNameNotFound() {
PropertyEditor pathEditor = new PathEditor(); PropertyEditor pathEditor = new PathEditor();
String fileName = ClassUtils.classPackageAsResourcePath(getClass()) + "/" + String fileName = ClassUtils.classPackageAsResourcePath(getClass()) + "/" +
ClassUtils.getShortName(getClass()) + ".clazz"; ClassUtils.getShortName(getClass()) + ".clazz";
pathEditor.setAsText(fileName); pathEditor.setAsText(fileName);
Object value = pathEditor.getValue(); Object value = pathEditor.getValue();
assertThat(value instanceof Path).isTrue(); assertThat(value).isInstanceOf(Path.class);
Path path = (Path) value; Path path = (Path) value;
File file = path.toFile(); File file = path.toFile();
assertThat(file.exists()).isFalse(); assertThat(file).doesNotExist();
String absolutePath = file.getAbsolutePath(); String absolutePath = file.getAbsolutePath();
if (File.separatorChar == '\\') { if (File.separatorChar == '\\') {
absolutePath = absolutePath.replace('\\', '/'); absolutePath = absolutePath.replace('\\', '/');
} }
assertThat(absolutePath.endsWith(fileName)).isTrue(); assertThat(absolutePath).endsWith(fileName);
} }
} }

Loading…
Cancel
Save