[fix][test] Fixed nondeterministic JSON ordering in multiple tests #24821
+113
−28
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 #24820
Motivation
Each of the tests below were written with the assumption that the json key-value pairs would have a deterministic order (by comparing json results vs hard coded strings). The order of key-value pairs is not guaranteed in JSON files or JSON objects, though. As a result, the ordering can change due to different environments producing the contents in different orders despite the logical contents being the same. Since each of the tests below compare the raw strings/trees "as-is", harmless re-ordering could flip the test from pass to fail despite the data being semantically the same.
org.apache.pulsar.common.policies.data.NamespaceOwnershipStatusTest#testSerialization
org.apache.pulsar.common.policies.impl.NamespaceIsolationPoliciesTest#testJsonSerialization
org.apache.pulsar.functions.utils.FunctionConfigUtilsTest#testConvertBackFidelity
org.apache.pulsar.functions.utils.SinkConfigUtilsTest#testConvertBackFidelity
org.apache.pulsar.functions.utils.SourceConfigUtilsTest#testBatchConfigMergeEqual
org.apache.pulsar.io.elasticsearch.ElasticSearchExtractTest#testGenericRecord
org.apache.pulsar.io.kinesis.UtilsTest#testKeyValueSerializeNoValue
.Modifications
We no longer compare raw strings "as-is" with
Assert.assertEquals
. Instead, we compare the json structures withJsonAssert.assertEquals(expectedJson, actualJson, JSONCompareMode)
which parses both inputs into JSON trees. It treats these JSON trees as unordered collections of key-value pairs when determining if they are equal so differences in property order no longer matter. 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.common.policies.data.NamespaceOwnershipStatusTest#testSerialization
,org.apache.pulsar.common.policies.impl.NamespaceIsolationPoliciesTest#testJsonSerialization
,org.apache.pulsar.functions.utils.FunctionConfigUtilsTest#testConvertBackFidelity
,org.apache.pulsar.functions.utils.SinkConfigUtilsTest#testConvertBackFidelity
,org.apache.pulsar.functions.utils.SourceConfigUtilsTest#testBatchConfigMergeEqual
,org.apache.pulsar.io.elasticsearch.ElasticSearchExtractTest#testGenericRecord
, andorg.apache.pulsar.io.kinesis.UtilsTest#testKeyValueSerializeNoValue
.Does this pull request potentially affect one of the following parts:
If the box was checked, please highlight the changes
Documentation
doc
doc-required
doc-not-needed
doc-complete
Matching PR in forked repository
PR in forked repository: LucasEby#3