feat(testing): add test helpers for deep reflection equality assertions #248
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.
Summary of Changes
Adds test helpers for comparing objects based on deep reflection. This is especially helpful when writing tests for object types that do not override
Object.equals().Public API Additions/Changes
Added
DeepReflectionEquals:This is a custom
ArgumentMatcherused with Mockitowhenandverifymethods. Mockito provideseq()which compares objects usingequals()anddeepEqwhich does a shallow reflection-based comparison. In contrast,deepRefEqdoes a deep reflection-based comparison, recursively comparing nested objects based on their internal structure.Added
TestUtils.deepEquals:This is a static assertion utility that compares two objects using deep reflection. Upon mismatch, it throws an AssertionError with detailed field-by-field differences. It also guarantees that both objects are of the exact same class.
The above example could also be written as:
However, this can become cumbersome for objects with lots of fields and nested objects.
Downstream Consumer Impact
N/A
How Has This Been Tested?
Added unit tests to confirm all new functionality. There are no changes to existing functionality and the new methods will only be used in test classes.
Checklist: