DSL for Http Server to assert on Webhooks and similar

I want to test that my API is calling webhooks, and that it is sending the data as specified. Currently, I need to write my own HTTP server that saves and returns the data, so I can assert it. It would be awesome to have this integrated in Cornichon.

Here’s an example with a made-up DSL:

// Create the HTTP server that listens for webhooks
When I httpListenTo("http://localhost:12345/webhook")
// Do something that should trigger the webhook
When I post("/users").withBody(
"""
{
  "firstname": "Foo",
  "lastname": "Bar"
}
""")
Then assert status.is(201)
// Check that webhook was delivered
Then assert httpListen.received_calls(1)
And assert httpListen.lastBody.is(...)

[agourlay]

Here is what I believe I can propose for a start.

httpListenTo(label = "my-server", port = 12345){
  When I post("/users").withBody(
  """
  {
    "firstname": "Foo",
    "lastname": "Bar"
  }
  """) 
  Then assert status.is(201)
}
// Check that webhook was delivered
Then assert httpListen("my-server").received_calls(1)
And assert httpListen("my-server").receivedRequest(1).onUrl("...").withVerb("...").withBody("...")

Design points:

• the server is automatically started and stopped at the end of the block.
• assertions on the server must be done outside of the block.
• by default POST will receive 201 and the rest 200.

WDYT?

[agourlay]

first public version shipped in 0.9.3 + minimal doc available in Readme.