Add option to capture raw snapshots when running tests #9775
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
dominikschubert
added
the
semver: patch
bentsku
reviewed
Nov 29, 2023
There was a problem hiding this comment.
This is great! I think this is a nice addition that can be really helpful when debugging snapshots and trying to understand why some parts are different, or why some transformers are not behaving like we expect them too.
It still marked as POC, but I'd up for merging this as is, as it's only opt-in and a nice tool.
It's also very nice that it keeps the ResponseMetadata, as sometimes some headers are not parsed/in the specs so we can quickly see if boto is missing something.
I now see what you meant with saving raw LocalStack snapshots too, to be able to full compare them. Maybe this would be a good addition 🤔
dominikschubert
changed the title
dominikschubert
changed the title
bentsku
approved these changes
Nov 30, 2023
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.
Motivation
A useful util for debugging snapshots. RAW snapshots are the RAW untransformed recorded content . In contrast to normal snapshots these should not be committed (see gitignore) and should only be used for debugging & exploration purposes.
Changes
SNAPSHOT_RAW=1or use the CLI argument--snapshot-rawto enable this mode. When enabled it will save a separate JSON file next to the normal snapshots with the "raw", i.e. untransformed recorded contents.Testing
Set
SNAPSHOT_RAW=1and execute a snapshot test