Clarify assert.Equal failure message given mismatched numeric types #327
Conversation
This file contains hidden or 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
This addresses vague and misleading output when asserting on the equality of two values of differing numeric types. Example: assert.Equal(t, int64(123), int32(123)) Previously, the user would have received a vague message claiming that 123 != 123. Now the message will read "int64(123) != int32(123)".
ernesto-jimenez
requested changes
Sep 24, 2016
There was a problem hiding this comment.
@jveski thanks, and sorry it has taken a while to reply. I've had some crazy busy time.
I've added some comments to make the code a bit more clear and check how structs are formatted too.
|
|
||
| func isNumericType(t reflect.Type) bool { | ||
| return numericTypes[t.String()] | ||
| } |
There was a problem hiding this comment.
Instead of this, you can do:
func isNumericType(t reflect.Type) bool {
switch t.Kind() {
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
return true
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
return true
case reflect.Float32, reflect.Float64:
return true
}
return false
}| expected, actual = formatUnequalValues(int64(123), int32(123)) | ||
| Equal(t, `int64(123)`, expected, "value should include type") | ||
| Equal(t, `int32(123)`, actual, "value should include type") | ||
| } |
There was a problem hiding this comment.
Include a check for a struct.
| " != %#v (actual)%s", expected, actual, diff), msgAndArgs...) | ||
| expected, actual = formatUnequalValues(expected, actual) | ||
| return Fail(t, fmt.Sprintf("Not equal: %v (expected)\n"+ | ||
| " != %v (actual)%s", expected, actual, diff), msgAndArgs...) |
There was a problem hiding this comment.
since expected and actual are going to be strings, we can use %s in Sprintf
This was referenced Sep 24, 2016
Since the values are already strings, there is no reason to use %v.
This expands the TestFormatUnequalValues test case to cover the behavior of the function when provided two struct type'd values.
|
@ernesto-jimenez no worries on the delay and I just pushed three commits with the changes you requested. btw thanks for maintaining this lib. It's really useful, and I know being a maintainer of projects like this can be rough, so thanks. 👍 |
ernesto-jimenez
approved these changes
Sep 25, 2016
jonnyreeves
pushed a commit
to jonnyreeves/testify
that referenced
this pull request
Jan 5, 2017
Clarify assert.Equal failure message given mismatched numeric types
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.
Resolves #155.
This change causes type names to be printed when the failure message would otherwise be ambiguous. Specifically, it addresses equality assertions on numeric values of unlike types.
Example
Before:
After: