Fix flaky test in BasicHttpClientTest #732
Merged
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.
Fix for Issue #733
Fix Flaky Test in
BasicHttpClientTestWhat is the purpose of this PR?
This pull request addresses several flaky test, in the
zerocodeproject. The test was failing intermittently due to assumptions about the ordering of fields returned by the code under test.Test Affected
BasicHttpClientTest.createRequestBuilderBasicHttpClientTest.createRequestBuilder_spaceInKeyValueBasicHttpClientTest.createRequestBuilder_frontSlashBasicHttpClientTest.createRequestBuilder_jsonValueWhy the test fails
The flakiness was caused by relying on field ordering from a java.util.Map (see BasicHttpClient.java#L305).
All test specified above relied on ordering returned by java.util.Map. It does not guarantee field order by default. This caused the test to fail when the field order changed, especially under NonDex shuffling, which explores non-deterministic behaviors.
How to reproduce the test failure
Run the test with NonDex to simulate shuffling of field order:
Before the fix, the test failed intermittently with errors similar to:
Expected results
The test should pass consistently, regardless of the order of fields in the returned response.
Actual results
Before the fix, the test failed intermittently due to changes in the order of the returned response.
Description of fix
Validation
Test Results
Tests run normally: Passed
mvn -pl core test -Dtest=org.jsmart.zerocode.core.httpclient.BasicHttpClientTestTests run with NonDex: Passed consistently across multiple seeds
Additional Notes
Let me know if further improvements or clarifications are needed!