Support for matching unordered arrays in nested jsons

[jeroenj]

We have a quite complex JSON structure in which we have a mix of hashes and arrays. The root node is a Hash causing include_unordered_json to not be supported.

An example of our json (simplified):

{
  "foo" => "bar",
  "baz" => ["one", "three", "two"]
}

In that case we need to know the exact order of the baz array.

A workaround we use now is by explicitly wrapping the array in our expected json in RSpec::JsonExpectations::Matchers::UnorderedArrayMatcher classes:

{
  "foo" => "bar",
  "baz" => RSpec::JsonExpectations::Matchers::UnorderedArrayMatcher.new(["one", "two", "three"])
}

I'd say that include_unordered_json could accept a Hash too and uses the unordered array matcher for arrays it has in its structure.

[waterlink]

@jeroenj As far as I understand, matchers include_unordered_json and match_unordered_json should solve that issue?

[jeroenj]

@waterlink the issue described here indeed is related but it's a bit different. match_unorderd_json can only be used if the root node of the JSON being checked is an Array. In case the root node is a Hash (with an array as one of the keys) match_unordered_json can not be used.

[jeroenj]

I'm looking into refactoring some parts. I think that the following matchers are what we want:

• include_json which only checks if the expected JSON is included. Arrays are matched unordered.
• match_json which checks if the returned JSON is an exact match of the expected JSON meaning that all key-values need to be present and arrays should be orderd exactly as expected.
• match_unordered_json which checks if the returned JSON has exactly the same data as the expected JSON but arrays are matched unordered. (basically match_json but without the requirement for ordered arrays)

What do you think about it? I think it would cover all possible situates needed but I might be overlooking something. :)

[benoittgt]

Very interested about the match_json 😃

[linkyndy]

What's the status on this issue? I also found myself in the same situation.

[XenoPhex]

We're also very interested in the match_json matcher for the Cloudfoundry's Cloud Controller API tests. We currently have a custom matcher to do JSON validation that errors when the actual JSON has extra fields. Having match_json would allow us to swap this custom matcher for this more generic matcher.

[waterlink]

@XenoPhex I’ll take a look into this. Shall we jump on chat/zoom at some point to discuss how you want to use such a matcher?

[tobiasz-p]

@waterlink @XenoPhex what's the status of this issue?