Skip to content

[TESTS-FOR-ALL-GENS] - refactor: replace Collectors.toMap with custom collector for case-insensitive file name ordering to simplify lookup in the table while debugging tests.#22977

Open
Picazsoo wants to merge 3 commits intoOpenAPITools:masterfrom
Picazsoo:feature/in-tests-order-generated-files-alphabetically
Open

[TESTS-FOR-ALL-GENS] - refactor: replace Collectors.toMap with custom collector for case-insensitive file name ordering to simplify lookup in the table while debugging tests.#22977
Picazsoo wants to merge 3 commits intoOpenAPITools:masterfrom
Picazsoo:feature/in-tests-order-generated-files-alphabetically

Conversation

@Picazsoo
Copy link
Copy Markdown
Contributor

@Picazsoo Picazsoo commented Feb 15, 2026

When debugging unit tests, it is very uncomfortable how the map for the generated files does not follow any logical order. I implemented the following fix to always present the items in the map in alphabetical order. The result is easier and quicker scanning when stepping through code in debug mode.
image

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Refactored tests to use a shared collector that maps generated files by name into a deterministically ordered TreeMap. This makes lookups predictable and debugging easier, with no changes to generator behavior.

  • Refactors
    • Added TestUtils.collectToCaseInsensitiveOrderedCaseSensitiveKeyMap to build a TreeMap ordered case-insensitively (then case-sensitively).
    • Replaced Collectors.toMap(File::getName, ...) with the new collector across tests.
    • Duplicate file names now fail fast with IllegalStateException.
    • Removed now-unneeded Function/Collectors imports in updated tests.

Written for commit c531df4. Summary will update on new commits.

Picazsoo and others added 3 commits February 15, 2026 09:40
…ensitive file name ordering to simplify lookup in the table while debugging tests.
…habetically

# Conflicts:
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java
…ensitive alphabetically ordered file name handling
@Picazsoo Picazsoo marked this pull request as ready for review April 16, 2026 00:34
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 14 files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant