Can I preserve Mapping title and matchers for proxy response?

[steven-nelson-olo]

Hello.

I use a third party SOAP service that I've been told I run tests against too often. I was hoping to use WireMock to proxy and record these requests. Then I'd like to use the recorded mappings as stubs going forward. To proxy and record the initial set, I use something like this:

    server
        .Given(Request.Create().WithPath("/*")
        .WithBody(new RegexMatcher("<RequestType>Auth</RequestType")))
        .WithTitle(rule.Name)
        .RespondWith(Response.Create().WithProxy(new ProxyAndRecordSettings
        {
           Url = proxyTarget,
           AllowAutoRedirect = true,
           SaveMapping = true,
           SaveMappingToFile = true,
        }));

Because it is a SOAP service, all the requests use the same URL. The request primarily differ on the body contents. Currently when I run these requests, it seems like a new mapping is creating, using the path and method to create a new title. Since the path and method are the same for each request, each request overwrites the one before it. It also seems that the regex matchers that were specified in the original mapping are being discarded in favor of matching the url, path, headers, and an exact match on the body of the request.

If that understanding is correct, is there a way to work around this behavior to preserve the original mapping? If there isn't a work around, I'd like to submit a PR. In it, I'd try to add an option to ProxyAndRecordSettings and use that to decide how to build the resulting mapping. Would that help?

[StefH]

It also seems that the regex matchers that were specified in the original mapping are being discarded in favor of matching the url, path, headers, and an exact match on the body of the request.

I would expect that all matches would be used to find the correct/best match.

---

So what would be you proposal? Create a mapping-file-title also based on the body matcher?

[steven-nelson-olo]

I'm surprised that the Path and Regex matcher aren't used for the saved mapping. I expect some immaterial changes in the request body, such as timestamps, so I wouldn't want an exact match on the request body saved in the mapping. But that seems to be what is happening.

For the title, I'd also expect it to be used for the mapping file as it was provided in the Given/RespondWith setup.

When I use version 1.3.10, the supplied title was used, but the response saved in the mapping was just the proxy url. In the current version, the Request and Response for the mapping look like they're recreated in the proxy helper instead of using what's stated in the Given/RespondWith methods.

[StefH]

Just to clarify how it's currently implemented ->

None of the matchers defined in your request are used when the proxy mapping is saved (saved to memory or saved to file).

The ProxyHelper.cs gets all the things (path, method, body, headers, ...) and builds a new mapping.
And the title is set to $"Proxy Mapping for {requestMessage.Method} {requestMessage.Path}".

[steven-nelson-olo]

That matches with what I've seen.

Because I'd like to reuse the mappings as stubs after they've been saved to a file, it would be nice if the matchers defined in the request are used when the proxy mapping is saved. Does that make sense, or does it run counter to an expected use case?

[StefH]

A possible solution could be to:

• define a property UseDefinedRequestMatchers on the ProxyAndRecordSettings.cs
• when this property is set, the ProxyHelper.cs should use these instead the default exact matchers.
• so in your example the WithBody should use "<RequestType>Auth</RequestType" instead of an default exact matcher.

[steven-nelson-olo]

That sounds like it would work to me. I've started working on a change that seems similar, but uses more of the mapping in the chance that more than the matchers might be wanted. I created a PR so you can see what I meant.

[StefH]

See preview: 1.5.6-ci-16482

[steven-nelson-olo]

I tested with 1.5.6-ci-16482

I was able to verify the recorded mappings are saved with the title from the request mapping, and that the request matchers are storing the matchers from the request. Looks good to me!

[StefH]

#821

[StefH]

A new official nuget version will be released in some days.

[steven-nelson-olo]

Thanks @StefH I appreciate all of your help!

[steven-nelson-olo]

Hello again @StefH
Is there any update on when we might see an official nuget version?

[StefH]

Later today.

[StefH]

Done.