[LOG4J2-3805] NamedInstantPatternTest#compatibilityOfLegacyPattern fails in timezones with minute offsets (e.g., GMT+05:30) #3888
+15
−1
Conversation
This file contains hidden or 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
…imezone offsets The compatibilityOfLegacyPattern test fails in environments where the system default timezone has a non-zero minute offset (e.g., Asia/Kolkata, Asia/Kathmandu). Root cause: - SimpleDateFormat's X pattern truncates fractional offsets (e.g., +05:30 → +05). - DateTimeFormatter's X pattern preserves the minutes (+05:30). Since Log4j intentionally follows DateTimeFormatter’s behavior, the test should not assert equivalence in such environments. This change adds an assumption to skip the test when the system timezone offset is not a whole hour. This ensures deterministic builds for contributors in all regions, while still verifying correctness in whole-hour zones. Closes apache#3805
ramanathan1504
changed the title
Generated by gradle/develocity-actions |
ppkarwasz
requested changes
Aug 19, 2025
There was a problem hiding this comment.
Hi @ramanathan1504,
Could you move the assumption to the beginning of the test, so it is easier to follow?
Comment on lines
+46
to
+55
| if (namedPattern == NamedInstantPattern.ISO8601_OFFSET_DATE_TIME_HH) { | ||
| java.time.ZoneOffset offset = | ||
| java.time.ZoneId.systemDefault().getRules().getOffset(java.time.Instant.now()); | ||
| Assumptions.assumeTrue( | ||
| offset.getTotalSeconds() % 3600 == 0, | ||
| () -> String.format( | ||
| "Skipping test: ISO8601_OFFSET_DATE_TIME_HH requires a whole-hour offset, but system offset is %s", | ||
| offset)); | ||
| assertThat(legacy).isEqualTo(modern); | ||
| } else { |
There was a problem hiding this comment.
The assumption check should be the very first thing in the test. That way, if it fails, none of the setup or assertions will run. Since Assumptions.assumeTrue(...) throws an exception when the condition is not met, you don’t need to wrap later code in an if block — the test will be skipped automatically. This also makes the test flow easier to follow.
Nitpick: personally I prefer AssertJ over pure JUnit5. It also has an Assumptions class.
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.
The compatibilityOfLegacyPattern test fails in timezones with fractional offsets
(e.g., Asia/Kolkata). This happens because SimpleDateFormat truncates fractional
offsets (+05:30 → +05) while DateTimeFormatter preserves them.
This change skips the test in such environments, ensuring consistent builds.
fix #3885