pact matcher for different number of elements in array

[iankurrathi]

Hi,
I have an endpoint which returns following format of response:

{
    "output": [
        "a",
        "b",
        "c"
    ]
}

This service can return any number of elements in array.
I was using 4.1.17 version of pact consumer and using array for matcher but it seems that matcher requires exact number of elements to be specified in pact.

My old code:

    @Pact(consumer = "test")
    private RequestResponsePact method(PactDslWithProvider builder) {
        return builder
                .given("test")
                .uponReceiving("test")
                .path("/api")
                .method(HttpGet.METHOD_NAME)
                .willRespondWith()
                .status(HttpStatus.SC_OK)
                .body(newJsonBody(o -> {
                    o.array("output", a -> {
                       a.stringType("a");
                    });
                }).build())
                .toPact();
    }

That's the matcher in json file:

"matchingRules": {
          "body": {
            "$.output[0]": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "type"
                }
              ]
            }
          }

This gives me following error:

Verifying a pact between test
  [Using File pacts/test-test.json]
  Given test
  test
    returns a response which
      has status code 200 (OK)
      has a matching body (FAILED)

Failures:

1) Verifying a pact between test and test - test has a matching body

    1.1) body: $.output Expected a List with 1 elements but received 3 elements

        [
        -  "a"
        +  "a",
        +  "b",
        +  "c"
        ]

As suggested to me in my stackoverflow question that I should use arrayContaining() method which supports varying list of elements in array.
I updated my code to following after updating pact consumer version to 4.2.0:

@Pact(consumer = "test")
    private RequestResponsePact method(PactDslWithProvider builder) {
        return builder
                .given("test")
                .uponReceiving("test")
                .path("/api")
                .method(HttpGet.METHOD_NAME)
                .willRespondWith()
                .status(HttpStatus.SC_OK)
                .body(newJsonBody(o -> {
                    o.arrayContaining("output", a -> {
                       a.stringType("a");
                    });
                }).build())
                .toPact();
    }

It generates following matcher in json file:

"matchingRules": {
          "body": {
            "$.output": {
              "combine": "AND",
              "matchers": [
                {
                  "match": "arrayContains",
                  "variants": [
                    {
                      "generators": {

                      },
                      "index": 0,
                      "rules": {
                        "[0]": {
                          "combine": "AND",
                          "matchers": [
                            {
                              "match": "type"
                            }
                          ]
                        }
                      }
                    }
                  ]
                }
              ]
            }
          }

However it gives me following error now:

Verifying a pact between test
  [Using File pacts/test-test.json]
  Given test
  test
      Request Failed - Path expression "[0]" does not start with a root marker "$"

Failures:

1) Verifying a pact between test and test - test

    1.1)       Path expression "[0]" does not start with a root marker "$"

Any help on this will be appreciated.
Thanks.

[uglyog]

What are you using to verify the pact with? That error means that the pact file is being verified as a V2 format, but the array contains matcher only works with V3 and V4 formatted pacts.

[uglyog]

Looks like there is an issue with the array contains matcher with simple values in the array.

[iankurrathi]

What are you using to verify the pact with? That error means that the pact file is being verified as a V2 format, but the array contains matcher only works with V3 and V4 formatted pacts.

Thanks for looking into. I am using 4.2.0 for both consumer and producer which I believe follows V4 specification.

[iankurrathi]

I see that you have put in a fix for this issue, can you please let me know which release version will have this fix? Thanks.

[uglyog]

4.2.2 released

[iankurrathi]

array matching works in 4.2.2.