Cannot request match when the request JSON body's element order is different from that specified in the Stub

• WireMock Version: com.github.tomakehurst:wiremock-jre8:2.24.1
• Framework: Spring Boot 2.0.3 - Release
• JUnit Version: org.powermock:powermock-module-junit4:2.0.0-beta.5
• WireMock Configuration:

    @Rule
    public WireMockRule wireMockRule = new WireMockRule(options().bindAddress(WIREMOCK_HOST).port(WIREMOCK_PORT).notifier(new ConsoleNotifier(true)));

• Stub:

Stub

stubFor(post(urlMatching(URL))
                    .withHeader("Content-Type", equalTo("application/json"))
                    .withRequestBody(equalToJson(REQUEST_BODY_JSON.toString(), true, true))
                    .willReturn(aResponse()
                            .withHeader("Content-Type", "application/json")
                            .withHeader("Connection", "close")
                            .withBody(RESPONSE_JSON.toString())));

Issue Description

The following JSON object (which consists of a few key-value pairs and an array) is used in the withRequestBody() matcher.

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3",
  "key4": "value4",
  "arr": [
    "arrValue1",
    "arrValue2",
    "arrValue3",
    "arrValue4"
  ]
}

When the following JSON is sent in the actual request body switching the order of the elements in the JSON object, WireMock fails to match it with the Stub.

{
  "arr": [
    "arrValue1",
    "arrValue2",
    "arrValue3",
    "arrValue4"
  ],
  "key1": "value1",
  "key2": "value2",
  "key3": "value3",
  "key4": "value4"
}

Actual Error

                                               Request was not matched
                                               =======================

-----------------------------------------------------------------------------------------------------------------------
| Closest stub                                             | Request                                                  |
-----------------------------------------------------------------------------------------------------------------------
                                                           |
POST                                                       | POST
/mockStub                                                  | /mockStub
                                                           |
Content-Type: application/json                             | Content-Type: application/json
                                                           |
{                                                          | {                                                   <<<<< Body does not match
  "category" : "060",                                      |   "children" : [ {
  "date" : "20200312",                                     |     "id" : "9010946",
  "isRegistered" : true,                                   |     "age" : 1,
  "id" : "12302067",                                       |     "isRegistered" : false
  "children" : [ {                                         |   }, {
    "id" : "9405762",                                      |     "id" : "9405762",
    "age" : 1,                                             |     "age" : 1,
    "isRegistered" : true                                  |     "isRegistered" : true
  }, {                                                     |   }, {
    "id" : "9010946",                                      |     "id" : "9166586",
    "age": 1,                                              |     "age" : 1,
    "isRegistered" : false                                 |     "isRegistered" : false
  }, {                                                     |   }, {
    "id" : "7537984",                                      |     "id" : "7537984",
    "age" : 1,                                             |     "age" : 1,
    "isRegistered" : true                                  |     "isRegistered" : true
  }, {                                                     |   } ],
    "id" : "9166586",                                      |   "category" : "060",
    "age" : 1,                                             |   "id" : "12302067",
    "isRegistered" : false                                 |   "isRegistered" : true,
  } ]                                                      |   "date" : "20200312"
}                                                          | }
                                                           |
-----------------------------------------------------------------------------------------------------------------------

[tomakehurst]

The JRE8 version of WireMock 2.26+ has a new underlying implementation for JSON equality that fixes some bugs regarding array order. The JRE7 version still uses the old impl because the library used by the new one is Java8+ only.

[damianperera]

@aaron-goff my bad, that was a copy-paste error - I edited it with the correct snippet.