[fix][test] Fixed ResponseBody Check in Test Helper #24872
+2
−1
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.
Fixes #24869
Motivation
Each of the below tests utilized a helper test method (called test) which incorrectly assumed that the json key-value pairs in responseBody would have a deterministic order. The order of key-value pairs is not guaranteed in JSON, however. As a result, the ordering can change due to different environments producing the contents in different orders despite the logical contents being the same. Each of the tests below used this helper to compare the responseBody "as-is" with an incorrect equals method so harmless re-ordering could flip the tests from pass to fail despite the data being semantically the same.
org.apache.pulsar.io.http.HttpSinkTest#testGenericRecordorg.apache.pulsar.io.http.HttpSinkTest#testKeyValueGenericRecordorg.apache.pulsar.io.http.HttpSinkTest#testKeyValuePrimitivesThis fix is similar to this other pull request which was previously merged (with the small difference that I used the test library these tests were already utilizing instead): #24821
Modifications
We no longer compare raw strings "as-is" with
WireMock.equalTo. Instead, we compare the json structures withWireMock.equalToJsonto perform a semantic comparison of the input JSON against the expected JSON as described in their documentation. This ensures the tests pass consistently, even when the serializer outputs fields in a different order.In essence, these changes keep the spirit of the original tests while eliminating failures caused solely by allowed (but previously unexpected) reordering.
Verifying this change
This change is already covered by existing tests, such as
org.apache.pulsar.io.http.HttpSinkTest#testGenericRecordorg.apache.pulsar.io.http.HttpSinkTest#testKeyValueGenericRecordorg.apache.pulsar.io.http.HttpSinkTest#testKeyValuePrimitivesorg.apache.pulsar.io.http.HttpSinkTest#testKeyValueGenericRecordDoes this pull request potentially affect one of the following parts:
If the box was checked, please highlight the changes
Documentation
docdoc-requireddoc-not-neededdoc-completeMatching PR in forked repository
PR in forked repository: LucasEby#6