From eb2c1cbcd47194191a2926d53f7ced787e0dbc9f Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Tue, 4 Oct 2022 12:29:45 +0200 Subject: [PATCH] Test encoding and Unicode normalization for scanned resources This commit introduces tests which serve as "regression tests" for the behavior of PathMatchingResourcePatternResolver in Spring Framework 5.3.x with regard to URL-encoding and Unicode normalization of resource paths. Specifically, the new tests demonstrate that resource paths do NOT need to be decoded or normalized in 5.3.x. See gh-29243 --- .../バリューオブジェクト.java | 26 ++++++++++ ...hMatchingResourcePatternResolverTests.java | 47 +++++++++++++++++++ .../バリューオブジェクト.text | 1 + src/checkstyle/checkstyle-suppressions.xml | 2 + 4 files changed, 76 insertions(+) create mode 100644 spring-core/src/test/java/example/japanese/バリューオブジェクト/バリューオブジェクト.java create mode 100644 spring-core/src/test/resources/japanese-resources/バリューオブジェクト/バリューオブジェクト.text diff --git a/spring-core/src/test/java/example/japanese/バリューオブジェクト/バリューオブジェクト.java b/spring-core/src/test/java/example/japanese/バリューオブジェクト/バリューオブジェクト.java new file mode 100644 index 0000000000..cede9b20ed --- /dev/null +++ b/spring-core/src/test/java/example/japanese/バリューオブジェクト/バリューオブジェクト.java @@ -0,0 +1,26 @@ +/* + * Copyright 2002-2022 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 example.japanese.バリューオブジェクト; + +/** + * This class and its package exist in order to test encoding and Unicode + * normalization for resource paths discovered via classpath scanning. + * + *

"バリューオブジェクト" is Japanese for "value object". + */ +public class バリューオブジェクト { +} diff --git a/spring-core/src/test/java/org/springframework/core/io/support/PathMatchingResourcePatternResolverTests.java b/spring-core/src/test/java/org/springframework/core/io/support/PathMatchingResourcePatternResolverTests.java index 31b3d6938c..b86da0fae0 100644 --- a/spring-core/src/test/java/org/springframework/core/io/support/PathMatchingResourcePatternResolverTests.java +++ b/spring-core/src/test/java/org/springframework/core/io/support/PathMatchingResourcePatternResolverTests.java @@ -105,6 +105,30 @@ class PathMatchingResourcePatternResolverTests { } + @Nested + class ContainingJapaneseCharactersInTheirPathsAndFileNames { + + @Test + void usingClasspathStarProtocol() { + String pattern = "classpath*:example/japanese/バリューオブジェクト/**/*.class"; + String pathPrefix = ".+example/japanese/"; + + assertExactFilenames(pattern, "バリューオブジェクト.class"); + assertExactSubPaths(pattern, pathPrefix, "バリューオブジェクト/バリューオブジェクト.class"); + } + + @Test + void usingFilePrototol() { + Path testResourcesDir = Paths.get("src/test/resources").toAbsolutePath(); + String pattern = String.format("file:%s/japanese-resources/バリューオブジェクト/**/*.text", testResourcesDir); + String pathPrefix = ".+japanese-resources/"; + + assertExactFilenames(pattern, "バリューオブジェクト.text"); + assertExactSubPaths(pattern, pathPrefix, "バリューオブジェクト/バリューオブジェクト.text"); + } + + } + } @@ -181,4 +205,27 @@ class PathMatchingResourcePatternResolverTests { } } + private void assertExactSubPaths(String pattern, String pathPrefix, String... subPaths) { + try { + Resource[] resources = resolver.getResources(pattern); + List actualSubPaths = Arrays.stream(resources) + .map(resource -> getPath(resource).replaceFirst(pathPrefix, "")) + .sorted() + .collect(Collectors.toList()); + assertThat(actualSubPaths).containsExactlyInAnyOrder(subPaths); + } + catch (IOException ex) { + throw new UncheckedIOException(ex); + } + } + + private String getPath(Resource resource) { + try { + return resource.getURL().getPath(); + } + catch (IOException ex) { + throw new UncheckedIOException(ex); + } + } + } diff --git a/spring-core/src/test/resources/japanese-resources/バリューオブジェクト/バリューオブジェクト.text b/spring-core/src/test/resources/japanese-resources/バリューオブジェクト/バリューオブジェクト.text new file mode 100644 index 0000000000..22c1978ca3 --- /dev/null +++ b/spring-core/src/test/resources/japanese-resources/バリューオブジェクト/バリューオブジェクト.text @@ -0,0 +1 @@ +value object \ No newline at end of file diff --git a/src/checkstyle/checkstyle-suppressions.xml b/src/checkstyle/checkstyle-suppressions.xml index b24ed59d9c..f4cf58230a 100644 --- a/src/checkstyle/checkstyle-suppressions.xml +++ b/src/checkstyle/checkstyle-suppressions.xml @@ -38,6 +38,8 @@ + +