Add option to ignore the order of elements in arrays when using Snapshot.Match

[marionzr]

Is your feature request related to a problem? Please describe. I have the following json response and I want to ignore the order of the elements of metadata array. I'm using the Snapshooter.Xunit version 0.5.2 which allows me to ignore some fields (e.g. ids) but the order of the elements should be ignored as the elements will checked

Renerated response

{
  "data": {
    "createItem": {
      "item": {
        "id": 1,
        "name": "Dummy item",        
        "metadata": [
          {
            "id": 1,            
            "key": "answer",
            "value": "42"
          },
		  {
            "id": 2,
            "key": "question",
            "value": "the answer to life, the universe and everything"
          }
        ]
      }
    }
  }
}

Snap file

{
  "data": {
    "createItem": {
      "item": {
        "id": 1,
        "name": "Dummy item",        
        "metadata": [
          {
            "id": 1,
            "key": "question",
            "value": "the answer to life, the universe and everything"
          },
	  {
            "id": 2,            
            "key": "answer",
            "value": "42"
          }
        ]
      }
    }
  }
}

Describe the solution you'd like When matching arrays should be possible to set an option to ignore the order and the elements should be checks one by one to see if a matched element is found in the array.

Describe alternatives you've considered Allow injecting a function in the Snapshot.Match( to order the arrays before the comparison is executed

Additional context The failure message Message: Assert.Equal() Failure Expected: ··· "key": "question",\n Actual: ··· "key": "answer",\n

[nscheibe]

I propose to have a additional match option, where you can define the order for an array. We order the array before the snapshot is created, so we can make sure, that the snapshots are always the same. We will discuss it next week in the team.

[Aashay23]

Hi, I was wondering if this was implemented to ignore order of an array or if someone has a work around to currently ignore order when matching snapshots?

[RohrerF]

@Aashay23 afaik this has not been implemented jet. the current workaround is to sort the array yourself before making the snapshot.

[christianweberr]

up!

[robg-test]

I recently had this same problem when running tests where the array ordering was tripping us up being able to use a Snapshooter

I have created an open source project for sorting JSON given some basic options and configuration that allowed for the use of Snapshooter in our use case and a few others that have come up before. I've decided to package it up as a nuget package. Robtest.JSorter if anyone fancies a try.

JSON reordering turns out to be quite an interesting topic as Arrays can be sequences and you may not want to sort them in certain circumstances but in others it doesn't matter.

I ended up writing an Integration test with Snapshooter as an example of using it in conjunction with Snapshooter -> Integration Test