Skip to content
This repository has been archived by the owner on Jun 27, 2023. It is now read-only.

Built-in matcher that compares slices of arbitrary elements order #545

Closed
vvkh opened this issue Mar 22, 2021 · 3 comments
Closed

Built-in matcher that compares slices of arbitrary elements order #545

vvkh opened this issue Mar 22, 2021 · 3 comments

Comments

@vvkh
Copy link
Contributor

vvkh commented Mar 22, 2021

Requested feature

It would nice to have built-in matcher that compares slices and returns true if slices have same elements in arbitrary order.

Why the feature is needed

Sometimes code we are testing produces slices with non-determined elements order. For example, when converting map to slice we may end up with many possible orders of elements.

s := make([]interface{}, 0, len(m))
for k, v := range m {
    s = append(s, v)
}

Some testing frameworks like testify include special assert function checking if two slices have same elements.

If we have a mock depending on arguments with non-determined elements order such as s then setting up expected calls for such mock can be quite inconvenient. We either have to use Any() matcher and skip validating this argument at all or implement custom matcher.

Proposed solution

Include built-in matcher like InAnyOrder(s []interface{}) or WithSameElements(s []interface{} implementing checks similar to assert.ElementsMatch

P.S.
I will be happy to implement the matcher if we agree on this feature being useful.

@codyoss
Copy link
Member

codyoss commented Mar 22, 2021

Hey, thanks for the feature request. I will let this issue sit for a little bit to see what others in the community think of the idea. I could see how a matcher like this could be useful.

@vvkh
Copy link
Contributor Author

vvkh commented Apr 8, 2021

Hey @codyoss. I've provided draft implementation for requested issue. Could you please take a look?

@vvkh
Copy link
Contributor Author

vvkh commented May 18, 2021

Implemented in #546

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants