[Jenkins-65548] Fix - Random ordering of generated sources #702
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ceGeneratorMojo.java`
…into random-ordering-fix
jglick
reviewed
Dec 19, 2024
| @@ -118,6 +119,10 @@ private void report(JPackage pkg, String fileName) { | |||
| private void walk(File dir, JPackage pkg, String dirName) throws JClassAlreadyExistsException, IOException { | |||
| File[] children = dir.listFiles(File::isDirectory); | |||
| if (children != null) { | |||
| // Sorting the children to maintain a consistent order | |||
| // This is important for reproducible builds | |||
| Arrays.sort(children, (a, b) -> a.getName().compareToIgnoreCase(b.getName())); | |||
There was a problem hiding this comment.
Generally prefer simple case-sensitive compare unless there is a specific reason to make it case-insensitive. I guess it should not matter here because the only way the current code could result in an unreproducible order is if the directory contained two files differing only in case, like something.jelly + someThing.jelly, in which case the random order from listFiles would be preserved by this sort. But in that situation the repository could not even be checked out on Windows so someone would probably have noticed the mistake long ago anyway.
There was a problem hiding this comment.
Thank You for the tip. Will keep in mind.
jglick
approved these changes
Dec 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Testing done
Closes this - JIRA Ticket
To fix this issue, I've utilized Arrays.sort() (Alphabetically sorted by ignoring cases). This aims to maintain a consistent order which is necessary for reproducible builds.
Submitter checklist