Elide uninteresting fields in object diffs. #498
Merged
Conversation
This file contains 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
porridge
requested review from
kensipe,
asekretenko and
kaiwalyajoshi
as code owners
kovayur
approved these changes
Nov 22, 2023
Signed-off-by: Marcin Owsiany <[email protected]>
kensipe
approved these changes
Jan 31, 2024
|
re-reading the PR desc... the first paragraph or sentence would make a perfect godoc for the |
Signed-off-by: Marcin Owsiany <[email protected]>
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.
What this PR does / why we need it:
Makes diffs on large objects much less verbose but not any less useful, by omitting these fields in the object which are not specified in the assertion and are at least moderately long when serialized.
This way, asserting on
status.availableReplicasof a Deployment (which is missing if zero replicas are available) will still show thestatus.unavailableReplicasfor example, but will omitspeccompletely unless the assertion also mentions it.This saves hundreds to thousands of lines of logs to scroll when debugging failures of my operator tests. See the test for an example output. Before this change, the diff would contain the entirety of the "actual" resource from a cluster.
Fixes #497
Fixes #370