Better snapshot output and JSON content-type verification #32
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
For cases like: - Parameters, such as `application/json; charset=utf-8` - Vendors, like `application/vnd.foo.bar.v2+json`
meydjer
changed the title
sjkaliski
requested changes
Mar 12, 2018
assert.go
Outdated
| @@ -132,16 +154,18 @@ func compareResults(t *testing.T, existing, new string) string { | |||
| return dmp.DiffPrettyText(allDiffs) | |||
| } | |||
|
|
|||
| func didNotMatchMessage(diff string) string { | |||
| msg := "\n\nExisting snapshot does not match results...\n\n" | |||
| func didNotMatchMessage(id string, diff string) string { | |||
There was a problem hiding this comment.
Since id and diff are both strings, let's collapse the function signature.
func didNotMatchMessage(id, diff string) string {
assert.go
Outdated
|
|
||
| isJSON := strings.HasSuffix(firstPart, "+json") | ||
|
|
||
| if isVendor && isJSON { |
There was a problem hiding this comment.
return isVendor && isJSON
assert.go
Outdated
| msg += diff | ||
| msg += "\n\n" | ||
| msg += "If this change was intentional, run tests again, $ go test -v -- -u\n" | ||
| return msg | ||
| } | ||
|
|
||
| func newSnapshotMessage(body string) string { | ||
| msg := "\n\nNew snapshot found...\n\n" | ||
| func newSnapshotMessage(id string, body string) string { |
assert_test.go
Outdated
| @@ -0,0 +1,31 @@ | |||
| package abide | |||
|
|
|||
| import "testing" | |||
assert_test.go
Outdated
|
|
||
| import "testing" | ||
|
|
||
| var contentTypeTestCases = []struct { |
There was a problem hiding this comment.
Since only this test would use this particular set of cases (e.g. different set if we had contentTypeIsXML), let's move this directly into TestContentTypeIsJSON. It may also be easier to use map[string]bool as well.
assert_test.go
Outdated
|
|
||
| func TestContentTypeIsJSON(test *testing.T) { | ||
| for _, testCase := range contentTypeTestCases { | ||
|
|
sjkaliski
approved these changes
Mar 14, 2018
|
LGTM! Thanks @meydjer |
|
You are welcome @sjkaliski, it's a great package. I'm using it to test JSON outputs for an API i'm building with Gin Gonic. I just started using it so I don't have much feedback yet (apart from this Pull Request). But I will keep in touch with you. Thanks for your time and for sharing this tool with us. |
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.
When you have a lot of snapshots with similar outputs is a little bit hard to differentiate them.
This commit improves readability by adding the snapshot ID to the output.