[fix][test] Fixed nondeterministic ordering in MongoSourceTest.testWriteBadMessage

[LucasEby]

Fixes #24834

Motivation

The test was written with the incorrect assumption that the compared strings have a deterministic order. Since the original data was stored with HashMaps, which makes no guarantees to the order of it's map, the resulting strings that were compared could potentially have reordered contents. The ordering can change due to different environments producing the contents in different orders despite the logical contents being the same. Since the raw strings/trees were compared "as-is", harmless re-ordering could flip the test from pass to fail despite the data being semantically the same.

Modifications

We no longer compare the raw strings "as-is", we instead convert the strings into BsonDocuments which are ordered to fix the nondeterminism. This ensures the tests pass consistently, even in cases where the original contents were in a different order due to the usage of HashMaps.

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

• Make sure that the change passes the CI checks.

This change is already covered by existing tests, such as org.apache.pulsar.io.mongodb.MongoSourceTest#testWriteBadMessage

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

• Dependencies (add or upgrade a dependency)
• The public API
• The schema
• The default values of configurations
• The threading model
• The binary protocol
• The REST endpoints
• The admin CLI options
• The metrics
• Anything that affects deployment

Documentation

• doc
• doc-required
• doc-not-needed
• doc-complete

Matching PR in forked repository

PR in forked repository: LucasEby#4

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 39.66%. Comparing base (4457b08) to head (04f3304).
⚠️ Report is 6 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master   #24835      +/-   ##
============================================
+ Coverage     38.39%   39.66%   +1.26%     
- Complexity    13123    13978     +855     
============================================
  Files          1856     1856              
  Lines        145015   148864    +3849     
  Branches      16818    17710     +892     
============================================
+ Hits          55684    59043    +3359     
- Misses        81787    82126     +339     
- Partials       7544     7695     +151     

Flag	Coverage Δ
inttests	27.43% <ø> (+1.11%)	⬆️
systests	23.66% <ø> (+0.90%)	⬆️
unittests	36.00% <ø> (+1.46%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 125 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.