ENH: SIMPL Backwards Compatibility Test Redesign#1588
Open
imikejackson wants to merge 1 commit intoBlueQuartzSoftware:developfrom
Open
ENH: SIMPL Backwards Compatibility Test Redesign#1588imikejackson wants to merge 1 commit intoBlueQuartzSoftware:developfrom
imikejackson wants to merge 1 commit intoBlueQuartzSoftware:developfrom
Conversation
2d92dc6 to
0d0d2d5
Compare
The original backwards compatibility test was a single 1,100-line monolithic test file (BackwardsCompatibilityTest.cpp) that validated SIMPL 6.5/6.6 pipeline conversion for all filters at once. It relied on two large hand-maintained data structures: - k_ParamMap (~500 lines) — a global map of parameter type UUIDs to expected exemplar values, with custom std::any comparator lambdas for each parameter type - k_KeyIgnoreMap (~180 lines) — a manual list of NX-only parameter keys per filter that the test had to skip The core maintenance problem: whenever a developer added a new parameter to any filter, they had to also update k_KeyIgnoreMap with that parameter's key, or the centralized test would fail. This was unintuitive, error-prone, and completely disconnected from the filter being changed. The ignore list grew with every filter enhancement and provided no signal about what it was actually protecting.
0d0d2d5 to
148ebe4
Compare
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
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.
The original backwards compatibility test was a single 1,100-line monolithic test file (BackwardsCompatibilityTest.cpp) that validated SIMPL 6.5/6.6 pipeline conversion for all
filters at once. It relied on two large hand-maintained data structures:
The core maintenance problem: whenever a developer added a new parameter to any filter, they had to also update k_KeyIgnoreMap with that parameter's key, or the centralized test
would fail. This was unintuitive, error-prone, and completely disconnected from the filter being changed. The ignore list grew with every filter enhancement and provided no
signal about what it was actually protecting.
⏺ Summary: SIMPL Backwards Compatibility Test Redesign
Problem
The original backwards compatibility test was a single 1,100-line monolithic test file (BackwardsCompatibilityTest.cpp) that validated SIMPL 6.5/6.6 pipeline conversion for all
filters at once. It relied on two large hand-maintained data structures:
The core maintenance problem: whenever a developer added a new parameter to any filter, they had to also update k_KeyIgnoreMap with that parameter's key, or the centralized test
would fail. This was unintuitive, error-prone, and completely disconnected from the filter being changed. The ignore list grew with every filter enhancement and provided no
signal about what it was actually protecting.
Additionally, the test:
Solution
Replace the centralized test with per-filter backwards compatibility tests embedded in each filter's existing test file. Each test:
Why this is better
Zero-maintenance ignore list: Tests only CHECK parameters that FromSIMPLJson actually converts. NX-only parameters are never mentioned, so adding new parameters to a filter
requires no test changes whatsoever.
Full pipeline loading path coverage: The original test bypassed UUID lookup, filter resolution, and the type validation in PipelineFilter::FromSIMPLJson. The new tests exercise
the exact code path a user hits when opening a legacy pipeline in DREAM3DNX. If someone breaks the UUID mapping in a plugin's LegacyUUIDMapping.hpp, the test catches it.
SIMPL 6.4 coverage: Each filter now tests the Filter_Name → k_LegacySimplFilterUuidMap fallback path, which was completely untested before.
Clear failure isolation: When a conversion breaks, the failing test names the exact filter — not "6.6 Mega Pipeline Conversion failed" with a wall of error strings to parse.
No test data download required: JSON fixtures are small text files stored in git under test/simpl_conversion/6_5/ and 6_4/. They diff cleanly in PRs, don't need tar/hash/upload
cycles, and don't require the TestFileSentinel download machinery.
Reviewable in context: When a filter's FromSIMPLJson changes, the corresponding test and fixture are right next to the filter code — reviewable in the same PR diff.
What was removed
What was added