fix(snap): Provide more stable snapshots #266
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
Before our auto-named snapshots used line numbers to make them unique. This would fail within macros. They could easily change for no good reason, requiring deleting the entire snapshot directory and restarting. Our paths were relative to the test file. I reconsidered this when doing the above because the function name made things less unique. In making them unique, I'd need to extend the path a lot (`src/<path>/snapshots/<path>.txt`). So I moved them to the root to all be together.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
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.
Before our auto-named snapshots used line numbers to make them unique.
This would fail within macros.
They could easily change for no good reason, requiring deleting the
entire snapshot directory and restarting.
In short, we change
src/<mod>/snapshots/<file>-<line>.txttests/snapshots/<normalized_fn_path>.txtwhere<normalized_fn_path> = <fn_path>.replace("::", "__")Our paths were relative to the test file.
I reconsidered this when doing the above because the function name made
things less unique.
In making them unique, I'd need to extend the path a lot
(
src/<path>/snapshots/<path>.txt).So I moved them to the root to all be together.
Not considering this a breaking change because of how non-deterministic the file names were before.