How to create a consumer test to application/x-www-form-urlencoded body

[Chuan Chuan Law]

Hi,

 

 

I am using the Groovy version is trying to write a consumer test that can POST a application/x-www-form-urlencoded body, for eg ‘number’ with 123456789.

 

Please advice.

 

 

Thank you very much.

 

 

Cheers,

 

Chuan

[Ronald Holshausen]

Hi Chuan,

You need to set the Content-Type header to application/x-www-form-urlencoded for the interactions in your test. Currently, Pact will do a comparison on the textual contents of the body for anything that is not in JSON format (basically string equality on the whole body). You test code might look something like:

            uponReceiving('a POST in application/x-www-form-urlencoded')
            withAttributes(method: 'post', path: '/path',
                headers: ['Accept': 'text/plain', 'Content-Type': 'application/x-www-form-urlencoded'],

                body: 'number=12345678'

            )
            willRespondWith(status: 201, body: 'form posted ok', headers: ['Content-Type': 'text/plain'])

Could you raise an issue against the pact-jvm project to get matching working for x-www-form-urlencoded encoded bodies?

--
You received this message because you are subscribed to the Google Groups "Pact" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pact-support...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--

Ronald Holshausen

DiUS Computing Pty Ltd

Level 10, 99 Queens Street
Melbourne, VIC 3000

Phone: +61 3 9008 5400
Mobile: +61 413 162 439

http://www.diuscomputing.com.au

[Chuan Chuan Law]

Thanks Ronald for the solution.

Yep, I've raised an issue on GitHub as you proposed.

Cheers,

Chuan

[Chuan Chuan Law]

In the Consumer test as well, I try to post like this:

def alice_response = client.post(path: '/task', requestContentType: 'application/x-www-form-urlencoded', headers:['Content-Type': 'application/x-www-form-urlencoded'], body: 'number=12345678' )

However, I keep getting a fail during "assert result == PactVerified$.MODULE"

If I change request content-type to 'text/html', assert will pass.

Does that mean that I will not be able to get a pass for this scenario although my response header is in text/html?  

Please advice.

Thanks helps.

Chuan

On Wednesday, 13 May 2015 13:36:10 UTC+10, Ronald Holshausen wrote:

[Ronald Holshausen]

If you can enable debug logging, you should be able to see the reason why it is not matching in the logs.

Regards,

Ronald

[Ronald Holshausen]

Hi Chuan,

I've worked out what the problem is. When posting a form that is URL encoded, the body gets interpreted as query parameters. Have a look at https://github.com/DiUS/pact-jvm/blob/master/pact-jvm-consumer-groovy/src/test/groovy/au/com/dius/pact/consumer/groovy/ExampleFormPostTest.groovy for a working example.

On Wednesday, 13 May 2015 14:40:55 UTC+10, Chuan Chuan Law wrote:

[Chuan Chuan Law]

Thank you so much for the example. The consumer test now passed.

However, the generated PACT file is as below:

"interactions" : [ {
  "providerState" : "Scenario of Carfacts REST asynchronous web service in LiveMarket for any internal requestor from within Carsales network",
  "description" : "a POST request",
  "request" : {
    "method" : "POST",
    "path" : "/task",
    "headers" : {
      "Content-Type" : "application/x-www-form-urlencoded"
    },
    "query" : "vin=1GJ2GYDG2A1827206"
  },

But the Provider expects is "body" instead of "query" though.

Please advice.

Thanks heaps.

Cheers,

Chuan

[Ronald Holshausen]

Looks like we need to change the provider verification to post the query in the body if it is a URL encoded form submission.

[Chuan Chuan Law]

Sorry, I don't really understand the suggested solution below:

Do you mind to give an example please?

Thanks.

[Ronald Holshausen]

The gradle/maven plugins need to be fixed to handle URL encoded form posts.

[Chuan Chuan Law]

Ah I see......thanks.

Let me know if I need to raise an issue on GitHub.

[Ronald Holshausen]

I think I'll just include it in the existing issue you raised.

[Chuan Chuan Law]

Hi Ronald,

Thanks for fixing the pact provider issue #119.

I guess there is 1 issue from this thread that's supposed to be included in issue #119 as well, which is still outstanding.

Basically the issue is that as below:

Consumer test looks like with post:

      given('Scenario of Carfacts REST asynchronous web service in LiveMarket for any internal requestor from within Carsales network')

            uponReceiving('a POST request')

            withAttributes(method: 'post', path: '/task', headers: ['Content-Type': 'application/x-www-form-urlencoded'],

                    query:'vin=1GJ2GYDG2A1827206&redbook=AAAAAAAA&musthave=7200&jde=100&kms=200&price=20000&pricetype=dap&image=www.google.com' +

                            '&rego=abc123&regostate=vic&colour=red&seller=SSE-SELLER-1984811&recorddesc=Current listing&comparison=0'

            )

            willRespondWith(

                    status: 201,

                    headers: ['Content-Type': 'text/html'],

                    body: '1'

            )

The generated pact file looks like:

 "interactions" : [ {

    "providerState" : "Scenario of Carfacts REST asynchronous web service in LiveMarket for any internal requestor from within Carsales network",

    "description" : "a POST request",

    "request" : {

      "method" : "POST",

      "path" : "/task",

      "headers" : {

        "Content-Type" : "application/x-www-form-urlencoded"

      },

      "query" : "vin=1GJ2GYDG2A1827206&redbook=AAAAAAAA&musthave=7200&jde=100&kms=200&price=20000&pricetype=dap&image=www.google.com&rego=abc123&regostate=vic&colour=red&seller=SSE-SELLER-1984811&recorddesc=Current listing&comparison=0"

    },

    "response" : {

      "status" : 201,

      "headers" : {

        "Content-Type" : "text/html"

      },

      "body" : "1"

    }

  } ],

However, we need the json to look like:

 "interactions" : [ {

    "providerState" : "there is some good mallory",

    "description" : "a retrieve Mallory request",

    "request" : {

      "method" : "POST",

      "path" : "/task",

      "headers" : {

        "Content-Type" : "application/x-www-form-urlencoded"

      },

      "body" : "vin=1GJ2GYDG2A1827206&redbook=AAAAAAAA&musthave=7200&jde=100&kms=200&price=20000&pricetype=dap&image=www.google.com&rego=abc123&regostate=vic&colour=red&seller=SSE-SELLER-1984811&recorddesc=Current listing&comparison=0"

    },

    "response" : {

      "status" : 201,

      "headers" : {

        "Content-Type" : "text/html"

      },

      "body" : "1"

    }

Basically, we need "query" to be "body". Please advice how can we generate a consumer test with POST and generates body.

Thanks.

[Ronald Holshausen]

Hi Chuan,

Part of the change I implemented will put the query string in the body when the content type is application/x-www-form-urlencoded.

[Chuan Chuan Law]

Hi Ronald,

I've got the latest version but:

   uponReceiving('a POST request')

            withAttributes(method: 'post', path: '/task', headers: ['Content-Type': 'application/x-www-form-urlencoded'],

                    query:'vin=1GJ2GYDG2A1827206&redbook=AAAAAAAA&musthave=7200&jde=100&kms=200&price=20000&pricetype=dap&image=www.google.com' +

                            '&rego=abc123&regostate=vic&colour=red&seller=SSE-SELLER-1984811&recorddesc=Current listing&comparison=0'

            )

Still generates:

  "request" : {

      "method" : "POST",

      "path" : "/task",

      "headers" : {

        "Content-Type" : "application/x-www-form-urlencoded"

      },

      "query" : "vin=1GJ2GYDG2A1827206&redbook=AAAAAAAA&musthave=7200&jde=100&kms=200&price=20000&pricetype=dap&image=www.google.com&rego=abc123&regostate=vic&colour=red&seller=SSE-SELLER-1984811&recorddesc=Current listing&comparison=0"

    },

Instead of:

 "request" : {

      "method" : "POST",

      "path" : "/task",

      "headers" : {

        "Content-Type" : "application/x-www-form-urlencoded"

      },

      "body" : "vin=1GJ2GYDG2A1827206&redbook=AAAAAAAA&musthave=7200&jde=100&kms=200&price=20000&pricetype=dap&image=www.google.com&rego=abc123&regostate=vic&colour=red&seller=SSE-SELLER-1984811&recorddesc=Current listing&comparison=0"

    },

Please advice.

Thank you.

[Ronald Holshausen]

It's still saved to the pact file as a query string. This is the correct form:

  "request" : {

      "method" : "POST",

      "path" : "/task",

      "headers" : {

        "Content-Type" : "application/x-www-form-urlencoded"

      },

      "query" : "vin=1GJ2GYDG2A1827206&redbook=AAAAAAAA&musthave=7200&jde=100&kms=200&price=20000&pricetype=dap&image=www.google.com&rego=abc123&regostate=vic&colour=red&seller=SSE-SELLER-1984811&recorddesc=Current listing&comparison=0"

    },

When the provider validates it, it will post the query string in the body because the content type is application/x-www-form-urlencoded.

[Chuan Chuan Law]

Got it Ronald.

It's working perfectly!

Thanks heaps.

Cheers,

Chuan