fix: resolve assert.Contains failure for byte slices #1721
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
|
cc: @brackendawson |
|
cc: @ccoVeille |
ccoVeille
reviewed
Mar 31, 2025
There was a problem hiding this comment.
Let me share here what I previously sent privately to @brackendawson
I'm unsure how these two differs:
- fix: resolve assert.Contains failure for byte slices #1721: yours @debug-ing )
- assert: support byte slice in Contains #1526: an old one reactivated recently by @nickajacks1
Because for me both are about:
Comment on lines
+932
to
+948
| if listType.Elem().Kind() == reflect.Uint8 { | ||
| if elementType, ok := element.(string); ok { | ||
| return true, bytes.Contains(listValue.Bytes(), []byte(elementType)) | ||
| } | ||
| if elementType, ok := element.([]byte); ok { | ||
| return true, bytes.Contains(listValue.Bytes(), elementType) | ||
| } | ||
| } | ||
|
|
||
| if elementValue.Kind() == reflect.Slice { | ||
| for i := 0; i <= listValue.Len()-elementValue.Len(); i++ { | ||
| if ObjectsAreEqual(listValue.Slice(i, i+elementValue.Len()).Interface(), element) { | ||
| return true, true | ||
| } | ||
| } | ||
| return true, false | ||
| } |
There was a problem hiding this comment.
check on same fields but with different values, means it should be a switch
switch listType.Elem().Kind() {
case reflect.Uint8:
case reflect.Slice:
}
Comment on lines
+933
to
+938
| if elementType, ok := element.(string); ok { | ||
| return true, bytes.Contains(listValue.Bytes(), []byte(elementType)) | ||
| } | ||
| if elementType, ok := element.([]byte); ok { | ||
| return true, bytes.Contains(listValue.Bytes(), elementType) | ||
| } |
There was a problem hiding this comment.
Please use a switch with type assertion here
Suggested change
| if elementType, ok := element.(string); ok { | |
| return true, bytes.Contains(listValue.Bytes(), []byte(elementType)) | |
| } | |
| if elementType, ok := element.([]byte); ok { | |
| return true, bytes.Contains(listValue.Bytes(), elementType) | |
| } | |
| switch elementType := element.(type) { | |
| case string: | |
| return true, bytes.Contains(listValue.Bytes(), []byte(elementType)) | |
| case []byte: | |
| return true, bytes.Contains(listValue.Bytes(), elementType) | |
| } |
this is pseudo code written on a phone, please adapt 😬
| @@ -927,6 +927,26 @@ func containsElement(list interface{}, element interface{}) (ok, found bool) { | |||
| return true, false | |||
| } | |||
|
|
|||
| if listKind == reflect.Slice { | |||
| elementValue := reflect.ValueOf(element) | |||
| if listType.Elem().Kind() == reflect.Uint8 { | |||
There was a problem hiding this comment.
I don't get the check on Uint8 type 🤔
Is it about checking its a byte?
Comment on lines
+942
to
+947
| for i := 0; i <= listValue.Len()-elementValue.Len(); i++ { | ||
| if ObjectsAreEqual(listValue.Slice(i, i+elementValue.Len()).Interface(), element) { | ||
| return true, true | ||
| } | ||
| } | ||
| return true, false |
There was a problem hiding this comment.
Please comment this, its purpose is quite obscure. Especially the check that is made
alexandear
reviewed
Apr 2, 2025
| @@ -1217,6 +1217,7 @@ func Test_containsElement(t *testing.T) { | |||
|
|
|||
| list1 := []string{"Foo", "Bar"} | |||
| list2 := []int{1, 2} | |||
| list3 := []byte(`Hello World Hello`) | |||
There was a problem hiding this comment.
Let be consistent here and below:
Suggested change
| list3 := []byte(`Hello World Hello`) | |
| list3 := []byte("Hello World Hello") |
| @@ -1251,6 +1252,14 @@ func Test_containsElement(t *testing.T) { | |||
| True(t, ok) | |||
| False(t, found) | |||
|
|
|||
| ok, found = containsElement(list3, []byte(`World`)) | |||
There was a problem hiding this comment.
Suggested change
| ok, found = containsElement(list3, []byte(`World`)) | |
| ok, found = containsElement(list3, []byte("World")) |
| True(t, ok) | ||
| True(t, found) | ||
|
|
||
| ok, found = containsElement(list3, []byte(`Foo`)) |
There was a problem hiding this comment.
Suggested change
| ok, found = containsElement(list3, []byte(`Foo`)) | |
| ok, found = containsElement(list3, []byte("Foo")) |
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.
Summary
Fixes assertion failure when using assert.Contains on byte slices.
Changes
Motivation
The previous implementation caused false negatives when checking for byte slice containment with assert.Contains. This fix ensures proper handling and improves test reliability.
Related issues
issue #1720