refactor: replace Collectors.toMap with custom collector for case-insensitive alphabetically ordered file name handling

Author: Picazsoo

modules/openapi-generator/src/test/java/org/openapitools/codegen/TestUtils.java

@@ -182,8 +182,9 @@ public static void assertFileContains(Path path, String... lines) {
 
     /**
      * Count occurrences of the given text
+     *
      * @param content content of the file
-     * @param text text to find
+     * @param text    text to find
      * @return
      */
     public static int countOccurrences(String content, String text) {
@@ -358,12 +359,24 @@ public static Path newTempFolder() {
     /**
      * Returns a collector that collects files into a {@link TreeMap} sorted by file name,
      * using case-insensitive ordering (but accepting both keys - e.g. "application" and "Application").
-     * This is used to have files sorted by name (case-insensitive) to simplify lookup during test debugging.
+     * This is used to have files sorted by name (case-insensitive) to improve developer experience during test debugging.
      */
     @NotNull
     public static Collector<File, ?, TreeMap<String, File>> collectToCaseInsensitiveOrderedCaseSensitiveKeyMap() {
+        return collectToCaseInsensitiveOrderedCaseSensitiveKeyMap(File::getName);
+    }
+
+    /**
+     * Returns a collector that collects files into a {@link TreeMap} sorted by file name,
+     * using case-insensitive ordering (but accepting both keys - e.g. "application" and "Application").
+     * This is used to have files sorted by name (case-insensitive) to improve developer experience during test debugging.
+     */
+    @NotNull
+    public static Collector<File, ?, TreeMap<String, File>> collectToCaseInsensitiveOrderedCaseSensitiveKeyMap(
+            Function<File, String> keyMapper
+    ) {
         return Collectors.toMap(
-                File::getName,
+                keyMapper,
                 Function.identity(),
                 (existing, replacement) -> {
                     throw new IllegalStateException("Duplicate key: " + existing);

modules/openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java

@@ -2069,7 +2069,7 @@ private static Map<String, File> generateFromContract(
                 .setOutputDir(output.toString());
         consumer.accept(configurator);
         return new DefaultGenerator().opts(configurator.toClientOptInput()).generate()
-                .stream().collect(Collectors.toMap(JavaClientCodegenTest::getUniqueName, Function.identity()));
+                .stream().collect(collectToCaseInsensitiveOrderedCaseSensitiveKeyMap(JavaClientCodegenTest::getUniqueName));
     }
 
     private static String getUniqueName(File file) {

modules/openapi-generator/src/test/java/org/openapitools/codegen/java/jaxrs/JavaJAXRSSpecServerCodegenTest.java

@@ -1251,7 +1251,7 @@ public void testDiscriminatorMappingUsedInJsonTypeName() throws Exception {
 
         DefaultGenerator generator = new DefaultGenerator();
         Map<String, File> files = generator.opts(input).generate().stream()
-                .collect(Collectors.toMap(File::getName, Function.identity()));
+                .collect(collectToCaseInsensitiveOrderedCaseSensitiveKeyMap());
 
         // Parent model uses its own name
         JavaFileAssert.assertThat(files.get("PetRequest.java"))

modules/openapi-generator/src/test/java/org/openapitools/codegen/java/microprofile/JavaMicroprofileServerCodegenTest.java

@@ -253,7 +253,7 @@ public void testClientCanAccessFieldInParent() throws Exception {
         List<File> files = new DefaultGenerator().opts(input).generate();
 
         Map<String, File> filesMap = files.stream()
-                .collect(Collectors.toMap(File::getName, Function.identity()));
+                .collect(collectToCaseInsensitiveOrderedCaseSensitiveKeyMap());
 
         validateJavaSourceFiles(files);
 

modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

@@ -54,7 +54,6 @@
 import java.util.List;
 import java.util.Map;
 import java.util.function.Consumer;
-import java.util.stream.Collectors;
 
 import static java.util.stream.Collectors.groupingBy;
 import static org.assertj.core.api.Assertions.assertThat;
@@ -65,9 +64,7 @@
 import static org.openapitools.codegen.languages.SpringCodegen.*;
 import static org.openapitools.codegen.languages.features.DocumentationProviderFeatures.ANNOTATION_LIBRARY;
 import static org.openapitools.codegen.languages.features.DocumentationProviderFeatures.DOCUMENTATION_PROVIDER;
-import static org.testng.Assert.assertEquals;
-import static org.testng.Assert.assertNotNull;
-import static org.testng.Assert.fail;
+import static org.testng.Assert.*;
 
 public class SpringCodegenTest {
 
@@ -1107,7 +1104,7 @@ public void shouldGenerateExclusiveMinMaxForOAS31() throws IOException {
         DefaultGenerator generator = new DefaultGenerator();
         generator.setGenerateMetadata(false);
         Map<String, File> files = generator.opts(input).generate().stream()
-                .collect(Collectors.toMap(File::getName, Function.identity()));
+                .collect(collectToCaseInsensitiveOrderedCaseSensitiveKeyMap());
 
         System.out.println("Generated files:");
         files.keySet().stream().sorted().forEach(System.out::println);
@@ -1379,7 +1376,7 @@ private Map<String, File> generateFiles(SpringCodegen codegen, String filePath)
         generator.setGenerateMetadata(false); // skip metadata generation
         List<File> files = generator.opts(input).generate();
 
-        return files.stream().collect(Collectors.toMap(e -> e.getName().replace(outputPath, ""), i -> i));
+        return files.stream().collect(collectToCaseInsensitiveOrderedCaseSensitiveKeyMap());
     }
 
     /*
@@ -3167,7 +3164,7 @@ private Map<String, File> generateFromContract(String url, String library, Map<S
         generator.setGenerateMetadata(false);
 
         return generator.opts(input).generate().stream()
-                .collect(Collectors.toMap(this::getUniqueName, Function.identity()));
+                .collect(collectToCaseInsensitiveOrderedCaseSensitiveKeyMap(this::getUniqueName));
     }
 
     private String getUniqueName(File file) {
@@ -6542,7 +6539,7 @@ public void shouldImportJackson2JsonDeserializeForUniqueItemsWhenJackson3NotSet(
         generator.setGenerateMetadata(false); // skip metadata generation
 
         Map<String, File> files = generator.opts(input).generate().stream()
-                .collect(Collectors.toMap(File::getName, Function.identity()));
+                .collect(collectToCaseInsensitiveOrderedCaseSensitiveKeyMap());
 
         JavaFileAssert.assertThat(Paths.get(outputPath + "/src/main/java/org/openapitools/model/Pet.java"))
                 .hasImports("com.fasterxml.jackson.databind.annotation.JsonDeserialize");
@@ -6571,7 +6568,7 @@ public void shouldImportJackson3JsonDeserializeForUniqueItemsWhenJackson3Set() t
         generator.setGenerateMetadata(false); // skip metadata generation
 
         Map<String, File> files = generator.opts(input).generate().stream()
-                .collect(Collectors.toMap(File::getName, Function.identity()));
+                .collect(collectToCaseInsensitiveOrderedCaseSensitiveKeyMap());
 
         JavaFileAssert.assertThat(Paths.get(outputPath + "/src/main/java/org/openapitools/model/Pet.java"))
                 .hasImports("tools.jackson.databind.annotation.JsonDeserialize");
@@ -6600,7 +6597,7 @@ public void shouldNotHaveDocumentationAnnotationWhenUsingLibrarySpringHttpInterf
         generator.setGenerateMetadata(false); // skip metadata generation
 
         Map<String, File> files = generator.opts(input).generate().stream()
-                .collect(Collectors.toMap(File::getName, Function.identity()));
+                .collect(collectToCaseInsensitiveOrderedCaseSensitiveKeyMap());
 
         JavaFileAssert.assertThat(Paths.get(outputPath + "/src/main/java/org/openapitools/api/PetApi.java"))
                 .assertMethod("addPet").assertParameter("pet").assertParameterAnnotations().doesNotContainWithName("Parameter");

modules/openapi-generator/src/test/java/org/openapitools/codegen/php/PhpNextgenClientCodegenTest.java

@@ -142,7 +142,7 @@ public void testDiscriminatorUsesModelPackageNamespace() throws Exception {
 
         DefaultGenerator generator = new DefaultGenerator();
         Map<String, File> files = generator.opts(input).generate().stream()
-                .collect(Collectors.toMap(File::getName, Function.identity()));
+                .collect(collectToCaseInsensitiveOrderedCaseSensitiveKeyMap());
 
         List<String> objectSerializerContent = Files
                 .readAllLines(files.get("ObjectSerializer.php").toPath())