Extending the model used by Handlebar Template

[hervé DARRITCHON]

Hi !

I have a question.

It's possible to use in the response some data from the request as it is written in the documentation and it works :)

Exemple :

{

  "request": {

    "method": "GET",

    "urlPath": "/some/thing"

  },

  "response": {

    "status": 200,

    "jsonBody": {

      "uuid": "c80ec299-e09d-43ee-afcf-10f4eeee349a",

      "lastModificationDate": "2016-11-21T10:02:27.390Z",

      "title": "{{request.url}}",

    },

    "headers": {

      "Content-Type": "application/json"

    }

  }

}

So far, it was enough :) But I'd like to extend the use of Handlebar template with some data that are not available in the request.

In the next example, I'd like to value the {{today}} with the current date.

Exemple :

{

  "request": {

    "method": "GET",

    "urlPath": "/some/thing"

  },

  "response": {

    "status": 200,

    "jsonBody": {

      "uuid": "c80ec299-e09d-43ee-afcf-10f4eeee349a",

      "lastModificationDate": "{{today}}",

      "title": "{{request.url}}",

    },

    "headers": {

      "Content-Type": "application/json"

    }

  }

}

What is the best way to do so ?

Thanks for the stuff done on this great mock and stub framework.

Hervé

[Tom Akehurst]

At the moment the easiest way to do this is to add your own Handlebars helper (documented near the bottom of the response templating page).

Unfortunately if you're running standalone this means you'll need to re-bake your own standalone JAR with your code in it.

[hervé DARRITCHON]

ok, thanks Tom.

But the documentation is a bit short :)

Where do I have to put the code of the Helper

Helper<String> stringLengthHelper = new Helper<String>() {
@Override public Object apply(String context, Options options) throws IOException { return context.length(); } };

I tried to put it in my class that starts the mock server 

 WireMockServer wireMockServer = new WireMockServer(wireMockConfig()
                .extensions(new MyShopDateTransformer(false),"string-length", stringLengthHelper)
                .extensions(new MyShopStatusTransformer())
                .port(8089)
                .usingFilesUnderDirectory("src/test/resources"));

But it's not working, no constructor found for extensions with this signature.

I'm a bit disoriented, If you can help me ;)

Thanks.

[Tom Akehurst]

Follow these instructions: http://wiremock.org/docs/response-templating#customer-helpers

[alperen üretmen]

I think custom helpers part is unclear beacuse there is almost no information in the website  (in " http://wiremock.org/docs/response-templating#customer-helpers")
I read the instructions but I still dont have any idea  where to declare it, where to use it and what is the context in helper(request or response ?? )

21 Nisan 2017 Cuma 13:06:32 UTC+3 tarihinde Tom Akehurst yazdı:

[Tom Akehurst]

The context is whatever you pass into the helper's arguments when you use it in a template. Suggest checking out the Handlebars docs because this is totally standard Handlebars behaviour, nothing unique to MockLab here.

You declare it in WireMock's configuration builder, passed to the WireMockRule constructor or WireMockServer constructor. This is shown in the doc I linked.

[alperen üretmen]

After reading more documentation and trial-errors, I finally did it, thank you:)

25 Ekim 2017 Çarşamba 19:59:25 UTC+3 tarihinde Tom Akehurst yazdı:

[Michael McFadyen]

Could you possibly share your code or create an example project for future reference? There seems to be very little documentation or examples on this feature. 

[Tom Akehurst]

Are you having trouble actually writing the helper or just with integrating it into WireMock?

If the former, have you looked at the Handlebars docs?

http://jknack.github.io/handlebars.java/helpers.html

[Michael McFadyen]

I'm unsure of how to go about create a custom helper and using it with standalone wiremock.

[Tom Akehurst]

Creating custom helpers with standalone is a bit of a pain at the moment unfortunately.

Basically you need to create your own fat JAR with WireMock + your helpers included.

[Michael McFadyen]

Yeah, that's why I was looking for an example as I'm not sure where to start. I'm guessing I will have to have a new main method that configures and runs wiremock with the custom helper. 

Can you post a link to the main class that is used for standalone wiremock? 

[Tom Akehurst]

It's this one:

https://github.com/tomakehurst/wiremock/blob/master/src/main/java/com/github/tomakehurst/wiremock/standalone/WireMockServerRunner.java

You could just clone that, and swap the command line options stuff for WireMockConfiguration.options(), which would allow you to register your helpers.

[Michael McFadyen]

great, thanks. I'll give it go and hopefully create an example project.