fix: Account for indeterminate Map ordering in unit tests #274
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
Fixed All Flaky Tests
lavaleri
suggested changes
Feb 8, 2022
There was a problem hiding this comment.
Thank you for the PR! I agree it would be good to fix up these tests. I have a couple bits of feedback on the PR, and once those are addressed I'd be happy to merge this in.
Also, the CI is failing due to formatting checks. You can run mvn com.coveo:fmt-maven-plugin:format to auto format your changes so that it meets our formatting requirements.
...st/java/com/amazonaws/services/dynamodbv2/datamodeling/encryption/DynamoDBEncryptorTest.java
Show resolved
Hide resolved
...va/com/amazonaws/services/dynamodbv2/datamodeling/internal/AttributeValueMarshallerTest.java
Outdated
Show resolved
Hide resolved
|
Hi there, thanks for your response! I've just addressed all requests. |
lavaleri
changed the title
|
Hi there, I just restored the original fix while addressing the style! |
seebees
pushed a commit
that referenced
this pull request
Dec 12, 2023
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.
Description
2 flaky tests are found using Nondex when running commands
mvn edu.illinois:nondex-maven-plugin:1.1.2:nondex Dtest=DynamoDBEncryptorTest#ensureEncryptedAttributesUnmodifiedand
mvn edu.illinois:nondex-maven-plugin:1.1.2:nondex -Dtest=AttributeValueMarshallerTest#testSimpleMapWithNullThe reason for test flakiness is that Java map API does not preserve the order of the key-value pairs. Comparing maps by casting to string can fail when, for example, the Java version upgrades in the future, or when the code is run in different environment.
Flaky Tests and Fixes
Test:
ensureEncryptedAttributesUnmodifiedinDynamoDBEncryptor.java.Reason & Fix: The test tries to compare two maps after casting them to strings. However, item orders in maps are not preserved. I converted the referenced maps to TreeMaps before casting them to string.
Test:
testSimpleMapWithNullinAttributeValueMarshallerTest.javaReason & Fix: Part of the expected string is a representation of a map. Similarly, order is not preserved in maps, hence I considered the 2 possible permutation patterns of the string representation of the map.