Use inline snapshots for error responses #9505
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
The downside of this is that the code needs to be recompiled when the expected error messages change, but it does bring the error messages closer to the test code, which makes the tests a little bit easier to digest. `cargo insta test` makes it fairly easy to update these expectations automatically, even for inline snapshots.
We can hardcode the error messages in our tests but that makes it quite hard to update the error messages, since they have to be updated in multiple places. With insta snapshots they will still have to be updated everywhere but `cargo insta test` can automate this process, which makes it a lot more straight-forward.
Turbo87
added
C-internal 🔧
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9505 +/- ##
==========================================
- Coverage 89.16% 89.09% -0.08%
==========================================
Files 286 286
Lines 29071 28878 -193
==========================================
- Hits 25921 25728 -193
Misses 3150 3150 ☔ View full report in Codecov by Sentry. |
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.
This PR converts most of our error response assertions to inline snapshot assertions powered by
insta. Snapshots are a lot easier to update automatically than hardcoded error messages (cargo insta test), and inline snapshots make it easier to comprehend what a test is expecting without having to open multiple files. The latter is obviously only valid for short responses, not for larger JSON documents.The main benefit of this is that our test code is now a bit more concise (+139 −994 🎉)